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

Getting the fetchState job status

Getting the fetchState job status

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

GET request

To get status of the fetchState job, use one of the following URIs:
  • To receive status of the fetchState job, use the following URI, where <id> is the fetchState job ID:
    /public/core/v3/fetchState/<job id>
  • To receive status for each object's state in the fetchState job, use the following URI:
    /public/core/v3/fetchState/<job id>?expand=objects
Continue polling the request until the state is SUCCESSFUL.

GET response

A request for status returns the following status information:
Field
Type
Description
id
String
ID of the fetchState job.
createTime
String
Time the fetchState job was created.
updateTime
String
Last time the fetchState job was updated.
name
String
Name of the fetchState job.
startTime
String
Start time of the fetchState job.
endTime
String
End time of the fetchState job.
status
Complex type
Status of the fetchState job.
state
String
Returned in the status object.
State of the fetchState job, such as In Progress, Success, or Failed.
message
String
Returned in the status object.
Job status message.
objects
Collection
Objects in the fetchState job. Returned when the URI includes
?expand=objects
id
String
Returned in the objects object.
Global ID of the object requested.
name
String
Returned in the objects object.
Name of the object..
path
String
Returned in the objects object.
Complete path of the object.
description
String
Returned in the objects object.
Description of the object.
status
Complex type
Returned in the objects object.
Status of the object.
state
String
Returned in the objects.status object.
Status of the object, such as IN PROGRESS, SUCCESS, FAILED, or SKIPPED.
message
String
Returned in the objects.status object.
Status message for the object.

GET response example

If your request for a fetchState job's status is 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": "2018-10-26T08:15:49.501Z", "status": { "state": "SUCCESSFUL", "message": "Export completed successfully." }, "objects": null }
If your request included status for individual objects, a successful response might be similar to the following example:
{ "id": "7evG9CokA1whk8ehF3opKM", "createTime": "2017-10-26T08:15:49.000Z", "updateTime": "2017-10-26T08:15:50.000Z", "name": "fetchStateJob1", "startTime": "2018-10-26T08:15:49.000Z", "endTime": "2018-10-26T08:15:50.000Z", "status": { "state": "SUCCESSFUL", "message": "Export completed successfully." }, "objects": [ { "id": "1YmwRT083ZtfO04mUABaGF", "name": "Mapping1", "path": "/Mappings", "type": "DTEMPLATE", "description": "", "status": { "state": "SKIPPED", "message": null } }, { "id": "46MhQv9oxrgbOD6qtosF8t", "name": "MappingTask1", "path": "/Tasks", "type": "MTT", "description": "", "status": { "state": "SUCCESSFUL", "message": null } }, { "id": "7rM2ll1YjWYgHz4xiqRQO3", "name": "Default", "path": "/", "type": "Project", "description": "Auto-generated Default Project", "status": { "state": "SKIPPED", "message": null } }, { "id": "8suj2pxCujqh5Vtmv0DsyP", "name": "Destination", "path": "null", "type": "Connection", "description": "Dst Connection", "status": { "state": "SKIPPED", "message": null } }, { "id": "cpnxnIQMIYvkDOemLhFJ2q", "name": "03", "path": null, "type": "AgentGroup", "description": null, "status": { "state": "SKIPPED", "message": null } }, { "id": "gJvuKZZuBifk9MfZFxtPAb", "name": "Source", "path": null, "type": "Connection", "description": "Src Connection", "status": { "state": "SKIPPED", "message": null } } ] }


Updated May 03, 2021