Interface: ITask
sdkApi/interfaces/entities/iTask.ITask
An interface representing a Task object, extending the IEntity interface.
Interface
ITask
Hierarchy
-
IEntity
↳
ITask
Implemented by
Table of contents
Properties
- assignmentIds
- availableActions
- clientId
- createdAt
- creator
- datasetId
- dueDate
- error
- forReview
- hasParent
- id
- issues
- itemStatus
- metadata
- name
- priority
- progress
- projectId
- query
- recipeId
- spec
- status
- taskOwner
- updatedAt
- updatedBy
Properties
assignmentIds
• assignmentIds: string
[]
The IDs of the assignments associated with the task.
availableActions
• Optional
availableActions: any
[]
Available actions for the task.
clientId
• Optional
clientId: string
A local identifier for the Entity, unique within the client.
Inherited from
createdAt
• createdAt: Date
The date and time when the task was created.
Overrides
creator
• creator: string
The creator of the task.
Overrides
datasetId
• datasetId: string
The ID of the dataset the task belongs to.
dueDate
• dueDate: number
The due date of the task.
error
• Optional
error: any
Task error.
forReview
• forReview: number
The number of items that need to be reviewed.
hasParent
• hasParent: boolean
Whether the task has a parent task.
id
• id: string
The unique identifier of the task.
Overrides
issues
• issues: number
The number of issues associated with the task.
itemStatus
• itemStatus: Object
The status of the items associated with the task.
Type declaration
Name | Type |
---|---|
approved? |
number |
completed? |
number |
remaining |
number |
metadata
• Optional
metadata: any
The task's metadata.
name
• name: string
The name of the task.
priority
• Optional
priority: number
Task priority.
progress
• progress: number
The progress of the task.
projectId
• projectId: string
The ID of the project the task belongs to.
query
• query: string
The query associated with the task.
recipeId
• recipeId: string
The ID of the recipe associated with the task.
spec
• spec: any
The task's spec.
status
• status: string
The status of the task.
taskOwner
• taskOwner: string
The owner of the task.
updatedAt
• updatedAt: Date
The date and time when the task was last updated.
Overrides
updatedBy
• Optional
updatedBy: string
The user who last updated the Entity.