Organisation Model

type

enum<string>

The type of resource

Available options:

organisations

Example:

"organisations"

string<uuid>

The organisation ID

Example:

"7e0c875a-fd47-401d-bd25-4278ed58d721"

attributes

object

Show child attributes

attributes.name

string

Sortable. The organisation name.

Example:

"Ctrl Hub"

attributes.slug

string

Sortable. The organisation slug, which is used in requests for subresources.

Example:

"ctrl-hub"

attributes.description

string

A description for the organisation

Example:

"Ctrl Hub deliver best in class software for managing your compliance, safety, risk and resource requirements"

attributes.settings

object

Show child attributes

attributes.settings.nomenclature

object

Show child attributes

attributes.settings.nomenclature.governance

object

Show child attributes

attributes.settings.nomenclature.governance.schemes

object[]

Show child attributes

attributes.settings.nomenclature.governance.schemes.language

string

Example:

"en-GB"

attributes.settings.nomenclature.governance.schemes.singular

string

Example:

"Scheme"

attributes.settings.nomenclature.governance.schemes.plural

string

Example:

"Schemes"

attributes.settings.nomenclature.governance.work_orders

object[]

Show child attributes

attributes.settings.nomenclature.governance.work_orders.language

string

Example:

"en-GB"

attributes.settings.nomenclature.governance.work_orders.singular

string

Example:

"Work Order"

attributes.settings.nomenclature.governance.work_orders.plural

string

Example:

"Work Orders"

attributes.settings.nomenclature.governance.operations

object[]

Show child attributes

attributes.settings.nomenclature.governance.operations.language

string

Example:

"en-GB"

attributes.settings.nomenclature.governance.operations.singular

string

Example:

"Operation"

attributes.settings.nomenclature.governance.operations.plural

string

Example:

"Operations"

API Documentation

Governance

Data Capture

Operations

Assets

Admin

Organisation Model