Skip to main content
POST
Convert an XLIFF file from the connector to a raw file used by Contentful synchronously

Authorizations

Authorization
string
header
required

IDM-issued JWT. Obtain via the IDM authentication flow and pass as: Bearer

Headers

X-ActionId
string
default:""

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.

X-ResponseType
enum<string>
default:ID

Specify if the response should contain the processed object itself in an application/octet-stream body, or a application/json body with an ID that can be then used to retrieve the object using a /load-content endpoint. Note that for larger files (> 1 MB), it is advised to use the ID option which is also default.

Available options:
ID,
OBJECT

Body

application/json

Request body for converting a stored XLIFF back into Contentful's raw entry format without writing it to Contentful. The result lands in Phrase file storage as a new storageId you can then push with upload-raw-file.

storageId
string
default:""
required

Storage ID of the translated XLIFF file to convert.

Minimum string length: 1
Example:

"e48eda63928c4155bez9fdbsaadc15f3"

sourceLocale
string
default:""
required

Source locale embedded in the XLIFF (Contentful locale code).

Minimum string length: 1
Example:

"en-US"

targetLocale
string
default:""
required

Target locale the XLIFF was translated into.

Minimum string length: 1
Example:

"de-DE"

{key}
any

Response

OK — raw binary stream (returned when X-ResponseType=OBJECT).

The response is of type file.