REST API Reference

Back Next

Getting the loadState job status

Use a GET request to get the status of a loadState job.

GET request

To get status of the loadState job, use one of the following URIs, where <id> is the loadState job ID:

To receive status of the loadState job, use the following URI:

/public/core/v3/loadState/<id>

To receive status for each object in the loadState job, use the following URI:

/public/core/v3/loadState/<id>?expand=objects

GET response

A request for status returns the following import status information:

Field	Type	Description
id	String	ID of the loadState job.
createTime	String	Time the object states package was created.
updateTime	String	Last time the object states package was updated.
name	String	Name of the loadState job.
startTime	String	Start time of the loadState job.
endTime	String	End time of the loadState job.
status	Complex type	Status of the package upload.
state	String	Returned in the status object. Status of the loadState job, such as IN PROGRESS, SUCCESS, or FAILED.
message	String	Returned in the status object. Job status message.
sourceOrgId	String	ID of the organization that created the object states package.
objects	Collection	Objects included in the import.
sourceObject	Collection	Returned in the objects object. Object included in the import.
id	String	Returned in the objects.sourceObject object. Global unique identifier for the object included in the import.
name	String	Returned in the objects.sourceObject object. Name of the object included in the import.
path	String	Returned in the objects.sourceObject object. Complete path of the object included in the import.
type	String	Returned in the objects.sourceObject object. Type of object included in the import.
description	String	Returned in the objects.sourceObject object. Description of the object included in the import.
targetObject	Collection	Returned in the objects object. Target object.
id	String	Returned in the objects.targetObject object. Global unique identifier for the target object.
name	String	Returned in the objects.targetObject object. Name of the target object.
path	String	Returned in the objects.targetObject object. Complete path of the target object.
type	String	Returned in the objects.targetObject object. Type of target object.
description	String	Returned in the objects.targetObject object. Description of target object.
status	String	Returned in the objects.targetObject object. Status of the target object.
status	Complex type	Returned in the objects object. Load status of the object.
state	String	Returned in the objects.status object. Load state of the object, such as IN PROGRESS, SUCCESS, or FAILED.
message	String	Returned in the objects.status object. Status message for the object.
checksumValid	Boolean	Returned in the objects.status object. Whether the checksum of the object was valid or not.

GET response example

If your request for a loadState job's status is successful, you might receive a response similar to the following example:

{
  "id": "2oZb7vFI2QQg4ncd4AyCGn",
  "createTime": "2017-10-26T08:40:09.000Z",
  "updateTime": "2017-10-26T08:55:56.000Z",
  "name": "stateImportJob",
  "startTime": "2017-10-26T08:55:53.000Z",
  "endTime": "2017-10-26T08:55:56.000Z",
  "status": {
    "state": "SUCCESSFUL",
    "message": "Import completed successfully."
  },
  "objects": null,
  "sourceOrgId": "2wy21a5fkUphzTVNKaPowg",
  "checksumValid": true
}

If your request included load status for individual objects, a successful response might be similar to the following example:

{
    "id": "3OpbyDU36UgkUhXXtvGsYA",
    "createTime": "2019-01-10T21:35:33.000Z",
    "updateTime": "2019-01-10T21:35:39.000Z",
    "name": "job-1547156138681",
    "startTime": "2019-01-10T21:35:39.000Z",
    "endTime": "2019-01-10T21:35:39.000Z",
    "status": {
        "state": "SUCCESSFUL",
        "message": "Import completed successfully."
    },
    "objects": [
        {
            "sourceObject": {
                "id": "46MhQv9oxrgbOD6qtosF8t",
                "name": "MappingTask",
                "path": "/Default",
                "type": "MTT",
                "description": ""
            },
            "targetObject": {
                "id": null,
                "name": "MappingTask",
                "path": "/Default",
                "type": "MTT",
                "description": null,
                "status": null
            },
            "status": {
                "state": "SUCCESSFUL",
                "message": "Overwrite existing."
            }
        }
    ],
    "sourceOrgId": "2wy21a5fkUphzTVNKaPowg",
    "checksumValid": true
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Getting the loadState job status

Getting the loadState job status

GET request

GET response

GET response example