Jump to

• Request
• Response

Update the scheduler request

patch

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

Creates or updates the request. Items that can be updated include one or more request parameters, the schedule information, or the callback URL. For request parameters, if the parameter does not exist, this operation will create a request. If the parameter exists, the request will get updated. 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

Request Body - application/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" ]
• scope: 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"
            ]
        },
        "scope":{
            "type":"string"
        }
    },
    "description":"A request parameter."
}

Request Body - 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" ]
• scope: 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"
            ]
        },
        "scope":{
            "type":"string"
        }
    },
    "description":"A request parameter."
}

Back to Top

Response

Supported Media Types

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

200 Response

OK

Body ()

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: string (uri)
  href of the provided link
• rel: string
  relationship with the returned resource

  Example: self

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"href of the provided link",
            "format":"uri"
        },
        "rel":{
            "type":"string",
            "description":"relationship with the returned resource",
            "example":"self"
        }
    },
    "xml":{
        "name":"link",
        "namespace":"http://xmlns.oracle.com/bpm/rest"
    }
}

400 Response

Invalid input

Body ()

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

Body ()

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

Body ()

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.

Body ()

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

Back to Top