openapi: 3.0.1
info:
contact:
email: support@transifex.com
name: Transifex Support
description: "
\n
\n\n# Introduction\n\nThis API is based on **{json:api}**.\n\n{json:api} is a specification that follows shared conventions and standards. This specification enables API discoverability and partial\nself-descriptiveness through conventions. The Json Api specification exposes resources and their relationships representations with\nunique uris and all CRUD operations are performed on those endpoints. With it's simplified approach it assists the API uniformity.\n\nRead more: https://jsonapi.org/\n\nAdditionally, this API is defined using OpenAPI (ex Swagger). This means that you can easily:\n* Generate clients in your preferred: https://swagger.io/tools/swagger-codegen/\n* Download the specification file (see above) and use it in clients like Postman etc\n\n
\n
\n\n# Pagination\n\nAll list endpoints include pagination to guarantee performant responses. Those endpoints will return `next` and `previous` links in the\nresponse payload (`links` section). The client does not have to construct any pagination specific URLs or headers, just follow those\nlinks.\n\nPage size is fixed to 150 items per page.\n\n
\n
\n\n# Content Negotiation\n\nThe basic media type for the API is `application/vnd.api+json`. If you want to execute a request that includes data (`POST`, `PATCH`, `DELETE`)\nyou should include this media type in the `Content-Type` header. The only case where a different `Content-Type` header will be accepted is for\nendpoints that can accept file like objects where the media type used should be `multipart/form-data`.\n\nThe base media type this API responds is `application/vnd.api+json`. To retrieve the data in this media type you should include it in the `Accept`\nheader. The only case where the server will return another media type is for endpoint that return file like objects.\nIn this case the media type used should be `*/*` and the server will prioritize the negotiation to the media type dictated from the file.\nNote that `application/vnd.api+json` will be also available for accept header in these cases and will return a JSON serialized representation of the file.\n\nRead more here: https://jsonapi.org/format/#content-negotiation\n\n# File Uploads\n\nThere are three different methods for uploading file content to Transifex:\n* Using Content-Type `application/vnd.api+json` the content must\n be JSON serializable.\n - For content that is directly JSON serializable you can dump the content\n of the file directly and set the `content_encoding` attribute to `text`.\n - For any content, even if it's not JSON serializable (eg .xlsx, .idml or .docx file extensions),\n you can encode the file using the `base64` encoding and set the `content_encoding` attribute to `base64`.\n* Using Content-Type `multipart/form-data` the content can be any raw file, and can\n be send without further processing.\n\n# Asynchronous Processing\n\nAsynchronous operations are triggered via a POST request. The response status in such cases is 202 Accepted, with a link in the Content-Location header.\nTo check the status of the operation, a client can send a request to the location given earlier.\nAn optional `callback_url` can be provided when the asynchronous operation is triggered. If such url is provided, upon completion\na HTTP POST request is executed containing all information required to identify the specific operation:\n\nExample request:\n```\nPOST callback_url HTTP/1.1\nContent-Type: application/json\n\n{\n \"data\": {\n \"type\": resource_strings_async_downloads\",\n \"id\": \"xxxxxxxxx\",\n \"attributes\": {\n \"location\": \"https://rest.api.transifex.com/resource_strings_async_downloads/xxxxxxxxx\",\n \"status\": \"succeeded\"\n }\n }\n}\n```\n\n# Restrictions\n\nThe following Plan based restrictions apply:\n* [Activity Reports](#tag/Activity-Reports) are available to Premium and up\n* [XLIFF export](#tag/Resource-Translations/paths/~1resource_translations_async_downloads/post) is available to Premium and up.\n* [Screenshots](#tag/Context-Screenshots) are available to Premium and up\n\n# Rate Limit\n\nTo maintain optimal performance and availability of the API, we limit the request rate to 500\nrequests/min or 30,000 requests / 5 minutes / IP. Polling endpoints like\n`resource_translations_async_downloads/{resource_translations_async_download_id}` and\n`resource_strings_async_downloads/{resource_strings_async_download_id}` have a rate limit of 1,200 requests/min.\nOnce past the respective limit, requests will be throttled and you will get a 429 Throttled response.\n\n\nExample response:\n```\n{\n \"errors\": [\n {\n \"code\": \"Throttled\",\n \"detail\": \"Request was throttled. Expected available in 60 seconds.\",\n \"status\": \"429\",\n \"title\": \"Throttled\"\n }\n ]\n}\n```\n\n# Authentication\n\n"
title: Transifex Activity Reports Resource Translations API
version: '3.0'
x-logo:
altText: Transifex logo
backgroundColor: '#FFFFFF'
url: transifex-blue-logo.svg
servers:
- url: https://rest.api.transifex.com
security:
- bearerAuth: []
tags:
- name: Resource Translations
paths:
/resource_translations:
summary: Get a Resource Translations collection
get:
parameters:
- description: Filter results by a resource
in: query
name: filter[resource]
required: true
schema:
description: Resource identifier.
example: o:organization_slug:p:project_slug:r:resource_slug
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$
type: string
- description: Filter results by a language
in: query
name: filter[language]
required: true
schema:
description: Language identifier.
example: l:en_US
pattern: ^l:[a-zA-Z0-9@_.-]+$
type: string
- description: 'The cursor used for pagination. The value of the cursor must be retrieved from pagination links included in previous responses; you should not attempt to write them on your own.
'
in: query
name: page[cursor]
schema:
type: string
- in: query
name: filter[date_translated][gt]
required: false
schema:
oneOf:
- example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
- description: Date, will be treated as UTC by the API
example: XXXX-XX-XX
format: date
type: string
- in: query
name: filter[date_translated][lt]
required: false
schema:
oneOf:
- example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
- description: Date, will be treated as UTC by the API
example: XXXX-XX-XX
format: date
type: string
- in: query
name: filter[resource_string][key]
required: false
schema:
example: hello_world
minLength: 1
type: string
- in: query
name: filter[resource_string][date_modified][gte]
required: false
schema:
oneOf:
- example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
- description: Date, will be treated as UTC by the API
example: XXXX-XX-XX
format: date
type: string
- in: query
name: filter[resource_string][date_modified][lte]
required: false
schema:
oneOf:
- example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
- description: Date, will be treated as UTC by the API
example: XXXX-XX-XX
format: date
type: string
- in: query
name: filter[translated]
required: false
schema:
example: true
type: boolean
- in: query
name: filter[reviewed]
required: false
schema:
example: true
type: boolean
- in: query
name: filter[proofread]
required: false
schema:
example: false
type: boolean
- in: query
name: filter[finalized]
required: false
schema:
example: false
type: boolean
- in: query
name: filter[translator]
required: false
schema:
example: u:username
minLength: 1
type: string
- in: query
name: filter[origin]
required: false
schema:
enum:
- API
- EDITOR
- UPLOAD
- TM
- VENDORS:GENGO
- VENDORS:TEXTMASTER
- VENDORS:E2F
- MT:GOOGLE
- MT:MICROSOFT
- MT:AMAZON
- MT:DEEPL
- AUTOFETCH
- TX:AUTOMATED
- TX:NATIVE_MIGRATION
- TX:PROPAGATED
- TX:MERGED
example: EDITOR
type: string
- in: query
name: filter[task_language_identifier]
required: false
schema:
example: project_slug:task_number:language_code:type
pattern: ^[a-zA-Z0-9._-]+:[0-9]+:[a-zA-Z0-9._-]+:(translation|review|proofread)$
type: string
- description: Use the value `resource_string` to get the list of resource string objects in the response.
explode: false
in: query
name: include
required: false
schema:
enum:
- resource_string
type: string
style: form
- description: Retrieve translation strings containing all of the query tags.
explode: false
in: query
name: filter[resource_string][tags][all]
required: false
schema:
items:
example: tag1,tag2
type: string
minItems: 1
type: array
style: form
- description: Retrieve translation strings containing any of the query tags. If the filter value is *, all strings with any tag will be returned. However, if you use * along with another tag value, such as *,tag1, only strings with either * or 'tag1' tags will be returned.
explode: false
in: query
name: filter[resource_string][tags][any]
required: false
schema:
items:
example: tag1,tag2
type: string
minItems: 1
type: array
style: form
- description: "Retrieve translation strings based on specified query tags.\n\nTo filter strings, use a combination of tags with the following syntax:\n- Use an ampersand ('&') to signify 'AND' functionality, indicating that all specified\n tags must be present.\n- Use a pipe ('|') to signify 'OR' functionality, meaning that at least one of\n the specified tags must be present.\n- Use parentheses '(' to ')' to define the order of statement execution.\n- To use the above special characters as part of the query content, escape them with a\n backslash ('\\\\')\n\nWhen combining AND and OR conditions, the query is evaluated from left to right, following operator precedence and respecting existing parentheses. Specifically, the AND operator (&) takes precedence over the OR operator (|).\n\nFor example, consider the query:\n'tag1&(tag2|tag3)'\n\nThis query is interpreted as follows:\ntag1 AND (tag2 OR tag3), and it returns strings that have both \"tag1\" and either \"tag2\" or \"tag3\"\n\nSimilarly, for the query:\n'tag1&tag2|tag3'\n\nThis query is read as follows:\n(tag1 AND tag2) OR tag3, and it returns strings that have both \"tag1\" and \"tag2\" or have \"tag3\"\n"
explode: false
in: query
name: filter[resource_string][tags][query]
required: false
schema:
example: tag1&tag2|tag3
minLength: 1
type: string
style: form
- description: The page size limit. If not set, the default value is 150.
If set, the minimum value it can take is 150 and the maximum 1000.
in: query
name: limit
schema:
example: 150
nullable: true
type: string
responses:
'200':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
data:
description: List of resource translation objects.
items:
additionalProperties: false
properties:
attributes:
additionalProperties: false
description: Resource Translation attributes.
properties:
datetime_created:
description: The date when a resource string is made available, in a target language, to receive translations. When a new resource string is added to the system, the value of this field is the same as the resource string creation date, for every existing target language in the related project. When a new target language is added to a project, the value of this field is the same as the date the target language was added, for all resource strings already in the project.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
datetime_proofread:
description: The date that the resource translation was proofread. Null, if the resource translation is not proofread.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
nullable: true
type: string
datetime_reviewed:
description: The date that the resource translation was reviewed. If multiple reviews have occurred, then this date holds the latest. Null, if the resource translation is not reviewed.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
nullable: true
type: string
datetime_translated:
description: The date that the resource string was last translated on this language. If multiple edits on the strings have occurred, then this date holds the latest. Null, if the resource string is not translated.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
nullable: true
type: string
finalized:
description: If the resource translation is finalized or not. Depending on the number of review steps in the project, this either denotes reviewed (1 review step) or proofread (2 review steps).
example: false
type: boolean
origin:
description: The origin of the translation
enum:
- API
- EDITOR
- UPLOAD
- TM
- VENDORS:GENGO
- VENDORS:TEXTMASTER
- VENDORS:E2F
- MT:GOOGLE
- MT:MICROSOFT
- MT:AMAZON
- MT:DEEPL
- AUTOFETCH
- TX:AUTOMATED
- TX:NATIVE_MIGRATION
- TX:PROPAGATED
- TX:MERGED
example: EDITOR
nullable: true
type: string
proofread:
description: If the resource translation is proofread or not.
example: false
type: boolean
reviewed:
description: If the resource translation is reviewed or not.
example: true
type: boolean
strings:
additionalProperties: false
description: 'Dictionary with the translation content. For pluralized resource strings, the keys will be all the available plural rules for target language, as defined in CLDR, and the values the actual translation for each plural rule.
For non-pluralized resource strings, only the default plural rule (''other'') will be present.
The object will be `null` in case of untranslated content.'
example:
one: hello
other: world
nullable: true
properties:
few:
type: string
many:
type: string
one:
type: string
other:
type: string
two:
type: string
zero:
type: string
required:
- other
type: object
required:
- strings
- reviewed
- proofread
- finalized
- origin
- datetime_created
- datetime_translated
- datetime_reviewed
- datetime_proofread
type: object
id:
description: Resource Translation identifier.
example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:el_GR
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-fA-F]{32}:l:[a-zA-Z0-9@_-]+$
type: string
links:
additionalProperties: false
description: Resource Translation links.
properties:
self:
description: Resource Translation details link.
example: /resource_translations/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:language_code
type: string
required:
- self
type: object
relationships:
additionalProperties: false
description: Resource Translation relationships.
properties:
language:
additionalProperties: false
description: Language object.
properties:
data:
additionalProperties: false
description: Language data container.
properties:
id:
description: Language identifier.
example: l:en_US
pattern: ^l:[a-zA-Z0-9@_.-]+$
type: string
type:
enum:
- languages
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Language related link.
properties:
related:
description: Language details link.
example: /languages/l:en_US
type: string
required:
- related
type: object
required:
- links
- data
type: object
proofreader:
additionalProperties: false
description: User object.
nullable: true
properties:
data:
description: User id.
properties:
id:
description: User identifier.
example: u:user_1
pattern: ^u:[\w.-]+$
type: string
type:
enum:
- users
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: User links.
properties:
related:
description: User details link.
example: /users/u:user_1
type: string
required:
- related
type: object
required:
- links
- data
type: object
resource:
additionalProperties: false
description: Resource object.
properties:
data:
additionalProperties: false
description: Resource data container.
properties:
id:
description: Resource identifier.
example: o:organization_slug:p:project_slug:r:resource_slug
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$
type: string
type:
enum:
- resources
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Resource related link.
properties:
related:
description: Resource details link.
example: /resources/o:organization_slug:p:project_slug:r:resource_slug
type: string
required:
- related
type: object
required:
- links
- data
type: object
resource_string:
additionalProperties: false
description: Resource String object.
properties:
data:
additionalProperties: false
description: Resource String data container.
properties:
id:
description: Resource String identifier.
example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32}
type: string
type:
enum:
- resource_strings
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Resource String related link.
properties:
related:
description: Resource String details link.
example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52
type: string
required:
- related
type: object
required:
- links
- data
type: object
reviewer:
additionalProperties: false
description: User object.
nullable: true
properties:
data:
description: User id.
properties:
id:
description: User identifier.
example: u:user_1
pattern: ^u:[\w.-]+$
type: string
type:
enum:
- users
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: User links.
properties:
related:
description: User details link.
example: /users/u:user_1
type: string
required:
- related
type: object
required:
- links
- data
type: object
translator:
additionalProperties: false
description: User object.
nullable: true
properties:
data:
description: User id.
properties:
id:
description: User identifier.
example: u:user_1
pattern: ^u:[\w.-]+$
type: string
type:
enum:
- users
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: User links.
properties:
related:
description: User details link.
example: /users/u:user_1
type: string
required:
- related
type: object
required:
- links
- data
type: object
required:
- resource
- language
- resource_string
- translator
- reviewer
- proofreader
type: object
type:
enum:
- resource_translations
type: string
required:
- type
- id
- attributes
- relationships
- links
type: object
type: array
included:
description: List of included resource string objects.
items:
additionalProperties: false
properties:
attributes:
additionalProperties: false
description: Resource String attributes.
properties:
appearance_order:
description: 'The order that the resource string appears in it''s container.
In case of files appearance order is extracted automatically,
where in other cases this may be missing
'
nullable: true
type: integer
character_limit:
description: The maximum translation string character length, excluding variables. Use value 0 to remove the existing character limit.
example: 100
maximum: 2147483647
minimum: 0
nullable: true
type: integer
context:
description: 'Additional context added, in order to link the resource string
to the environment in which the communication takes
place and/or disambiguate resource strings with the same content.
Context can be multiple substrings, concatenated with some separator.
'
example: frontpage,footer,verb
type: string
datetime_created:
description: The date the resource string was created.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
developer_comment:
description: 'Developer comment gives additional information about the usage of this
string and/or technical details relevant to this string.
'
example: Wrapped in a 30px width div
nullable: true
type: string
instructions:
description: Additional translation instructions. Usually provided if the `developer_comment` is not present or not sufficiently clear. The maximum length should be up to 1000 characters.
example: Please use causal language for translations.
maxLength: 1000
nullable: true
type: string
key:
description: 'The identifier of the resource string in it''s container.
In cases where two resource strings in the same container share the same key,
`context` is also used to disambiguate the identity of each resource string.
'
example: hello_world
type: string
metadata_datetime_modified:
description: The date the resource string's metadata were last updated. Examples of such attributes are `tags` and `character limit`.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
occurrences:
description: The occurrences of the resource string in the source code.
example: /my_project/templates/frontpage/hello.html:30
nullable: true
type: string
pluralized:
description: If the resource string is pluralized or not.
type: boolean
string_hash:
description: The hash of the resource string. This is calculated as the hexadecimal digest on the md5 hash of the concatenation of the key and the context. More info [here](https://help.transifex.com/en/articles/6649327-how-string-hashes-are-calculated).
example: 2e354ef120752c67afa1b6855aa80c52
type: string
strings:
additionalProperties: false
description: 'Dictionary with the translation content.
For pluralized resource strings, the keys should be all the
available plural rules for source language, as defined in CLDR,
and the values the actual content for each plural rule.
For non-pluralized resource strings, only the default plural rule
(''other'') is required.
'
example:
one: hello
other: world
properties:
few:
type: string
many:
type: string
one:
type: string
other:
type: string
two:
type: string
zero:
type: string
required:
- other
type: object
strings_datetime_modified:
description: The date the resource string's content was last updated.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
tags:
description: List of tags for the resource string.
example:
- foo
- bar
items:
type: string
type: array
required:
- appearance_order
- key
- context
- strings
- tags
- occurrences
- developer_comment
- instructions
- character_limit
- pluralized
- string_hash
- datetime_created
- metadata_datetime_modified
- strings_datetime_modified
type: object
id:
description: Resource String identifier.
example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32}
type: string
links:
additionalProperties: false
description: Resource String link.
properties:
self:
description: Resource String details link.
example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52
type: string
required:
- self
type: object
relationships:
additionalProperties: false
description: Resource String relationships.
properties:
committer:
additionalProperties: false
description: User object.
properties:
data:
description: User id.
properties:
id:
description: User identifier.
example: u:user_1
pattern: ^u:[\w.-]+$
type: string
type:
enum:
- users
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: User links.
properties:
related:
description: User details link.
example: /users/u:user_1
type: string
required:
- related
type: object
required:
- links
- data
type: object
language:
additionalProperties: false
description: Language object.
properties:
data:
additionalProperties: false
description: Language data container.
properties:
id:
description: Language identifier.
example: l:en_US
pattern: ^l:[a-zA-Z0-9@_.-]+$
type: string
type:
enum:
- languages
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Language related link.
properties:
related:
description: Language details link.
example: /languages/l:en_US
type: string
required:
- related
type: object
required:
- links
- data
type: object
resource:
additionalProperties: false
description: Resource object.
properties:
data:
additionalProperties: false
description: Resource data container.
properties:
id:
description: Resource identifier.
example: o:organization_slug:p:project_slug:r:resource_slug
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$
type: string
type:
enum:
- resources
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Resource related link.
properties:
related:
description: Resource details link.
example: /resources/o:organization_slug:p:project_slug:r:resource_slug
type: string
required:
- related
type: object
required:
- links
- data
type: object
required:
- language
- resource
- committer
type: object
type:
enum:
- resource_strings
type: string
required:
- type
- id
- attributes
- relationships
- links
type: object
type: array
links:
additionalProperties: false
description: Pagination links.
properties:
next:
description: Link to the next page of results.
example: /resource_strings?filter[resource]=o:organization_slug:p:project_slug:r:resource_slug&page[cursor]=XXX
nullable: true
type: string
previous:
description: Link to the next page of results.
example: /resource_strings?filter[resource]=o:organization_slug:p:project_slug:r:resource_slug&page[cursor]=XXX
nullable: true
type: string
self:
description: Link to the current page of results.
example: /resource_strings?filter[resource]=o:organization_slug:p:project_slug:r:resource_slug
type: string
required:
- self
- next
- previous
type: object
required:
- links
- data
type: object
description: List of Resource Translations for a given resource and language.
'400':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: invalid
type: string
detail:
example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens
type: string
source:
anyOf:
- properties:
pointer:
example: /data/attributes/name
type: string
- properties:
parameter:
example: ?filter[foo]
type: string
status:
example: '400'
type: string
title:
example: Field `name` is invalid
type: string
type: object
type: array
type: object
description: Invalid
'401':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: unauthorized
type: string
detail:
example: Please verify your credentials
type: string
status:
example: '401'
type: string
title:
example: Unauthorized
type: string
type: object
type: array
type: object
description: Unauthorized
'403':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: true
properties:
code:
example: forbidden
type: string
detail:
example: You do not have permissions to perform this action
type: string
status:
example: '403'
type: string
title:
example: Operation not allowed
type: string
type: object
type: array
type: object
description: Forbidden
'404':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
properties:
code:
example: not found
type: string
detail:
example: Object not found. It may have been deleted or not been created yet
type: string
status:
example: '404'
type: string
title:
example: Object not found
type: string
type: object
type: array
type: object
description: Not found
'409':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: conflict
type: string
detail:
example: Value `some_field_value` already exists
type: string
source:
additionalProperties: false
properties:
pointer:
example: /data/attributes/some_field
type: string
type: object
status:
example: '409'
type: string
title:
example: Field `some_field` conflicted
type: string
type: object
type: array
type: object
description: Conflict
'429':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: Throttled
type: string
detail:
example: Request was throttled. Expected available in 60 seconds.
type: string
status:
example: '429'
type: string
title:
example: Throttled
type: string
type: object
type: array
type: object
description: Throttled
'500':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: server error
type: string
detail:
example: Something went wrong, please try again
type: string
status:
example: '500'
type: string
title:
example: Something went wrong
type: string
type: object
type: array
type: object
description: Internal Error
security:
- bearerAuth: []
summary: Get a Resource Translations collection
tags:
- Resource Translations
x-released: true
patch:
description: 'Allows for bulk updating of translations up to 150 at a time.
All resource strings should belong to the same resource
and target the same translation language.
'
requestBody:
content:
application/vnd.api+json;profile="bulk":
schema:
additionalProperties: false
properties:
data:
items:
additionalProperties: false
description: Update resource translations request details.
properties:
attributes:
additionalProperties: false
minProperties: 1
properties:
proofread:
description: If the resource translation is proofread or not.
example: false
type: boolean
reviewed:
description: If the resource translation is reviewed or not.
example: true
type: boolean
strings:
additionalProperties: false
description: 'Dictionary with the translation content. For pluralized resource strings, the keys should be all the available plural rules for target language, as defined in CLDR, and the values the actual translation for each plural rule.
For non-pluralized resource strings, only the default plural rule (''other'') is required.
In order to delete existing translated content, the client should supply `null` as the value of the object.'
example:
one: hello
other: world
nullable: true
properties:
few:
type: string
many:
type: string
one:
type: string
other:
type: string
two:
type: string
zero:
type: string
required:
- other
type: object
type: object
id:
description: Resource Translation identifier.
example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:el_GR
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-fA-F]{32}:l:[a-zA-Z0-9@_-]+$
type: string
type:
enum:
- resource_translations
type: string
required:
- type
- id
- attributes
type: object
maxItems: 150
minItems: 1
type: array
uniqueItems: true
required:
- data
type: object
required: true
responses:
'200':
content:
application/vnd.api+json;profile="bulk":
schema:
additionalProperties: false
properties:
data:
description: List of resource translation objects.
items:
additionalProperties: false
properties:
attributes:
additionalProperties: false
description: Resource Translation attributes.
properties:
datetime_created:
description: The date when a resource string is made available, in a target language, to receive translations. When a new resource string is added to the system, the value of this field is the same as the resource string creation date, for every existing target language in the related project. When a new target language is added to a project, the value of this field is the same as the date the target language was added, for all resource strings already in the project.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
datetime_proofread:
description: The date that the resource translation was proofread. Null, if the resource translation is not proofread.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
nullable: true
type: string
datetime_reviewed:
description: The date that the resource translation was reviewed. If multiple reviews have occurred, then this date holds the latest. Null, if the resource translation is not reviewed.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
nullable: true
type: string
datetime_translated:
description: The date that the resource string was last translated on this language. If multiple edits on the strings have occurred, then this date holds the latest. Null, if the resource string is not translated.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
nullable: true
type: string
finalized:
description: If the resource translation is finalized or not. Depending on the number of review steps in the project, this either denotes reviewed (1 review step) or proofread (2 review steps).
example: false
type: boolean
origin:
description: The origin of the translation
enum:
- API
- EDITOR
- UPLOAD
- TM
- VENDORS:GENGO
- VENDORS:TEXTMASTER
- VENDORS:E2F
- MT:GOOGLE
- MT:MICROSOFT
- MT:AMAZON
- MT:DEEPL
- AUTOFETCH
- TX:AUTOMATED
- TX:NATIVE_MIGRATION
- TX:PROPAGATED
- TX:MERGED
example: EDITOR
nullable: true
type: string
proofread:
description: If the resource translation is proofread or not.
example: false
type: boolean
reviewed:
description: If the resource translation is reviewed or not.
example: true
type: boolean
strings:
additionalProperties: false
description: 'Dictionary with the translation content. For pluralized resource strings, the keys will be all the available plural rules for target language, as defined in CLDR, and the values the actual translation for each plural rule.
For non-pluralized resource strings, only the default plural rule (''other'') will be present.
The object will be `null` in case of untranslated content.'
example:
one: hello
other: world
nullable: true
properties:
few:
type: string
many:
type: string
one:
type: string
other:
type: string
two:
type: string
zero:
type: string
required:
- other
type: object
required:
- strings
- reviewed
- proofread
- finalized
- origin
- datetime_created
- datetime_translated
- datetime_reviewed
- datetime_proofread
type: object
id:
description: Resource Translation identifier.
example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:el_GR
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-fA-F]{32}:l:[a-zA-Z0-9@_-]+$
type: string
links:
additionalProperties: false
description: Resource Translation links.
properties:
self:
description: Resource Translation details link.
example: /resource_translations/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:language_code
type: string
required:
- self
type: object
relationships:
additionalProperties: false
description: Resource Translation relationships.
properties:
language:
additionalProperties: false
description: Language object.
properties:
data:
additionalProperties: false
description: Language data container.
properties:
id:
description: Language identifier.
example: l:en_US
pattern: ^l:[a-zA-Z0-9@_.-]+$
type: string
type:
enum:
- languages
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Language related link.
properties:
related:
description: Language details link.
example: /languages/l:en_US
type: string
required:
- related
type: object
required:
- links
- data
type: object
proofreader:
additionalProperties: false
description: User object.
nullable: true
properties:
data:
description: User id.
properties:
id:
description: User identifier.
example: u:user_1
pattern: ^u:[\w.-]+$
type: string
type:
enum:
- users
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: User links.
properties:
related:
description: User details link.
example: /users/u:user_1
type: string
required:
- related
type: object
required:
- links
- data
type: object
resource:
additionalProperties: false
description: Resource object.
properties:
data:
additionalProperties: false
description: Resource data container.
properties:
id:
description: Resource identifier.
example: o:organization_slug:p:project_slug:r:resource_slug
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$
type: string
type:
enum:
- resources
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Resource related link.
properties:
related:
description: Resource details link.
example: /resources/o:organization_slug:p:project_slug:r:resource_slug
type: string
required:
- related
type: object
required:
- links
- data
type: object
resource_string:
additionalProperties: false
description: Resource String object.
properties:
data:
additionalProperties: false
description: Resource String data container.
properties:
id:
description: Resource String identifier.
example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32}
type: string
type:
enum:
- resource_strings
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Resource String related link.
properties:
related:
description: Resource String details link.
example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52
type: string
required:
- related
type: object
required:
- links
- data
type: object
reviewer:
additionalProperties: false
description: User object.
nullable: true
properties:
data:
description: User id.
properties:
id:
description: User identifier.
example: u:user_1
pattern: ^u:[\w.-]+$
type: string
type:
enum:
- users
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: User links.
properties:
related:
description: User details link.
example: /users/u:user_1
type: string
required:
- related
type: object
required:
- links
- data
type: object
translator:
additionalProperties: false
description: User object.
nullable: true
properties:
data:
description: User id.
properties:
id:
description: User identifier.
example: u:user_1
pattern: ^u:[\w.-]+$
type: string
type:
enum:
- users
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: User links.
properties:
related:
description: User details link.
example: /users/u:user_1
type: string
required:
- related
type: object
required:
- links
- data
type: object
required:
- resource
- language
- resource_string
- translator
- reviewer
- proofreader
type: object
type:
enum:
- resource_translations
type: string
required:
- type
- id
- attributes
- relationships
- links
type: object
type: array
required:
- data
type: object
description: List of Resource Translations for a given resource and language.
'400':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: invalid
type: string
detail:
example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens
type: string
source:
anyOf:
- properties:
pointer:
example: /data/attributes/name
type: string
- properties:
parameter:
example: ?filter[foo]
type: string
status:
example: '400'
type: string
title:
example: Field `name` is invalid
type: string
type: object
type: array
type: object
description: Invalid
'401':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: unauthorized
type: string
detail:
example: Please verify your credentials
type: string
status:
example: '401'
type: string
title:
example: Unauthorized
type: string
type: object
type: array
type: object
description: Unauthorized
'403':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: true
properties:
code:
example: forbidden
type: string
detail:
example: You do not have permissions to perform this action
type: string
status:
example: '403'
type: string
title:
example: Operation not allowed
type: string
type: object
type: array
type: object
description: Forbidden
'404':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
properties:
code:
example: not found
type: string
detail:
example: Object not found. It may have been deleted or not been created yet
type: string
status:
example: '404'
type: string
title:
example: Object not found
type: string
type: object
type: array
type: object
description: Not found
'409':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: conflict
type: string
detail:
example: Value `some_field_value` already exists
type: string
source:
additionalProperties: false
properties:
pointer:
example: /data/attributes/some_field
type: string
type: object
status:
example: '409'
type: string
title:
example: Field `some_field` conflicted
type: string
type: object
type: array
type: object
description: Conflict
'429':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: Throttled
type: string
detail:
example: Request was throttled. Expected available in 60 seconds.
type: string
status:
example: '429'
type: string
title:
example: Throttled
type: string
type: object
type: array
type: object
description: Throttled
'500':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: server error
type: string
detail:
example: Something went wrong, please try again
type: string
status:
example: '500'
type: string
title:
example: Something went wrong
type: string
type: object
type: array
type: object
description: Internal Error
security:
- bearerAuth: []
summary: Bulk update a resource's translations.
tags:
- Resource Translations
x-released: true
/resource_translations/{resource_translation_id}:
get:
parameters:
- description: Format of the Resource Translation id. Should be `o:organization_slug:p:project_slug:r:resource_slug:s:string_hash:l:language_code`.
in: path
name: resource_translation_id
required: true
schema:
description: Resource Translation identifier.
example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:el_GR
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-fA-F]{32}:l:[a-zA-Z0-9@_-]+$
type: string
- description: Use the value `resource_string` to get the list of resource string objects in the response.
explode: false
in: query
name: include
required: false
schema:
enum:
- resource_string
type: string
style: form
responses:
'200':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
data:
additionalProperties: false
properties:
attributes:
additionalProperties: false
description: Resource Translation attributes.
properties:
datetime_created:
description: The date when a resource string is made available, in a target language, to receive translations. When a new resource string is added to the system, the value of this field is the same as the resource string creation date, for every existing target language in the related project. When a new target language is added to a project, the value of this field is the same as the date the target language was added, for all resource strings already in the project.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
datetime_proofread:
description: The date that the resource translation was proofread. Null, if the resource translation is not proofread.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
nullable: true
type: string
datetime_reviewed:
description: The date that the resource translation was reviewed. If multiple reviews have occurred, then this date holds the latest. Null, if the resource translation is not reviewed.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
nullable: true
type: string
datetime_translated:
description: The date that the resource string was last translated on this language. If multiple edits on the strings have occurred, then this date holds the latest. Null, if the resource string is not translated.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
nullable: true
type: string
finalized:
description: If the resource translation is finalized or not. Depending on the number of review steps in the project, this either denotes reviewed (1 review step) or proofread (2 review steps).
example: false
type: boolean
origin:
description: The origin of the translation
enum:
- API
- EDITOR
- UPLOAD
- TM
- VENDORS:GENGO
- VENDORS:TEXTMASTER
- VENDORS:E2F
- MT:GOOGLE
- MT:MICROSOFT
- MT:AMAZON
- MT:DEEPL
- AUTOFETCH
- TX:AUTOMATED
- TX:NATIVE_MIGRATION
- TX:PROPAGATED
- TX:MERGED
example: EDITOR
nullable: true
type: string
proofread:
description: If the resource translation is proofread or not.
example: false
type: boolean
reviewed:
description: If the resource translation is reviewed or not.
example: true
type: boolean
strings:
additionalProperties: false
description: 'Dictionary with the translation content. For pluralized resource strings, the keys will be all the available plural rules for target language, as defined in CLDR, and the values the actual translation for each plural rule.
For non-pluralized resource strings, only the default plural rule (''other'') will be present.
The object will be `null` in case of untranslated content.'
example:
one: hello
other: world
nullable: true
properties:
few:
type: string
many:
type: string
one:
type: string
other:
type: string
two:
type: string
zero:
type: string
required:
- other
type: object
required:
- strings
- reviewed
- proofread
- finalized
- origin
- datetime_created
- datetime_translated
- datetime_reviewed
- datetime_proofread
type: object
id:
description: Resource Translation identifier.
example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:el_GR
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-fA-F]{32}:l:[a-zA-Z0-9@_-]+$
type: string
links:
additionalProperties: false
description: Resource Translation links.
properties:
self:
description: Resource Translation details link.
example: /resource_translations/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:language_code
type: string
required:
- self
type: object
relationships:
additionalProperties: false
description: Resource Translation relationships.
properties:
language:
additionalProperties: false
description: Language object.
properties:
data:
additionalProperties: false
description: Language data container.
properties:
id:
description: Language identifier.
example: l:en_US
pattern: ^l:[a-zA-Z0-9@_.-]+$
type: string
type:
enum:
- languages
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Language related link.
properties:
related:
description: Language details link.
example: /languages/l:en_US
type: string
required:
- related
type: object
required:
- links
- data
type: object
proofreader:
additionalProperties: false
description: User object.
nullable: true
properties:
data:
description: User id.
properties:
id:
description: User identifier.
example: u:user_1
pattern: ^u:[\w.-]+$
type: string
type:
enum:
- users
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: User links.
properties:
related:
description: User details link.
example: /users/u:user_1
type: string
required:
- related
type: object
required:
- links
- data
type: object
resource:
additionalProperties: false
description: Resource object.
properties:
data:
additionalProperties: false
description: Resource data container.
properties:
id:
description: Resource identifier.
example: o:organization_slug:p:project_slug:r:resource_slug
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$
type: string
type:
enum:
- resources
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Resource related link.
properties:
related:
description: Resource details link.
example: /resources/o:organization_slug:p:project_slug:r:resource_slug
type: string
required:
- related
type: object
required:
- links
- data
type: object
resource_string:
additionalProperties: false
description: Resource String object.
properties:
data:
additionalProperties: false
description: Resource String data container.
properties:
id:
description: Resource String identifier.
example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32}
type: string
type:
enum:
- resource_strings
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Resource String related link.
properties:
related:
description: Resource String details link.
example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52
type: string
required:
- related
type: object
required:
- links
- data
type: object
reviewer:
additionalProperties: false
description: User object.
nullable: true
properties:
data:
description: User id.
properties:
id:
description: User identifier.
example: u:user_1
pattern: ^u:[\w.-]+$
type: string
type:
enum:
- users
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: User links.
properties:
related:
description: User details link.
example: /users/u:user_1
type: string
required:
- related
type: object
required:
- links
- data
type: object
translator:
additionalProperties: false
description: User object.
nullable: true
properties:
data:
description: User id.
properties:
id:
description: User identifier.
example: u:user_1
pattern: ^u:[\w.-]+$
type: string
type:
enum:
- users
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: User links.
properties:
related:
description: User details link.
example: /users/u:user_1
type: string
required:
- related
type: object
required:
- links
- data
type: object
required:
- resource
- language
- resource_string
- translator
- reviewer
- proofreader
type: object
type:
enum:
- resource_translations
type: string
required:
- type
- id
- attributes
- relationships
- links
type: object
included:
description: List of included resource string objects.
items:
additionalProperties: false
properties:
attributes:
additionalProperties: false
description: Resource String attributes.
properties:
appearance_order:
description: 'The order that the resource string appears in it''s container.
In case of files appearance order is extracted automatically,
where in other cases this may be missing
'
nullable: true
type: integer
character_limit:
description: The maximum translation string character length, excluding variables. Use value 0 to remove the existing character limit.
example: 100
maximum: 2147483647
minimum: 0
nullable: true
type: integer
context:
description: 'Additional context added, in order to link the resource string
to the environment in which the communication takes
place and/or disambiguate resource strings with the same content.
Context can be multiple substrings, concatenated with some separator.
'
example: frontpage,footer,verb
type: string
datetime_created:
description: The date the resource string was created.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
developer_comment:
description: 'Developer comment gives additional information about the usage of this
string and/or technical details relevant to this string.
'
example: Wrapped in a 30px width div
nullable: true
type: string
instructions:
description: Additional translation instructions. Usually provided if the `developer_comment` is not present or not sufficiently clear. The maximum length should be up to 1000 characters.
example: Please use causal language for translations.
maxLength: 1000
nullable: true
type: string
key:
description: 'The identifier of the resource string in it''s container.
In cases where two resource strings in the same container share the same key,
`context` is also used to disambiguate the identity of each resource string.
'
example: hello_world
type: string
metadata_datetime_modified:
description: The date the resource string's metadata were last updated. Examples of such attributes are `tags` and `character limit`.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
occurrences:
description: The occurrences of the resource string in the source code.
example: /my_project/templates/frontpage/hello.html:30
nullable: true
type: string
pluralized:
description: If the resource string is pluralized or not.
type: boolean
string_hash:
description: The hash of the resource string. This is calculated as the hexadecimal digest on the md5 hash of the concatenation of the key and the context. More info [here](https://help.transifex.com/en/articles/6649327-how-string-hashes-are-calculated).
example: 2e354ef120752c67afa1b6855aa80c52
type: string
strings:
additionalProperties: false
description: 'Dictionary with the translation content.
For pluralized resource strings, the keys should be all the
available plural rules for source language, as defined in CLDR,
and the values the actual content for each plural rule.
For non-pluralized resource strings, only the default plural rule
(''other'') is required.
'
example:
one: hello
other: world
properties:
few:
type: string
many:
type: string
one:
type: string
other:
type: string
two:
type: string
zero:
type: string
required:
- other
type: object
strings_datetime_modified:
description: The date the resource string's content was last updated.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
tags:
description: List of tags for the resource string.
example:
- foo
- bar
items:
type: string
type: array
required:
- appearance_order
- key
- context
- strings
- tags
- occurrences
- developer_comment
- instructions
- character_limit
- pluralized
- string_hash
- datetime_created
- metadata_datetime_modified
- strings_datetime_modified
type: object
id:
description: Resource String identifier.
example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32}
type: string
links:
additionalProperties: false
description: Resource String link.
properties:
self:
description: Resource String details link.
example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52
type: string
required:
- self
type: object
relationships:
additionalProperties: false
description: Resource String relationships.
properties:
committer:
additionalProperties: false
description: User object.
properties:
data:
description: User id.
properties:
id:
description: User identifier.
example: u:user_1
pattern: ^u:[\w.-]+$
type: string
type:
enum:
- users
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: User links.
properties:
related:
description: User details link.
example: /users/u:user_1
type: string
required:
- related
type: object
required:
- links
- data
type: object
language:
additionalProperties: false
description: Language object.
properties:
data:
additionalProperties: false
description: Language data container.
properties:
id:
description: Language identifier.
example: l:en_US
pattern: ^l:[a-zA-Z0-9@_.-]+$
type: string
type:
enum:
- languages
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Language related link.
properties:
related:
description: Language details link.
example: /languages/l:en_US
type: string
required:
- related
type: object
required:
- links
- data
type: object
resource:
additionalProperties: false
description: Resource object.
properties:
data:
additionalProperties: false
description: Resource data container.
properties:
id:
description: Resource identifier.
example: o:organization_slug:p:project_slug:r:resource_slug
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$
type: string
type:
enum:
- resources
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Resource related link.
properties:
related:
description: Resource details link.
example: /resources/o:organization_slug:p:project_slug:r:resource_slug
type: string
required:
- related
type: object
required:
- links
- data
type: object
required:
- language
- resource
- committer
type: object
type:
enum:
- resource_strings
type: string
required:
- type
- id
- attributes
- relationships
- links
type: object
type: array
required:
- data
type: object
description: Successful response.
'401':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: unauthorized
type: string
detail:
example: Please verify your credentials
type: string
status:
example: '401'
type: string
title:
example: Unauthorized
type: string
type: object
type: array
type: object
description: Unauthorized
'403':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: true
properties:
code:
example: forbidden
type: string
detail:
example: You do not have permissions to perform this action
type: string
status:
example: '403'
type: string
title:
example: Operation not allowed
type: string
type: object
type: array
type: object
description: Forbidden
'404':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
properties:
code:
example: not found
type: string
detail:
example: Object not found. It may have been deleted or not been created yet
type: string
status:
example: '404'
type: string
title:
example: Object not found
type: string
type: object
type: array
type: object
description: Not found
'409':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: conflict
type: string
detail:
example: Value `some_field_value` already exists
type: string
source:
additionalProperties: false
properties:
pointer:
example: /data/attributes/some_field
type: string
type: object
status:
example: '409'
type: string
title:
example: Field `some_field` conflicted
type: string
type: object
type: array
type: object
description: Conflict
'429':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: Throttled
type: string
detail:
example: Request was throttled. Expected available in 60 seconds.
type: string
status:
example: '429'
type: string
title:
example: Throttled
type: string
type: object
type: array
type: object
description: Throttled
'500':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: server error
type: string
detail:
example: Something went wrong, please try again
type: string
status:
example: '500'
type: string
title:
example: Something went wrong
type: string
type: object
type: array
type: object
description: Internal Error
security:
- bearerAuth: []
summary: Get a Resource Translation details
tags:
- Resource Translations
x-released: true
patch:
description: 'Allows to add/update/remove content for Resource Translations as well as
reviewing/unreviewing existing work.
When not all of the attributes are supplied in the request, these are interpreted as
if they were included with their current value.
The only exception in this rule is when `strings` are modified,
the resource translation is by default unreviewed unless otherwise specified
(with the `reviewed`/`proofread` attributes on the request body).
'
parameters:
- description: Format of the Resource Translation id. Should be `o:organization_slug:p:project_slug:r:resource_slug:s:string_hash:l:language_code`.
in: path
name: resource_translation_id
required: true
schema:
description: Resource Translation identifier.
example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:el_GR
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-fA-F]{32}:l:[a-zA-Z0-9@_-]+$
type: string
requestBody:
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
data:
additionalProperties: false
description: Update resource body request details.
properties:
attributes:
additionalProperties: false
minProperties: 1
properties:
proofread:
description: If the resource translation is proofread or not.
example: false
type: boolean
reviewed:
description: If the resource translation is reviewed or not.
example: true
type: boolean
strings:
additionalProperties: false
description: 'Dictionary with the translation content. For pluralized resource strings, the keys should be all the available plural rules for target language, as defined in CLDR, and the values the actual translation for each plural rule.
For non-pluralized resource strings, only the default plural rule (''other'') is required.
In order to delete existing translated content, the client should supply `null` as the value of the object.'
example:
one: hello
other: world
nullable: true
properties:
few:
type: string
many:
type: string
one:
type: string
other:
type: string
two:
type: string
zero:
type: string
required:
- other
type: object
type: object
id:
description: Resource Translation identifier.
example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:el_GR
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-fA-F]{32}:l:[a-zA-Z0-9@_-]+$
type: string
type:
enum:
- resource_translations
type: string
required:
- type
- id
- attributes
type: object
required:
- data
type: object
required: true
responses:
'200':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
data:
additionalProperties: false
properties:
attributes:
additionalProperties: false
description: Resource Translation attributes.
properties:
datetime_created:
description: The date when a resource string is made available, in a target language, to receive translations. When a new resource string is added to the system, the value of this field is the same as the resource string creation date, for every existing target language in the related project. When a new target language is added to a project, the value of this field is the same as the date the target language was added, for all resource strings already in the project.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
datetime_proofread:
description: The date that the resource translation was proofread. Null, if the resource translation is not proofread.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
nullable: true
type: string
datetime_reviewed:
description: The date that the resource translation was reviewed. If multiple reviews have occurred, then this date holds the latest. Null, if the resource translation is not reviewed.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
nullable: true
type: string
datetime_translated:
description: The date that the resource string was last translated on this language. If multiple edits on the strings have occurred, then this date holds the latest. Null, if the resource string is not translated.
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
nullable: true
type: string
finalized:
description: If the resource translation is finalized or not. Depending on the number of review steps in the project, this either denotes reviewed (1 review step) or proofread (2 review steps).
example: false
type: boolean
origin:
description: The origin of the translation
enum:
- API
- EDITOR
- UPLOAD
- TM
- VENDORS:GENGO
- VENDORS:TEXTMASTER
- VENDORS:E2F
- MT:GOOGLE
- MT:MICROSOFT
- MT:AMAZON
- MT:DEEPL
- AUTOFETCH
- TX:AUTOMATED
- TX:NATIVE_MIGRATION
- TX:PROPAGATED
- TX:MERGED
example: EDITOR
nullable: true
type: string
proofread:
description: If the resource translation is proofread or not.
example: false
type: boolean
reviewed:
description: If the resource translation is reviewed or not.
example: true
type: boolean
strings:
additionalProperties: false
description: 'Dictionary with the translation content. For pluralized resource strings, the keys will be all the available plural rules for target language, as defined in CLDR, and the values the actual translation for each plural rule.
For non-pluralized resource strings, only the default plural rule (''other'') will be present.
The object will be `null` in case of untranslated content.'
example:
one: hello
other: world
nullable: true
properties:
few:
type: string
many:
type: string
one:
type: string
other:
type: string
two:
type: string
zero:
type: string
required:
- other
type: object
required:
- strings
- reviewed
- proofread
- finalized
- origin
- datetime_created
- datetime_translated
- datetime_reviewed
- datetime_proofread
type: object
id:
description: Resource Translation identifier.
example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:el_GR
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-fA-F]{32}:l:[a-zA-Z0-9@_-]+$
type: string
links:
additionalProperties: false
description: Resource Translation links.
properties:
self:
description: Resource Translation details link.
example: /resource_translations/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52:l:language_code
type: string
required:
- self
type: object
relationships:
additionalProperties: false
description: Resource Translation relationships.
properties:
language:
additionalProperties: false
description: Language object.
properties:
data:
additionalProperties: false
description: Language data container.
properties:
id:
description: Language identifier.
example: l:en_US
pattern: ^l:[a-zA-Z0-9@_.-]+$
type: string
type:
enum:
- languages
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Language related link.
properties:
related:
description: Language details link.
example: /languages/l:en_US
type: string
required:
- related
type: object
required:
- links
- data
type: object
proofreader:
additionalProperties: false
description: User object.
nullable: true
properties:
data:
description: User id.
properties:
id:
description: User identifier.
example: u:user_1
pattern: ^u:[\w.-]+$
type: string
type:
enum:
- users
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: User links.
properties:
related:
description: User details link.
example: /users/u:user_1
type: string
required:
- related
type: object
required:
- links
- data
type: object
resource:
additionalProperties: false
description: Resource object.
properties:
data:
additionalProperties: false
description: Resource data container.
properties:
id:
description: Resource identifier.
example: o:organization_slug:p:project_slug:r:resource_slug
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$
type: string
type:
enum:
- resources
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Resource related link.
properties:
related:
description: Resource details link.
example: /resources/o:organization_slug:p:project_slug:r:resource_slug
type: string
required:
- related
type: object
required:
- links
- data
type: object
resource_string:
additionalProperties: false
description: Resource String object.
properties:
data:
additionalProperties: false
description: Resource String data container.
properties:
id:
description: Resource String identifier.
example: o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+:s:[0-9a-f]{32}
type: string
type:
enum:
- resource_strings
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Resource String related link.
properties:
related:
description: Resource String details link.
example: /resource_strings/o:organization_slug:p:project_slug:r:resource_slug:s:2e354ef120752c67afa1b6855aa80c52
type: string
required:
- related
type: object
required:
- links
- data
type: object
reviewer:
additionalProperties: false
description: User object.
nullable: true
properties:
data:
description: User id.
properties:
id:
description: User identifier.
example: u:user_1
pattern: ^u:[\w.-]+$
type: string
type:
enum:
- users
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: User links.
properties:
related:
description: User details link.
example: /users/u:user_1
type: string
required:
- related
type: object
required:
- links
- data
type: object
translator:
additionalProperties: false
description: User object.
nullable: true
properties:
data:
description: User id.
properties:
id:
description: User identifier.
example: u:user_1
pattern: ^u:[\w.-]+$
type: string
type:
enum:
- users
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: User links.
properties:
related:
description: User details link.
example: /users/u:user_1
type: string
required:
- related
type: object
required:
- links
- data
type: object
required:
- resource
- language
- resource_string
- translator
- reviewer
- proofreader
type: object
type:
enum:
- resource_translations
type: string
required:
- type
- id
- attributes
- relationships
- links
type: object
required:
- data
type: object
description: Successful response.
'400':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: invalid
type: string
detail:
example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens
type: string
source:
anyOf:
- properties:
pointer:
example: /data/attributes/name
type: string
- properties:
parameter:
example: ?filter[foo]
type: string
status:
example: '400'
type: string
title:
example: Field `name` is invalid
type: string
type: object
type: array
type: object
description: Invalid
'401':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: unauthorized
type: string
detail:
example: Please verify your credentials
type: string
status:
example: '401'
type: string
title:
example: Unauthorized
type: string
type: object
type: array
type: object
description: Unauthorized
'403':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: true
properties:
code:
example: forbidden
type: string
detail:
example: You do not have permissions to perform this action
type: string
status:
example: '403'
type: string
title:
example: Operation not allowed
type: string
type: object
type: array
type: object
description: Forbidden
'404':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
properties:
code:
example: not found
type: string
detail:
example: Object not found. It may have been deleted or not been created yet
type: string
status:
example: '404'
type: string
title:
example: Object not found
type: string
type: object
type: array
type: object
description: Not found
'409':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: conflict
type: string
detail:
example: Value `some_field_value` already exists
type: string
source:
additionalProperties: false
properties:
pointer:
example: /data/attributes/some_field
type: string
type: object
status:
example: '409'
type: string
title:
example: Field `some_field` conflicted
type: string
type: object
type: array
type: object
description: Conflict
'429':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: Throttled
type: string
detail:
example: Request was throttled. Expected available in 60 seconds.
type: string
status:
example: '429'
type: string
title:
example: Throttled
type: string
type: object
type: array
type: object
description: Throttled
'500':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: server error
type: string
detail:
example: Something went wrong, please try again
type: string
status:
example: '500'
type: string
title:
example: Something went wrong
type: string
type: object
type: array
type: object
description: Internal Error
security:
- bearerAuth: []
summary: Update a Resource Translation
tags:
- Resource Translations
x-released: true
/resource_translations_async_downloads:
summary: Create a translation file download action
post:
description: 'The response represents the file download job. Check the job''s status
and download the file itself once that is completed.
'
requestBody:
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
data:
additionalProperties: false
description: Create resource translation download body request details.
properties:
attributes:
additionalProperties: false
description: Resource translations async download attributes
properties:
callback_url:
default: null
description: 'The url that will be called when the processing is completed.
For more details about callback_url you can refer to [Asynchronous Processing](#section/Asynchronous-Processing) section
'
format: uri
nullable: true
type: string
content_encoding:
default: text
description: The encoding of the file.
enum:
- text
- base64
type: string
file_type:
default: default
description: The file type.
enum:
- default
- xliff
- json
type: string
mode:
default: default
description: The transliteration mode of the downloaded file.
enum:
- default
- reviewed
- proofread
- translator
- untranslated
- onlytranslated
- onlyreviewed
- onlyproofread
- sourceastranslation
type: string
pseudo:
default: false
deprecated: true
description: 'Generate mock translation of phrases.
More about pseudo-localization: https://help.transifex.com/en/articles/6231812-testing-localized-apps-with-pseudo-files.
This attribute is deprecated and will be removed in a future release.
For pseudo translations see [/resource_strings_async_downloads](#tag/Resource-Strings/paths/~1resource_strings_async_downloads/post)
'
type: boolean
relationships:
additionalProperties: false
description: Resource translation Download parent relationships.
properties:
language:
additionalProperties: false
description: The language for which a translation file is downloaded.
properties:
data:
additionalProperties: false
description: Language data container.
properties:
id:
description: Language identifier.
example: l:en_US
pattern: ^l:[a-zA-Z0-9@_.-]+$
type: string
type:
enum:
- languages
type: string
required:
- type
- id
type: object
required:
- data
type: object
resource:
additionalProperties: false
description: The `resource` for which a translation file is downloaded.
properties:
data:
additionalProperties: false
description: Resource data container.
properties:
id:
description: Resource identifier.
example: o:organization_slug:p:project_slug:r:resource_slug
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$
type: string
type:
enum:
- resources
type: string
required:
- type
- id
type: object
required:
- data
type: object
required:
- resource
- language
type: object
type:
enum:
- resource_translations_async_downloads
type: string
required:
- type
- relationships
type: object
required:
- data
type: object
required: true
responses:
'202':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
data:
additionalProperties: false
properties:
attributes:
additionalProperties: false
properties:
date_created:
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
date_modified:
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
errors:
items:
additionalProperties: false
properties:
code:
example: parse_error
type: string
detail:
example: Could not decode JSON object
type: string
required:
- code
- detail
type: object
type: array
status:
enum:
- pending
- processing
- failed
example: failed
type: string
required:
- status
- errors
- date_created
- date_modified
type: object
id:
example: 4abfc726-6a27-4c33-9d99-e5254c8df748
pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
type: string
links:
additionalProperties: false
properties:
self:
example: /resource_translations_async_uploads/4abfc726-6a27-4c33-9d99-e5254c8df748
type: string
required:
- self
type: object
relationships:
additionalProperties: false
properties:
language:
additionalProperties: false
properties:
data:
additionalProperties: false
description: Language data container.
properties:
id:
description: Language identifier.
example: l:en_US
pattern: ^l:[a-zA-Z0-9@_.-]+$
type: string
type:
enum:
- languages
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Language related link.
properties:
related:
description: Language details link.
example: /languages/l:en_US
type: string
required:
- related
type: object
required:
- links
- data
type: object
resource:
additionalProperties: false
properties:
data:
additionalProperties: false
description: Resource data container.
properties:
id:
description: Resource identifier.
example: o:organization_slug:p:project_slug:r:resource_slug
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$
type: string
type:
enum:
- resources
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Resource related link.
properties:
related:
description: Resource details link.
example: /resources/o:organization_slug:p:project_slug:r:resource_slug
type: string
required:
- related
type: object
required:
- links
- data
type: object
required:
- resource
- language
type: object
type:
enum:
- resource_translations_async_downloads
type: string
required:
- type
- id
- attributes
- relationships
- links
type: object
required:
- data
type: object
description: Accepted.
headers:
Content-Location:
description: The location of the translation download.
required: true
schema:
type: string
'400':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: invalid
type: string
detail:
example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens
type: string
source:
anyOf:
- properties:
pointer:
example: /data/attributes/name
type: string
- properties:
parameter:
example: ?filter[foo]
type: string
status:
example: '400'
type: string
title:
example: Field `name` is invalid
type: string
type: object
type: array
type: object
description: Invalid
'401':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: unauthorized
type: string
detail:
example: Please verify your credentials
type: string
status:
example: '401'
type: string
title:
example: Unauthorized
type: string
type: object
type: array
type: object
description: Unauthorized
'403':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: true
properties:
code:
example: forbidden
type: string
detail:
example: You do not have permissions to perform this action
type: string
status:
example: '403'
type: string
title:
example: Operation not allowed
type: string
type: object
type: array
type: object
description: Forbidden
'404':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
properties:
code:
example: not found
type: string
detail:
example: Object not found. It may have been deleted or not been created yet
type: string
status:
example: '404'
type: string
title:
example: Object not found
type: string
type: object
type: array
type: object
description: Not found
'409':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: conflict
type: string
detail:
example: Value `some_field_value` already exists
type: string
source:
additionalProperties: false
properties:
pointer:
example: /data/attributes/some_field
type: string
type: object
status:
example: '409'
type: string
title:
example: Field `some_field` conflicted
type: string
type: object
type: array
type: object
description: Conflict
'429':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: Throttled
type: string
detail:
example: Request was throttled. Expected available in 60 seconds.
type: string
status:
example: '429'
type: string
title:
example: Throttled
type: string
type: object
type: array
type: object
description: Throttled
'500':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: server error
type: string
detail:
example: Something went wrong, please try again
type: string
status:
example: '500'
type: string
title:
example: Something went wrong
type: string
type: object
type: array
type: object
description: Internal Error
security:
- bearerAuth: []
summary: Create a translation file download action
tags:
- Resource Translations
x-released: true
/resource_translations_async_downloads/{resource_translations_async_download_id}:
summary: Get translation download status
get:
description: "With this endpoint, you can inquire about the status of an translation download job.\n\n- If the value of the 'status' attribute is 'pending' or 'processing', you\n should check this endpoint again later.\n- If the 'status' is 'failed', the translation has failed to be compiled.\n- In case the upload job has been successful, you will receive a \"303 - See\n Other\" response and you can follow its `Location` to [download the file](#tag/File-Downloads/paths/get)\n that have been extracted from your file.\n"
parameters:
- description: Format of the resource_translations_async_download_id should be a UUID.
in: path
name: resource_translations_async_download_id
required: true
schema:
example: 4abfc726-6a27-4c33-9d99-e5254c8df748
pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
type: string
responses:
'200':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
data:
additionalProperties: false
properties:
attributes:
additionalProperties: false
properties:
date_created:
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
date_modified:
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
errors:
items:
additionalProperties: false
properties:
code:
example: parse_error
type: string
detail:
example: Could not decode JSON object
type: string
required:
- code
- detail
type: object
type: array
status:
enum:
- pending
- processing
- failed
example: failed
type: string
required:
- status
- errors
- date_created
- date_modified
type: object
id:
example: 4abfc726-6a27-4c33-9d99-e5254c8df748
pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
type: string
links:
additionalProperties: false
properties:
self:
example: /resource_translations_async_uploads/4abfc726-6a27-4c33-9d99-e5254c8df748
type: string
required:
- self
type: object
relationships:
additionalProperties: false
properties:
language:
additionalProperties: false
properties:
data:
additionalProperties: false
description: Language data container.
properties:
id:
description: Language identifier.
example: l:en_US
pattern: ^l:[a-zA-Z0-9@_.-]+$
type: string
type:
enum:
- languages
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Language related link.
properties:
related:
description: Language details link.
example: /languages/l:en_US
type: string
required:
- related
type: object
required:
- links
- data
type: object
resource:
additionalProperties: false
properties:
data:
additionalProperties: false
description: Resource data container.
properties:
id:
description: Resource identifier.
example: o:organization_slug:p:project_slug:r:resource_slug
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$
type: string
type:
enum:
- resources
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Resource related link.
properties:
related:
description: Resource details link.
example: /resources/o:organization_slug:p:project_slug:r:resource_slug
type: string
required:
- related
type: object
required:
- links
- data
type: object
required:
- resource
- language
type: object
type:
enum:
- resource_translations_async_downloads
type: string
required:
- type
- id
- attributes
- relationships
- links
type: object
required:
- data
type: object
description: Successful response.
'303':
content:
application/vnd.api+json:
schema: {}
description: See other
headers:
Location:
description: The location of the translation file.
required: true
schema:
example: https://storage.svc.transifex.net/files/663a7a83-cb15-4c72-a37d-125dfb8432a6-file?auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZXMiOiJkb3dubG9hZCIsIm1ldGFkYXRhIjpudWxsLCJmaWxlX2lkcyI6IjY2M2E3YTgzLWNiMTUtNGM3Mi1hMzdkLTEyNWRmYjg0MzJhNi1maWxlIiwiZXhwIjoxNTg0NzE3NTkzLCJwcm92aWRlciI6InR4YyJ9.IHgLS4gtL0A6YZd-2zKkrg__geitcvs9DV8LcE8-1io
type: string
'401':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: unauthorized
type: string
detail:
example: Please verify your credentials
type: string
status:
example: '401'
type: string
title:
example: Unauthorized
type: string
type: object
type: array
type: object
description: Unauthorized
'403':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: true
properties:
code:
example: forbidden
type: string
detail:
example: You do not have permissions to perform this action
type: string
status:
example: '403'
type: string
title:
example: Operation not allowed
type: string
type: object
type: array
type: object
description: Forbidden
'404':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
properties:
code:
example: not found
type: string
detail:
example: Object not found. It may have been deleted or not been created yet
type: string
status:
example: '404'
type: string
title:
example: Object not found
type: string
type: object
type: array
type: object
description: Not found
'429':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: Throttled
type: string
detail:
example: Request was throttled. Expected available in 60 seconds.
type: string
status:
example: '429'
type: string
title:
example: Throttled
type: string
type: object
type: array
type: object
description: Throttled
'500':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: server error
type: string
detail:
example: Something went wrong, please try again
type: string
status:
example: '500'
type: string
title:
example: Something went wrong
type: string
type: object
type: array
type: object
description: Internal Error
security:
- bearerAuth: []
summary: Get translation download status
tags:
- Resource Translations
x-released: true
/resource_translations_async_fillups:
post:
description: Trigger an on demand fillup process for a resource's translations.
requestBody:
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
data:
additionalProperties: false
description: Provide parameters for fillup.
properties:
attributes:
additionalProperties: false
description: Fillup attributes
properties:
ai_fillup:
description: Whether to include AI fillup in the fillup process.
example: true
type: boolean
machine_translation_fillup:
description: Whether to include machine translation fillup in the fillup process.
example: true
type: boolean
translation_memory_fillup:
description: Whether to include translation memory fillup in the fillup process.
example: true
type: boolean
translation_memory_fillup_options:
additionalProperties: false
description: Additional settings for the fillup process. Only available for TM fillup.
properties:
autoreview_policy:
default: NONE
description: Settings for autoreview policy.
enum:
- NONE
- '100'
- '101'
example: NONE
type: string
context_matching_enabled:
default: false
description: Whether to consider context in the fillup process.
example: true
type: boolean
fuzzy_match_cutoff_percent:
default: 100
description: The percent threshold for the fillup process.
example: 95
maximum: 100
minimum: 85
type: integer
similar_locales_enabled:
default: false
description: Whether to include similar locales in the fillup process.
example: true
type: boolean
type: object
required:
- translation_memory_fillup
- machine_translation_fillup
- ai_fillup
type: object
relationships:
additionalProperties: false
description: Fillup relationships
properties:
language:
additionalProperties: false
description: The language for which the fillup is triggered.
properties:
data:
additionalProperties: false
description: Language data container.
properties:
id:
description: Language identifier.
example: l:en_US
pattern: ^l:[a-zA-Z0-9@_.-]+$
type: string
type:
enum:
- languages
type: string
required:
- type
- id
type: object
required:
- data
type: object
resource:
additionalProperties: false
description: The `resource` for which the fillup is triggered.
properties:
data:
additionalProperties: false
description: Resource data container.
properties:
id:
description: Resource identifier.
example: o:organization_slug:p:project_slug:r:resource_slug
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$
type: string
type:
enum:
- resources
type: string
required:
- type
- id
type: object
required:
- data
type: object
required:
- resource
- language
type: object
type:
enum:
- resource_translations_async_fillups
type: string
required:
- attributes
- type
- relationships
type: object
required:
- data
type: object
required: true
responses:
'204':
description: Fillup action created successfully. No response body.
'400':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: invalid
type: string
detail:
example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens
type: string
source:
anyOf:
- properties:
pointer:
example: /data/attributes/name
type: string
- properties:
parameter:
example: ?filter[foo]
type: string
status:
example: '400'
type: string
title:
example: Field `name` is invalid
type: string
type: object
type: array
type: object
description: Invalid
'401':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: unauthorized
type: string
detail:
example: Please verify your credentials
type: string
status:
example: '401'
type: string
title:
example: Unauthorized
type: string
type: object
type: array
type: object
description: Unauthorized
'403':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: true
properties:
code:
example: forbidden
type: string
detail:
example: You do not have permissions to perform this action
type: string
status:
example: '403'
type: string
title:
example: Operation not allowed
type: string
type: object
type: array
type: object
description: Forbidden
'404':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
properties:
code:
example: not found
type: string
detail:
example: Object not found. It may have been deleted or not been created yet
type: string
status:
example: '404'
type: string
title:
example: Object not found
type: string
type: object
type: array
type: object
description: Not found
'409':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: conflict
type: string
detail:
example: Value `some_field_value` already exists
type: string
source:
additionalProperties: false
properties:
pointer:
example: /data/attributes/some_field
type: string
type: object
status:
example: '409'
type: string
title:
example: Field `some_field` conflicted
type: string
type: object
type: array
type: object
description: Conflict
'500':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: server error
type: string
detail:
example: Something went wrong, please try again
type: string
status:
example: '500'
type: string
title:
example: Something went wrong
type: string
type: object
type: array
type: object
description: Internal Error
security:
- bearerAuth: []
summary: Create a resource translations fillup action
tags:
- Resource Translations
x-released: true
/resource_translations_async_uploads:
summary: Create a new resource translation upload
post:
description: 'Upload a new resource translation file for a specific language.
'
requestBody:
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
data:
additionalProperties: false
description: Create resource translation upload body request details.
properties:
attributes:
additionalProperties: false
description: Resource translations async upload attributes
properties:
callback_url:
default: null
description: 'The url that will be called when the processing is completed.
For more details about callback_url you can refer to [Asynchronous Processing](#section/Asynchronous-Processing) section
'
format: uri
nullable: true
type: string
content:
description: The file to upload json or base64 encoded.
example: '{"hello": "Γεια σου"}'
type: string
content_encoding:
description: The encoding of the file.
enum:
- text
- base64
type: string
file_type:
description: The file type.
enum:
- default
- xliff
type: string
required:
- content
- content_encoding
- file_type
relationships:
additionalProperties: false
description: Resource translation Upload parent relationships.
properties:
language:
additionalProperties: false
description: The language for which a translation file is uploaded.
properties:
data:
additionalProperties: false
description: Language data container.
properties:
id:
description: Language identifier.
example: l:en_US
pattern: ^l:[a-zA-Z0-9@_.-]+$
type: string
type:
enum:
- languages
type: string
required:
- type
- id
type: object
required:
- data
type: object
resource:
additionalProperties: false
description: The `resource` for which a translation file is uploaded.
properties:
data:
additionalProperties: false
description: Resource data container.
properties:
id:
description: Resource identifier.
example: o:organization_slug:p:project_slug:r:resource_slug
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$
type: string
type:
enum:
- resources
type: string
required:
- type
- id
type: object
required:
- data
type: object
required:
- resource
- language
type: object
type:
enum:
- resource_translations_async_uploads
type: string
required:
- type
- attributes
- relationships
type: object
required:
- data
type: object
multipart/form-data:
schema:
additionalProperties: false
properties:
callback_url:
default: null
description: 'The url that will be called when the processing is completed.
For more details about callback_url you can refer to [Asynchronous Processing](#section/Asynchronous-Processing) section
'
format: uri
nullable: true
type: string
content:
description: The file to upload.
example: FILE
format: binary
type: string
file_type:
enum:
- default
- xliff
type: string
language:
description: Language identifier.
example: l:en_US
pattern: ^l:[a-zA-Z0-9@_.-]+$
type: string
resource:
description: Resource identifier.
example: o:organization_slug:p:project_slug:r:resource_slug
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$
type: string
required:
- content
- resource
- language
type: object
required: true
responses:
'202':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
data:
additionalProperties: false
properties:
attributes:
additionalProperties: false
properties:
date_created:
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
date_modified:
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
details:
additionalProperties: false
nullable: true
properties:
translations_created:
type: integer
translations_updated:
type: integer
required:
- translations_created
- translations_updated
type: object
errors:
items:
additionalProperties: false
properties:
code:
example: parse_error
type: string
detail:
example: Could not decode JSON object
type: string
required:
- code
- detail
type: object
type: array
status:
enum:
- pending
- processing
- failed
- succeeded
example: failed
type: string
required:
- status
- errors
- date_created
- date_modified
type: object
id:
example: 4abfc726-6a27-4c33-9d99-e5254c8df748
pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
type: string
links:
additionalProperties: false
properties:
self:
example: /resource_translations_async_uploads/4abfc726-6a27-4c33-9d99-e5254c8df748
type: string
required:
- self
type: object
relationships:
additionalProperties: false
properties:
language:
additionalProperties: false
properties:
data:
additionalProperties: false
description: Language data container.
properties:
id:
description: Language identifier.
example: l:en_US
pattern: ^l:[a-zA-Z0-9@_.-]+$
type: string
type:
enum:
- languages
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Language related link.
properties:
related:
description: Language details link.
example: /languages/l:en_US
type: string
required:
- related
type: object
required:
- links
- data
type: object
resource:
additionalProperties: false
properties:
data:
additionalProperties: false
description: Resource data container.
properties:
id:
description: Resource identifier.
example: o:organization_slug:p:project_slug:r:resource_slug
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$
type: string
type:
enum:
- resources
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Resource related link.
properties:
related:
description: Resource details link.
example: /resources/o:organization_slug:p:project_slug:r:resource_slug
type: string
required:
- related
type: object
required:
- links
- data
type: object
required:
- resource
- language
type: object
type:
enum:
- resource_translations_async_uploads
type: string
required:
- type
- id
- attributes
- relationships
- links
type: object
required:
- data
type: object
description: Accepted.
headers:
Content-Location:
description: The location of the source upload.
required: true
schema:
type: string
'400':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: invalid
type: string
detail:
example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens
type: string
source:
anyOf:
- properties:
pointer:
example: /data/attributes/name
type: string
- properties:
parameter:
example: ?filter[foo]
type: string
status:
example: '400'
type: string
title:
example: Field `name` is invalid
type: string
type: object
type: array
type: object
description: Invalid
'401':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: unauthorized
type: string
detail:
example: Please verify your credentials
type: string
status:
example: '401'
type: string
title:
example: Unauthorized
type: string
type: object
type: array
type: object
description: Unauthorized
'403':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: true
properties:
code:
example: forbidden
type: string
detail:
example: You do not have permissions to perform this action
type: string
status:
example: '403'
type: string
title:
example: Operation not allowed
type: string
type: object
type: array
type: object
description: Forbidden
'404':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
properties:
code:
example: not found
type: string
detail:
example: Object not found. It may have been deleted or not been created yet
type: string
status:
example: '404'
type: string
title:
example: Object not found
type: string
type: object
type: array
type: object
description: Not found
'409':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: conflict
type: string
detail:
example: Value `some_field_value` already exists
type: string
source:
additionalProperties: false
properties:
pointer:
example: /data/attributes/some_field
type: string
type: object
status:
example: '409'
type: string
title:
example: Field `some_field` conflicted
type: string
type: object
type: array
type: object
description: Conflict
'429':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: Throttled
type: string
detail:
example: Request was throttled. Expected available in 60 seconds.
type: string
status:
example: '429'
type: string
title:
example: Throttled
type: string
type: object
type: array
type: object
description: Throttled
'500':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: server error
type: string
detail:
example: Something went wrong, please try again
type: string
status:
example: '500'
type: string
title:
example: Something went wrong
type: string
type: object
type: array
type: object
description: Internal Error
security:
- bearerAuth: []
summary: Create a new resource translation upload
tags:
- Resource Translations
x-released: true
/resource_translations_async_uploads/{resource_translations_async_upload_id}:
summary: Get resource translation async upload
get:
description: Get details of a resource translations upload.
parameters:
- description: Format of the resource_translations_async_upload_id should be a UUID.
in: path
name: resource_translations_async_upload_id
required: true
schema:
example: 4abfc726-6a27-4c33-9d99-e5254c8df748
pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
type: string
responses:
'200':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
data:
additionalProperties: false
properties:
attributes:
additionalProperties: false
properties:
date_created:
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
date_modified:
example: XXXX-XX-XXTXX:XX:XXZ
format: date-time
type: string
details:
additionalProperties: false
nullable: true
properties:
translations_created:
type: integer
translations_updated:
type: integer
required:
- translations_created
- translations_updated
type: object
errors:
items:
additionalProperties: false
properties:
code:
example: parse_error
type: string
detail:
example: Could not decode JSON object
type: string
required:
- code
- detail
type: object
type: array
status:
enum:
- pending
- processing
- failed
- succeeded
example: failed
type: string
required:
- status
- errors
- date_created
- date_modified
type: object
id:
example: 4abfc726-6a27-4c33-9d99-e5254c8df748
pattern: ^([0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
type: string
links:
additionalProperties: false
properties:
self:
example: /resource_translations_async_uploads/4abfc726-6a27-4c33-9d99-e5254c8df748
type: string
required:
- self
type: object
relationships:
additionalProperties: false
properties:
language:
additionalProperties: false
properties:
data:
additionalProperties: false
description: Language data container.
properties:
id:
description: Language identifier.
example: l:en_US
pattern: ^l:[a-zA-Z0-9@_.-]+$
type: string
type:
enum:
- languages
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Language related link.
properties:
related:
description: Language details link.
example: /languages/l:en_US
type: string
required:
- related
type: object
required:
- links
- data
type: object
resource:
additionalProperties: false
properties:
data:
additionalProperties: false
description: Resource data container.
properties:
id:
description: Resource identifier.
example: o:organization_slug:p:project_slug:r:resource_slug
pattern: ^o:[a-zA-Z0-9._-]+:p:[a-zA-Z0-9_-]+:r:[a-zA-Z0-9_-]+$
type: string
type:
enum:
- resources
type: string
required:
- type
- id
type: object
links:
additionalProperties: false
description: Resource related link.
properties:
related:
description: Resource details link.
example: /resources/o:organization_slug:p:project_slug:r:resource_slug
type: string
required:
- related
type: object
required:
- links
- data
type: object
required:
- resource
- language
type: object
type:
enum:
- resource_translations_async_uploads
type: string
required:
- type
- id
- attributes
- relationships
- links
type: object
required:
- data
type: object
description: Successful response.
'400':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: invalid
type: string
detail:
example: Enter a valid `name` consisting of Unicode letters, numbers, underscores, or hyphens
type: string
source:
anyOf:
- properties:
pointer:
example: /data/attributes/name
type: string
- properties:
parameter:
example: ?filter[foo]
type: string
status:
example: '400'
type: string
title:
example: Field `name` is invalid
type: string
type: object
type: array
type: object
description: Invalid
'401':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: unauthorized
type: string
detail:
example: Please verify your credentials
type: string
status:
example: '401'
type: string
title:
example: Unauthorized
type: string
type: object
type: array
type: object
description: Unauthorized
'403':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: true
properties:
code:
example: forbidden
type: string
detail:
example: You do not have permissions to perform this action
type: string
status:
example: '403'
type: string
title:
example: Operation not allowed
type: string
type: object
type: array
type: object
description: Forbidden
'404':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
properties:
code:
example: not found
type: string
detail:
example: Object not found. It may have been deleted or not been created yet
type: string
status:
example: '404'
type: string
title:
example: Object not found
type: string
type: object
type: array
type: object
description: Not found
'500':
content:
application/vnd.api+json:
schema:
additionalProperties: false
properties:
errors:
items:
additionalProperties: false
properties:
code:
example: server error
type: string
detail:
example: Something went wrong, please try again
type: string
status:
example: '500'
type: string
title:
example: Something went wrong
type: string
type: object
type: array
type: object
description: Internal Error
security:
- bearerAuth: []
summary: Get resource translation async upload
tags:
- Resource Translations
x-released: true
components:
securitySchemes:
bearerAuth:
description: 'To use the API you need to authenticate your requests using Token Authentication. Specifically, you need to
* Acquire an authentication token from the Transifex (under user settings)
* Uses the `Bearer` keyword and prepend the token when passing the header.
For example, if the authentication token is `1/0b4e75552e481aeae813aebad53f3de3fcc67ccd`, then the HTTP header should look like this:
`Authorization: Bearer 1/0b4e75552e481aeae813aebad53f3de3fcc67ccd`
To create an API token:
1. Head to your User Settings by going to the main navigation, and clicking on your profile image in the top right corner.
2. In the left menu, click on API token.
3. Click Generate a token.
Once you''ve generated a token, you can edit its name so it''s easier to remember where you use the token.
To keep your API token secure, we''ll only show it once, so please be sure to save it somewhere secure.
In case you lose your API token, you can regenerate a new one at any time. However, when you regenerate
a new token, you''ll need to update your applications and replace the old token with the new one.
'
scheme: bearer
type: http