Stop an Integration Schedule
post
/ic/api/integration/v1/integrations/{id}/schedule/stop
Stops an integration schedule. Cancels all existing runs and no new runs are submitted.
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
-
async: boolean
Stop the schedule in asynchronous manner. Link in the location header can be used to monitor the state of the schedule.
-
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.
-
retry: boolean
Retry stop schedule if it's stuck in STOPPING state. Link in the location header can be used to monitor the state of the schedule.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json; charset=utf-8
200 Response
Successful operation
202 Response
Request accepted
404 Response
Resource not found
Examples
The following example shows how to stop the schedule of an integration 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: Pause the Schedule for the Integration HELLO_WORLD|01.02.0000
Request:
curl -X POST -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/schedule/stop?integrationInstance=service-instance