Permit Model

type

enum<string>

The resource type

Available options:

permits

Example:

"permits"

string<uuid>

The ID of the permit

Example:

"bcbdf616-6dd9-4ad6-a01b-b451a0c1205a"

attributes

object

Show child attributes

attributes.reference

string

The reference of the permit

Example:

"REF001"

attributes.description

string

The description of the permit

Example:

"DESC-123456"

attributes.proposed_start_date

string

The proposed start date of the permit

Example:

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

attributes.proposed_end_date

string

The proposed end date of the permit

Example:

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

meta

object

Show child attributes

meta.created_at

string

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

Example:

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

meta.updated_at

string

Sortable. The time the permit was updated (RFC 3339)

Example:

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

meta.status

enum<string>

Available options:

submitted,

proposed,

refused,

granted,

in_progress,

cancelled,

closed

Example:

"granted"

links

object

Show child attributes

links.self

string

Example:

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

API Documentation

Governance

Data Capture

Operations

Assets

Admin