Resources
Resource container list
Returns the list of the resource containers (files) of a given project
REQUEST
PARAMETERS
workspaceUrl
required (path) - Workspace URLprojectUrl
required (path) - Project URLlocaleInFileName
(query) - determines if the locale info should be rendered in the file name:ALL
(default),TARGETS
,NONE
.addIso2Slug
(query) - iftrue
theiso2_slug
parameter will be always added to the rendered resource file URLs.
RESPONSE
OK
: Returns a list of the project's resource containers (files).
Upload resource file
Uploads & imports the given resource file to the specified project
REQUEST
Since this is a multipart/form-data
request, we will show an example based on curl:
PARAMETERS
workspaceUrl
required (path) - Workspace URLprojectUrl
required (path) - Project URLfile
required (request body) - the file content as request body havingContent-Disposition: form-data; name="file"
path
(query) - to which path the resource file has to be uploadediso2_slug
(query) - The iso code of the resource file language. Alias ofiso2_code
iso2_code
(query) - The iso code of the resource file language. Alias ofiso_slug
source:createNew
(query, boolean) - if this file belongs to the source language: new segments should be createdsource:updateExisting
(query, boolean) - if this file belongs to the source language: changed segments should be updatedsource:deactivateMissing
(query, boolean) - if this file belongs to the source language: removed segments should be deactivatedtarget:createNew
(query, boolean) - if this file belongs to the target language: new segments should be createdtarget:updateExisting
(query, boolean) - if this file belongs to the target language: changed segments should be updatedtarget:deactivateMissing
(query, boolean) - if this file belongs to the target language: removed segments should be deactivated
Download resource file
Exports & downloads the requested resource file
REQUEST
PARAMETERS
workspaceUrl
required (path) - Workspace URLprojectUrl
required (path) - Project URLfileName
required (path) - Name of the resource file to downloadpath
(query) - the specified path of the resource container (file) to download. If a path has been specifiediso2_slug
(query) - The iso code of the resource file language. Alias ofiso2_code
iso2_code
(query) - The iso code of the resource file language. Alias ofiso_slug
source:blankContentHandling
(query) - Should the segment be exported if source content is blank. One of:keep
,skip
target:blankContentHandling
(query) - Should the segment be exported if target content is blank. One of:fallback
,use_source
,keep
,skip
source:filterByStatus
(query) - Filter for source segments based on status. One of:ALL
,TRANSLATED_AND_APPROVED
,APPROVED
target:filterByStatus
(query) - Filter for target segments based on status. One of:ALL
,TRANSLATED_AND_APPROVED
,APPROVED
htmlEncoding
(query) - If the segment content holds HTML, how should it be escaped? One of:RAW
,ESCAPE
,CDATA
encoding
(query) - The character encoding that has to be used to render the file. Eg. UTF-8, UTF-16, ISO-8859-1escapeMode
(query) - Alias ofhtmlEncoding
addLocaleInformationToFilename
(query) - If the language (locale) information should be part of the file name. One of:ALL
,TARGETS
,NONE
escapeCharacters
(query, boolean) - If special characters should be escaped. Different behaviour according to the resource typeexportTargetComments
(query, boolean) - Should comments be exported to files of the target language?exportSourceLocale
(query, boolean) - If a resource file holds multiple languages, this indicates if the source language should be included in this exportexportHeader
(query, boolean) - If the file header (if applicable) should be exportedexportTitle
(query, boolean) - If the title of the segments should be rendered in this exportexportDescription
(query) - If the description of the segments should be rendered in this exportprojectType
(query) - Overrides the project type of the project for this export. Enables to eg. download an iOS file as Android XML or vice versa.
Delete Resource container
Deletes the addressed resource container from the given project.
For addressing the resource container, the fileName
and path
of the resource belonging to the source language has to be given. If the target language is provided, an error will be responded.
REQUEST
PARAMETERS
workspaceUrl
required (path) - Workspace URLprojectUrl
required (path) - Project URLfileName
required (path) - Name of the resource file to downloadpath
(query) - the specified path of the resource container (file) to download. If a path has been specified
RESPONSE
OK
: if the resource container has been deleted
NOT_FOUND
: Not able to determine the resource container
BAD_REQUEST
: The specified file name/path has to belong to the source language of the project
Last updated