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. Mass Ingestion Streaming REST API
  8. RunAJob utility
  9. ParamSetCli utility
  10. REST API codes
  11. REST API resource quick references

REST API Reference

REST API Reference

Starting an import job

Starting an import job

Use a POST request to specify and start an import job. You can import objects such as assets, connections, Secure Agent configurations, and schedules.

POST request

In the request, include a list of objects to import and parameters to resolve any conflict resolution that might occur. An example of a conflict resolution might be if you try to import an asset that has the same name as another asset in the target organization.
You can specify a runtime environment that exists in the target organization to use instead of the source runtime environment provided that the connector types and versions are the same. To find a list of the runtime environments in the target organization, you can use the lookup resource.
To specify the import objects and start the import job, use the following URI:
/public/core/v3/import/<id>
The <id> is the import job ID received in the POST response for the import package upload.
To get the object IDs that you want to include in the request, you can use the lookup resource. For more information, see lookup.
Include the following fields in the request:
Field
Type
Required
Description
name
String
Name of the import job.
Default name is job-<currentTimeInMilliseconds>
importSpecification
Complex type
Used to specify import specifications. By default, the import includes all objects in the import package with default conflict resolution settings.
defaultConflictResolution
String
Include in the importSpecification object.
Whether to overwrite existing objects with all of the objects in the import file. Includes the following options:
  • OVERWRITE. Overwrite the existing objects with the objects in the import file.
    Default value for assets.
  • REUSE. Use the existing objects. If an object doesn't exist, it is created.
    Default value for connections, runtime environments, projects, folders, and schedules.
includeObjects
Collection<String>
Include in the importSpecification object.
Objects to include in the import. You can use the lookup resource to find the object IDs.
By default, the import includes all objects in the import package.
If the specified object is a project, the import includes all assets that belong to the project and all dependent objects that are not already present in the target organization.
If the specified object is an asset, the import creates the asset's containers (project, folder) if they do not already exist.
Informatica recommends that you include no more than 1000 objects in an import job.
objectSpecification
Collection <complex type>
Include in the importSpecification object.
Specifies the object properties. If properties are not specified for a particular object, the import uses the default conflict resolution settings.
conflictResolution
String
Include in the objectSpecification object.
Whether to overwrite an existing asset with an asset in the import file. Includes the following options:
  • OVERWRITE. Overwrite the existing asset with the asset in the import file.
  • REUSE. Use the existing object. If the object doesn't exist, it is created.
Applicable to assets, for example, Data Integration mapping tasks, Application Integration guides, B2B Gateway suppliers, and Data Quality dictionaries. Do not use for projects, folders, runtime environments, or connections.
The import includes connections and runtime environments associated with the asset if they do not exist in the target organization.
sourceObjectId
String
Yes
Include in the objectSpecification object.
The object ID in the export package file.
Required if objectSpecification is present.
targetObjectId
String
Include in the objectSpecification object.
Used for Container to Container mapping, as well as some asset to asset mappings.
Use to specify a connection or runtime environment that exists in the target organization. The target object must use the same connector type and version that is used in the source object.

POST request example

You might use a request similar to the following example:
POST <baseApiUrl>/public/core/v3/import/2oZb7vFI2QQg4ncd4AyCGn Content-Type: application/json Accept: application/json INFA-SESSION-ID: <sessionId> { "name" : "ImportName", "importSpecification" : { "defaultConflictResolution" : "REUSE", "includeObjects" : ["iIVBNZSpUKFg4N6g2PKUox","ejZY66c19YUccBdbGwKG4P"], "objectSpecification" : [{ "sourceObjectId" : "iIVBNZSpUKFg4N6g2PKUox", "conflictResolution" : "OVERWRITE" }, { "sourceObjectId" : "5FA0DnMzeuDbYZnn3hdto9", "targetObjectId" : "5KgUiEkW95NkjLRRefWKiG" }] } }

POST response

If successful, returns the following information for the import job:
Field
Type
Description
jobId
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
Collection
Status of the package upload.
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 job status message.
objects
Collection
Objects included in the import job.
sourceOrgId
String
Organization ID of the organization that created the export package that was imported.

POST response examples

If 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:53.238Z", "name": "ImportName", "startTime": "2017-10-26T08:55:53.232Z", "endTime": "2017-10-26T08:53:03.000Z", "status": { "state": "IN_PROGRESS", "message": "In Progress." }, "objects": null, "sourceOrgId": "0VOx1gScNH7dlDyA4tD8yX" }
If you receive an error, you might see a response similar to the following example:
{ "error": { "code": "MigrationSvc_040", "message": "User does not have required permissions.", "requestId": "2ataXVlgw3ydI1Yb2MA4sq" } }

0 COMMENTS

We’d like to hear from you!