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

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
  Starts 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 start schedule if it's stuck in STARTING state. Link in the location header can be used to monitor the state of the schedule.

Supported Media Types

• application/json;charset=utf-8

Request Body - application/json;charset=utf-8 ()

Root Schema : schema

Type: object

ScheduleJobRs

Show Source

• 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

{
    "type":"object",
    "properties":{
        "run-as-user-name":{
            "type":"string",
            "description":"Run as Username"
        },
        "action":{
            "$ref":"#/components/schemas/ScheduleJobRs.ScheduleEnum"
        },
        "run-as-schedule":{
            "type":"boolean",
            "description":"Run as Part of Schedule"
        },
        "parameters":{
            "type":"array",
            "description":"List of Schedule Parameters",
            "items":{
                "$ref":"#/components/schemas/ScheduleParamRs"
            }
        }
    },
    "description":"ScheduleJobRs"
}

Nested Schema : parameters

Type: array

List of Schedule Parameters

Show Source

• Array of: object ScheduleParamRs

{
    "type":"array",
    "description":"List of Schedule Parameters",
    "items":{
        "$ref":"#/components/schemas/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

202 Response

Request accepted

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://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000/schedule/start?integrationInstance=service-instance

Back to Top