Submission Versions
Get Submission Versions
API Documentation
Governance
- Organisations
- Schemes
- Work Orders
- Permits
- Operations
- Properties
- Streets
Data Capture
- Forms
- Form Categories
- Submissions
- Submission Versions
Operations
- Reinstatements
Assets
- Vehicles
Admin
- IAM
Submission Versions
Get Submission Versions
Returns all versions for a submission
GET
/
v3
/
orgs
/
{orgId}
/
data-capture
/
submissions
/
{submissionId}
/
relationships
/
versions
curl --request GET \
--url https://api.ctrl-hub.com/v3/orgs/{orgId}/data-capture/submissions/{submissionId}/relationships/versions \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"type": "submission-versions",
"id": "7813209e-db7b-4d3d-82a9-73c3c1b10090",
"attributes": {
"status": "complete",
"content": {
"field": "value"
}
},
"meta": {
"created_at": "2024-06-13T07:15:23.000Z"
},
"relationships": {
"form": {
"data": {
"type": "forms",
"id": "feabf5d3-91b4-42ad-b145-8bee6c115b78"
}
},
"form_version": {
"data": {
"type": "form-versions",
"id": "03c37271-70bb-4f03-955d-b4fcbe252a15"
}
},
"submission": {
"data": {
"type": "submissions",
"id": "65f661ff-1ef6-487a-a098-faeba6de3af6"
}
},
"author": {
"data": {
"type": "users",
"id": "c9927007-a8e3-46bc-b507-7867b114bef5"
}
}
},
"links": {
"self": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721/submissions/eb2b4aa7-048d-470b-b504-a3eb3bf45e29/relationships/versions/7813209e-db7b-4d3d-82a9-73c3c1b10090"
}
}
],
"meta": {
"counts": {
"limit": 10
},
"page": {
"limit": 10,
"offset": {
"current": 20,
"next": 30,
"previous": 10
}
}
},
"links": {
"current": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721/data-capture/submissions/eb2b4aa7-048d-470b-b504-a3eb3bf45e29/relationships/versions?limit=10&offset=20",
"next": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721/data-capture/submissions/eb2b4aa7-048d-470b-b504-a3eb3bf45e29/relationships/versions?limit=10&offset=30",
"previous": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721/data-capture/submissions/eb2b4aa7-048d-470b-b504-a3eb3bf45e29/relationships/versions?limit=10&offset=10"
}
}
Authorizations
To understand how to authenticate, see the auth docs
Path Parameters
The ID of the organisation
Query Parameters
Limit the number of resources returned by the API
Offset for resources returned by the API
A field in the resource to sort results with. Not all attributes are supported, please see the Object Model for sortable fields.
Response
200
application/json
The resource type
Available options:
submission-versions
The ID of the version
curl --request GET \
--url https://api.ctrl-hub.com/v3/orgs/{orgId}/data-capture/submissions/{submissionId}/relationships/versions \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"type": "submission-versions",
"id": "7813209e-db7b-4d3d-82a9-73c3c1b10090",
"attributes": {
"status": "complete",
"content": {
"field": "value"
}
},
"meta": {
"created_at": "2024-06-13T07:15:23.000Z"
},
"relationships": {
"form": {
"data": {
"type": "forms",
"id": "feabf5d3-91b4-42ad-b145-8bee6c115b78"
}
},
"form_version": {
"data": {
"type": "form-versions",
"id": "03c37271-70bb-4f03-955d-b4fcbe252a15"
}
},
"submission": {
"data": {
"type": "submissions",
"id": "65f661ff-1ef6-487a-a098-faeba6de3af6"
}
},
"author": {
"data": {
"type": "users",
"id": "c9927007-a8e3-46bc-b507-7867b114bef5"
}
}
},
"links": {
"self": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721/submissions/eb2b4aa7-048d-470b-b504-a3eb3bf45e29/relationships/versions/7813209e-db7b-4d3d-82a9-73c3c1b10090"
}
}
],
"meta": {
"counts": {
"limit": 10
},
"page": {
"limit": 10,
"offset": {
"current": 20,
"next": 30,
"previous": 10
}
}
},
"links": {
"current": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721/data-capture/submissions/eb2b4aa7-048d-470b-b504-a3eb3bf45e29/relationships/versions?limit=10&offset=20",
"next": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721/data-capture/submissions/eb2b4aa7-048d-470b-b504-a3eb3bf45e29/relationships/versions?limit=10&offset=30",
"previous": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721/data-capture/submissions/eb2b4aa7-048d-470b-b504-a3eb3bf45e29/relationships/versions?limit=10&offset=10"
}
}