Skip to main content
POST/transactional-api/publish-custom-dashboard-version

Publish Custom Dashboard Version

Publishes a draft version of a custom dashboard template, making it the active version.

Authorization: Bearer token (JWT). See Authentication.

Request

curl -L -X POST 'https://{tenantId}.api.england.medicus.health/transactional-api/publish-custom-dashboard-version' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
"dashboardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

Body parameters

FieldTypeRequiredDescription
dashboardIdstring<uuid>YesID of the custom dashboard to publish.
versionIdstring<uuid>YesID of the version to publish. Required when publishing a subsequent version; ignored on the first publish.

Responses

200 Success.
{
"status": "ok"
}
400 Invalid request.
3 possible code values
CodeDescriptionWhen
missing-required-fieldfieldName is requireda required field is absent
invalid-operationHuman-readable reason.business rule violation
invalid-fieldfieldName must be a valid UUIDa UUID field is not a valid UUID
{
"errors": [
{
"code": "missing-required-field",
"description": "fieldName is required"
}
]
}
404 Dashboard not found.