taskTemplates

Returns the task template.

Changed on

Returns the task template. The response includes the task template configuration. <Check title="Required Permissions" icon="key">The user must have permission to access the requested resource.</Check>

get/tasktemplates/{taskTemplateId}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/tasktemplates/{taskTemplateId}
  • Auth: HTTP bearer

Path parameters

taskTemplateIdstring uuid required

The id of the task template.

Response

OK

namestring nullable

The name of the task created from this template.

descriptionstring nullable

The description of the task created from this template.

isPrioboolean

Whether the task created from this template will be marked as priority.

plannedDurationinteger

The expected planned workload of the task created from this template, in seconds.

relativeStartOninteger nullable

The relative start date and time of the task created from this template, in seconds, from the moment of creating the task.

relativeDueOninteger nullable

The relative due date and time of the task created from this template, in seconds, from the moment of creating the task.

typeOfWorkIdstring uuid

The id of the type of work of this task.

assignedRoleIdstring uuid nullable

The id of the assigned role of this task.

parentIdstring uuid nullable

The id of the parent task template if the task template is a subtask.

subtaskOrdernumber double nullable

The order of the subtask template relative to its parent task template.

laneOrderinteger nullable

The lane order defines the vertical position in the planner.

deriveDatesFromSubtasksboolean nullable

When true, if the task is a parent task, the StartOn and DueOn will be automatically adjusted to the start and due date of the subtasks.

idstring uuid

The Id of the task template.

assigneeIdsstring[] nullable

The list of assigned users to that task template.

createdOnstring date-time

The date this task was created.

createdBystring uuid

The id of the user who created this task.

updatedOnstring date-time

The date this task was last modified.

updatedBystring uuid

The id of the user who last modified this task.

ordernumber double nullable

For internal purposes.

hasAttachmentsboolean

If the task template has attachments.

isRecurringboolean

If the task is a recurrency template, the flag is true.

Changes

  • ab257be657b1Revision changes
    • info

      added the optional property to the response with the status

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API