POST Flow/Tickets/Load

Returns details about approved Flow tickets. For more information, see Flow Ticket status codes.

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

Specify one of the following:

Input parameters
Name	Description
TicketId	Case sensitive. A Flow Ticket Id that is Pending review for approval or rejection. Carefully review and use an Id from POST Flow/Tickets/Enumerate.
TicketIDs	Case sensitive. An array of Flow Ticket Ids that are Pending review for approval or rejection. Carefully review and use Ids from POST Flow/Tickets/Enumerate.

Returns

Response description
Name	Description
Error	The reason the HTTP 400 Bad Request occurred.
Message	Appears only if Result is a non-zero value.
Result	The Result code of this API call. For more information, see Flow Ticket result codes.
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. Remaining uses: The number of Flow Ticket reuses. RequiredApprovals: The minimum number of approvals required to set this ticket to approved .

Example: View tickets that are pending approval

Request

POST https://tpp.venafi.example/vedsdk/Flow/Tickets/Load
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "TicketId": 8

}

Response

HTTP/1.1 200 OK
{
   "Message":"",
   "Ticket":{
      "Approvals":[
         {
            "ApprovalTime":"/Date(1591740402690)/",
            "Universal":"local:{70179c4d-9f47-496b-923f-e10ac805e2f2}"
         }
      ],
      "Approvers":[
         "local:{70179c4d-9f47-496b-923f-e10ac805e2f2}"
      ],
      "CreationTime":"/Date(1591745561531-0700)/",
      "Environment":[

      ],
      "Id":8,
      "Identifier":"555E659817DB430747D574A4DF0B195201D96DE5259194D3E9380B63B607AB07",
      "ProductCode":4390913,
      "RemainingUses":0,
      "RequiredApprovals":1
   }
}