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

Getting the import job status

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

GET request

To obtain status of the import job, use one of the following URIs, where <id> is the import job ID:
  • To receive status of the import job, use the following URI:
    /public/core/v3/import/<id>
  • To receive status for each object in the import job, use the following URI:
    /public/core/v3/import/<id>?expand=objects
To download the import job log, use the following URI:
/public/core/v3/import/<id>/log

GET response

A request for an import job log returns the log in a text file.
A request for status returns the following import status information:
Field
Type
Description
id
String
ID of the import job.
createTime
String
Time the import job was created.
updateTime
String
Last time the import job was updated.
name
String
Name of the import job.
startTime
String
Start time of the import job.
endTime
String
End time of the import job.
status
Complex type
Status of the package upload.
state
String
Returned in the status object.
Status of the import job, such as IN PROGRESS, SUCCESS, or FAILED.
message
String
Returned in the status object.
Import job status message.
sourceOrgId
String
ID of the organization that created the export package that was imported.
objects
Collection
Objects included in the import.
sourceObject
Collection
Returned in the objects object.
Object included in the import.
id
String
Returned in the sourceObject object.
Global ID of the object included in the import.
name
String
Returned in the sourceObject object.
Name of the objectincluded in the import.
path
String
Returned in the sourceObject object.
Complete path of the object included in the import.
type
String
Returned in the sourceObject object.
Type of object included in the import.
description
String
Returned in the sourceObject object.
Description of object included in the import.
targetObject
Collection
Returned in the objects object.
Target object.
id
String
Returned in the targetObject object.
Global ID of the target object.
name
String
Returned in the targetObject object.
Name of the target object.
path
String
Returned in the targetObject object.
Complete path of the target object.
type
String
Returned in the targetObject object.
Type of target object.
description
String
Returned in the targetObject object.
Description of target object.
status
String
Returned in the targetObject object.
Status of the target object.
status
Complex type
Returned in the objects object.
Import status of the individual object.
state
String
Returned in the status object.
Import state of the individual object, such as IN PROGRESS, SUCCESS, or FAILED.
message
String
Returned in the status object.
Import status message for the individual object.

GET response example

If your request for an import job's status is successful, you might receive a response similar to the following example:
{ "id": "2oZb7vFI2QQg4ncd4AyCGn", "createTime": "2017-10-26T08:40:09.000Z", "updateTime": "2017-10-26T08:55:56.000Z", "name": "ImportName", "startTime": "2017-10-26T08:55:53.000Z", "endTime": "2017-10-26T08:55:56.000Z", "status": { "state": "SUCCESSFUL", "message": "Import completed successfully." }, "objects": null, "sourceOrgId": "0VOx1gScNH7dlDyA4tD8yX" }
If your request included import status for individual objects, a successful response might be similar to the following example:
{ "id": "2oZb7vFI2QQg4ncd4AyCGn", "createTime": "2017-10-26T08:40:09.000Z", "updateTime": "2017-10-26T08:55:56.000Z", "name": "ImportName", "startTime": "2017-10-26T08:55:53.000Z", "endTime": "2017-10-26T08:55:56.000Z", "status": { "state": "SUCCESSFUL", "message": "Import completed successfully." }, "objects": [ { "sourceObject": { "id": "ejZY66c19YUccBdbGwKG4P", "name": "M1", "path": "/Default", "type": "MAPPING", "description": "ab" }, "targetObject": { "id": null, "name": "M1", "path": "/default1", "type": "MAPPING", "description": null, "status": null }, "status": { "state": "SUCCESSFUL", "message": "Reuse existing." } }, { "sourceObject": { "id": "iIVBNZSpUKFg4N6g2PKUox", "name": "abc_map", "path": "/Default", "type": "MAPPING", "description": "" }, "targetObject": { "id": null, "name": "abc_map", "path": "/default1", "type": "MAPPING", "description": null, "status": null }, "status": { "state": "SUCCESSFUL", "message": "Overwrite existing." } } ], "sourceOrgId": "0VOx1gScNH7dlDyA4tD8yX" }
If you requested an import job log, the contents of the text file might be similar to the following example:
> OIE_002 INFO 2019-02-07T01:02:24.986Z Starting import operation. Execution Client: API Job Name: ImportExportMapping2-1541009746833 Organization: infa.doc RequestId: 68srkYNhdSkdKCKfLBGxyd User: janer2 > OIE_006 INFO 2019-02-07T01:02:25.416Z Successfully imported object [/Explore/ImportExport] of type [Project] id [3z0FL8tjqEbizNwVBV9LWR] to [/Explore/ImportExport] > OIE_006 INFO 2019-02-07T01:02:25.931Z Successfully imported object [/SYS/CustFF] of type [SAAS_CONNECTION] id [76c7oud5pBzlyAC3tdfVK2] to [/SYS/CustFF] > OIE_006 INFO 2019-02-07T01:02:26.598Z Successfully imported object [/Explore/ImportExport/ImportExportMapping2] of type [MAPPING] id [09wsnChCzUYl9OWCy6PKIe] to [/Explore/ImportExport/ImportExportMapping2] > OIE_003 INFO 2019-02-07T01:02:26.598Z Finished import operation. Job Name: ImportExportMapping2-1541009746833 Start Time: 2019-02-07T01:02:24.915Z End Time: 2019-02-07T01:02:26.598Z Started by: janer2 Start Method: API Source Organization: infadoc2 Status: SUCCESSFUL


Updated May 03, 2021