curl --request GET \
--url https://eu.phrase.com/orchestrator/api/v1/actions/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://eu.phrase.com/orchestrator/api/v1/actions/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.phrase.com/orchestrator/api/v1/actions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://eu.phrase.com/orchestrator/api/v1/actions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://eu.phrase.com/orchestrator/api/v1/actions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://eu.phrase.com/orchestrator/api/v1/actions/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu.phrase.com/orchestrator/api/v1/actions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"description": "Makes an HTTP request to the given URL.",
"id": 42,
"input_json_schema": {
"additionalProperties": false,
"properties": {
"method": {
"additionalProperties": false,
"format": "linkedField",
"properties": {
"source": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"enum": [
"",
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"title": "method",
"type": "string"
}
},
"type": "object"
},
"url": {
"additionalProperties": false,
"format": "linkedField",
"properties": {
"source": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"description": "The request URL",
"title": "url",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"required": [
"url"
],
"type": "object"
},
"name": "Send HTTP Request",
"operation_id": "http_request",
"output_json_schema": {
"properties": {
"body": {
"description": "Response body",
"type": "string"
},
"status": {
"description": "HTTP response status code",
"type": "integer"
}
},
"type": "object"
},
"provider": "orchestrator"
}{
"code": "unauthorized",
"detail": "The request has no valid Phrase Platform JWT issued for Orchestrator. Send one as `Authorization: Bearer <JWT>`.",
"status": 401,
"title": "Unauthorized",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#unauthorized"
}{
"code": "forbidden",
"detail": "The authenticated user isn't allowed to perform this action on the resource.",
"status": 403,
"title": "Forbidden",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#forbidden"
}{
"code": "not_found",
"detail": "The resource doesn't exist, or the authenticated user can't access it.",
"status": 404,
"title": "Not Found",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#not_found"
}{
"code": "unprocessable_content",
"detail": "A parameter doesn't match its schema, or the change isn't allowed in the resource's current state. Each entry in `errors` describes one cause.",
"errors": [
{
"detail": "Has already been taken in this folder.",
"pointer": "/name"
}
],
"status": 422,
"title": "Unprocessable Content",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#unprocessable_content"
}{
"code": "rate_limited",
"detail": "This user's limit of 1000 requests per 300 seconds is used up. Retry in 42 seconds.",
"status": 429,
"title": "Too Many Requests",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#rate_limited"
}{
"code": "internal_server_error",
"detail": "Orchestrator failed unexpectedly. A write may or may not have been applied, so check the resource before retrying it.",
"status": 500,
"title": "Internal Server Error",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#internal_server_error"
}Get a single action
Returns detailed information about a single action. Fields whose options come from the authenticated user’s integrations are resolved for that user. For example, for the Slack slack/send_message action, data.channel lists the IDs of the public Slack channels the Orchestrator app is a member of in enum, with the channel names in options.enum_titles; send one of these IDs as the value. Invite the Orchestrator app to a channel to add it to this list. The hidden access_token can be left out of a workflow definition: it is filled from the user’s Slack integration. These fields cannot be resolved until the user connects the integration in Orchestrator.
curl --request GET \
--url https://eu.phrase.com/orchestrator/api/v1/actions/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://eu.phrase.com/orchestrator/api/v1/actions/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.phrase.com/orchestrator/api/v1/actions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://eu.phrase.com/orchestrator/api/v1/actions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://eu.phrase.com/orchestrator/api/v1/actions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://eu.phrase.com/orchestrator/api/v1/actions/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu.phrase.com/orchestrator/api/v1/actions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"description": "Makes an HTTP request to the given URL.",
"id": 42,
"input_json_schema": {
"additionalProperties": false,
"properties": {
"method": {
"additionalProperties": false,
"format": "linkedField",
"properties": {
"source": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"enum": [
"",
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"title": "method",
"type": "string"
}
},
"type": "object"
},
"url": {
"additionalProperties": false,
"format": "linkedField",
"properties": {
"source": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"description": "The request URL",
"title": "url",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"required": [
"url"
],
"type": "object"
},
"name": "Send HTTP Request",
"operation_id": "http_request",
"output_json_schema": {
"properties": {
"body": {
"description": "Response body",
"type": "string"
},
"status": {
"description": "HTTP response status code",
"type": "integer"
}
},
"type": "object"
},
"provider": "orchestrator"
}{
"code": "unauthorized",
"detail": "The request has no valid Phrase Platform JWT issued for Orchestrator. Send one as `Authorization: Bearer <JWT>`.",
"status": 401,
"title": "Unauthorized",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#unauthorized"
}{
"code": "forbidden",
"detail": "The authenticated user isn't allowed to perform this action on the resource.",
"status": 403,
"title": "Forbidden",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#forbidden"
}{
"code": "not_found",
"detail": "The resource doesn't exist, or the authenticated user can't access it.",
"status": 404,
"title": "Not Found",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#not_found"
}{
"code": "unprocessable_content",
"detail": "A parameter doesn't match its schema, or the change isn't allowed in the resource's current state. Each entry in `errors` describes one cause.",
"errors": [
{
"detail": "Has already been taken in this folder.",
"pointer": "/name"
}
],
"status": 422,
"title": "Unprocessable Content",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#unprocessable_content"
}{
"code": "rate_limited",
"detail": "This user's limit of 1000 requests per 300 seconds is used up. Retry in 42 seconds.",
"status": 429,
"title": "Too Many Requests",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#rate_limited"
}{
"code": "internal_server_error",
"detail": "Orchestrator failed unexpectedly. A write may or may not have been applied, so check the resource before retrying it.",
"status": 500,
"title": "Internal Server Error",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#internal_server_error"
}Authorizations
A Phrase Platform JWT issued for Orchestrator, sent as Authorization: Bearer <JWT>. See Authentication and access for how to obtain one.
Response
OK
Detailed information about a single action, including the JSON Schema of its inputs and outputs.
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.
strings, tms, orchestrator, eureka, slack, bifrost, custom, welocalize, vistatec "orchestrator"
JSON Schema for the action's input parameters. Each parameter can be an object with value, source and type keys:
valueis a literal or a JSONPath interpolation (for example,{{ $.field }});sourceandtypeare empty for a literal, or identify the referenced step for an interpolation (the action'sslugwithtask, ortrigger).
Was this page helpful?