Submission Model

type

enum<string>

The resource type

Available options:

submissions

Example:

"submissions"

string<uuid>

The ID of the submission

Example:

"eb2b4aa7-048d-470b-b504-a3eb3bf45e29"

attributes

object

Show child attributes

attributes.reference

string

The reference of the submission

Example:

"1234A567BCD"

attributes.status

string

The status of the submission - this is always the latest status based on the submission versions

Example:

"complete"

meta

object

Show child attributes

meta.created_at

string

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

Example:

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

meta.updated_at

string

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

Example:

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

relationships

object

Show child attributes

relationships.form

object

The id of form this submission relates to

Show child attributes

relationships.form.data

object

Show child attributes

relationships.form.data.type

enum<string>

The resource type

Available options:

forms

Example:

"forms"

relationships.form.data.id

string<uuid>

The ID of the form

Example:

"feabf5d3-91b4-42ad-b145-8bee6c115b78"

relationships.form_version

object

The id of the form version this submission version relates to

Show child attributes

relationships.form_version.data

object

Show child attributes

relationships.form_version.data.type

enum<string>

The resource type

Available options:

form-versions

Example:

"form-versions"

relationships.form_version.data.id

string<uuid>

The ID of the form version

Example:

"03c37271-70bb-4f03-955d-b4fcbe252a15"

relationships.author

object

The id of user this submission relates to

Show child attributes

relationships.author.data

object

Show child attributes

relationships.author.data.type

enum<string>

The resource type

Available options:

users

Example:

"users"

relationships.author.data.id

string<uuid>

The ID of the user

Example:

"c9927007-a8e3-46bc-b507-7867b114bef5"

relationships.versions

object

The id's of versions this submission relates to

Show child attributes

relationships.versions.data

object[]

Show child attributes

relationships.versions.data.type

enum<string>

The resource type

Available options:

submission-versions

Example:

"submission-versions"

relationships.versions.data.id

string<uuid>

The ID of the submission version

Example:

"f7bd5f57-8b79-40c5-bb80-acf82b068da0"

links

object

Show child attributes

links.self

string

Example:

"https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721/submissions/eb2b4aa7-048d-470b-b504-a3eb3bf45e29"

API Documentation

Governance

Data Capture

Operations

Assets

Admin