OnboardingTaskTemplateDto
DTO for onboarding task templates, exposing only codes and enums (never DB IDs).
Properties
| Name | Type | Description |
|---|---|---|
| libraryCode | string | The Code of the library template this entity was imported from, or null if the entity |
The Code of the library template this entity was imported from, or null if the entity | ||
| libraryStatus | enum | Describes a library-imported entity's relationship to its source library template. |
Describes a library-imported entity's relationship to its source library template. | ||
| isImported | boolean | True if the tenant has already imported this library item. |
True if the tenant has already imported this library item. | ||
| code | string | |
| billableService | CodeAndNameDto | |
| name | string | |
| description | string | |
| timeEstimateMinutes | integer | |
| dueDateOffsetDays | integer | Days after service start date for the task due date |
Days after service start date for the task due date | ||
| assignmentType | enum | Unassigned SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate |
Unassigned SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate | ||
| assignedUser | CodeAndNameDto | |
| assignedTeam | CodeAndNameDto | |
| workflow | CodeAndNameDto | |
| category | CodeAndNameDto | |
| checklist | array of ChecklistItemDto | Checklist items for this onboarding task template |
Checklist items for this onboarding task template | ||
| active | boolean | Whether this template is active |
Whether this template is active | ||
JSON Example
{
"libraryCode": "string",
"libraryStatus": "NotFromLibrary",
"isImported": false,
"code": "string",
"billableService": {
"code": "string",
"name": "string"
}
}
Used By Operations
-
POST
Create OnboardingTaskTemplate
/tenants/{tenant}/onboarding-task-templates
-
GET
Get OnboardingTaskTemplate
/tenants/{tenant}/onboarding-task-templates/{code}
-
PUT
Update OnboardingTaskTemplate
/tenants/{tenant}/onboarding-task-templates/{code}
-
PUT
Revert OnboardingTaskTemplate to Library
/tenants/{tenant}/onboarding-task-templates/{code}/library-version