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 fetchState job

Starting a fetchState job

Use a POST request to start a fetchState job.

POST request

To start the job, use the following URI:
/public/core/v3/fetchState
Include the following fields in the request:
Field
Type
Required
Description
name
String
Name of the fetchState job. If blank, default is job-<currentTimeInMilliseconds>
objects
Collection <complex type>
Yes
Object IDs for the states to include in the object state package.
Informatica recommends that you include no more than 1000 objects in a package.
id
String
Yes
Included in the objects object.
Global ID for the object for which the state is requested. This can be a project, folder, or asset ID.
includeDependencies
Boolean
Included in the objects object.
Determines whether to include the dependent objects' states.
Default is True.

POST request example

You might use a request similar to the following example:
POST <baseApiUrl>/public/core/v3/fetchstate Content-Type: application/json Accept: application/json INFA-SESSION-ID: <sessionId> { "name" : "fetchStateJob1", "objects" : [ { "id": "l7bgB85m5oGiXObDxwnvK9", "includeDependencies" : true }, { "id": "1MW0GDAE1sFgnvWkvom7mK", "includeDependencies" : false }, { "id": "iIVBNZSpUKFg4N6g2PKUox" } ] }

POST response

If successful, returns the following information for the fetchState job:
Field
Type
Description
id
String
ID of the fetchState job.
createTime
String
Time object state package was created.
updateTime
String
Time object state package was last updated.
name
String
Name of the fetchState job.
startTime
String
Time the fetchState job was started.
endTime
String
Time the fetchState job ended.
status
Complex type
Status of the job.
state
String
Returned in the status object.
Status of the fetchState job, such as In Progress, Success, or Failed.
message
String
Returned in the status object.
Job status message.
objects
Collection
Collection of objects and object level status. Returns null if blank.

POST response examples

If successful, you might receive a response similar to the following example:
{ "id": "7evG9CokA1whk8ehF3opKM", "createTime": "2018-10-26T08:15:48.502Z", "updateTime": "2018-10-26T08:15:48.502Z", "name": "fetchStateJob1", "startTime": "2018-10-26T08:15:48.501Z", "endTime": null, "status": { "state": "IN_PROGRESS", "message": "In Progress" }, "objects": null }
If you receive an error, you might see a response similar to the following example:
{ "error": { "code": "MigrationSvc_034", "message": "User does not have required permissions.", "requestId": "2ataXVlgw3ydI1Yb2MA4sq" } }


Updated May 03, 2021