REST API Reference

Back Next

Uploading an object states package

Use a POST request to upload an object states package.

POST request

To upload the object states package, use the following URI:

/public/core/v3/loadState/package

For Content-Type, use

multipart/form-data

In the request body, include a part with the name of

package

. For its content, use the object states ZIP file that you want to upload.

POST response

If successful, returns the following information for the loadState job:

Field	Type	Description
jobId	String	ID of the loadState job.
jobStatus	Collection	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.
checksumValid	Boolean	Indicates whether the object states package has valid checksum.

POST response example

You might receive a response similar to the following example:

{
    "jobId": "hUV9Uq1cKYtf8niqF09CWC",
    "jobStatus": {
        "state": "NOT_STARTED",
        "message": null
    },
    "checksumValid": true
}

loadState

Download Guide

Watch

Comments

Cloud Data Integration Homepage