Base URL: https://{tenant-domain}/api/v2/tasks Parameters: - notable_type (path parameter): The type of entity (e.g., `client` `application=>application_stage`) - notable_id (path parameter): The ID of the entity |
Endpoint:/
Method: GET
Description: Retrieves all tasks
Response:
{ "data": [], “link”:{}, “meta”:{} } |
HTTP Status Codes:
- 200 OK: Success
- 401 Unauthorized: Invalid or missing authentication
- 403 Forbidden: Insufficient permissions
- 404 Not Found: Entity not found
Endpoint:/{task_id}
Method: GET
Description: Retrieves individual tasks
Response:
{ "data": [], “meta”:{} } |
HTTP Status Codes:
- 200 OK: Success
- 401 Unauthorized: Invalid or missing authentication
- 403 Forbidden: Insufficient permissions
- 404 Not Found: Entity not found
Endpoint:/
Method: POST
Description: Uploads documents for a specific entity type and ID
Payload:
{ "assignee_id": “”, “subject”:””. “category”:””, “application_stage_id”:”” } |
Response:
{ "uploadedFiles": [], "rejectedFiles": [ { "original_name": “", "path":””, "type": "pdf", "description": "", "file_size": , "namespace": "”, "givenName": "" } ] } |
HTTP Status Codes:
- 200 OK: Success
- 400 Bad Request: Validation error
- 401 Unauthorized: Invalid or missing authentication
- 403 Forbidden: Insufficient permissions
- 404 Not Found: Entity not found
Endpoint:/{task_id}/archive
Method: PUT
Description: archive documents for a specific entity type and ID
[] |
{ "data": {}, "assignee":{}, “reporter”:{}, “created_at”:{}, “updated_at”:{}. “reminder”:{} } |
- 200 OK: Success
- 400 Bad Request: Validation error
- 401 Unauthorized: Invalid or missing authentication
- 403 Forbidden: Insufficient permissions
- 404 Not Found: Entity not found
Endpoint:/{task_id}/archive
Method: PUT
Description: Update task
{ “{field_to_update}”:””, //here field_to_update is the filed to be updated (options are: status, priority,due_date(yy-mm-dd),due_time(hh:mm AM/PM),assignee_id,description,follower_ids([]),attachments(form type field) “_method”:”PUT” |
Response:
{ "data": {}, "assignee":{}, “reporter”:{}, “created_at”:{}, “updated_at”:{}. “reminder”:{} } |
HTTP Status Codes:
- 200 OK: Success
- 400 Bad Request: Validation error
- 401 Unauthorized: Invalid or missing authentication
- 403 Forbidden: Insufficient permissions
- 404 Not Found: Entity not found
Endpoint:/{task_id}/archive
Method: POST
Description: update comment of specific task
{ “message”:”” } |
[] |
- 200 OK: Success
- 400 Bad Request: Validation error
- 401 Unauthorized: Invalid or missing authentication
- 403 Forbidden: Insufficient permissions
- 404 Not Found: Entity not found
Endpoint:/{task_id}/archive
Method: DELETE
Description:Delete attachments from task
{ “ids”:[], “_method”:”delete” } |
[] |
- 200 OK: Success
- 400 Bad Request: Validation error
- 401 Unauthorized: Invalid or missing authentication
- 403 Forbidden: Insufficient permissions
- 404 Not Found: Entity not found
Endpoint:/{task_id}/reminder
Method: POST
Description:Add reminder
{ “channel”:””, //email/notification,both “duration”:”” //numeric value, "duration_type": "minutes", //minutes/hour/days “_method": "POST" } |
[] |
- 200 OK: Success
- 400 Bad Request: Validation error
- 401 Unauthorized: Invalid or missing authentication
- 403 Forbidden: Insufficient permissions
- 404 Not Found: Entity not found
Endpoint:/{task_id}/reminder
Method: PUT
Description:Edit reminder
{ "id": "", "task_id": , "channel": "", "duration": , "duration_type": “", "_method": "PUT" }
|
{ “data”:{} |
- 200 OK: Success
- 400 Bad Request: Validation error
- 401 Unauthorized: Invalid or missing authentication
- 403 Forbidden: Insufficient permissions
- 404 Not Found: Entity not found
