Task POST API Documentation

Purpose

This API is used to create a new task in the Exsited system. Tasks can be created independently like Accounts or Items, or they can be generated under Workflow → State → Milestone → Task. This endpoint allows users to define all task attributes including name, display name, priority, scheduling details, parent task relationships, workflow milestone mapping, assignees, alerts, checklist items, and custom attributes. It supports both simple task creation and complex workflow‑driven task structures, ensuring flexibility for operational and automation needs.

Use Case

This endpoint is used when a new task needs to be created . It supports scenarios such as onboarding workflows, production processes, job scheduling, or custom component automation. When used with workflow milestones, the task becomes part of a structured workflow. When used independently, it acts as a standalone task entity. The API also supports creating checklist items, assigning labours or operators, configuring alerts, and attaching custom attributes, making it suitable for detailed task management and automation.

Path Parameters

No path parameters required for this endpoint.

Query Parameters

No query parameters required for this endpoint.

Request Body

The request body contains the full definition of the task to be created. It includes core fields such as code, name, display name, priority, estimated hours, actual hours, start and end dates, workflow milestone mapping, parent task references, resource associations, checklist items, assignees, alerts, and custom attributes. Checklist items may include their own custom attributes, and alerts may include recipients and trigger configurations.

                JSON
              

                      {
  "task": {
    "code": "TASK_CODE",
    "name": "TASK_NAME",
    "display_name": "TASK_DISPLAY_NAME",
    "description": "TASK_DESCRIPTION",
    "sort_order": "TASK_SORT_ORDER",
    "estimated_hours": "ESTIMATED_HOURS",
    "actual_hours": "ACTUAL_HOURS",
    "start_after": "START_AFTER_TASK_UUID",
    "priority": "TASK_PRIORITY",
    "task_status": "TASK_PROGRESS_STATUS",
    "start_date": "START_DATE",
    "end_date": "END_DATE",
    "note": "TASK_NOTE",
    "workflow_milestone": "WORKFLOW_MILESTONE_UUID",
    "entity": "ENTITY_NAME",
    "resource_id": "RESOURCE_UUID",
    "parent_task": "PARENT_TASK_UUID",
    "checklist": [
      {
        "name": "CHECKLIST_NAME",
        "display_name": "CHECKLIST_DISPLAY_NAME",
        "description": "CHECKLIST_DESCRIPTION",
        "status": "CHECKLIST_STATUS",
        "sort_order": "CHECKLIST_SORT_ORDER",
        "custom_attributes": [
          {
            "name": "CUSTOM_ATTRIBUTE_NAME",
            "value": "CUSTOM_ATTRIBUTE_VALUE"
          }
        ]
      },
      {
        "name": "CHECKLIST_NAME",
        "display_name": "CHECKLIST_DISPLAY_NAME",
        "description": "CHECKLIST_DESCRIPTION",
        "sort_order": "CHECKLIST_SORT_ORDER",
        "custom_attributes": [
          {
            "name": "CUSTOM_ATTRIBUTE_NAME",
            "value": "CUSTOM_ATTRIBUTE_VALUE"
          }
        ]
      }
    ],
    "assignees": [
      {
        "type": "ASSIGNEE_TYPE",
        "labour_code": "LABOUR_CODE"
      }
    ],
    "alerts": [
      {
        "name": "ALERT_NAME",
        "display_name": "ALERT_DISPLAY_NAME",
        "description": "ALERT_DESCRIPTION",
        "time_interval": {
          "trigger": "ALERT_TRIGGER",
          "trigger_value": "ALERT_TRIGGER_VALUE",
          "trigger_unit": "ALERT_TRIGGER_UNIT"
        },
        "notification_option": "NOTIFICATION_OPTION",
        "email_html": "EMAIL_HTML",
        "selected_labours": [
          {
            "labour_code": "LABOUR_CODE"
          }
        ]
      }
    ],
    "custom_attributes": [
      {
        "name": "CUSTOM_ATTRIBUTE_NAME",
        "value": "CUSTOM_ATTRIBUTE_VALUE"
      }
    ]
  }
}

                    

