Jump to

• Request
• Response

Set the status of the request execution

post

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

Sets the status of the request execution. It is meant to be invoked from a job request to signal the result of its execution to the scheduler. The scheduler uses it as an indicator to transition the request state.

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

• requestHandle: string
  The request handle associated with the executing request represents an opaque identifer for the executing instance of the request.
• status: string
  Allowed Values: [ "SUCCESS", "UPDATE", "PAUSE", "WARNING", "ERROR", "BUSINESS_ERROR", "CANCEL", "SUSPEND" ]

  Callback status of an asynchronous job. Returning an asynchronous status does not guarantee that the state of the request will change to the corresponding value. The new state of the request will depend on the old state, the async status, and any errors that may occur in subsequent processing. SUCCESS -- the job ran successfully UPDATE -- the asynchronous job is updated PAUSE -- the job has paused for the execution of sub-requests WARNING -- the job is issuing a warning ERROR -- the job encountered a retryable error CANCEL -- The job has cancelled its execution. Usually this originates from cancelling the job using the scheduler APIs SUSPEND -- the job has suspended itself BUSINESS_ERROR -- the job encountered a non-retryable error
• statusMessage: string
  An error message if the status is ERROR or BUSINESS_ERROR, a warning message if the status is WARNING, the paused state if the status is PAUSED. The value will be ignored if the status is SUCCESS or CANCEL.

{
    "type":"object",
    "properties":{
        "requestHandle":{
            "type":"string",
            "description":"The request handle associated with the executing request represents an opaque identifer for the executing instance of the request."
        },
        "status":{
            "type":"string",
            "description":"Callback status of an asynchronous job. Returning an asynchronous status does not guarantee\nthat the state of the request will change to the corresponding value. The new state of the request\nwill depend on the old state, the async status, and any errors that may occur in subsequent processing.\n\nSUCCESS         -- the job ran successfully\n\nUPDATE          -- the asynchronous job is updated\n\nPAUSE           -- the job has paused for the execution of sub-requests\n\nWARNING         -- the job is issuing a warning\n\nERROR           -- the job encountered a retryable error\n\nCANCEL          -- The job has cancelled its execution. Usually this originates from cancelling the job using the scheduler APIs\n\nSUSPEND         -- the job has suspended itself\n\nBUSINESS_ERROR  -- the job encountered a non-retryable error\n",
            "enum":[
                "SUCCESS",
                "UPDATE",
                "PAUSE",
                "WARNING",
                "ERROR",
                "BUSINESS_ERROR",
                "CANCEL",
                "SUSPEND"
            ]
        },
        "statusMessage":{
            "type":"string",
            "description":"An error message if the status is ERROR or BUSINESS_ERROR, a warning message if the status\nis WARNING, the paused state if the status is PAUSED. The value will be ignored if the\nstatus is SUCCESS or CANCEL.\n"
        }
    }
}

Request Body - application/vnd.oracle.resource+json ()

Root Schema : schema

Type: object

Show Source

• requestHandle: string
  The request handle associated with the executing request represents an opaque identifer for the executing instance of the request.
• status: string
  Allowed Values: [ "SUCCESS", "UPDATE", "PAUSE", "WARNING", "ERROR", "BUSINESS_ERROR", "CANCEL", "SUSPEND" ]

  Callback status of an asynchronous job. Returning an asynchronous status does not guarantee that the state of the request will change to the corresponding value. The new state of the request will depend on the old state, the async status, and any errors that may occur in subsequent processing. SUCCESS -- the job ran successfully UPDATE -- the asynchronous job is updated PAUSE -- the job has paused for the execution of sub-requests WARNING -- the job is issuing a warning ERROR -- the job encountered a retryable error CANCEL -- The job has cancelled its execution. Usually this originates from cancelling the job using the scheduler APIs SUSPEND -- the job has suspended itself BUSINESS_ERROR -- the job encountered a non-retryable error
• statusMessage: string
  An error message if the status is ERROR or BUSINESS_ERROR, a warning message if the status is WARNING, the paused state if the status is PAUSED. The value will be ignored if the status is SUCCESS or CANCEL.

{
    "type":"object",
    "properties":{
        "requestHandle":{
            "type":"string",
            "description":"The request handle associated with the executing request represents an opaque identifer for the executing instance of the request."
        },
        "status":{
            "type":"string",
            "description":"Callback status of an asynchronous job. Returning an asynchronous status does not guarantee\nthat the state of the request will change to the corresponding value. The new state of the request\nwill depend on the old state, the async status, and any errors that may occur in subsequent processing.\n\nSUCCESS         -- the job ran successfully\n\nUPDATE          -- the asynchronous job is updated\n\nPAUSE           -- the job has paused for the execution of sub-requests\n\nWARNING         -- the job is issuing a warning\n\nERROR           -- the job encountered a retryable error\n\nCANCEL          -- The job has cancelled its execution. Usually this originates from cancelling the job using the scheduler APIs\n\nSUSPEND         -- the job has suspended itself\n\nBUSINESS_ERROR  -- the job encountered a non-retryable error\n",
            "enum":[
                "SUCCESS",
                "UPDATE",
                "PAUSE",
                "WARNING",
                "ERROR",
                "BUSINESS_ERROR",
                "CANCEL",
                "SUSPEND"
            ]
        },
        "statusMessage":{
            "type":"string",
            "description":"An error message if the status is ERROR or BUSINESS_ERROR, a warning message if the status\nis WARNING, the paused state if the status is PAUSED. The value will be ignored if the\nstatus is SUCCESS or CANCEL.\n"
        }
    }
}

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