Task interface

Package:

@azure/ai-discovery

Task resource.

Properties

assignedTo	Application or user assigned to this task.
comments	Comments or notes about the task.
createdAt	The timestamp when the resource was created
createdBy	The ID of the user who created this resource.
createdByType	Type of entity that created the resource (User, Application, System, or custom type).
dependsOn	IDs of tasks that must complete before this task can be executed.
description	The description of the task.
executionHistory	History of execution events for this task.
investigationId	The investigation identifier associated with the task.
lastModifiedAt	The timestamp when the resource was last updated
lastModifiedBy	The ID of the user who updated this resource.
lastModifiedByType	The type of user who updated this resource.
name	The unique identifier of the task.
parentId	ID of the parent task if this is a subtask.
priority	The priority of the task.
relatedTo	IDs of tasks that are related to this task.
status	The current status of the task.
storageAssetIds	List of storage assets related to the task.
taskResult	Task execution result with text and storage assets.
title	The title of the task.
validationRequirements	Array of validation requirements for the task.

Property Details

assignedTo

Application or user assigned to this task.

assignedTo?: TaskAssignee

Property Value

TaskAssignee

comments

Comments or notes about the task.

comments?: TaskComment[]

Property Value

TaskComment[]

createdAt

The timestamp when the resource was created

createdAt?: Date

Property Value

Date

createdBy

The ID of the user who created this resource.

createdBy?: string

Property Value

string

createdByType

Type of entity that created the resource (User, Application, System, or custom type).

createdByType?: string

Property Value

string

dependsOn

IDs of tasks that must complete before this task can be executed.

dependsOn?: string[]

Property Value

string[]

description

The description of the task.

description?: string

Property Value

string

executionHistory

History of execution events for this task.

executionHistory?: ExecutionHistoryEntry[]

Property Value

ExecutionHistoryEntry[]

investigationId

The investigation identifier associated with the task.

investigationId?: string

Property Value

string

lastModifiedAt

The timestamp when the resource was last updated

lastModifiedAt?: Date

Property Value

Date

lastModifiedBy

The ID of the user who updated this resource.

lastModifiedBy?: string

Property Value

string

lastModifiedByType

The type of user who updated this resource.

lastModifiedByType?: string

Property Value

string

name

The unique identifier of the task.

name: string

Property Value

string

parentId

ID of the parent task if this is a subtask.

parentId?: string

Property Value

string

priority

The priority of the task.

priority?: string

Property Value

string

relatedTo

IDs of tasks that are related to this task.

relatedTo?: string[]

Property Value

string[]

status

The current status of the task.

status?: string

Property Value

string

storageAssetIds

List of storage assets related to the task.

storageAssetIds?: string[]

Property Value

string[]

taskResult

Task execution result with text and storage assets.

taskResult?: TaskResult

Property Value

TaskResult

title

The title of the task.

title?: string

Property Value

string

validationRequirements

Array of validation requirements for the task.

validationRequirements?: string[]

Property Value

string[]