POST Flow/Tickets/Enumerate

Returns all Flow tickets that are pending approval. Flow tickets for Teams requires setup. For more information, see the Administration Guide.

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
Tickets

The array of information about items that require approval or rejection:

  • ProductCode: (Optional) The product code of the flow that created this ticket.
  • TicketPageSize: (Optional) The number of items per page to return.
  • TicketPageNumber: (Optional) The page number of Flow Tickets to return. If there is only one page, specify 0.

Returns

Response description

Name

Description

Error

The reason the HTTP 400 Bad Request occurred.

Result

The Result code of this API call. For more information, see Flow Ticket result codes.

Message

Appears only if Result is a non-zero value.
Tickets

The array of information about items that require approval or rejection:

  • Approvals: The array of ApprovalTime and prefixed Universal of users who have approved the request.
  • Approvers: The array of prefixed universals of users/groups who can approve this ticket.
  • CreationTime: The Flow Ticket creation time in the Epoch format.
  • Environment: The array of key and value pairs that describe the action.
  • FlowProcessId: The Id of the process blocked by this ticket, if any.
  • Id: The Ticket Id that identifies the process.
  • Identifier: The identifier string of the Flow Ticket process.
  • ProductCode: The product code of the flow that created this ticket.
  • RequiredApprovals: The minimum number of approvals required to set this ticket to approved .

Example: List Pending Flow Tickets

Request

POST https://tpp.venafi.example/vedsdk/Flow/Tickets/Enumerate
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "ProductCode": 4390913,
   "TicketPageSize": 10
}

Response

HTTP/1.1 200 OK
{
   "Tickets":[
      {
         "Approvals":[

         ],
         "Approvers":[
            "local:{a69f5174-4961-4781-b338-58f983b0b922}"
         ],
         "CreationTime":"/Date(1591289490905-0700)/",
         "Environment":[
            {
               "Key":"Object DN",
               "Value":"\\VED\\Identity\\Employee Onboard"
            },
            {
               "Key":"Suggested Member",
               "Value":"local:{8b5211ec-ee45-4c98-9aa5-8cdfa6c127ee}"
            },
            {
               "Key":"Suggested By",
               "Value":"local:{8b5211ec-ee45-4c98-9aa5-8cdfa6c127ee}"
            },
            {
               "Key":"Suggested On",
               "Value":"06/04/2020 16:48:49"
            },
            {
               "Key":"Attribute Name",
               "Value":"Owner"
            },
            {
               "Key":"Context",
               "Value":"\\VED\\Identity\\Employee Onboard"
            },
            {
               "Key":"Team Name",
               "Value":"Employee Onboard"
            },
            {
               "Key":"ToDo Id",
               "Value":"20"
            },
            {
               "Key":"GroupingId",
               "Value":"2"
            },
            {
               "Key":"Process Start Time",
               "Value":"2020-06-04 16:48:50.237"
            },
            {
               "Key":"Last Approval Requested",
               "Value":"2020-06-04 16:48:50.252"
            },
            {
               "Key":"SkippedStages",
               "Value":"[]"
            }
         ],
         "FlowProcessId":2,
         "Id":2,
         "Identifier":"CF6EA460586BAA09A165B1DCD20436F81FF348A38B3C78677E36C33B6DF49692",
         "ProductCode":4390913,
         "RequiredApprovals":1
      }
   ]
}