Table of Contents

Search

  1. Preface
  2. Informatica Intelligent Cloud Services REST API
  3. Platform REST API version 2 resources
  4. Platform REST API version 3 resources
  5. Data Integration REST API
  6. Mass Ingestion Files REST API
  7. RunAJob utility
  8. REST API codes
  9. REST API resource quick references

REST API Reference

REST API Reference

Starting a loadState job

Starting a loadState job

Use a POST request to specify and start a loadState job.

POST request

To specify the objects and start the loadState job, use the following URI:
/public/core/v3/loadState/<id>
The <id> is the loadState job ID received in the POST response for the object states package upload.
Include the following fields in the request:
Field
Type
Required
Description
name
String
Name of the loadState job.
Default name is job-<currentTimeInMilliseconds>
importSpecification
Complex type
Used to specify the objects to include.
includeObjects
Collection<String>
Include in the importSpecification object.
Objects to load.
If not specified, the load includes all states in the object states package.
If the specified object is a project, the load includes state of all objects that belong to the project and all dependent objects.
objectSpecification
Collection <complex type>
Include in the importSpecification object.
Specifies the object properties.
sourceObjectId
String
Yes
Include in the objectSpecification object.
The container ID in the object states package file.
Required if objectSpecification is present.
targetObjectId
String
Yes
Include in the objectSpecification object.
Used for Container to Container mapping.
Required if objectSpecification is present.

POST request example

You might use a request similar to the following example:
POST <baseApiUrl>/public/core/v3/loadState/2oZb7vFI2QQg4ncd4AyCGn HTTP/1.0 Content-Type: application/json Accept: application/json INFA-SESSION-ID: <sessionId> { "name" : "stateImportJob", "importSpecification" : { "includeObjects" : ["iIVBNZSpUKFg4N6g2PKUox","ejZY66c19YUccBdbGwKG4P"], "objectSpecification" : [{ "sourceObjectId" : "iIVBNZSpUKFg4N6g2PKUox" }, { "sourceObjectId" : "5FA0DnMzeuDbYZnn3hdto9", "targetObjectId" : "5KgUiEkW95NkjLRRefWKiG" }] } }

POST response

If successful, returns the following information for the loadState job:
Field
Type
Description
Id
String
ID of the loadState job.
createTime
String
Time the loadState job was created.
updateTime
String
Last time the loadState job 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
Collection
Status of the package upload.
state
String
Returned in the status object.
Load state for each individual object, such as IN PROGRESS, SUCCESS, FAILED, or SKIPPED.
message
String
Returned in the status object.
Job status message.
objects
Collection
Objects included in the loadState job and object level status.
sourceOrgId
String
Organization ID of the organization that created the object states package.
checksumValid
Boolean
Indicates whether the import package has valid checksum.

POST response examples

If successful, you might receive a response similar to the following example:
{ "id": "a7oaBNCyc8DdhxQD4mY4ul", "createTime": "2019-01-10T01:35:45.000Z", "updateTime": "2019-01-10T21:08:41.398Z", "name": "job-1547154520680", "startTime": "2019-01-10T21:08:41.389Z", "endTime": null, "status": { "state": "IN_PROGRESS", "message": "In Progress" }, "objects": null, "sourceOrgId": "2wy21a5fkUphzTVNKaPowg", "checksumValid": true }
If you receive an error, you might see a response similar to the following example:
{ "error": { "message": "Import request with identifier [a7oaBNCyc8DdhxQD4mY4u] doesnt exist.", "requestId": "9MopwrDFAOGbuMM9utiTqJ" } }


Updated May 03, 2021