GET Workflow Definitions Types

The GET /WorkflowClosed A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store./Definitions/Types method is used to retrieve the workflow definition types that have been defined for use. Query parameters enable filtering using defined criteria, control over pagination by specifying the page number and return limit, and customization of sorting based on specified fields and order. This method returns HTTP 200 OK on a success with information about the defined workflow definition types.

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/workflows/definitions/read/

Table 953: GET Workflow Definitions Types 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: Using the Workflow Definitions Search Feature. The query fields supported for this endpoint are:

  • Name
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. Very large values can result in long processing time.
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 WorkflowType.
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 954: GET Workflow Definitions Types Response Data

Name Description
WorkflowType A string indicating the display name of the workflow type.
KeyType A string indicating the key type for the workflow. The built-in enrollment and revocation workflows use Templates as the key type. The built-in certificate entered collection and certificate left collection workflows use Certificate Collections as the key type.
ContextParameters An object containing the tokens that the workflow type provider has the ability to replace. These will vary depending on the workflow type.
BuiltInSteps

An object containing the information about the built-in step(s) for the workflow type (e.g. the enrollment step of the enrollment type). ClosedShow step details.

Note:  There are no built-in steps for workflows of types certificate entered collection and certificate left collection.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor APIClosed An API is a set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflow development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon () at the top of the Management Portal page next to the Log Out button.