The Workflow
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. Instances component of the Keyfactor API 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. includes operations necessary to programmatically retrieve, restart, delete and submit data into workflow instances.
Table 1175: Workflow Instances Operations
| Endpoint | Method | Description | Link |
|---|---|---|---|
| / | GET | Retrieve a list of the workflow instances. | GET Workflow Instances |
| /{instanceId} | DELETE | Delete the workflow instance with the specified GUID. | DELETE Workflow Instances Instance Id |
| /{instanceId} | GET | Retrieve the workflow instance with the specified GUID. | GET Workflow Instances Instance ID |
| /{instanceId}/Restart | POST | Restart the specified workflow instance after a failure. | POST Workflow Instances Instance Id Restart |
| /{instanceId}/Signals | POST | Input data to the workflow instance with the specified GUID. | POST Workflow Instances Instance ID Signals |
| /{instanceId}/Stop | POST | Rejects a workflow instance, preventing it from continuing. | POST Workflow Instances Instance Id Stop |
| /AssignedToMe | GET | Retrieve the workflow instances assigned to the user making the API request. | GET Workflow Instances AssignedToMe |
| /My | GET | Retrieve the workflow instances created by the user making the API request. | GET Workflow Instances My |
Was this page helpful? Provide Feedback