The GET /JobTypes/Custom/{id} method is used to return a custom job type with the specified GUID. This method returns HTTP 200 OK on a success with details for the custom job type.
Tip: The following permissions (see Security Roles and Claims) are required to use this feature:
/agents/management/read/
Table 420: GET JobTypes Custom {id} Input Parameters
| Name | In | Description |
|---|---|---|
| id | Path |
Required. The Keyfactor Command reference GUID of the custom job type. Use the GET /JobTypes/Custom method (see GET Custom Job Types) to retrieve a list of all the custom job types to determine the job type GUID. |
Table 421: GET JobTypes Custom {id} Response Data
| Name | Description |
|---|---|
| Id | The Keyfactor Command reference GUID for the custom job type. This ID is automatically set by Keyfactor Command. |
| Job Type Name | A string containing the short name for the custom job type. This is used to reference the job type when submitting a job for it. |
| Description | A string containing a description for the custom job type. |
| Job Type Fields |
An array of job type fields that indicate the type of tasks the job type is designed to perform. |
Tip: See the Keyfactor API Reference and Utility which provides a utility through which 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. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and 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. 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.
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 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. 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.Was this page helpful? Provide Feedback