GET Workflow Instances

The GET /WorkflowClosed A workflow is a series of steps necessary to complete a process. In the context of Keyfactor Command, it refers to the workflow builder, which allows you automate event-driven tasks when a certificate is requested or revoked./Instances method is used to retrieve the list of workflows that have been initiated. Both in progress and completed workflows are included. This method returns HTTP 200 OK on a success with details about the workflow instances.

Tip:  The following permissions (see Security Overview) are required to use this feature:

WorkflowInstances: ReadAll

Table 659: GET Workflow Instances Input Parameters

Name In Description
queryString Query

A string containing a query to limit the results (e.g. field1 -eq value1 AND field2 -gt value2). The default is to return all records. Fields available for querying through the API for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns for the same feature. For querying guidelines, refer to the Keyfactor Command Reference Guide: Using the Workflow Instances Search Feature. The query fields supported for this endpoint are:

  • DefinitionId (workflow definition ID)
  • Id (workflow instance GUID)
  • InitiatingUserName (DOMAIN\\username)
  • LastModified
  • ReferenceId (workflow instance integer ID)
  • StartDate
  • Status
  • Title
  • WorkflowType
pageReturned Query An integer that specifies how many multiples of the returnLimit to skip and offset by before returning results, to enable paging. The default is 1.
returnLimit Query An integer that specifies how many results to return per page. The default is 50.
sortField Query A string containing the property by which the results should be sorted. Fields available for sorting through the API for the most part match those that appear as sortable columns in the Keyfactor Command Management Portal. The default sort field is CurrentStepDisplayName.
sortAscending Query An integer that sets the sort order on the returned results. A value of 0 sorts results in ascending order while a value of 1 sorts results in descending order. The default is ascending.

Table 660: GET Workflow Instances Response Data

Name Description
Id A string indicating the Keyfactor Command reference GUID of the workflow instance.
Status

A string indicating the current status of the workflow instance. The possible statuses are:

  • CanceledForRestart
  • Complete

  • Failed

  • Rejected

  • Running

  • Suspended
CurrentStepID A string indicating the Keyfactor Command reference GUID of the workflow instance step.
StatusMessage

A string indicating the current status message for the workflow instance. Possible status messages vary and may include:

  • Access is denied
  • Awaiting # more approval(s) from approval roles.

  • Either the credentials are invalid, or the CA on [CA hostname] is not running

  • Issued

  • Issued. The private key was successfully retained.

  • Post-process Failed: [Message indicating reason for failure generally from the CA]

  • Pre-process failed: [Message indicating details of the failure]

  • Revoked

  • Step ‘Keyfactor-Enroll’ failed: [Message indicating details of the failure]

  • Step ‘Keyfactor-Revoke’ failed:[Message indicating details of the failure]

  • Step [custom step name] failed: [Message indicating details of the failure]

  • Taken Under Submission. The certificate template requires manager approval, and is marked as pending.

  • Workflow rejected by user with Id #.
Definition

An array containing the workflow definition. ClosedShow workflow definition details.
CurrentStepDisplayName A string indicating the display name defined for the workflow instance step.
CurrentStepUniqueName A string indicating the unique name defined for the workflow instance step. This value is unique among the steps in a particular workflow definition. It is intended to be used as a user-friendly reference ID.
Title

A string indicating a description for the action taking place in the step, made up of the InitiatingUserName (either DOMAIN\\username or Timer Service) followed by an indication of the type of action and a specific message about the action. For example:

"KEYEXAMPLE\\jsmith is enrolling for a certificate with CN=appsrvr14.keyexample.com."

Or

"KEYEXAMPLE\\jsmith is revoking certificate with CN=appsrvr12.keyexample.com."
LastModified A string indicating the date and time on which the initiated instance was last updated. The instance is updated each time a step in the workflow is completed, when signals are received for a step that accepts signals (e.g. a requires approval step), or when an instance is stopped or restarted.
StartDate A string indicating the date and time when the instance was initiated.
ReferenceId A integer indicating the Keyfactor Command reference ID for the workflow instance.
Tip:  For code examples, see the Keyfactor API Endpoint Utility. To find the embedded web copy of this utility, click the help icon () at the top of the Keyfactor Command Management Portal page next to the Log Out button.