Sorry, no results found for "".

Show examples in:
Javascript HTTP
Endpoint info
Available examples

Content Management API > Upload Collection

Reorders a set of upload collections

Returns

Returns a Job ID. You can then poll for the completion of the job that will eventually return an array of resource objects of type upload_collection

Examples

The response contains the ID of the asynchronous job that started:

POST https://site-api.datocms.com/upload-collections/reorder HTTP/1.1
Authorization: Bearer YOUR-API-TOKEN
Accept: application/json
X-Api-Version: 3
Content-Type: application/vnd.api+json
{
"data": [
{
"id": "uinr2zfqQLeCo_1O0-ao-Q",
"type": "upload_collection",
"attributes": {
"position": 1
},
"relationships": {
"parent": {
"data": null
}
}
}
]
}
Terminal window
curl -g 'https://site-api.datocms.com/upload-collections/reorder' \
-X POST \
-H "Authorization: Bearer YOUR-API-TOKEN" \
-H "Accept: application/json" \
-H "X-Api-Version: 3" \
-H "Content-Type: application/vnd.api+json" \
--data-binary '{"data":[{"id":"uinr2zfqQLeCo_1O0-ao-Q","type":"upload_collection","attributes":{"position":1},"relationships":{"parent":{"data":null}}}]}'
await fetch("https://site-api.datocms.com/upload-collections/reorder", {
method: "POST",
headers: {
Authorization: "Bearer YOUR-API-TOKEN",
Accept: "application/json",
"X-Api-Version": "3",
"Content-Type": "application/vnd.api+json",
},
body: JSON.stringify({
data: [
{
id: "uinr2zfqQLeCo_1O0-ao-Q",
type: "upload_collection",
attributes: { position: 1 },
relationships: { parent: { data: null } },
},
],
}),
});
HTTP/1.1 202 Accepted
Content-Type: application/json
Cache-Control: cache-control: max-age=0, private, must-revalidate
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 28
{
"data": {
"type": "job",
"id": "4235"
}
}

To get the asynchronous job result, poll the job result endpoint. While the task is in progress, the endpoint returns a 404 status code. When the job completes, the status changes to 200 OK:

GET https://site-api.datocms.com/job-results/:job_result_id HTTP/1.1
Authorization: Bearer YOUR-API-TOKEN
Accept: application/json
X-Api-Version: 3
Terminal window
curl -g 'https://site-api.datocms.com/job-results/:job_result_id' \
\
-H "Authorization: Bearer YOUR-API-TOKEN" \
-H "Accept: application/json" \
-H "X-Api-Version: 3"
await fetch("https://site-api.datocms.com/job-results/:job_result_id", {
headers: {
Authorization: "Bearer YOUR-API-TOKEN",
Accept: "application/json",
"X-Api-Version": "3",
},
});
HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: cache-control: max-age=0, private, must-revalidate
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 28
{
"data": {
"type": "job_result",
"id": "34",
"attributes": {
"status": 200,
"payload": {
"data": [
{
"type": "upload_collection",
"id": "uinr2zfqQLeCo_1O0-ao-Q",
"relationships": {
"parent": {
"data": null
},
"children": {
"data": [
{
"type": "upload_collection",
"id": "uinr2zfqQLeCo_1O0-ao-Q"
}
]
}
},
"attributes": {
"label": "Posts",
"position": 1
}
}
]
}
}
}
}