POST/transactional-api/create-custom-dashboard

Create Custom Dashboard

Creates a new custom dashboard template.

Authorization: Bearer token (JWT). See Authentication.

Request

curl -L -X POST 'https://{tenantId}.api.england.medicus.health/transactional-api/create-custom-dashboard' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <token>' \
  -d '{
    "name": "string",
    "identifier": "string",
    "type": "long-term-condition-management"
  }'

Body parameters

Field	Type	Required	Description
name	string	Yes	Dashboard name.
identifier	string	Yes	Stable machine-readable identifier for the dashboard.
type	enum	Yes	Dashboard category type. One of: long-term-condition-management, qof, ncd, ldhc, cqc, local-enhanced-services, registers, screening, testing, vaccination-payments, vaccination-recalls, medication-monitoring, preventative-care, lipid-management.

Responses

201 Created.

{
  "id": "00000000-0000-0000-0000-000000000000"
}

400 Invalid request.

3 possible code values

Code	Description	When
missing-required-field	fieldName is required	a required field is absent
invalid-operation	Human-readable reason.	business rule violation
invalid-field	fieldName must be a valid UUID	a UUID field is not a valid UUID

{
  "errors": [
    {
      "code": "missing-required-field",
      "description": "fieldName is required"
    }
  ]
}