Resources

name path methods description
Asynchronous Process
  • /async/{processId}
  • /async/projects/p/{projectSlug}/iterations/i/{iterationSlug}/r
  • /async/projects/p/{projectSlug}/iterations/i/{iterationSlug}/resource
  • /async/projects/p/{projectSlug}/iterations/i/{iterationSlug}/r/{id}
  • /async/projects/p/{projectSlug}/iterations/i/{iterationSlug}/resource/translations/{locale}
  • /async/projects/p/{projectSlug}/iterations/i/{iterationSlug}/r/{id}/translations/{locale}
  • GET
  • POST
  • PUT
  • PUT
  • PUT
  • PUT
Represents a resource for an asynchronous (i.e. background) process. Only certain types of processes are exposed as asynchronous resources.
Copy Trans
  • /copytrans/proj/{projectSlug}/iter/{iterationSlug}/doc/{docId}
  • GET POST
Represents the state of a copy trans run. These are special processes which search for and reuse translations.
Files
  • /file/accepted_document_types
  • /file/accepted_types
  • /file/file_type_info
  • /file/download/{downloadId}
  • /file/source/{projectSlug}/{iterationSlug}
  • /file/source/{projectSlug}/{iterationSlug}/{fileType}
  • /file/translation/{projectSlug}/{iterationSlug}/{locale}
  • /file/translation/{projectSlug}/{iterationSlug}/{locale}/{fileType}
  • GET
  • GET
  • GET
  • GET
  • POST
  • GET
  • POST
  • GET
Represents various types of translatable files to be processed by the server instead of the REST client. This REST interface provides endpoints for uploading and downloading files in multiple formats.
Glossary
  • /glossary
  • /glossary/entries
  • /glossary/file
  • /glossary/info
  • /glossary/qualifiedName
  • /glossary/search
  • /glossary/details/{locale}
  • /glossary/entries/{id}
  • DELETE POST
  • GET POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • DELETE
Glossary management
Languages
  • /locales
  • /locales/locale
  • /locales/new
  • /locales/source
  • /locales/ui
  • /locales/locale/{localeId}
  • /locales/locale/{localeId}/members
  • GET
  • PUT
  • GET
  • GET
  • GET
  • DELETE GET
  • GET
Project
  • /projects/p/{projectSlug}
  • /projects/p/{projectSlug}/glossary/qualifiedName
  • GET HEAD PUT
  • GET
Manage projects
projectSlug: Project Identifier.
Project List
  • /projects
  • GET
API endpoint to get a list of projects.
Project Version
  • /project/{projectSlug}/version/{versionSlug}
  • /project/{projectSlug}/version/{versionSlug}/config
  • /project/{projectSlug}/version/{versionSlug}/docs
  • /project/{projectSlug}/version/{versionSlug}/locales
  • /project/{projectSlug}/version/{versionSlug}/contributors/{dateRange}
  • /project/{projectSlug}/version/{versionSlug}/doc/{docId}/status/{localeId}
  • GET HEAD PUT
  • GET
  • GET
  • GET
  • GET
  • POST
Project version resource API, replacing ProjectIterationResource.
Project locales
  • /projects/p/{projectSlug}/locales
  • /projects/p/{projectSlug}/locales/source
  • GET
  • GET
REST interface for configured project locales.
ProjectIterationResource
  • /projects/p/{projectSlug}/iterations/i/{iterationSlug}
  • /projects/p/{projectSlug}/iterations/i/{iterationSlug}/config
  • GET HEAD PUT
  • GET
Deprecated. See Project Version projectSlug: Project Identifier. iterationSlug: Project Iteration identifier.
Source Documents
  • /projects/p/{projectSlug}/iterations/i/{iterationSlug}/r
  • /projects/p/{projectSlug}/iterations/i/{iterationSlug}/resource
  • /projects/p/{projectSlug}/iterations/i/{iterationSlug}/r/{id}
  • /projects/p/{projectSlug}/iterations/i/{iterationSlug}/resource/meta
  • /projects/p/{projectSlug}/iterations/i/{iterationSlug}/r/{id}/meta
  • GET HEAD POST
  • DELETE GET PUT
  • DELETE GET PUT
  • GET PUT
  • GET PUT
Source document API. This API uses format-independent data structures. For format specific source document access see Files
projectSlug: Project Identifier.
iterationSlug: Project Iteration identifier.
Statistics
  • /stats/proj/{projectSlug}/iter/{iterationSlug}
  • /stats/proj/{projectSlug}/iter/{iterationSlug}/doc
  • /stats/project/{projectSlug}/version/{versionSlug}/{dateRangeParam}
  • /stats/proj/{projectSlug}/iter/{iterationSlug}/doc/{docId}
  • /stats/project/{projectSlug}/version/{versionSlug}/contributor/{username}/{dateRange}
  • GET
  • GET
  • GET
  • GET
  • GET
Fetch different translation statistics
System Version
  • /version
  • GET
Retrieves the system's version.
Translated Documents
  • /projects/p/{projectSlug}/iterations/i/{iterationSlug}/resource/translations/{locale}
  • /projects/p/{projectSlug}/iterations/i/{iterationSlug}/r/{id}/translations/{locale}
  • DELETE GET PUT
  • DELETE GET PUT
Translated document API. This API uses format-independent data structures. For format specific source document access see Files
projectSlug: Project Identifier.
iterationSlug: Project Iteration identifier.
Translation Memory
  • /tm/all
  • /tm/{slug}
  • /tm/projects/{projectSlug}
  • /tm/{slug}/transunits
  • /tm/projects/{projectSlug}/iterations/{iterationSlug}
  • GET
  • GET POST
  • GET
  • DELETE
  • GET
Allows clients to [push and] pull translation memories.
User Account
  • /accounts/u/{username}
  • GET PUT
Represents user accounts in the system. username: User name that identifies an account
Version Locales
  • /projects/p/{projectSlug}/iterations/i/{iterationSlug}/locales
  • /projects/p/{projectSlug}/iterations/i/{iterationSlug}/locales/source
  • GET
  • GET
REST interface for configured version locales.