Developer API for Oracle Integration 3

Export an Integration

get

/ic/api/integration/v1/integrations/{id}/archive

Exports an integration for use in other Oracle Integration environments to the location specified with the -o option.

Request

Path Parameters

id(required): string

Integration composite identifier. The ID consists of the code and the version separated by the | (vertical line) character. Format: code%7Cversion. Example: SC2RN%7C01.00.0000. When using cURL, substitute the %7C code for the vertical line.

Query Parameters

includeRecordingFlag: string

Include recording flag
integrationInstance(required): string

This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.

There's no request body for this operation.

Response

Supported Media Types

application/octet-stream

200 Response

Successful operation

Root Schema : schema

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

404 Response

Integration not found

423 Response

Integration is in locked status or PREBUILT type

500 Response

Server error

Examples

The following example shows how to export an integration to a specified file by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.

Example: Export an integration

This command exports the integration to the specified file myfile.iar in the same directory from which the command was run.

The id is in the form: code%7Cversion. The %7C is the encoded | (vertical line).

curl -X GET -H 'Authorization: Bearer access_token' -o 'myfile.iar' https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000/archive?integrationInstance=service-instance

Required options for this cURL request:

-o '/path/myfile.iar': Location and name of the file in which to save the integration.