OBJECT

Task

Represents a single engine task

link GraphQL Schema definition

1type Task {
2
3# The task ID
4id: ID!
5
6name: String
7
8description: String
9
10# Date and time the task was created
11createdDateTime: DateTime
12
13# Date and time the task was last modified
14modifiedDateTime: DateTime
15
16createdBy: String
17
18modifiedBy: String
19
20# Date and time the task was queued for execution.
21queuedDateTime: DateTime
22
23# Date and time the task completed.
24completedDateTime: DateTime
25
26# Date and time task execution started
27startedDateTime: DateTime
28
29# The task status. See TaskStatus enum for details.
30status: TaskStatus
31
32# Optional order in which the task should run, relative to other tasks
33# in the job that contains it.
34order: Int
35
36# Whether or not the task is run on the clone of a TDO
37isClone: Boolean
38
39# Application ID that owns the task
40applicationId: String
41
42# The ID of the TemporalDataObject the task
43# was created for.
44targetId: ID
45
46# The TemporalDataObject the task was created for.
47target: TemporalDataObject
48
49# ID of the engine for the task.
50engineId: ID
51
52# The engine for the task
53engine: Engine
54
55# The ID of the job that contains this task
56jobId: ID
57
58# The job that contains this task.
59job: Job
60
61# ID of the engine build used for this task.
62buildId: ID
63
64# The engine build used for this task
65build: Build
66
67# The source asset for this task, if there is one.
68sourceAsset: Asset
69
70# The ID of the source asset for this task, if there is one.
71sourceAssetId: ID
72
73mediaLengthSec: Int
74
75mediaStorageBytes: Int
76
77mediaFileName: String
78
79# The incoming task payload, in JSON format
80payload: JSONData
81
82# The task output, in JSON format.
83output: JSONData
84
85# The incoming task payload, in String format.
86payloadString: String
87
88# The task output, in String format.
89outputString: String
90
91# The log file produced during task execution
92log: TaskLog
93
94# For backwards compatibility only
95taskPayload: JSONData
96
97# For backwards compatibility only
98taskOutput: JSONData
99
100# True if this task was created as a test task
101testTask: Boolean
102
103parentTaskId: ID
104
105parentTask: Task
106
107childTaskIds: [ID!]
108
109childTasks: [Task!]
110
111warnings: [TaskWarning]
112
113# A standby task that will execute if this one fails.
114standbyTask: Task
115
116# The task that this task is a standby for. If the task
117# identified in this field fails, the current task will execute.
118standbyForTask: Task
119
120# Contains metadata used by the platform run-time system to execute
121# the task. This field is accessible only to platform components.
122runtimePayload: JSONData
123
124# Failure reason code. This will be set only if the task final status
125# was `failed`.
126failureReason: TaskFailureReason
127
128# Failure message from the engine. This will be set only if the task final
129# status was `failed` and `failureReason` is set.
130failureMessage: String
131
132# Execution preferences for the current task
133executionPreferences: ExecutionPreferences
134
135ioFolders: [IoFolder]
136
137# This contains a list of URIs engine toolkit will send completed chunks.
138notificationUris: [String]
139
140}