Oracle Cloud Infrastructure Documentation

Workflow Status API Specifications

Use the Workflow Status API to get information on execution status. This API can be used to get parent status of execution or detailed status of an execution.

The following resources are supported:

Get Workflow Status

Use this API to get the workflow status of the execution.

API

/selfservice/v1/executions/status

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can get execution status only for executions created by your customer.
  • You can get execution status only for self-service functionality for which customer has opted-in.

Headers

  • Authorization: Bearer <Token>

    Where <Token> is the OAUTH token returned by the Authorization Server (JWT Token).

  • Identifier: <JWKS Identifier>

    Where <JWKS Identifier> is the GUID generated when JWKS URI is set by customer admin in self-service platform.

Base Path

/selfservice/v1/

Functionality

  • This API exposes workflow status of executions.
  • executionId is the execution ID.
  • status is parent status of given execution.

Verb

GET

Parameters

Name Type Description Mandatory
id Query parameter

Execution ID.

  • For CEMLI, BOUNCE, and CONFIG, use the RFC number.

  • For VM start/stop, Exadata, and Health check, use the Execution ID.

Note:

Multiple IDs can be passed in the following format:

/selfservice/v1/executions/status?id=<id1>&id=<id2>&...

 At least one ID has to be passed.
requestor Query parameter

Functionality name calling API. For example, EXADATA_CPU_SCALE for Exadata Scale Up or Scale Down functionality.

Requestor values are as follows:
Functionality Requestor
Cemli CEMLI
Bounce BOUNCE
Config CONFIG
VM start/stop BOUNCE_VM
Exadata Scale Up or Scale Down EXADATA_CPU_SCALE
Instance Health check INSTANCE_HEALTHCHECK
Yes

Sample response

{
"response": [
    {
        "executionId": "3-BLFVC0W",
        "status": "success"
    },
    {
        "executionId": "3-XTFVC0W",
        "status": "success"
    }
  ]
}

Get Workflow Status Details

Use this API to get workflow status details.

API

/selfservice/v1/executions/{id}/status/details

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can get execution details status only for executions created by your customer.
  • You can get execution status only for self-service functionality for which customer has opted-in.

Headers

  • Authorization: Bearer <Token>

    Where <Token> is the OAUTH token returned by the Authorization Server (JWT Token).

  • Identifier: <JWKS Identifier>

    Where <JWKS Identifier> is the GUID generated when JWKS URI is set by customer admin in self-service platform.

Base Path

/selfservice/v1/

Functionality

  • This API exposes workflow status details of executions.
  • executionId is the execution ID.
  • stepId is current step ID and is used to identify child steps for the given step. If not passed, the step is treated as root step.
  • subSteps.stepId is step ID for a substep and is used in subsequent API calls to identify child steps for the given step.
  • subSteps.endTime is the time at which given milestone is completed.
  • subSteps.hasSubStep denotes if given subStep has child steps
  • subSteps.name is the milestone name.
  • subSteps.status is status for given milestone for RFC.
  • subSteps.remark is logs for the given milestone.

Verb

GET

Parameters

Name Type Description Mandatory
id Query parameter

Execution ID.

  • For CEMLI, BOUNCE, and CONFIG, use the RFC number.

  • For VM start/stop, Exadata, and Health check, use the Execution ID.

 Yes
stepId Query parameter This parameter denotes current step ID. This parameter is used to identify child steps for a given Step. If not passed, the step is treated as root step.

No

Default is 0
requestor Query parameter

Functionality name calling API. For example, EXADATA_CPU_SCALE for Exadata Scale Up or Scale Down functionality.

Requestor values are as follows:
Functionality Requestor
Cemli CEMLI
Bounce BOUNCE
Config CONFIG
VM start/stop BOUNCE_VM
Exadata Scale Up or Scale Down EXADATA_CPU_SCALE
Instance Health check INSTANCE_HEALTHCHECK
Yes

Sample response

{
    "executionId": "3-7JZXAGH",
    "stepId": 0,
    "subSteps": [
        {
            "endTime": "2021-04-21T01:56:24Z",
            "hasSubStep": true,
            "name": "RFC Submission",
            "startTime": "2021-04-21T01:52:24Z",
            "status": "Completed",
            "stepId": 159,
            "remark": "RFC successfully submitted to workflow engine"
        },
        {
            "endTime": "2021-04-21T01:59:24Z",
            "hasSubStep": false,
            "name": "RFC Execution",
            "startTime": "2021-04-21T01:52:24Z",
            "status": "Queued",
            "stepId": 236,
            "remark": "RFC successfully executed"
        }
    ]
}