Skip to main content
POST
/
v3
/
nomenclature
Create nomenclature settings
curl --request POST \
  --url https://api.ctrl-hub.com/v3/nomenclature \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Session-Token: <api-key>' \
  --data '
{
  "data": {
    "type": "<string>",
    "attributes": {
      "governance": {
        "schemes": [
          {
            "singular": "<string>",
            "plural": "<string>",
            "language": "<string>"
          }
        ],
        "work_orders": [
          {
            "singular": "<string>",
            "plural": "<string>",
            "language": "<string>"
          }
        ],
        "operations": [
          {
            "singular": "<string>",
            "plural": "<string>",
            "language": "<string>"
          }
        ],
        "scheme_contracts": [
          {
            "singular": "<string>",
            "plural": "<string>",
            "language": "<string>"
          }
        ]
      }
    },
    "relationships": {
      "organisation": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      }
    }
  }
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "governance": {
        "schemes": [
          {
            "singular": "<string>",
            "plural": "<string>",
            "language": "<string>"
          }
        ],
        "work_orders": [
          {
            "singular": "<string>",
            "plural": "<string>",
            "language": "<string>"
          }
        ],
        "operations": [
          {
            "singular": "<string>",
            "plural": "<string>",
            "language": "<string>"
          }
        ],
        "scheme_contracts": [
          {
            "singular": "<string>",
            "plural": "<string>",
            "language": "<string>"
          }
        ]
      }
    },
    "meta": {
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  },
  "jsonapi": {
    "version": "<string>"
  }
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Body

application/vnd.api+json

The nomenclature settings to create.

data
object
required

Response

The nomenclature settings for an organisation.

JSON API response object

data
object
required

Nomenclature settings for an organisation

jsonapi
object
required