Update a Schedule
put
/ic/api/integration/v1/integrations/{id}/schedule
Updates the schedule for a scheduled orchestration.
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.
Supported Media Types
- application/json
Nested Schema : type
Type:
Show Source
object
-
created: string
(date-time)
-
createdBy: string
-
description: string
-
endDate: string
-
errorCode: string
-
errorMessage: string
-
frequency: object
ScheduleDefinitionRs
-
icalExpression: string
-
lockedBy: string
-
lockedDate: string
(date-time)
-
lockedFlag: boolean
-
name: string
-
scheduleType: string
-
scheduleTZ: string
-
scheduleTZDisplayName: string
-
startDate: string
-
state: string
-
status: string
-
updated: string
(date-time)
-
updatedBy: string
Nested Schema : days-of-week
Type:
Show Source
array
-
Array of:
string
Allowed Values:
[ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]
Nested Schema : months-of-year
Type:
Show Source
array
-
Array of:
string
Allowed Values:
[ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ]
Nested Schema : weeks-of-month
Type:
Show Source
array
-
Array of:
string
Allowed Values:
[ "FIRST", "SECOND", "THIRD", "FOURTH", "LAST" ]
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : type
Type:
Show Source
object
-
created: string
(date-time)
-
createdBy: string
-
description: string
-
endDate: string
-
errorCode: string
-
errorMessage: string
-
frequency: object
ScheduleDefinitionRs
-
icalExpression: string
-
lockedBy: string
-
lockedDate: string
(date-time)
-
lockedFlag: boolean
-
name: string
-
scheduleType: string
-
scheduleTZ: string
-
scheduleTZDisplayName: string
-
startDate: string
-
state: string
-
status: string
-
updated: string
(date-time)
-
updatedBy: string
Nested Schema : days-of-week
Type:
Show Source
array
-
Array of:
string
Allowed Values:
[ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]
Nested Schema : months-of-year
Type:
Show Source
array
-
Array of:
string
Allowed Values:
[ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ]
Nested Schema : weeks-of-month
Type:
Show Source
array
-
Array of:
string
Allowed Values:
[ "FIRST", "SECOND", "THIRD", "FOURTH", "LAST" ]
400 Response
Bad request, missing required data
404 Response
Integration not found
412 Response
Precondition failed
423 Response
Schedule is locked by another user
500 Response
Server error