Jump to

• Request
• Response

Add a Schedule

post

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

Adds a schedule to 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

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "lockedFlag":{
                    "type":"boolean"
                },
                "lockedBy":{
                    "type":"string"
                },
                "lockedDate":{
                    "type":"string",
                    "format":"date-time"
                },
                "scheduleTZ":{
                    "type":"string"
                },
                "scheduleTZDisplayName":{
                    "type":"string"
                },
                "state":{
                    "type":"string"
                },
                "startDate":{
                    "type":"string"
                },
                "endDate":{
                    "type":"string"
                },
                "name":{
                    "type":"string"
                },
                "description":{
                    "type":"string"
                },
                "created":{
                    "type":"string",
                    "format":"date-time"
                },
                "updated":{
                    "type":"string",
                    "format":"date-time"
                },
                "createdBy":{
                    "type":"string"
                },
                "updatedBy":{
                    "type":"string"
                },
                "status":{
                    "type":"string"
                },
                "frequency":{
                    "$ref":"#/components/schemas/ScheduleDefinitionRs"
                },
                "scheduleType":{
                    "type":"string"
                },
                "icalExpression":{
                    "type":"string"
                },
                "errorCode":{
                    "type":"string"
                },
                "errorMessage":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IdRs

Match All

Show Source

• object GenericRestRs
• object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : type

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "lockedFlag":{
            "type":"boolean"
        },
        "lockedBy":{
            "type":"string"
        },
        "lockedDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduleTZ":{
            "type":"string"
        },
        "scheduleTZDisplayName":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "startDate":{
            "type":"string"
        },
        "endDate":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "created":{
            "type":"string",
            "format":"date-time"
        },
        "updated":{
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "frequency":{
            "$ref":"#/components/schemas/ScheduleDefinitionRs"
        },
        "scheduleType":{
            "type":"string"
        },
        "icalExpression":{
            "type":"string"
        },
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• media-type: string
• method: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : ScheduleDefinitionRs

Type: object

Show Source

• days-of-month: array days-of-month
• days-of-week: array days-of-week
• frequency-type: string
• interval: integer (int32)
• months-of-year: array months-of-year
• weeks-of-month: array weeks-of-month

{
    "type":"object",
    "properties":{
        "frequency-type":{
            "type":"string"
        },
        "interval":{
            "type":"integer",
            "format":"int32"
        },
        "days-of-week":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ScheduleDayOfWeek"
            }
        },
        "days-of-month":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int32"
            }
        },
        "weeks-of-month":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ScheduleWeekOfMonth"
            }
        },
        "months-of-year":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ScheduleMonthsOfYear"
            }
        }
    }
}

Nested Schema : days-of-month

Type: array

Show Source

• Array of: integer(int32)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

Nested Schema : days-of-week

Type: array

Show Source

• Array of: string
  Allowed Values: [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ScheduleDayOfWeek"
    }
}

Nested Schema : months-of-year

Type: array

Show Source

• Array of: string
  Allowed Values: [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ]

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ScheduleMonthsOfYear"
    }
}

Nested Schema : weeks-of-month

Type: array

Show Source

• Array of: string
  Allowed Values: [ "FIRST", "SECOND", "THIRD", "FOURTH", "LAST" ]

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ScheduleWeekOfMonth"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "lockedFlag":{
                    "type":"boolean"
                },
                "lockedBy":{
                    "type":"string"
                },
                "lockedDate":{
                    "type":"string",
                    "format":"date-time"
                },
                "scheduleTZ":{
                    "type":"string"
                },
                "scheduleTZDisplayName":{
                    "type":"string"
                },
                "state":{
                    "type":"string"
                },
                "startDate":{
                    "type":"string"
                },
                "endDate":{
                    "type":"string"
                },
                "name":{
                    "type":"string"
                },
                "description":{
                    "type":"string"
                },
                "created":{
                    "type":"string",
                    "format":"date-time"
                },
                "updated":{
                    "type":"string",
                    "format":"date-time"
                },
                "createdBy":{
                    "type":"string"
                },
                "updatedBy":{
                    "type":"string"
                },
                "status":{
                    "type":"string"
                },
                "frequency":{
                    "$ref":"#/components/schemas/ScheduleDefinitionRs"
                },
                "scheduleType":{
                    "type":"string"
                },
                "icalExpression":{
                    "type":"string"
                },
                "errorCode":{
                    "type":"string"
                },
                "errorMessage":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IdRs

Match All

Show Source

• object GenericRestRs
• object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : type

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "lockedFlag":{
            "type":"boolean"
        },
        "lockedBy":{
            "type":"string"
        },
        "lockedDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduleTZ":{
            "type":"string"
        },
        "scheduleTZDisplayName":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "startDate":{
            "type":"string"
        },
        "endDate":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "created":{
            "type":"string",
            "format":"date-time"
        },
        "updated":{
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "frequency":{
            "$ref":"#/components/schemas/ScheduleDefinitionRs"
        },
        "scheduleType":{
            "type":"string"
        },
        "icalExpression":{
            "type":"string"
        },
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• media-type: string
• method: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : ScheduleDefinitionRs

Type: object

Show Source

• days-of-month: array days-of-month
• days-of-week: array days-of-week
• frequency-type: string
• interval: integer (int32)
• months-of-year: array months-of-year
• weeks-of-month: array weeks-of-month

{
    "type":"object",
    "properties":{
        "frequency-type":{
            "type":"string"
        },
        "interval":{
            "type":"integer",
            "format":"int32"
        },
        "days-of-week":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ScheduleDayOfWeek"
            }
        },
        "days-of-month":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int32"
            }
        },
        "weeks-of-month":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ScheduleWeekOfMonth"
            }
        },
        "months-of-year":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ScheduleMonthsOfYear"
            }
        }
    }
}

Nested Schema : days-of-month

Type: array

Show Source

• Array of: integer(int32)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

Nested Schema : days-of-week

Type: array

Show Source

• Array of: string
  Allowed Values: [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ScheduleDayOfWeek"
    }
}

Nested Schema : months-of-year

Type: array

Show Source

• Array of: string
  Allowed Values: [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ]

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ScheduleMonthsOfYear"
    }
}

Nested Schema : weeks-of-month

Type: array

Show Source

• Array of: string
  Allowed Values: [ "FIRST", "SECOND", "THIRD", "FOURTH", "LAST" ]

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ScheduleWeekOfMonth"
    }
}

400 Response

Bad request, missing required data

404 Response

Integration not found

409 Response

Schedule already exists

412 Response

Precondition failed

500 Response

Server error

Back to Top