Tasks

Apply a suggestion task

Apply a suggestion task to its target entity. This approves the suggestion and applies the suggested change to the entity. Only works for tasks with type=Suggestion and SuggestionPayload.

put/v1/tasks/{id}/suggestion/apply

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/tasks/{id}/suggestion/apply
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Task Id

Query parameters

commentstring

Comment for the approval

Response

The applied suggestion 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.