Jump to

• Request
• Response
• Examples

Update Scheduled Integration Parameters

patch

/ic/api/integration/v1/integrations/{id}/schedule/parameters

Update scheduled integration parameters.

Request

Supported Media Types

• application/json; charset=utf-8

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.

Header Parameters

• X-Oracle-IntegrationSuite-Parent-Ctx: string

Body ()

ScheduleJob resource

Root Schema : schedulejob

Type: object

Show Source

• action: string
  Allowed Values: [ "NOW" ]
• parameters: array parameters
• runAsSchedule: boolean
  Default Value: false

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "NOW"
            ]
        },
        "runAsSchedule":{
            "type":"boolean",
            "default":false
        },
        "parameters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScheduleParamRs"
            }
        }
    },
    "xml":{
        "name":"schedulejob"
    }
}

Nested Schema : parameters

Type: array

Show Source

• Array of: object ScheduleParamRs

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ScheduleParamRs"
    }
}

Nested Schema : ScheduleParamRs

Type: object

Show Source

• name: string
• value: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

400 Response

Bad request, missing required data

404 Response

Resource not found

412 Response

Precondition failed

Back to Top

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://integration.us.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000/schedule/parameters

Back to Top