Dashboard
Dashboard
[POST] /api/v2/dashboard/dashboards
Create new dashboard
Request Schema
Response
Status Code: 201
Created
Status Code: 400
Bad Request
Status Code: 403
Forbidden
Status Code: 404
Not Found
[POST] /api/v2/dashboard/templates
Create new template
Request Schema
Response
Status Code: 201
Created
Status Code: 400
Bad Request
Status Code: 403
Forbidden
Status Code: 404
Not Found
[PUT] /api/v2/dashboard/dashboards/{id}
Update Dashboard
Parameters
Name | Type | Located In | Description |
---|---|---|---|
idRequired | string | path | dashboard 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/dashboards/{id}
Delete Dashboard
Parameters
Name | Type | Located In | Description |
---|---|---|---|
idRequired | string | path | dashboard id |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 403
Forbidden
Status Code: 404
Not Found
[GET] /api/v2/dashboard/dashboards/{id}
Get Dashboard
Parameters
Name | Type | Located In | Description |
---|---|---|---|
idRequired | string | path | dashboard id |
rev | int32 | query | dashboard revision |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 403
Forbidden
Status Code: 404
Not Found
[PUT] /api/v2/dashboard/templates/{id}
Update template
Parameters
Name | Type | Located In | Description |
---|---|---|---|
idRequired | string | path | template 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/templates/{id}
Delete Dashboard Template
Parameters
Name | Type | Located In | Description |
---|---|---|---|
idRequired | string | path | dashboard template id |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 403
Forbidden
Status Code: 404
Not Found
[GET] /api/v2/dashboard/templates/{id}
Get Template
Parameters
Name | Type | Located In | Description |
---|---|---|---|
idRequired | string | path | template id |
rev | int32 | query | template revision |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 403
Forbidden
Status Code: 404
Not Found
[POST] /api/v2/dashboard/{id}/revert
Revert dashboard
Parameters
Name | Type | Located In | Description |
---|---|---|---|
idRequired | string | path | dashboard id |
rev | int32 | query | dashboard revision |
Response
Status Code: 400
Bad Request
Status Code: 403
Forbidden
Status Code: 404
Not Found
[GET] /api/v2/dashboard/dashboards/{id}/export
Export Dashboard
Parameters
Name | Type | Located In | Description |
---|---|---|---|
idRequired | string | path | dashboard id |
dp | string | query | dashboard parameters |
token | string | query | wyn token |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 401
Unauthorized
Status Code: 403
Forbidden
Status Code: 404
Not Found
Models
Ƭ DashboardResponse
Dashboard POST Response
Name | Type | Description | Example |
---|---|---|---|
dashboardIdNullable | string | New Dashboard ID |
Ƭ ServerPluginError
Server plugin error
Name | Type | Description | Example |
---|---|---|---|
codeNullable | string | error code | |
messageNullable | string | error message | |
contextNullable | string | error context |
Ƭ DashboardBaseViewModel
Name | Type | Description | Example |
---|---|---|---|
titleNullable | string | ||
content | Content | ||
optionsNullable | any | ||
scenariosNullable | Scenario | ||
pagesNullable | DashboardPage | ||
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 |
Ƭ Scenario
Name | Type | Description | Example |
---|---|---|---|
idNullable | string | ||
contentNullable | any | ||
optionsNullable | any | ||
pageIdNullable | string | ||
nameNullable | string |
Ƭ DashboardPage
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
Scene
Glb
DashboardTemplate
VizTemplate
Ƭ 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> |
Ƭ DashboardTemplatePayload
Name | Type | Description | Example |
---|---|---|---|
dashboardIdNullable | string | ||
templateNameNullable | string | ||
commentNullable | string |
Ƭ DashboardViewModel
Name | Type | Description | Example |
---|---|---|---|
idNullable | string | ||
titleNullable | string | ||
content | Content | ||
optionsNullable | any | ||
scenariosNullable | Scenario | ||
pagesNullable | DashboardPage | ||
sharedResourcesNullable | SharedResource | ||
versionNullable | string | ||
datasetProfilesNullable | any | ||
tagIdsNullable | Array<string> |
||
commentNullable | string | ||
parametersNullable | DashboardParameter |
Ƭ File
Name | Type | Description | Example |
---|