Scheme Model

type

enum<string>

The resource type

Available options:

schemes

Example:

"schemes"

string<uuid>

The ID of the schemes

Example:

"5852cf16-8ec8-4aba-809e-f8d828772c4e"

attributes

object

Show child attributes

attributes.name

string

The name of the scheme

Example:

"IMGA100000"

attributes.code

string

The code of the scheme

Example:

"CODE001"

attributes.description

string

The description of the scheme

Example:

"DESC-123456"

attributes.status

enum<string>

The status of the scheme

Available options:

In Planning,

Live,

On Hold,

Complete,

Cancelled

Example:

"active"

attributes.start_date

string

The start date of the scheme

Example:

"2024-06-13T00:00:00.000Z"

attributes.end_date

string

The end date of the scheme

Example:

"2024-08-13T00:00:00.000Z"

attributes.labels

object[]

An array of label objects related to the scheme

Show child attributes

attributes.labels.key

string

attributes.labels.value

string

Example:

[
  { "key": "your-label", "value": "abc123" },
  {
    "key": "another-label",
    "value": "meaningful-value"
  }
]

API Documentation

Governance

Data Capture

Operations

Assets

Admin