Upload translated XLIFF asynchronously
curl --request POST \
--url https://eu.phrase.com/connectors/document360/v1/async/upload-xliff-file \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Webhook: <x-webhook>' \
--data '
{
"credentials": {
"connectionUid": "7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11",
"organizationUid": "3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10"
},
"path": {
"pathType": "ARTICLE",
"projectId": "8f1c0f7a-1111-4a2b-9c3d-000000000001",
"articleId": "8f1c0f7a-4444-4a2b-9c3d-000000000004"
},
"sourceLocale": "en",
"targetLocale": "de",
"storageId": "e48eda63928c4155bez9fdbsaadc15f3"
}
'import requests
url = "https://eu.phrase.com/connectors/document360/v1/async/upload-xliff-file"
payload = {
"credentials": {
"connectionUid": "7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11",
"organizationUid": "3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10"
},
"path": {
"pathType": "ARTICLE",
"projectId": "8f1c0f7a-1111-4a2b-9c3d-000000000001",
"articleId": "8f1c0f7a-4444-4a2b-9c3d-000000000004"
},
"sourceLocale": "en",
"targetLocale": "de",
"storageId": "e48eda63928c4155bez9fdbsaadc15f3"
}
headers = {
"X-Webhook": "<x-webhook>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Webhook': '<x-webhook>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
credentials: {
connectionUid: '7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11',
organizationUid: '3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10'
},
path: {
pathType: 'ARTICLE',
projectId: '8f1c0f7a-1111-4a2b-9c3d-000000000001',
articleId: '8f1c0f7a-4444-4a2b-9c3d-000000000004'
},
sourceLocale: 'en',
targetLocale: 'de',
storageId: 'e48eda63928c4155bez9fdbsaadc15f3'
})
};
fetch('https://eu.phrase.com/connectors/document360/v1/async/upload-xliff-file', 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/connectors/document360/v1/async/upload-xliff-file",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'credentials' => [
'connectionUid' => '7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11',
'organizationUid' => '3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10'
],
'path' => [
'pathType' => 'ARTICLE',
'projectId' => '8f1c0f7a-1111-4a2b-9c3d-000000000001',
'articleId' => '8f1c0f7a-4444-4a2b-9c3d-000000000004'
],
'sourceLocale' => 'en',
'targetLocale' => 'de',
'storageId' => 'e48eda63928c4155bez9fdbsaadc15f3'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Webhook: <x-webhook>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://eu.phrase.com/connectors/document360/v1/async/upload-xliff-file"
payload := strings.NewReader("{\n \"credentials\": {\n \"connectionUid\": \"7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11\",\n \"organizationUid\": \"3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10\"\n },\n \"path\": {\n \"pathType\": \"ARTICLE\",\n \"projectId\": \"8f1c0f7a-1111-4a2b-9c3d-000000000001\",\n \"articleId\": \"8f1c0f7a-4444-4a2b-9c3d-000000000004\"\n },\n \"sourceLocale\": \"en\",\n \"targetLocale\": \"de\",\n \"storageId\": \"e48eda63928c4155bez9fdbsaadc15f3\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Webhook", "<x-webhook>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://eu.phrase.com/connectors/document360/v1/async/upload-xliff-file")
.header("X-Webhook", "<x-webhook>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"credentials\": {\n \"connectionUid\": \"7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11\",\n \"organizationUid\": \"3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10\"\n },\n \"path\": {\n \"pathType\": \"ARTICLE\",\n \"projectId\": \"8f1c0f7a-1111-4a2b-9c3d-000000000001\",\n \"articleId\": \"8f1c0f7a-4444-4a2b-9c3d-000000000004\"\n },\n \"sourceLocale\": \"en\",\n \"targetLocale\": \"de\",\n \"storageId\": \"e48eda63928c4155bez9fdbsaadc15f3\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu.phrase.com/connectors/document360/v1/async/upload-xliff-file")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Webhook"] = '<x-webhook>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"credentials\": {\n \"connectionUid\": \"7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11\",\n \"organizationUid\": \"3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10\"\n },\n \"path\": {\n \"pathType\": \"ARTICLE\",\n \"projectId\": \"8f1c0f7a-1111-4a2b-9c3d-000000000001\",\n \"articleId\": \"8f1c0f7a-4444-4a2b-9c3d-000000000004\"\n },\n \"sourceLocale\": \"en\",\n \"targetLocale\": \"de\",\n \"storageId\": \"e48eda63928c4155bez9fdbsaadc15f3\"\n}"
response = http.request(request)
puts response.read_body{
"requestId": "e48eda63-928c-4155-bez9-fdbsaadc15f3",
"webHookUrl": "https://example.tld/my-webhook"
}""Document360
Upload translated XLIFF asynchronously
Upload translated XLIFF into one language of a Document360 article. The connector converts
the XLIFF back to the raw article format and writes it to targetLocale, as
upload-raw-file does. path must be an ARTICLE path.
Async variant. Returns immediately with { requestId, webHookUrl }. The upload result is POSTed to the URL supplied in X-Webhook. X-Webhook is required.
POST
/
document360
/
v1
/
async
/
upload-xliff-file
Upload translated XLIFF asynchronously
curl --request POST \
--url https://eu.phrase.com/connectors/document360/v1/async/upload-xliff-file \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Webhook: <x-webhook>' \
--data '
{
"credentials": {
"connectionUid": "7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11",
"organizationUid": "3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10"
},
"path": {
"pathType": "ARTICLE",
"projectId": "8f1c0f7a-1111-4a2b-9c3d-000000000001",
"articleId": "8f1c0f7a-4444-4a2b-9c3d-000000000004"
},
"sourceLocale": "en",
"targetLocale": "de",
"storageId": "e48eda63928c4155bez9fdbsaadc15f3"
}
'import requests
url = "https://eu.phrase.com/connectors/document360/v1/async/upload-xliff-file"
payload = {
"credentials": {
"connectionUid": "7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11",
"organizationUid": "3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10"
},
"path": {
"pathType": "ARTICLE",
"projectId": "8f1c0f7a-1111-4a2b-9c3d-000000000001",
"articleId": "8f1c0f7a-4444-4a2b-9c3d-000000000004"
},
"sourceLocale": "en",
"targetLocale": "de",
"storageId": "e48eda63928c4155bez9fdbsaadc15f3"
}
headers = {
"X-Webhook": "<x-webhook>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Webhook': '<x-webhook>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
credentials: {
connectionUid: '7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11',
organizationUid: '3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10'
},
path: {
pathType: 'ARTICLE',
projectId: '8f1c0f7a-1111-4a2b-9c3d-000000000001',
articleId: '8f1c0f7a-4444-4a2b-9c3d-000000000004'
},
sourceLocale: 'en',
targetLocale: 'de',
storageId: 'e48eda63928c4155bez9fdbsaadc15f3'
})
};
fetch('https://eu.phrase.com/connectors/document360/v1/async/upload-xliff-file', 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/connectors/document360/v1/async/upload-xliff-file",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'credentials' => [
'connectionUid' => '7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11',
'organizationUid' => '3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10'
],
'path' => [
'pathType' => 'ARTICLE',
'projectId' => '8f1c0f7a-1111-4a2b-9c3d-000000000001',
'articleId' => '8f1c0f7a-4444-4a2b-9c3d-000000000004'
],
'sourceLocale' => 'en',
'targetLocale' => 'de',
'storageId' => 'e48eda63928c4155bez9fdbsaadc15f3'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Webhook: <x-webhook>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://eu.phrase.com/connectors/document360/v1/async/upload-xliff-file"
payload := strings.NewReader("{\n \"credentials\": {\n \"connectionUid\": \"7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11\",\n \"organizationUid\": \"3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10\"\n },\n \"path\": {\n \"pathType\": \"ARTICLE\",\n \"projectId\": \"8f1c0f7a-1111-4a2b-9c3d-000000000001\",\n \"articleId\": \"8f1c0f7a-4444-4a2b-9c3d-000000000004\"\n },\n \"sourceLocale\": \"en\",\n \"targetLocale\": \"de\",\n \"storageId\": \"e48eda63928c4155bez9fdbsaadc15f3\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Webhook", "<x-webhook>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://eu.phrase.com/connectors/document360/v1/async/upload-xliff-file")
.header("X-Webhook", "<x-webhook>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"credentials\": {\n \"connectionUid\": \"7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11\",\n \"organizationUid\": \"3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10\"\n },\n \"path\": {\n \"pathType\": \"ARTICLE\",\n \"projectId\": \"8f1c0f7a-1111-4a2b-9c3d-000000000001\",\n \"articleId\": \"8f1c0f7a-4444-4a2b-9c3d-000000000004\"\n },\n \"sourceLocale\": \"en\",\n \"targetLocale\": \"de\",\n \"storageId\": \"e48eda63928c4155bez9fdbsaadc15f3\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu.phrase.com/connectors/document360/v1/async/upload-xliff-file")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Webhook"] = '<x-webhook>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"credentials\": {\n \"connectionUid\": \"7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11\",\n \"organizationUid\": \"3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10\"\n },\n \"path\": {\n \"pathType\": \"ARTICLE\",\n \"projectId\": \"8f1c0f7a-1111-4a2b-9c3d-000000000001\",\n \"articleId\": \"8f1c0f7a-4444-4a2b-9c3d-000000000004\"\n },\n \"sourceLocale\": \"en\",\n \"targetLocale\": \"de\",\n \"storageId\": \"e48eda63928c4155bez9fdbsaadc15f3\"\n}"
response = http.request(request)
puts response.read_body{
"requestId": "e48eda63-928c-4155-bez9-fdbsaadc15f3",
"webHookUrl": "https://example.tld/my-webhook"
}""Authorizations
IDM-issued JWT. Obtain via the IDM authentication flow and pass as: Bearer
Headers
A logging ID of the request. It is propagated through Phrase systems, making it easier to connect logs from various services. If no ActionId is sent with a request, one will be generated by Bifrost and returned with the response.
Required on /async/... endpoints. Bifrost POSTs the operation result to this URL once the connector finishes processing.
Omitting this header on an async endpoint returns 400.
Body
application/json
Request body for uploading a translated XLIFF into one language of a Document360 article. The connector converts the XLIFF to the raw format and then writes it, as in upload-raw-file.
Connection holding the Document360 API key and host.
Show child attributes
Show child attributes
The article the translation is written to (ARTICLE with projectId and articleId).
Show child attributes
Show child attributes
Source locale of the XLIFF (locale code, e.g. en).
Minimum string length:
1Example:
"en"
Language to write into (locale code, e.g. de).
Minimum string length:
1Example:
"de"
Storage ID of the translated XLIFF file (already in Phrase file storage).
Minimum string length:
1Example:
"e48eda63928c4155bez9fdbsaadc15f3"
Document360 settings; may be omitted (connector defaults apply).
Show child attributes
Show child attributes
Example:
{
"includeArchived": false,
"workspaceTypes": ["KNOWLEDGE_BASE"],
"publishAfterUpload": true
}
Response
Successful operation. If X-ResponseType is set to 'ID' or no value is sent in the header, the file is saved and can be retrieved by sending a GET request to this endpoint. If X-ResponseType is set to 'OBJECT', the file is returned as a stream.
Was this page helpful?