Notebook

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

Parameters

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

Get Notebook

Responses

[200] Success

NotebookViewModel

Type: [application/json]

[400] Bad Request

ServerPluginError

Type: [application/json]

[403] Forbidden

ServerPluginError

Type: [application/json]

[404] Not Found

ServerPluginError

Type: [application/json]

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

Parameters

Name	In	Type	Description
idRequired	path	string	notebook id

Update Notebook

Request Body

Description: notebook docData

Type: application/json

NotebookEditViewModel

Responses

[200] Success

[400] Bad Request

ServerPluginError

Type: [application/json]

[403] Forbidden

ServerPluginError

Type: [application/json]

[404] Not Found

ServerPluginError

Type: [application/json]

[POST] /api/v2/notebooks

Create new Notebook

Request Body

Description: notebook data

Type: application/json

NotebookCreateViewModel

Responses

[201] Created

NotebookPostResponse

Type: [application/json]

[400] Bad Request

ServerPluginError

Type: [application/json]

[403] Forbidden

ServerPluginError

Type: [application/json]

[404] Not Found

ServerPluginError

Type: [application/json]

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

Parameters

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

Revert Notebook

Responses

[400] Bad Request

ServerPluginError

Type: [application/json]

[403] Forbidden

ServerPluginError

Type: [application/json]

[404] Not Found

ServerPluginError

Type: [application/json]

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

Parameters

Name	In	Type	Description
idRequired	path	string	notebook id

Download Notebook

Responses

[200] Success

Models

Ƭ NotebookViewModel

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

Ƭ Content

Name	Type
docThemeNullable	any
filtersNullable	Array
imageListNullable	Array<DashboardImage>
languageResourceNullable	any

Ƭ Note

Name	Type
idNullable	string
contentNullable	any
optionsNullable	any

Ƭ SharedResource

Name	Type
idNullable	string
type	DocumentType

Ƭ DashboardParameter

Name	Type	Description
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
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
datasetReference	DatasetReference
valuesNullable	Array<ParameterValue>	Gets the list of possible values for the parameter.

Ƭ DefaultValue

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

Ƭ Binding

Name	Type
value	ParameterBindingValue
valueTypeNullable	string

Ƭ Transform

Name	Type
ruleNullable	string
directionNullable	string
unitNullable	string
formatterNullable	string

Ƭ DatasetReference

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

Ƭ ParameterValue

Name	Type	Description
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
order	int32
columnNullable	string

Ƭ LogicValue

Name	Type
valueTypeNullable	string
valueNullable	string
datasetReference	DatasetReference

Ƭ ParameterBindingValue

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

Ƭ ServerPluginError

Server plugin error

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

Ƭ NotebookEditViewModel

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

Ƭ NotebookPostResponse

Notebook POST Response

Name	Type	Description
notebookIdNullable	string	New Notebook ID

Ƭ NotebookCreateViewModel

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