Get all dashboards
query Parameters
| cursor | string <byte> Paging cursor |
| direction | string (PagingCommand.Direction) Enum: "NEXT" "PREVIOUS" Paging direction |
| pageSize | integer [ 1 .. 100 ] Page size |
header Parameters
| X-Scope-OrgID | string Tenant header |
| Api-Version | string API version |
Responses
Response samples
- 200
- 401
- 500
Content type
application/json
[- {
- "data": [
- { }
], - "paging": {
- "cursor": {
- "firstName": "string",
- "lastName": "string"
}, - "hasNext": true,
- "hasPrevious": true
}
}
]Create a new dashboard
header Parameters
| X-Scope-OrgID | string Tenant header |
| Api-Version | string API version |
Request Body schema: application/jsonrequired
JSON representation of the dashboard to be created
| name required | string [ 1 .. 255 ] characters |
| default | boolean |
required | Array of objects (Dashboard.Widget) |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string",
- "default": true,
- "widgets": [
- {
- "name": "string",
- "layouts": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "config": {
- "property1": "string",
- "property2": "string"
}
}
]
}Response samples
- 400
- 401
- 500
Content type
application/json
{- "_links": { },
- "_embedded": {
- "property1": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
], - "property2": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
]
}, - "message": "string",
- "logref": "string",
- "path": "string"
}Get dashboard by name
path Parameters
| name required | string Dashboard name |
header Parameters
| X-Scope-OrgID | string Tenant header |
| Api-Version | string API version |
Responses
Response samples
- 200
- 401
- 404
- 500
Content type
application/json
{- "name": "string",
- "default": true,
- "widgets": [
- {
- "name": "string",
- "layouts": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "config": {
- "property1": "string",
- "property2": "string"
}
}
]
}Update an existing dashboard
path Parameters
| name required | string Dashboard name |
header Parameters
| X-Scope-OrgID | string Tenant header |
| Api-Version | string API version |
Request Body schema: application/jsonrequired
| name required | string [ 1 .. 255 ] characters |
| default | boolean |
required | Array of objects (Dashboard.Widget) |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string",
- "default": true,
- "widgets": [
- {
- "name": "string",
- "layouts": {
- "property1": {
- "property1": 0,
- "property2": 0
}, - "property2": {
- "property1": 0,
- "property2": 0
}
}, - "config": {
- "property1": "string",
- "property2": "string"
}
}
]
}Response samples
- 400
- 401
- 404
- 500
Content type
application/json
{- "_links": { },
- "_embedded": {
- "property1": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
], - "property2": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
]
}, - "message": "string",
- "logref": "string",
- "path": "string"
}Remove an existing dashboard
path Parameters
| name required | string Dashboard name |
header Parameters
| X-Scope-OrgID | string Tenant header |
| Api-Version | string API version |
Responses
Response samples
- 401
- 404
- 500
Content type
application/json
{- "_links": { },
- "_embedded": {
- "property1": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
], - "property2": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
]
}, - "message": "string",
- "logref": "string",
- "path": "string"
}