Skip to main content
GET
Get a single task of a revision

Authorizations

Authorization
string
header
required

A Phrase Platform JWT issued for Orchestrator, sent as Authorization: Bearer <JWT>. See Authentication and access for how to obtain one.

Path Parameters

workflow_id
integer
required

ID of the workflow the revision belongs to.

Example:

123

revision_id
integer
required

ID of the revision the task belongs to.

Example:

789

id
string<uuid>
required

ID of the task.

Example:

"8fa72263-21ab-4f76-83ba-50c6b4378c49"

Response

OK

A task configured within a revision, including its full configuration.

id
string<uuid>
required

Unique identifier of the task.

Example:

"8fa72263-21ab-4f76-83ba-50c6b4378c49"

name
string
required

Name of the task.

Example:

"Create job"

source
TaskSource · object
required

The catalog action a task is bound to.

Example:
validation_status
enum<string>
required

Result of validating the task's configuration against its action's input schema: new (created, not validated yet), valid, invalid (its configuration doesn't match the action's input schema) or needs_check (it has inputs the action doesn't accept, usually after the action was updated). A revision can be published once every task is valid or needs_check.

Available options:
new,
valid,
invalid,
needs_check
Example:

"valid"

conditions
Conditions · object

Conditions controlling whether the action runs; omit when the action has none.

continue_on_status
enum<string>

Which outcome of this task lets the tasks that depend on it run: succeeded (only when it succeeds, its execution state completed) or succeeded_skipped (when it succeeds or is skipped).

Available options:
succeeded,
succeeded_skipped
Example:

"succeeded"

description
string | null

Description of the task, taken from its action, or null if the action has none.

Example:

"Creates a job in the TMS project."

event_trigger
EventTrigger · object

Configuration of an orchestrator orchestrator/event_trigger ("Wait for trigger") action, which pauses the workflow until the event selected in its input_parameters.event arrives. Not allowed on other actions.

input_parameters
object

Inputs passed to the action, keyed by its parameter names, following the action's input_json_schema.

loop
Loop · object

Loop configuration controlling how the action iterates. The action runs once per item; its input_parameters and conditions reference the current item with {{ @item }} or {{ @item.field.path }}. To use the iterations' outputs downstream, add an orchestrator collect_loop_outputs/call action that depends on the looped action, with input_parameters {"source": {"source": "<looped action slug>", "type": "task", "value": "{{ @raw }}"}}. Its output is a JSON array of the iterations' outputs, referenced like any other action's output.

note
string | null

Free-text note about the task, or null if it has none.

Example:

"Creates the job for the incoming project."

retry_strategy
RetryStrategy · object

Retry strategy configuration.