Domains

List tasks for a domain

Get a list of tasks belonging to the given domain.

get/v1/domains/{fqn}/tasks

Request

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

Path parameters

fqnstring required

Fully qualified name of the domain

Query parameters

fieldsstring

Fields to include in response

status'Open' | 'InProgress' | 'Pending' | 'Approved' | 'Granted' | 'ManualRevoke' | 'Rejected' | 'Completed' | 'Cancelled' | 'Failed' | 'Revoked' | 'Expired'

Filter by task status

statusGroupstring

Filter by status group: 'open' for Open tasks, 'closed' for Approved/Rejected/Completed/Cancelled/Failed tasks

category'Approval' | 'DataAccess' | 'MetadataUpdate' | 'Incident' | 'Review' | 'Custom'

Filter by task category

type'GlossaryApproval' | 'RequestApproval' | 'DataAccessRequest' | 'DescriptionUpdate' | 'TagUpdate' | 'OwnershipUpdate' | 'TierUpdate' | 'DomainUpdate' | 'Suggestion' | 'TestCaseResolution' | 'IncidentResolution' | 'PipelineReview' | 'DataQualityReview' | 'RecognizerFeedbackApproval' | 'CustomTask'

Filter by task type

priority'Critical' | 'High' | 'Medium' | 'Low'

Filter by priority

assigneestring

Filter by assignee (user or team FQN)

createdBystring

Filter by creator FQN

aboutEntitystring

Filter by entity FQN the task is about

mentionedUserstring

Filter by user FQN who was mentioned in task comments

limitinteger

Limit the number results

beforestring

Returns list of tasks before this cursor

afterstring

Returns list of tasks after this cursor

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

Include deleted tasks

Response

List of tasks in the domain

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.