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 export job status

Getting the export job status

Use a GET request to get the status of an export job or download an export job log.

GET request

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

GET response

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

GET response example

If your request for an export job's status is successful, you might receive a response similar to the following example:
{ "id": "7evG9CokA1whk8ehF3opKM", "createTime": "2017-10-26T08:15:48.502Z", "updateTime": "2017-10-26T08:15:48.502Z", "name": "testJob1", "startTime": "2017-10-26T08:15:48.501Z", "endTime": null, "status": { "state": "IN_PROGRESS", "message": "In Progress." }, "objects": null }
If your request included import 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": "testJob1", "startTime": "2017-10-26T08:15:49.000Z", "endTime": "2017-10-26T08:15:50.000Z", "status": { "state": "SUCCESSFUL", "message": "Export completed successfully." }, "objects": [ { "id": "1MW0GDAE1sFgnvWkvom7mK", "name": "Linear Taskflow", "path": "/ICS Taskflow", "type": "SAAS_LINEAR_TASKFLOW", "description": null, "status": { "state": "SUCCESSFUL", "message": null } }, { "id": "1SuZ9Gf8LtphrJn9EdHCod", "name": "SQL Server", "path": "/DSS", "type": "Folder", "description": "", "status": { "state": "SUCCESSFUL", "message": null } }, { "id": "1Uf9PTj6kTjbsVYMk55OC6", "name": "Synchronization Task Multi Source", "path": "/Default/SQL Server", "type": "SAAS_DSS", "description": "", "status": { "state": "SUCCESSFUL", "message": null } }, { "id": "2UL9ZO9Z3OJeuxbL2cYbaX", "name": "Synchronization Task Simple Filter", "path": "/Default/SQL Server", "type": "SAAS_DSS", "description": "", "status": { "state": "SUCCESSFUL", "message": null } }, { "id": "31SzqpeEEKacy7OaXXCfaD", "name": "Synchronization Task Multi Source", "path": "/DSS/SQL Server", "type": "SAAS_DSS", "description": "", "status": { "state": "SUCCESSFUL", "message": null } }, { "id": "5FA0DnMzeuDbYZnn3hdto9", "name": "Default", "path": "/", "type": "Project", "description": "Auto-generated Default Project", "status": { "state": "SUCCESSFUL", "message": null } }, { "id": "5V5VpaoJGTNkWCB2f2t4MG", "name": "Synchronization Task Simple Filter", "path": "/DSS/SQL Server", "type": "SAAS_DSS", "description": "", "status": { "state": "SUCCESSFUL", "message": null } }, { "id": "7udJJF48H5Iizzry8gjUAb", "name": "SQL Server", "path": "/Default", "type": "Folder", "description": "", "status": { "state": "SUCCESSFUL", "message": null } }, { "id": "fIQLvhNnsqBjXKNfjyZFaH", "name": "ICS Taskflow", "path": "/", "type": "Project", "description": "", "status": { "state": "SUCCESSFUL", "message": null } }, { "id": "hGrgtrajWMUjNIsnLKQCAi", "name": "SQL Server Linux", "path": null, "type": "SAAS_CONNECTION", "description": null, "status": { "state": "SUCCESSFUL", "message": null } }, { "id": "iIVBNZSpUKFg4N6g2PKUox", "name": "abc_map", "path": "/Default", "type": "MAPPING", "description": "", "status": { "state": "SUCCESSFUL", "message": null } }, { "id": "l7bgB85m5oGiXObDxwnvK9", "name": "DSS", "path": "/", "type": "Project", "description": "", "status": { "state": "SUCCESSFUL", "message": null } }, { "id": "lOqsFQE4OSWeyg77AeWwK2", "name": "Linux", "path": null, "type": "SAAS_RUNTIME_ENVIRONMENT", "description": null, "status": { "state": "SUCCESSFUL", "message": null } } ] }
If you requested an export job log, the contents of the text file might be similar to the following example:
> OIE_002 INFO 2019-02-05T22:50:08.788Z Starting export operation. Execution Client: API Job Name: m_RegionTotalNew-1549407002393 Organization: infa2.doc RequestId: iklHoZTokKAiNO95Cw9NG3 User: janer2 > OIE_004 INFO 2019-02-05T22:50:09.042Z Successfully exported object [/SYS/_SYSTEM_PROJECT] of type [Project] id [5UrdDrgV5yKerYgtJAA4IU]> OIE_004 INFO 2019-02-05T22:50:09.042Z Successfully exported object [/Explore/Accounts] of type [Project] id [8Uyq1wiZ9lye2Sou5OCqOa] > OIE_004 INFO 2019-02-05T22:50:09.126Z Successfully exported object [/SYS/_SYSTEM_FOLDER] of type [Folder] id [b98UuC0ADGEkXxF9EIlUCZ] > OIE_004 INFO 2019-02-05T22:50:09.126Z Successfully exported object [/Explore/Accounts/February2018] of type [Folder] id [cojSZpHcqcafFy6YkCBgIl] > OIE_004 INFO 2019-02-05T22:50:09.354Z Successfully exported object [/SYS/TMS26W0864] of type [SAAS_RUNTIME_ENVIRONMENT] id [6TKTNZ3wfIIjV5yBTJmYWO] > OIE_004 INFO 2019-02-05T22:50:09.504Z Successfully exported object [/SYS/ff] of type [SAAS_CONNECTION] id [7GgahDJzE9GbYb75xQ35GM] > OIE_004 INFO 2019-02-05T22:50:09.765Z Successfully exported object [/Explore/Accounts/February2018/m_RegionTotalNew] of type [MAPPING] id [4LiKwGKgegAixI2awqWgK1] > OIE_003 INFO 2019-02-05T22:50:09.843Z Finished export operation. Job Name: m_RegionTotalNew-1549407002393 Start Time: 2019-02-05T22:50:03.000Z End Time: 2019-02-05T22:50:09.765Z Started by: janer2 Start Method: API Source Organization: infa.doc Status: SUCCESSFUL


Updated May 03, 2021