Skip to main content
GET
Get a single action

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

id
integer
required

ID of the action.

Example:

42

Response

OK

Detailed information about a single action, including the JSON Schema of its inputs and outputs.

description
string
required

What the action does.

Example:

"Makes an HTTP request to the given URL."

id
integer
required

Unique identifier of the action.

Example:

42

name
string
required

Human-readable name of the action.

Example:

"Send HTTP Request"

operation_id
string
required

Operation identifier used with provider to reference this action.

Example:

"http_request"

provider
enum<string>
required

Product that provides the action: strings (Phrase Strings), tms (Phrase TMS, the translation management system), orchestrator (Orchestrator's built-in actions), eureka (Phrase TMS quality evaluation), slack (Slack), bifrost (Phrase Connector API), welocalize (Welocalize), vistatec (Vistatec) or custom.

Available options:
strings,
tms,
orchestrator,
eureka,
slack,
bifrost,
custom,
welocalize,
vistatec
Example:

"orchestrator"

input_json_schema
object
required

JSON Schema for the action's input parameters. Each parameter can be an object with value, source and type keys:

  • value is a literal or a JSONPath interpolation (for example, {{ $.field }});
  • source and type are empty for a literal, or identify the referenced step for an interpolation (the action's slug with task, or trigger).
output_json_schema
object
required

JSON Schema for the data the action produces. Downstream steps reference these field paths via JSONPath interpolation, using this action's slug as source and task as type.