You're reading "Content Management API"

Job result

Some API endpoint give results asyncronously, returning the ID of a job

The Job result object

A Job result object is returned as part of the response body of each successful Retrieve a job result API call. The following table contains the list of all its fields along with their type, description and example values.

Object fields:
payloadobject

JSON API response of the HTTP request

statusinteger

Status of delayed HTTP response

This attribute is required

Retrieve a job result

To retrieve a job result, send a GET request to the /job-results/:job_result_id endpoint. The following table contains the list of all the possible arguments, along with their type, description and examples values. All the arguments marked as required must be present in the request.

GET https://site-api.datocms.com/job-results/:job_result_id HTTP/1.1
X-Api-Version3
AuthorizationBearer YOUR-API-KEY
Acceptapplication/json
HTTP Response
HTTP/1.1 200 OK
Content-Typeapplication/json; charset=utf-8
Cache-Controlcache-control: max-age=0, private, must-revalidate
X-RateLimit-Limit30
X-RateLimit-Remaining28
{ "data": { "type": "job_result", "id": "34", "attributes": { "status": 200, "payload": { "data": { "id": 999, "type": "item_type", "attributes": { "some": "attributes" } } } } } }
Go ahead to: Site upload tags