Oracle Enterprise Scheduling Service

Update the scheduler request

patch

ess/rest/scheduler/v1/requests/{requestId}

Create or update the request. Items that can be updated include on or more request parameters, the schedule information, or the callback URL. For request parameters, if the parameter does not exist, this operation will create it. If it does exist, it will update it. If the schedule is replaced, all previously scheduled instances of this request that have not started running will be canceled. The new schedule will be effective immediately for scheduling new instances.

Request

Path Parameters

requestId(required): integer(int64)

the job request ID

Supported Media Types

application/json
application/vnd.oracle.resource+json

Root Schema : schema

Type: object

Show Source

requestParameters: array requestParameters

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

Nested Schema : requestParameters

Type: array

Show Source

Array of: object RequestParameter

a request parameter

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

Nested Schema : RequestParameter

Type: object

a request parameter

Show Source

name(required): string

the parameter name
paramType(required): string

Allowed Values: [ "BOOLEAN", "LONG", "INTEGER", "DATETIME", "STRING" ]
value: string

{
    "required":[
        "name",
        "paramType"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"the parameter name"
        },
        "value":{
            "type":"string"
        },
        "paramType":{
            "type":"string",
            "enum":[
                "BOOLEAN",
                "LONG",
                "INTEGER",
                "DATETIME",
                "STRING"
            ]
        }
    },
    "description":"a request parameter"
}

Root Schema : schema

Type: object

Show Source

requestParameters: array requestParameters

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

Nested Schema : requestParameters

Type: array

Show Source

Array of: object RequestParameter

a request parameter

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

Nested Schema : RequestParameter

Type: object

a request parameter

Show Source

name(required): string

the parameter name
paramType(required): string

Allowed Values: [ "BOOLEAN", "LONG", "INTEGER", "DATETIME", "STRING" ]
value: string

{
    "required":[
        "name",
        "paramType"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"the parameter name"
        },
        "value":{
            "type":"string"
        },
        "paramType":{
            "type":"string",
            "enum":[
                "BOOLEAN",
                "LONG",
                "INTEGER",
                "DATETIME",
                "STRING"
            ]
        }
    },
    "description":"a request parameter"
}

Response

Supported Media Types

application/json
application/vnd.oracle.resource+json

200 Response

Root Schema : Links

Type: array

Show Source

Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

href(required): string
rel(required): string

Allowed Values: [ "self", "cancel", "forceCancel", "hold", "release", "subscribe", "permissions", "executionStatus" ]

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "enum":[
                "self",
                "cancel",
                "forceCancel",
                "hold",
                "release",
                "subscribe",
                "permissions",
                "executionStatus"
            ]
        },
        "href":{
            "type":"string"
        }
    }
}

400 Response

Invalid input

Root Schema : SimpleExceptionDetail

Type: object

Show Source

detail: string

Detailed error message
errorCode: string

ESS-specific error code. For example ESS-00500.
status: integer

HTTP status code
title(required): string

summary error message
type(required): string

URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page.

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

403 Response

Not allowed for this operation

Root Schema : SimpleExceptionDetail

Type: object

Show Source

detail: string

Detailed error message
errorCode: string

ESS-specific error code. For example ESS-00500.
status: integer

HTTP status code
title(required): string

summary error message
type(required): string

URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page.

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

404 Response

Request ID not found

Root Schema : SimpleExceptionDetail

Type: object

Show Source

detail: string

Detailed error message
errorCode: string

ESS-specific error code. For example ESS-00500.
status: integer

HTTP status code
title(required): string

summary error message
type(required): string

URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page.

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

500 Response

A scheduling sub-system error occurred.

Root Schema : SimpleExceptionDetail

Type: object

Show Source

detail: string

Detailed error message
errorCode: string

ESS-specific error code. For example ESS-00500.
status: integer

HTTP status code
title(required): string

summary error message
type(required): string

URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page.

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}