Attribute	Type	Description
code	String	Custom task code. If not provided, system may generate one.
name	String	Internal name of the task.
display_name	String	User‑friendly name.
description	String	Description of the task.
sort_order	Integer	Order of the task under a milestone.
estimated_hours	String	Estimated time (HH:MM:SS).
actual_hours	String	Actual time spent in seconds.
start_after	UUID	Task UUID that this task should start after.
priority	String	LOW, MEDIUM, HIGH, CRITICAL.
task_status	String	IN_PROGRESS, COMPLETED, etc.
start_date	Date	Task start date.
end_date	Date	Task end date.
note	String	Additional notes.
workflow_milestone	UUID	Milestone under which the task will be created.
entity	String	Custom component entity name.
resource_id	UUID	Resource UUID of the custom component.
parent_task	UUID	Parent task UUID.
checklist	Array	List of checklist items.
assignees	Array	List of assigned labours, operators, employees, etc.
alerts	Array	Alerts to be triggered for the task.
custom_attributes	Array	Custom attributes for the task.

Response

On success, the API returns a task object containing all details of the newly created task. The response includes system‑generated fields such as UUID, status, created_on, completed_at, workflow and milestone mapping, and activity logs. Checklist items are returned with their generated UUIDs and updated statuses. Assignees are expanded into detailed objects containing labour or operator metadata. Alerts are returned with their generated UUIDs and recipient details. This response provides a complete representation of the created task, ensuring full traceability and visibility for UI rendering, workflow automation, and auditing.

