Update Scheduled Integration Parameters
/ic/api/integration/v1/integrations/{id}/schedule/parameters
Request
-
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.
-
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.
- application/json
object
-
action: string
Allowed Values:
[ "NOW", "now" ]
-
parameters: array
parameters
List of Schedule Parameters
-
run-as-schedule: boolean
Run as Part of Schedule
-
run-as-user-name: string
Run as Username
Response
200 Response
400 Response
404 Response
412 Response
Examples
The following example shows how to update schedule parameters for a scheduled integration by submitting a PATCH 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: Update Schedule Parameters for the Scheduled Integration HELLO_WORLD|01.02.0000
Update schedule parameters in between runs of a scheduled integration run. You can update one or more schedule parameter values.
To retrieve the schedule parameter values for an integration, use the API Retrieve an Integration.
Example request to update schedule parameters:
The id is in the form: code%7Cversion. The %7C is the encoded | (vertical line).
curl -X PATCH -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d '{"parameters":[{"name":"param_name_1","value": "value_of_param_1"},{"name":"param_name_2","value":"value_of_param_2"}]}' https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000/schedule/parameters?integrationInstance=service-instance