POST Workflow/Ticket/Status

Retrieves the status string for an existing workflow ticket.

If the WebSDK caller is configured to be an approver and the workflow ticket was created after the established WebSDK session (automatically by Trust Protection Platform as part of lifecycle processing or by calling POST Workflow/Ticket/Create), you must call GET Permissions/Refresh after ticket creation. Otherwise, the caller will not be able to see or act on the ticket until you get another bearer token.

Requirements

  • Token scope:  Any valid scope, such as agent, certificate, or SSH.

Headers

  • Content type: Content-Type:application/json.

  • Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

Input parameters

Name

Description

GUID

The unique identification string of the workflow ticket for which the status is to be returned.

Returns

Response description

Name

Description

HTTP 200

For valid requests, this call returns a HTTP 200 message and the following data in the message body:

  • Result:  Result code indicating success 1 or failure. For more information, see Workflow result codes.

  • Status: The approval status of the ticket: Pending, Approved or Rejected.

HTTP 400

For invalid requests, this call returns HTTP 400 Bad Request and the following data in the message body:

  • error: The reason for the error.
  • error_description: If available, additional information about how to retry the request.

Example: Show the status of a workflow ticket

Request

POST https://tpp.venafi.example/vedsdk/Workflow/Ticket/Status
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "GUID":"6ede0e12-f7c0-4068-9977-001076205c84"
}

Response

HTTP/1.1 200 OK
{
 "Result": 1
 "Status": "Pending"
}