Jump to

• Request
• Response
• Examples

Start an Integration Schedule

post

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

Start the integration schedule for the integration with the specified ID.

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.

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

404 Response

Resource not found

Back to Top

Examples

The following example shows how to start 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: Start the Schedule for the Integration HELLO_WORLD|01.02.0000

Request:

curl -X POST -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://integration.us.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000/schedule/start

Back to Top