Informatica Intelligent Cloud Services returns the status of the import such as In Progress or Success, or returns an error message. The response also includes the source organization ID for the organization that created the export package.
To upload the import package, use the following URI:
/public/core/v3/import/package
For Content-Type, use
multipart/form-data
In the request body, include a part with the name of package. For its content, use the export ZIP file that you want to import.
By default, Informatica Intelligent Cloud Services uses checksum validation to verify that no changes were made to the contents of the export ZIP file after it was created. If you want to upload an import package that contains a modified export ZIP file, include the relaxChecksum parameter and set the value to True.
The following image shows an example of the request body in Postman:
POST response
If successful, returns the following information for the import job:
Field
Type
Description
jobId
String
ID of the import job.
jobStatus
Collection
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.
checksumValid
Boolean
Indicates whether the import package has valid checksum.
POST response example
You might receive a response similar to the following example:
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.
When you import a Data Integration shared sequence or a mapping task that contains in-out parameters or sequences, you can choose to retain, reset, or overwrite persisted values.
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
Yes
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.
Note: 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.
Note: 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.
mergeTags
Boolean
-
Include in the objectSpecification object.
Determines whether to merge incoming asset tags with asset tags in the target project.
Default is False.
additionalProviderFlags
Collection <complex type>
-
Additional object specifications.
Use key-value pairs to retain, reset, or overwrite persisted values when you import a Data Integration shared sequence or a mapping task that contains in-out parameters or sequences.
For new assets, use the key, "mapping_conflict_new" and one of the following values:
- RESET. Creates the asset using the initial, default values as defined in the source.
- RETAIN. Creates the asset using the current values from the source.
For existing assets, use the key, "mapping_conflict_existing" and one of the following values:
- RESET. Resets persisted values to the initial, default value.
- RETAIN. Ignores the values coming from the source.
- REPLACE. Overwrites persisted values in the target with values from the source.
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>
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
