Export Data Integration

The Export Data Integration API enables you to back up setup and staging data in Data Integration as a snapshot.

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 Export Data Integration

{
    "action":"EXPORT",
    "snapshotType":"ALL",
    "fileName":"MyBackup.zip",
    "overwriteFile":true
}
 

The following table summarizes the client request.

Table 15-12 Parameters

Name	Description	Type	Required	Default
api_version	Version of the API you are working with, such as V1.	Path	Yes	None
action	EXPORT	Payload	Yes	None
snapshottype	Snapshot type: ALL, ALL_INCREMENTAL, INCREMENTAL, SETUP ALL—Include all setup and staging data. ALL_INCREMENTAL—Include only new or changed staging data based on the POV since the last snapshot was exported and include SETUP and all POVs (old and new) in the output file. INCREMENTAL—Include only new or changed staging data based on the POV since the last snapshot was exported and include only SETUP and new POVs in the output file. SETUP—Include only setup data.	Payload	Yes	None
fileName	Name of the output file in ZIP format. This file is generated in the outbox as: outbox/<filename>.zip. If the file doesn't end with a ZIP extension, Data Management appends the ZIP file extension at the end of the file name.	Payload	Yes	None
overwriteFile	true/false—Boolean option to specify whether or not to replace the output file specified in the filename parameter. This parameter prevents a user from accidentally overwriting the output file if it already exists by throwing a HTTP 400 error.	Payload	No	false

Response

The following table summarizes the response parameters.

Table 15-13 Parameters

Name	Description
action	Always EXPORT
snapshotType	Name of the snapshot type
jobId	The process ID generated in Data Integration for the job, such as 1880
links	Describes links to other resources and actions applicable on the current resource.
status	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": "EXPORT",
    "snapshotType": "SETUP",
    "jobId": 423,
    "links": [
        {
            "rel": "self",
            "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/aif/rest/v1/jobs/jobID",
            "action": "GET"
        }
    ],
    "status": -1
}