LinX Template Summary Object

The LinX Template Summary object represents summary information for a workflow template. This object contains the template ID and version information, the template name and description, the number of steps in the template, the template creation date, and statistics regarding the template use.

Attributes

templateId

string (UUID)

ID of the LinX template. This ID is the same for all versions of the template.

templateVersionId

string (UUID)

ID of this version of the template.

name

string

Name for the LinX template. This name is used internally and should describe the purpose of the workflow (example: create-customer-and-enhance-profile). If name is not provided, a unique name for the template will be generated automatically.

displayName

string

Short readable name for the template.

description

string

Description of the template’s purpose.

numberOfSteps

integer

Number of steps in the template.

createdAt

string (date-time)

Date and time the LinX template was created in the RocketKOR system.

stats

object

Statistics tracking the template use.

allVersionsActiveWorkflows

integer

Number of active workflows (state = active) created by the template. Includes all versions of the template.

allVersionsWorkflows

integer

Number of workflows (all states) created by the template. Includes all versions of the template.

allVersionsLastExecutedAt

string (date-time)

Date and time the template was last used to create a workflow request. Includes all versions of the template.

currentVersionActiveWorkflows

integer

Number of active workflows (state = active) created by this version of the template.

currentVersionWorkflows

integer

Number of workflows (all states) created by this version of the template.

currentVersionLastExecutedAt

string (date-time)

Date and time this version of the template was last used to create a workflow request.

LinX Template Summary Object

				
					{
  "templateId": "6746d9f8-eb72-45d3-81c9-d53f386d6ce3",
  "templateVersionId": "0e96b2ef-0642-4666-bc35-3c9e81eaf0b7",
  "name": "transaction-for-new-customer",
  "displayName": "Create a transaction for a new Customer",
  "description": "Create a new Customer and a new Financial Account, accept required documents, and create a transaction",
  "numberOfSteps": 2,
  "createdAt": "2024-02-01T23:38:06.437Z",
  "stats": {
    "allVersionsActiveWorkflows": 2,
    "allVersionsWorkflows": 5,
    "allVersionsLastExecutedAt": "2024-02-01T23:38:06.437Z",
    "currentVersionActiveWorkflows": 1,
    "currentVersionWorkflows": 3,
    "currentVersionLastExecutedAt": "2024-02-01T23:38:06.437Z"
  }
}