Document Actions

Retrieves the actions done to the document during the authorization workflow

This API resource is only available to Premium APPs.

GET /authorization/:documentId/actions

Collection properties

Property Type Description
actions Array A list of the document's actions
_links Array A list of useful preconfigured URI's a client app can use to navigate this resource collection.
_metadata Complex object Optional object with additional information concerning the current returned result.

Authorizer action's details

Property Type Description
authorizerId guid Unique identifier of the authorizer.
authorizerName string Name of the authorizer.
action string The action performed by the authorizer. Can be Authorized or OnHold.
authorizedAt datetime Date for when the document was authorized.
type string Type of the authorization. Can be BeforeBooking or AfterBooking.
index int Index of the authorizer on the workflow.

Example response

{
    "actions":[
        {
            "authorizerId": "3069ba37-935b-4b2a-8016-8d345e29bec9",
            "authorizerName": "AuthorizerA",
            "action": "Authorized",
            "authorizerAt": "2020-07-20T00:00:00",
            "type": "BeforeBooking",
            "index": 0
        },
        {
            "authorizerId": "3069ba37-935b-4b2a-8016-8d345e29bec1",
            "authorizerName": "AuthorizerB",
            "action": "OnHold",
            "authorizerAt": "2020-07-20T00:00:00",
            "type": "AfterBooking",
            "index": 0
        },
        {
            "authorizerId": "3069ba37-935b-4b2a-8016-8d345e29bec2",
            "authorizerName": "AuthorizerC",
            "action": "Authorized",
            "authorizerAt": "2020-07-20T00:00:00",
            "type": "AfterBooking",
            "index": 1
        }
    ],
    "_metadata": {
        "total": 3,
        "count": 3
    },
    "_links": [
        {
            "rel": "self",
            "href": "https://api.basecone.com/authorization/6fcd4649-29f7-4c5b-9b61-f1fb4551ff61/actions?limit=20&offset=0"
        }
    ]
}