REST API for Oracle Integration 3

Run a Scheduled Integration Now

post

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

Creates an ad-hoc integration run for a scheduled integration. This is useful for when you want to test a scheduled integration.

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

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.

Header Parameters

X-Oracle-IntegrationSuite-Parent-Ctx:

Supported Media Types

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"
        }
    }
}

Response

204 Response

Successful operation

404 Response

Resource not found

Examples

The following example shows how to run a scheduled integration now 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: Run a Scheduled Integration Now

Request:

curl -X POST -H 'Authorization: Bearer access_token' -H "Content-Type:application/json" -d @runIntegration.json https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000/schedule/jobs?integrationInstance=service-instance

Request Body:

The following example shows the contents of the request body in JSON format. This is the contents of the runIntegration.json file listed in the cURL command.

{"action":"NOW"}