Scene
Scene
[POST] /api/v2/dashboard/scenes
Request Schema
Response
Status Code: 201
Created
Status Code: 400
Bad Request
Status Code: 403
Forbidden
Status Code: 404
Not Found
[GET] /api/v2/dashboard/scenes/{id}
Get Scene
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| idRequired | string | path | scene id |
| rev | int32 | query | scene revision |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 403
Forbidden
Status Code: 404
Not Found
[PUT] /api/v2/dashboard/scenes/{id}
Update Scene
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| idRequired | string | path | scene id |
Request Schema
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 403
Forbidden
Status Code: 404
Not Found
[DELETE] /api/v2/dashboard/scenes/{id}
Delete Scene
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| idRequired | string | path | scene id |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 403
Forbidden
Status Code: 404
Not Found
[POST] /api/v2/dashboard/scenes/{id}/revert
Revert Scene
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| idRequired | string | path | scene id |
| rev | int32 | query | scene revision |
Response
Status Code: 400
Bad Request
Status Code: 403
Forbidden
Status Code: 404
Not Found
[GET] /api/v2/dashboard/scenes/{id}/download
Parameters
| Name | Type | Located In |
|---|---|---|
| idRequired | string | path |
Response
Status Code: 200
Success
Models
Ƭ SceneResponse
Scene POST Response
| Name | Type | Description | Example |
|---|---|---|---|
| sceneIdNullable | string | New Scene ID |
Ƭ ServerPluginError
Server plugin error
| Name | Type | Description | Example |
|---|---|---|---|
| codeNullable | string | error code | |
| messageNullable | string | error message | |
| contextNullable | string | error context |
Ƭ SceneBaseViewModel
| Name | Type | Description | Example |
|---|---|---|---|
| titleNullable | string | ||
| commentNullable | string | ||
| tagIdsNullable | Array<string> |
||
| datasetProfilesNullable | any | ||
| sharedResourcesNullable | SharedResource | ||
| optionsNullable | any | ||
| modelsNullable | Array |
||
| meshesNullable | Array |
||
| lightsNullable | Array |
||
| camerasNullable | Array |
||
| dataLayersNullable | Array |
||
| content | Content | ||
| parametersNullable | DashboardParameter | ||
| versionNullable | string |
Ƭ SharedResource
| Name | Type | Description | Example |
|---|---|---|---|
| idNullable | string | ||
| type | DocumentType |
Ƭ Content
| Name | Type | Description | Example |
|---|---|---|---|
| docThemeNullable | any | ||
| filtersNullable | Array |
||
| imageListNullable | DashboardImage | ||
| languageResourceNullable | any |
Ƭ 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 |
Ƭ DocumentType
Enum:
UnknownDashboardDatasetDataSourceImageThemeMapHierarchyGeoJsonReportVisualFloorPlanAnalysisModelFontLanguageResourceNativeQuerySceneGlbDashboardTemplateVizTemplate
Ƭ DashboardImage
| Name | Type | Description | Example |
|---|---|---|---|
| idNullable | string | ||
| nameNullable | string | ||
| srcNullable | string | ||
| size | int32 | ||
| typeNullable | string | ||
| dashboardIdNullable | string |
Ƭ 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
Representing the query to execute to obtain the default value(s) for the parameter.
| Name | Type | Description | Example |
|---|---|---|---|
| datasetIdNullable | string | ||
| valueFieldNullable | string | ||
| entityNameNullable | string | ||
| aggTypeNullable | string |
Ƭ ParameterValue
| Name | Type | Description | Example |
|---|---|---|---|
| labelNullable | string | Label for the value to display in a UI | |
| valueNullable | string | Specifies a value for a parameter. |
Ƭ 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> |
Ƭ SceneViewModel
| Name | Type | Description | Example |
|---|---|---|---|
| idNullable | string | ||
| titleNullable | string | ||
| commentNullable | string | ||
| tagIdsNullable | Array<string> |
||
| datasetProfilesNullable | any | ||
| sharedResourcesNullable | SharedResource | ||
| optionsNullable | any | ||
| modelsNullable | Array |
||
| meshesNullable | Array |
||
| lightsNullable | Array |
||
| camerasNullable | Array |
||
| dataLayersNullable | Array |
||
| content | Content | ||
| parametersNullable | DashboardParameter | ||
| versionNullable | string |