Response Body

                JSON
              

                      {
  "task": {
    "uuid": "TASK_UUID",
    "code": "TASK_CODE",
    "status": "TASK_STATUS",
    "task_status": "TASK_PROGRESS_STATUS",
    "name": "TASK_NAME",
    "display_name": "TASK_DISPLAY_NAME",
    "description": "TASK_DESCRIPTION",
    "resource": {
      "entity": "RESOURCE_ENTITY",
      "resource_id": "RESOURCE_ID",
      "resource_uuid": "RESOURCE_UUID"
    },
    "priority": "TASK_PRIORITY",
    "parent_task": {
      "uuid": "PARENT_TASK_UUID",
      "code": "PARENT_TASK_CODE",
      "name": "PARENT_TASK_NAME",
      "link": "PARENT_TASK_LINK"
    },
    "sort_order": "TASK_SORT_ORDER",
    "estimated_hours": "ESTIMATED_HOURS",
    "actual_hours": "ACTUAL_HOURS",
    "start_after": {
      "uuid": "START_AFTER_UUID",
      "code": "START_AFTER_CODE",
      "name": "START_AFTER_NAME",
      "link": "START_AFTER_LINK"
    },
    "start_date": "START_DATE",
    "due_date": "DUE_DATE",
    "completed_at": "COMPLETED_AT",
    "completed_by": "COMPLETED_BY",
    "created_on": "CREATED_TIMESTAMP",
    "workflow": {
      "uuid": "WORKFLOW_UUID",
      "name": "WORKFLOW_NAME"
    },
    "milestone": {
      "uuid": "MILESTONE_UUID",
      "name": "MILESTONE_NAME",
      "display_name": "MILESTONE_DISPLAY_NAME"
    },
    "checklist": [
      {
        "uuid": "CHECKLIST_UUID",
        "name": "CHECKLIST_NAME",
        "display_name": "CHECKLIST_DISPLAY_NAME",
        "description": "CHECKLIST_DESCRIPTION",
        "status": "CHECKLIST_STATUS",
        "sort_order": "CHECKLIST_SORT_ORDER",
        "completed_at": "CHECKLIST_COMPLETED_AT",
        "completed_by": "CHECKLIST_COMPLETED_BY",
        "custom_attributes": [
          {
            "name": "CUSTOM_ATTRIBUTE_NAME",
            "value": "CUSTOM_ATTRIBUTE_VALUE"
          }
        ]
      },
      {
        "uuid": "CHECKLIST_UUID",
        "name": "CHECKLIST_NAME",
        "display_name": "CHECKLIST_DISPLAY_NAME",
        "description": "CHECKLIST_DESCRIPTION",
        "status": "CHECKLIST_STATUS",
        "sort_order": "CHECKLIST_SORT_ORDER",
        "completed_at": "CHECKLIST_COMPLETED_AT",
        "completed_by": "CHECKLIST_COMPLETED_BY",
        "custom_attributes": [
          {
            "name": "CUSTOM_ATTRIBUTE_NAME",
            "value": "CUSTOM_ATTRIBUTE_VALUE"
          }
        ]
      }
    ],
    "assignees": {
      "selected_operators": "SELECTED_OPERATORS",
      "selected_account_contacts": "SELECTED_ACCOUNT_CONTACTS",
      "selected_labours": [
        {
          "uuid": "LABOUR_UUID",
          "name": "LABOUR_NAME",
          "display_name": "LABOUR_DISPLAY_NAME",
          "email": "LABOUR_EMAIL",
          "display_order": "LABOUR_DISPLAY_ORDER",
          "labour_code": "LABOUR_CODE",
          "labour_uuid": "LABOUR_UUID",
          "responsibility_uuid": "RESPONSIBILITY_UUID",
          "responsibility_name": "RESPONSIBILITY_NAME",
          "responsibility_display_name": "RESPONSIBILITY_DISPLAY_NAME"
        }
      ],
      "selected_employees": "SELECTED_EMPLOYEES",
      "manually_added_account_contacts": "MANUALLY_ADDED_ACCOUNT_CONTACTS"
    },
    "alerts": [
      {
        "uuid": "ALERT_UUID",
        "name": "ALERT_NAME",
        "display_name": "ALERT_DISPLAY_NAME",
        "description": "ALERT_DESCRIPTION",
        "type": "ALERT_TYPE",
        "trigger_value": "ALERT_TRIGGER_VALUE",
        "trigger_unit": "ALERT_TRIGGER_UNIT",
        "trigger": "ALERT_TRIGGER",
        "trigger_field": "ALERT_TRIGGER_FIELD",
        "alert_content": "ALERT_CONTENT",
        "status": "ALERT_STATUS",
        "recipients": [
          {
            "uuid": "RECIPIENT_UUID",
            "display_order": "RECIPIENT_DISPLAY_ORDER",
            "account_code": "RECIPIENT_ACCOUNT_CODE",
            "user_uuid": "RECIPIENT_USER_UUID",
            "contact_uuid": "RECIPIENT_CONTACT_UUID",
            "labour_code": "RECIPIENT_LABOUR_CODE",
            "labour_uuid": "RECIPIENT_LABOUR_UUID",
            "name": "RECIPIENT_NAME",
            "display_name": "RECIPIENT_DISPLAY_NAME",
            "email": "RECIPIENT_EMAIL",
            "type": "RECIPIENT_TYPE"
          }
        ],
        "responsibilities": "ALERT_RESPONSIBILITIES",
        "actions": "ALERT_ACTIONS"
      }
    ],
    "parent_organization": "PARENT_ORGANIZATION
                    

Attribute	Type	Description
uuid	String	Unique identifier of the task.
code	String	Task code.
status	String	ACTIVE / INACTIVE.
task_status	String	Current task progress status.
name	String	Internal task name.
display_name	String	User‑friendly name.
description	String	Task description.
resource	Object	Contains entity, resource_id, and resource_uuid.
priority	String	Task priority.
parent_task	Object	Parent task details.
sort_order	String	Task order.
estimated_hours	String	Estimated time.
actual_hours	String	Actual time spent.
start_after	Object	Task dependency details.
start_date	DateTime	Start date.
due_date	DateTime	End date.
completed_at	DateTime	Completion timestamp.
completed_by	String	User who completed the task.
created_on	DateTime	Creation timestamp.
workflow	Object	Workflow details.
milestone	Object	Milestone details.
checklist	Array	Checklist items with UUIDs and statuses.
assignees	Object	Assigned operators, labours, employees, etc.
alerts	Array	Alerts with recipients and trigger details.
parent_organization	String	Organization ID.
created_by	String	Creator of the task.
last_updated_by	String	Last user who updated the task.
last_updated_on	DateTime	Last update timestamp.
version	String	Version number.
custom_attributes	Array	Custom attributes.
activity_logs	Array	Activity history for auditing.

Purpose

This API is used to add one or more checklist items to an existing task. Checklist items represent smaller actionable steps required to complete the task, and this endpoint allows users or systems to append new checklist entries to the task’s existing checklist. It supports adding multiple items at once, each with its own name, display name, description, status, sort order, and optional custom attributes. This ensures that tasks can be expanded or updated as workflow requirements evolve.

Use Case

This endpoint is used when additional steps need to be added to a task after its creation. For example, during workflow refinement, new requirements may emerge that require adding more checklist items. It is also used when tasks are dynamically updated based on user input, automation rules, or operational changes. QA teams use this endpoint to validate checklist creation behavior and ensure that newly added items appear correctly in the task’s checklist list.

Path Parameters

Parameter	Type	Description
task_id	String	Unique identifier of the task to which checklist items will be added.

Query Parameters

No query parameters required for this endpoint.

Request Body

The request body contains an array of checklist items to be added to the task. Each checklist item includes its name, display name, description, status, sort order, and optional custom attributes. Multiple checklist items can be added in a single request, and the system will append them to the existing checklist of the task.

                JSON
              

                      {
  "checklist": [
    {
      "name": "CHECKLIST_NAME",
      "display_name": "CHECKLIST_DISPLAY_NAME",
      "description": "CHECKLIST_DESCRIPTION",
      "status": "CHECKLIST_STATUS",
      "sort_order": "CHECKLIST_SORT_ORDER"
    },
    {
      "name": "CHECKLIST_NAME",
      "display_name": "CHECKLIST_DISPLAY_NAME",
      "description": "CHECKLIST_DESCRIPTION"
    }
  ]
}

                    

Attribute	Type	Description
checklist	Array	List of checklist items to add.
.name	String	Internal name of the checklist item.
display_name	String	User‑friendly name.
description	String	Description of the checklist action.
status	String	Status of the item (PENDING, COMPLETED). Default: PENDING.
sort_order	Integer	Order of the item within the checklist.
custom_attributes	Array	Custom attributes for the checklist item.
name	String	Attribute name.
value	String	Attribute value.

Response

On success, the API returns the updated task object, including all existing checklist items plus the newly added ones. Each newly created checklist item is returned with a system‑generated UUID and updated status fields. The response also includes all other task metadata such as name, display name, priority, scheduling details, assignees, alerts, and audit information. This ensures full visibility into the updated task structure and confirms that the checklist items were successfully added.

Response Body

                JSON
              

                      {
  "task": {
    "uuid": "TASK_UUID",
    "code": "TASK_CODE",
    "status": "TASK_STATUS",
    "task_status": "TASK_PROGRESS_STATUS",
    "name": "TASK_NAME",
    "display_name": "TASK_DISPLAY_NAME",
    "description": "TASK_DESCRIPTION",
    "priority": "TASK_PRIORITY",
    "sort_order": "TASK_SORT_ORDER",
    "estimated_hours": "ESTIMATED_HOURS",
    "actual_hours": "ACTUAL_HOURS",
    "start_date": "START_DATE",
    "due_date": "DUE_DATE",
    "completed_at": "COMPLETED_AT",
    "completed_by": "COMPLETED_BY",
    "created_on": "CREATED_TIMESTAMP",

    "checklist": [
      {
        "uuid": "CHECKLIST_UUID",
        "name": "CHECKLIST_NAME",
        "display_name": "CHECKLIST_DISPLAY_NAME",
        "description": "CHECKLIST_DESCRIPTION",
        "status": "CHECKLIST_STATUS",
        "sort_order": "CHECKLIST_SORT_ORDER",
        "completed_at": "CHECKLIST_COMPLETED_AT",
        "completed_by": "CHECKLIST_COMPLETED_BY"
      },
      {
        "uuid": "CHECKLIST_UUID",
        "name": "CHECKLIST_NAME",
        "display_name": "CHECKLIST_DISPLAY_NAME",
        "description": "CHECKLIST_DESCRIPTION",
        "status": "CHECKLIST_STATUS",
        "sort_order": "CHECKLIST_SORT_ORDER",
        "completed_at": "CHECKLIST_COMPLETED_AT",
        "completed_by": "CHECKLIST_COMPLETED_BY"
      },
      {
        "uuid": "CHECKLIST_UUID",
        "name": "CHECKLIST_NAME",
        "display_name": "CHECKLIST_DISPLAY_NAME",
        "description": "CHECKLIST_DESCRIPTION",
        "status": "CHECKLIST_STATUS",
        "sort_order": "CHECKLIST_SORT_ORDER",
        "completed_at": "CHECKLIST_COMPLETED_AT",
        "completed_by": "CHECKLIST_COMPLETED_BY"
      },
      {
        "uuid": "CHECKLIST_UUID",
        "name": "CHECKLIST_NAME",
        "display_name": "CHECKLIST_DISPLAY_NAME",
        "description": "CHECKLIST_DESCRIPTION",
        "status": "CHECKLIST_STATUS",
        "sort_order": "CHECKLIST_SORT_ORDER",
        "completed_at": "CHECKLIST_COMPLETED_AT",
        "completed_by": "CHECKLIST_COMPLETED_BY"
      },
      {
        "uuid": "CHECKLIST_UUID",
        "name": "CHECKLIST_NAME",
        "display_name": "CHECKLIST_DISPLAY_NAME",
        "description": "CHECKLIST_DESCRIPTION",
        "status": "CHECKLIST_STATUS",
        "sort_order": "CHECKLIST_SORT_ORDER",

                    

Attribute	Type	Description
uuid	String	Unique identifier of the task.
code	String	Task code.
status	String	ACTIVE / INACTIVE.
task_status	String	Current task progress status.
name	String	Task name.
display_name	String	User‑friendly name.
description	String	Task description.
priority	String	Task priority.
sort_order	String	Task order.
estimated_hours	String	Estimated time.
actual_hours	String	Actual time spent.
start_date	DateTime	Start date.
due_date	DateTime	End date.
checklist	Array	Updated list of checklist items.
checklist[].uuid	String	Unique identifier of the checklist item.
checklist[].name	String	Checklist item name.
checklist[].display_name	String	Display name.
checklist[].description	String	Description.
checklist[].status	String	Status (PENDING, COMPLETED).
checklist[].sort_order	String	Order of the item.
checklist[].completed_at	DateTime	Completion timestamp.
checklist[].completed_by	String	User who completed the item.
assignees	Object	Assigned operators, labours, employees, etc.
alerts	Array	Alerts configured for the task.
parent_organization	String	Organization ID.
created_by	String	Creator of the task.
last_updated_by	String	Last user who updated the task.
last_updated_on	DateTime	Last update timestamp.
version	String	Version number.

Create a Task: /tasks

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Add Checklist Items to a Task : /tasks/{task_id}/checklist

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Looking to build your next big project?