Notebook

[GET] /api/v2/notebooks/{id}

Get Notebook

Parameters

Name	Type	Located In	Description
idRequired	string	path	notebook id
rev	int32	query	notebook revision

Response

Status Code: 200

Success

NotebookViewModel

Status Code: 400

Bad Request

ServerPluginError

Status Code: 403

Forbidden

ServerPluginError

Status Code: 404

Not Found

ServerPluginError

[PUT] /api/v2/notebooks/{id}

Update Notebook

Parameters

Name	Type	Located In	Description
idRequired	string	path	notebook id

Request Schema

NotebookEditViewModel

Response

Status Code: 200

Success

Status Code: 400

Bad Request

ServerPluginError

Status Code: 403

Forbidden

ServerPluginError

Status Code: 404

Not Found

ServerPluginError

[POST] /api/v2/notebooks

Create new Notebook

Request Schema

NotebookCreateViewModel

Response

Status Code: 201

Created

NotebookPostResponse

Status Code: 400

Bad Request

ServerPluginError

Status Code: 403

Forbidden

ServerPluginError

Status Code: 404

Not Found

ServerPluginError

[POST] /api/v2/notebooks/{id}/revert

Revert Notebook

Parameters

Name	Type	Located In	Description
idRequired	string	path	notbook id
rev	int32	query	notebook revision

Response

Status Code: 400

Bad Request

ServerPluginError

Status Code: 403

Forbidden

ServerPluginError

Status Code: 404

Not Found

ServerPluginError

[GET] /api/v2/notebooks/{id}/download

Download Notebook

Parameters

Name	Type	Located In	Description
idRequired	string	path	notebook id

Response

Status Code: 200

Success

Models

Ƭ NotebookViewModel

Name	Type	Description	Example
idNullable	string
titleNullable	string
content	Content
optionsNullable	any
notesNullable	Note
sharedResourcesNullable	SharedResource
versionNullable	string
datasetProfilesNullable	any
tagIdsNullable	Array<string>
commentNullable	string
parametersNullable	DashboardParameter

Ƭ Content

Name	Type	Description	Example
docThemeNullable	any
filtersNullable	Array
imageListNullable	DashboardImage
languageResourceNullable	any

Ƭ Note

Name	Type	Description	Example
idNullable	string
contentNullable	any
optionsNullable	any

Ƭ SharedResource

Name	Type	Description	Example
idNullable	string
type	DocumentType

Ƭ DashboardParameter

Name	Type	Description	Example
nameNullable	string	Name of the parameter.
promptNullable	string	The text to display to a user when prompting the a for the parameter's value.
dataTypeNullable	string	The data type of the parameter.
outputDataTypeNullable	string
dateOnly	Boolean
multiValue	Boolean
multiline	Boolean
hidden	Boolean
allowBlank	Boolean
validValues	ValidValues
defaultValue	DefaultValue
binding	Binding
transform	Transform
valueTypeNullable	string

Ƭ DashboardImage

Name	Type	Description	Example
idNullable	string
nameNullable	string
srcNullable	string
size	int32
typeNullable	string
dashboardIdNullable	string

Ƭ DocumentType

Enum:

• Unknown
• Dashboard
• Dataset
• DataSource
• Image
• Theme
• MapHierarchy
• GeoJson
• Report
• Visual
• FloorPlan
• AnalysisModel
• Font
• LanguageResource
• NativeQuery
• DataFile
• Spreadsheet
• Scene
• Glb
• DashboardTemplate
• VizTemplate
• IoT
• FilterView
• Notebook

Ƭ ValidValues

Name	Type	Description	Example
datasetReference	DatasetReference
valuesNullable	ParameterValue	Gets the list of possible values for the parameter.

Ƭ DefaultValue

Name	Type	Description	Example
datasetReference	DatasetReference
valuesNullable	Array<string>	Gets the default values for the parameter.
logicValuesNullable	LogicValue	Gets the Logic values of default values.

Ƭ Binding

Name	Type	Description	Example
value	ParameterBindingValue
valueTypeNullable	string

Ƭ Transform

Name	Type	Description	Example
ruleNullable	string
directionNullable	string
unitNullable	string
formatterNullable	string

Ƭ DatasetReference

Name	Type	Description	Example
datasetIdNullable	string
valueFieldNullable	string
entityNameNullable	string
aggTypeNullable	string
sortBy	SortBy

Ƭ ParameterValue

Name	Type	Description	Example
labelNullable	string	Label for the value to display in a UI
valueNullable	string	Specifies a value for a parameter.

Ƭ SortBy

Representing the query to execute to obtain the default value(s) for the parameter.

Name	Type	Description	Example
order	int32
columnNullable	string

Ƭ LogicValue

Name	Type	Description	Example
valueTypeNullable	string
valueNullable	string
datasetReference	DatasetReference

Ƭ ParameterBindingValue

Name	Type	Description	Example
nameNullable	string
valuePropertyNameNullable	string
columnsNullable	Array<string>
checkedFieldNamesNullable	Array<string>

Ƭ ServerPluginError

Server plugin error

Name	Type	Description	Example
codeNullable	string	error code
messageNullable	string	error message
contextNullable	string	error context

Ƭ NotebookEditViewModel

Name	Type	Description	Example
content	Content
optionsNullable	any
notesNullable	Note
sharedResourcesNullable	SharedResource
versionNullable	string
datasetProfilesNullable	any
tagIdsNullable	Array<string>
commentNullable	string
parametersNullable	DashboardParameter

Ƭ NotebookPostResponse

Notebook POST Response

Name	Type	Description	Example
notebookIdNullable	string	New Notebook ID

Ƭ NotebookCreateViewModel

Name	Type	Description	Example
titleNullable	string
content	Content
optionsNullable	any
notesNullable	Note
sharedResourcesNullable	SharedResource
versionNullable	string
datasetProfilesNullable	any
tagIdsNullable	Array<string>
commentNullable	string
parametersNullable	DashboardParameter