Get Schemes

cURL

curl --request GET \
  --url https://api.ctrl-hub.com/v3/orgs/{orgId}/governance/schemes \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "type": "schemes",
      "id": "5852cf16-8ec8-4aba-809e-f8d828772c4e",
      "attributes": {
        "name": "IMGA100000",
        "code": "CODE001",
        "description": "DESC-123456",
        "status": "active",
        "start_date": "2024-06-13T00:00:00.000Z",
        "end_date": "2024-08-13T00:00:00.000Z",
        "labels": [
          {
            "key": "your-label",
            "value": "abc123"
          },
          {
            "key": "another-label",
            "value": "meaningful-value"
          }
        ]
      },
      "meta": {
        "created_at": "2024-06-13T07:15:23.000Z"
      },
      "links": {
        "self": "https://api.ctrl-hub.com/v3/governance/schemes/5852cf16-8ec8-4aba-809e-f8d828772c4e"
      }
    }
  ],
  "meta": {
    "counts": {
      "limit": 10
    },
    "page": {
      "limit": 10,
      "offset": {
        "current": 20,
        "next": 30,
        "previous": 10
      }
    }
  },
  "links": {
    "current": "https://api.ctrl-hub.com/v3/governance/schemes?limit=10&offset=20",
    "next": "https://api.ctrl-hub.com/v3/governance/schemes?limit=10&offset=30",
    "previous": "https://api.ctrl-hub.com/v3/governance/schemes?limit=10&offset=10"
  }
}

GET

orgs

{orgId}

governance

schemes

cURL

curl --request GET \
  --url https://api.ctrl-hub.com/v3/orgs/{orgId}/governance/schemes \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "type": "schemes",
      "id": "5852cf16-8ec8-4aba-809e-f8d828772c4e",
      "attributes": {
        "name": "IMGA100000",
        "code": "CODE001",
        "description": "DESC-123456",
        "status": "active",
        "start_date": "2024-06-13T00:00:00.000Z",
        "end_date": "2024-08-13T00:00:00.000Z",
        "labels": [
          {
            "key": "your-label",
            "value": "abc123"
          },
          {
            "key": "another-label",
            "value": "meaningful-value"
          }
        ]
      },
      "meta": {
        "created_at": "2024-06-13T07:15:23.000Z"
      },
      "links": {
        "self": "https://api.ctrl-hub.com/v3/governance/schemes/5852cf16-8ec8-4aba-809e-f8d828772c4e"
      }
    }
  ],
  "meta": {
    "counts": {
      "limit": 10
    },
    "page": {
      "limit": 10,
      "offset": {
        "current": 20,
        "next": 30,
        "previous": 10
      }
    }
  },
  "links": {
    "current": "https://api.ctrl-hub.com/v3/governance/schemes?limit=10&offset=20",
    "next": "https://api.ctrl-hub.com/v3/governance/schemes?limit=10&offset=30",
    "previous": "https://api.ctrl-hub.com/v3/governance/schemes?limit=10&offset=10"
  }
}

Sort Support

Resources can be sorted by name, code, status or created_at

Authorizations

Authorization

string

header

required

To understand how to authenticate, see the auth docs

Path Parameters

orgId

string

required

The ID of the organisation

Example:

"cc9746e0-9286-4575-ae0b-ac1b0fe873a6"

Query Parameters

limit

integer

default:10

Limit the number of resources returned by the API

offset

integer

default:0

Offset for resources returned by the API

sort

string

default:created_at

A field in the resource to sort results with. Not all attributes are supported, please see the Object Model for sortable fields.

Response

data

object[]

Show child attributes

data.type

enum<string>

The resource type

Available options:

schemes

Example:

"schemes"

data.id

string<uuid>

The ID of the schemes

Example:

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

data.attributes

object

Show child attributes

data.attributes.name

string

The name of the scheme

Example:

"IMGA100000"

data.attributes.code

string

The code of the scheme

Example:

"CODE001"

data.attributes.description

string

The description of the scheme

Example:

"DESC-123456"

data.attributes.status

enum<string>

The status of the scheme

Available options:

In Planning,

Live,

On Hold,

Complete,

Cancelled

Example:

"active"

data.attributes.start_date

string

The start date of the scheme

Example:

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

data.attributes.end_date

string

The end date of the scheme

Example:

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

data.attributes.labels

object[]

An array of label objects related to the scheme

Show child attributes

data.attributes.labels.key

string

data.attributes.labels.value

string

Example:

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

data.meta

object

Show child attributes

data.meta.created_at

string

Sortable. The time the scheme was created (RFC 3339)

Example:

"2024-06-13T07:15:23.000Z"

data.links

object

Show child attributes

data.links.self

string

Example:

"https://api.ctrl-hub.com/v3/governance/schemes/5852cf16-8ec8-4aba-809e-f8d828772c4e"

API Documentation

Governance

Data Capture

Operations

Assets

Admin

Sort Support

Authorizations

Path Parameters

Query Parameters

Response

API Documentation

Governance

Data Capture

Operations

Assets

Admin

​Sort Support

Authorizations

Path Parameters

Query Parameters

Response

Sort Support