Skip to main content
GET
/
app
/
workflows
/
approval_requests
/
{approval_id}
import cobo_waas2
from cobo_waas2.models.approval_request_detail import ApprovalRequestDetail
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.AppWorkflowsApi(api_client)
    approval_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"

    try:
        # Get approval request details
        api_response = api_instance.get_approval_request_by_id(approval_id)
        print("The response of AppWorkflowsApi->get_approval_request_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling AppWorkflowsApi->get_approval_request_by_id: %s\n"
            % e
        )

{
  "approval_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "initiator": {
    "email": "john.smith@example.com",
    "name": "John Smith",
    "status": "Pending",
    "created_timestamp": 1610445878970
  },
  "approved_list": [
    {
      "status": "Pending",
      "created_timestamp": 1610445878970,
      "approval_users": [
        {
          "email": "john.smith@example.com",
          "name": "John Smith",
          "status": "Pending",
          "created_timestamp": 1610445878970
        }
      ]
    }
  ],
  "status": "Pending",
  "modified_timestamp": 1610445878970
}
import cobo_waas2
from cobo_waas2.models.approval_request_detail import ApprovalRequestDetail
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.AppWorkflowsApi(api_client)
    approval_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"

    try:
        # Get approval request details
        api_response = api_instance.get_approval_request_by_id(approval_id)
        print("The response of AppWorkflowsApi->get_approval_request_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling AppWorkflowsApi->get_approval_request_by_id: %s\n"
            % e
        )

Authorizations

BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Path Parameters

approval_id
string<uuid>
required

The system-generated unique ID of the approval request.

Response

The information about an approval request.

The information of an approval request detail.

initiator
object
required

The information of the user.

status
enum<string>
required

The approval status. Possible values include:

  • Pending: The approval is pending.
  • Completed: The approval is completed.
  • Failed: The approval is rejected.
  • Revoked: The approval is revoked.
Available options:
Pending,
Completed,
Failed,
Revoked
Example:

"Pending"

approval_id
string

The system-generated unique ID of the approval request.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

approved_list
object[]
modified_timestamp
integer

The time when the approval was modified, in Unix timestamp format, measured in milliseconds.

Example:

1610445878970