Jump to

• Request
• Response

Start an Integration Schedule in a Project

post

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

Start the integration schedule in a project 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.
• projectId(required): string
  Project identifier

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.
• 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