REST API for Oracle Integration 3

Abort an Integration Instance

post

/ic/api/integration/v1/monitoring/instances/{id}/abort

Abort a waiting or paused scheduled integration instance or any in-progress asynchronous integration instance with the specified identifier.

Request

Path Parameters

id(required): string

Integration instance identifier.

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 : InstanceAbortRs

Type: object

Show Source

abort-job-id: string

Abort Job Id
message: string

Message
status: string

Allowed Values: [ "IN_PROGRESS", "SCHEDULE_WAITING", "QUEUED", "SCHEDULE_PAUSED", "PAUSED", "FAILED", "COMPLETED", "ABORTED", "UNKNOWN", "RESUBMITTED", "BLOCKED" ]

{
    "type":"object",
    "properties":{
        "status":{
            "$ref":"#/components/schemas/FlowStatus"
        },
        "message":{
            "type":"string",
            "description":"Message"
        },
        "abort-job-id":{
            "type":"string",
            "description":"Abort Job Id"
        }
    }
}

400 Response

Malformed parameters

404 Response

Instance not found

409 Response

Instance not in-progress status

500 Response

Server error

Examples

The following example shows how to abort a instance by submitting a POST 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: Abort an Integration Instance

Request:

curl -X POST -H 'Authorization: Bearer access_token' -H "Content-Type:application/json"  https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/instances/hpTwuRitEe2sHXnqDAJVyQ/abort?integrationInstance=service-instance

Request Body:

The following example shows the contents of the request body in JSON format. This is the content of the runIntegration.json file listed in the cURL command.

Request Body:

{}