Import Data Integration
The Import Data Integration API enables you to restore setup and staging data from one environment to another. The system clears the existing data in the target environment and then imports the data from the backup files without merging any operations.
REST Resource
/aif/rest/V1/snapshots
Required Roles
Service Administrator, Power User
Method
POST
Request
Supported Media Types: application/json
Sample REST API Payload for Import Data Integration
{
"action":"IMPORT",
"fileName":"inbox/MyBackup.zip"
}
The following table summarizes the client request.
Table 15-14 Parameters
Name | Description | Type | Required | Default |
---|---|---|---|---|
action |
IMPORT | Payload | Yes | None |
filename |
File name of the import snapshot (for example:
If no path is specified, it is assumed that the file is in the Data Integration root folder. (Files to the Data Integration root folder can only be uploaded from the Data Integration user interface.) |
Payload | Yes | None |
Response
The following table summarizes the response parameters.
Table 15-15 Parameters
Name | Description |
---|---|
action |
Always IMPORT |
|
The process ID generated in Data Integration for an import Data Integration job is "0." |
|
Describes links to other resources and actions applicable on the current resource. |
|
Status of the job: -1 = in progress; 0 = success; 1 = error; 2 =cancel pending; 3 = cancelled; 4 = invalid parameter;Integer.MAX_VALUE = unknown |
Supported Media Types: application/json
The following shows an example of the response in JSON format.
{
"action": "IMPORT",
"jobId": 0,
"links": [
{
"rel": "self",
"href": "https://<BASE-URL>/aif/rest/v1/jobs/jobID",
"action": "GET"
}
],
"status": -1
}