REST API for Oracle Integration 3

Retrieve Integration Activation Status

get

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

Retrieves integration activation progress. Possible responses:

CONFIGURED: Activation has not yet started
ACTIVATION_INPROGRESS: Activation is still in progress
ACTIVATED: Activation completed successfully
FAILEDACTIVATION: Activation failed.

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

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/json; charset=utf-8

200 Response

Successful operation

Root Schema : IntegrationActivationStatusRs

Type: object

Show Source

activationStatus: string

Integration Activation Status

{
    "type":"object",
    "properties":{
        "activationStatus":{
            "type":"string",
            "description":"Integration Activation Status"
        }
    }
}

404 Response

Integration not found

412 Response

Precondition failed

500 Response

Server error

Examples

The following example shows how to get the progress of an integration activation 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: Get Activation Status for the Integration HELLO_WORLD|01.02.0000

Request:

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

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json"https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000/activationStatus?integrationInstance=service-instance

Response Body:

The following example shows the contents of the response body in JSON format.

{"activationStatus":"CONFIGURED"}