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

Starting an export job

Use a POST request to start an export job.

POST request

You can export objects such as assets, connections, Secure Agent configurations, and schedules. To specify the objects to export and start the export job, use the following URI:
/public/core/v3/export
Include the following fields in the request:
Field
Type
Required
Description
name
String
Name of the export job. If a name is not specified, the default name will be used in the following format: job-<currentTimeInMilliseconds>
objects
Collection <complex type>
Yes
Object IDs for objects to export.
Informatica recommends that you include no more than 1000 objects in an export file.
id
String
Yes
Included in the objects object.
Global ID for the export object. This can be a project, folder, or asset ID.
includeDependencies
Boolean
Included in the objects object.
Determines whether to include dependent objects for the assets in the export.
Default is True.

POST request example

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

POST response

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

POST response examples

If 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 you receive an error, you might see a response similar to the following example:
{ "error": { "code": "MigrationSvc_034", "message": "Invalid object id/s [[242973wgfscbwasd23]]. Object resolution failed.", "requestId": "2ataXVlgw3ydI1Yb2MA4sq" } }


Updated May 03, 2021