Tasks

Get a task by task ID

Get a task by human-readable task ID (e.g., TASK-00001).

get/v1/tasks/name/{taskId}

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/tasks/name/{taskId}
  • Auth: HTTP bearer

Path parameters

taskIdstring required

Task ID (e.g., TASK-00001)

Query parameters

fieldsstring

Fields to include in response

include'all' | 'deleted' | 'non-deleted'

Include deleted task

Response

The task

idstring uuid required
taskIdstring
namestring required
displayNamestring
fullyQualifiedNamestring
descriptionstring
category'Approval' | 'DataAccess' | 'MetadataUpdate' | 'Incident' | 'Review' | 'Custom' required
type'GlossaryApproval' | 'RequestApproval' | 'DataAccessRequest' | 'DescriptionUpdate' | 'TagUpdate' | 'OwnershipUpdate' | 'TierUpdate' | 'DomainUpdate' | 'Suggestion' | 'TestCaseResolution' | 'IncidentResolution' | 'PipelineReview' | 'DataQualityReview' | 'RecognizerFeedbackApproval' | 'CustomTask' required
status'Open' | 'InProgress' | 'Pending' | 'Approved' | 'Granted' | 'ManualRevoke' | 'Rejected' | 'Completed' | 'Cancelled' | 'Failed' | 'Revoked' | 'Expired' required
priority'Critical' | 'High' | 'Medium' | 'Low'
aboutFqnHashstring
createdByIdstring
approvedByIdstring
approvedAtinteger
payloadobject
dueDateinteger
workflowInstanceIdstring uuid
workflowDefinitionIdstring uuid
workflowStageIdstring
workflowStageDisplayNamestring
taskFormSchemaIdstring uuid
taskFormSchemaVersionnumber double
commentCountinteger
createdAtinteger
versionnumber double
updatedAtinteger
updatedBystring
hrefstring uri
deletedboolean
extensionobject
provider'system' | 'user' | 'automation'
impersonatedBystring
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
sourceHashstring

Changes

No recorded changes to this operation across all 1 revision of this API.