{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"open-api","parameters":{"macroParams":{"filter":{"value":"none"},"validatorUrl":{"value":"none"},"supportedSubmitMethods":{"value":"none"},"showUrl":{"value":"false"},"__bodyContent":{"value":"openapi: 3.0.0\nservers: []\ninfo:\n description: |\n This is the Globalese API v2.1 documentation.\n More information about Globalese:\n [globalese.ai](https://www.globalese-mt.com)\n\n **Base URL**\n ```\n https://{subdomain}.globalese.ai/api/v2.1/\n ```\n\n The use of the `https` protocol is mandatory.\n\n # Authentication\n Globalese requires Basic HTTP authentication. Every request **must** contain an `Authorization` header using the username and API key associated with a user account existing in Globalese.\n\n Assuming the username is `john_doe` and the API key is `12345678`, the header entry should look like this:\n ```\n Authorization: Basic am9obl9kb2U6MTIzNDU2Nzg=\n ```\n The actions performed through the API reflect the restrictions by groups and permissions the authenticated user has.\n\n # Checking user credentials\n Globalese offers the `/` endpoint accepting `GET` requests.\n\n Sending an empty `GET /` request with the appropriate `Authorization` header will either return a `200` or a `401` response.\n\n # Format\n The necessary parameters must be passed on in the following manner:\n * `GET` and `DELETE` requests: in the query part of the URL\n * `POST`, `PUT` and `PATCH` requests: in the request body as a JSON-encoded array\n * File uploads: in the request body\n\n ## Passing arrays in GET requests\n If a request parameter is an array, use a comma-separated form of array elements (no spaces) in the `GET` request parameters. For example, if:\n ```\n $group = [1, 3, 7]\n ```\n then in the request, use the query parameters in the form of\n ```\n ?group=1,3,7\n ```\n\n ## Language codes\n Globalese works with the 2-letter [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for languages and the 2-letter [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) codes for countries in the following format:\n ```\n en\n fr\n zh\n ```\n or\n ```\n en-us\n fr-fr\n zh-cn\n ```\n\n # Responses\n ## Format\n All responses containing a body that is not a file use the JSON format.\n\n ## HTTP status codes used\n The following HTTP status codes are sent back in response headers:\n ```\n 200 The request has been processed.\n 201 A new resource has been created.\n 400 Bad request or missing required parameter.\n 401 Unauthorized request.\n 403 Insufficient user permissions.\n 404 Entity not found.\n 500 Internal error while processing the request.\n ```\n\n ## Error messages\n In case the request returns an error, the error message is sent in JSON format as shown here (except for 401 responses which always indicate an authorisation error):\n ```\n {\n \"error\": \"Some error message.\"\n }\n ```\n version: \"2.1\"\n title: Globalese\ntags:\n - name: Corpora\n - name: Engines\n - name: Groups\n - name: Languages\n - name: Projects\n - name: Stock engines\n - name: Translation files\n - name: Users\n description: Only accessible to system administrators.\npaths:\n /corpora:\n get:\n deprecated: true\n tags:\n - Corpora\n summary: List corpora\n description: Returns a collection of corpora, optionally filtered.\n parameters:\n - $ref: '#/components/parameters/limitmax100'\n - $ref: '#/components/parameters/offset'\n - $ref: '#/components/parameters/source'\n - $ref: '#/components/parameters/target'\n - $ref: '#/components/parameters/groups'\n - $ref: '#/components/parameters/engineId'\n - $ref: '#/components/parameters/metadataDomain'\n - $ref: '#/components/parameters/metadataSubject'\n - $ref: '#/components/parameters/metadataClient'\n - $ref: '#/components/parameters/metadataProject'\n - $ref: '#/components/parameters/metadataDescription'\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/CorpusCollection'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n post:\n deprecated: true\n tags:\n - Corpora\n summary: Create a new corpus entity as a prerequisite before uploading\n description: |\n This is the first of the required two steps for uploading a new corpus.\n The second step is `PUT /corpora/{id}`\n responses:\n '201':\n headers:\n Location:\n schema:\n type: string\n description: |\n URI of the newly created corpus.\n Example: /corpora/532352f85e2149.3a073428\n description: |\n The newly created corpus entity.\n The next step **must** be `PUT /corpora/{id}`\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Corpus'\n '400':\n $ref: '#/components/responses/400BadRequest'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n security:\n - basic: []\n requestBody:\n $ref: '#/components/requestBodies/createCorpus'\n '/corpora/{id}':\n get:\n deprecated: true\n tags:\n - Corpora\n summary: Show the details of a corpus\n description: Returns a single corpus.\n parameters:\n - name: id\n in: path\n description: corpus ID\n required: true\n schema:\n type: string\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Corpus'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n security:\n - basic: []\n put:\n deprecated: true\n tags:\n - Corpora\n summary: Upload a corpus\n description: |\n This is the second of the required two steps for uploading a new corpus.\n The first step is `POST /corpora`\n\n It can also be used to update the content of an existing corpus.\n\n Maximum file size: 600 MB.\n\n Accepted CAT tool file formats:\n * `.mqxliff`/`.mqxlz` from memoQ\n * `.mxliff` from Memsource\n * `.sdlxliff` from SDL Trados Studio\n * `.tbx`\n * `.tmx`\n * `.txlf` from Wordfast\n * `.xliff`/`.xlf` from Smartcat, XTM, translate5, Wordbee, SDL (Idiom) WorldServer, or any standard XLIFF 1.2\n * `.xlz` from SDL (Idiom) WorldServer\n\n Accepted delimited file formats:\n * `.bi`\n * `.csv` (either comma- or semicolon-delimited)\n * `.tsv`\n parameters:\n - name: id\n in: path\n description: The ID of the corpus to be uploaded.\n required: true\n schema:\n type: string\n responses:\n '201':\n description: Created\n headers:\n Location:\n schema:\n type: string\n description: |\n URI of the newly created corpus.\n Example: /corpora/532352f85e2149.3a073428\n '400':\n $ref: '#/components/responses/400BadRequest'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n requestBody:\n required: true\n content:\n text/plain:\n schema:\n type: string\n example:

OneUno\n patch:\n deprecated: true\n tags:\n - Corpora\n summary: Update corpus name, groups or metadata\n parameters:\n - name: id\n in: path\n description: The ID of the corpus to be updated.\n required: true\n schema:\n type: string\n responses:\n '200':\n $ref: '#/components/responses/200OK'\n '400':\n $ref: '#/components/responses/400BadRequest'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n requestBody:\n $ref: '#/components/requestBodies/updateCorpus'\n delete:\n deprecated: true\n tags:\n - Corpora\n summary: Delete a corpus\n parameters:\n - name: id\n in: path\n description: The ID of the corpus to be deleted.\n required: true\n schema:\n type: string\n responses:\n '204':\n $ref: '#/components/responses/204NoContent'\n '400':\n $ref: '#/components/responses/400BadRequest'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n '/corpora/{id}/download':\n get:\n deprecated: true\n tags:\n - Corpora\n summary: Download a corpus in a zipped TMX file\n description: Returns a zip file containing a TMX file.\n parameters:\n - name: id\n in: path\n description: Corpus ID\n required: true\n schema:\n type: string\n responses:\n '200':\n description: A zip file containing a TMX file made from the corpus content.\n content:\n application/octet-stream:\n schema:\n type: string\n format: binary\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n '/corpora/merge':\n post:\n deprecated: true\n tags:\n - Corpora\n summary: Merge corpora\n description: |\n Creates a new corpus by merging multiple corpora.\n responses:\n '201':\n headers:\n Location:\n schema:\n type: string\n description: |\n URI of the newly created corpus.\n Example: /corpora/532352f85e2150.3a073450\n description: |\n The ID of the newly created corpus.\n content:\n application/json:\n schema:\n type: object\n properties:\n id:\n type: string\n description: The new corpus ID.\n example:\n id: 532352f85e2150.3a073450\n '400':\n $ref: '#/components/responses/400BadRequest'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n requestBody:\n $ref: '#/components/requestBodies/mergeCorpora'\n /engines:\n get:\n deprecated: true\n tags:\n - Engines\n summary: List engines\n description: |\n Returns a collection of engines, optionally filtered.\n\n If the license allows the use of stock engines, and both the `source` and `target` parameters are provided,\n the response may also continue an entry with the ID `stock`.\n parameters:\n - $ref: '#/components/parameters/limit'\n - $ref: '#/components/parameters/offset'\n - $ref: '#/components/parameters/source'\n - $ref: '#/components/parameters/target'\n - $ref: '#/components/parameters/engineStatus'\n - $ref: '#/components/parameters/groups'\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/EngineCollection'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n post:\n deprecated: true\n tags:\n - Engines\n summary: Create a new engine\n security:\n - basic: []\n requestBody:\n $ref: '#/components/requestBodies/createEngine'\n responses:\n '201':\n description: Created\n headers:\n Location:\n schema:\n type: string\n description: |\n URI of the newly created engine.\n Example: /engines/11\n content:\n application/json:\n schema:\n type: object\n properties:\n id:\n type: integer\n description: The new engine ID.\n example:\n id: 11\n '400':\n $ref: '#/components/responses/400BadRequest'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '402':\n description: Engine limit allowed by license reached.\n '403':\n $ref: '#/components/responses/403Forbidden'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n '/engines/{id}':\n parameters:\n - name: id\n in: path\n required: true\n schema:\n type: integer\n get:\n deprecated: true\n tags:\n - Engines\n summary: Show the details of an engine\n description: Returns a single engine.\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Engine'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n security:\n - basic: []\n patch:\n deprecated: true\n tags:\n - Engines\n summary: Update an engine\n responses:\n '200':\n $ref: '#/components/responses/200OK'\n '400':\n $ref: '#/components/responses/400BadRequest'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n requestBody:\n $ref: '#/components/requestBodies/updateEngine'\n delete:\n deprecated: true\n tags:\n - Engines\n summary: Delete an engine\n responses:\n '204':\n $ref: '#/components/responses/204NoContent'\n '400':\n $ref: '#/components/responses/400BadRequest'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n '/engines/{id}/train':\n parameters:\n - name: id\n in: path\n required: true\n schema:\n type: integer\n post:\n deprecated: true\n tags:\n - Engines\n summary: Train an engine\n description: |\n **Note:** An engine can only be trained if it is not being trained at the moment, i.e. it has the status `untrained`, `trained` or `changed`.\n The corpora included in the engine must exceed the required minimum volume.\n responses:\n '202':\n $ref: '#/components/responses/202Accepted'\n '400':\n $ref: '#/components/responses/400BadRequest'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '402':\n description: Training has been disabled because subscription has expired.\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n '409':\n $ref: '#/components/responses/409Conflict'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n '502':\n $ref: '#/components/responses/502BadGateway'\n '504':\n $ref: '#/components/responses/504GatewayTimeout'\n security:\n - basic: []\n '/engines/{id}/tune':\n parameters:\n - name: id\n in: path\n required: true\n schema:\n type: integer\n post:\n deprecated: true\n tags:\n - Engines\n summary: Tune an engine\n description: |\n **Note:** A stock+ engine can only be tuned if it is not being trained at the moment, i.e. it has the status `untrained`, `trained` or `changed`.\n\n A custom engine can only be tuned if engine's status is `changed`, the engine has been trained/tuned before, the use of the core corpora has changed, the use of the auxiliary and stock corpora haven't changed and the engine size is above the minimum threshold.\n responses:\n '202':\n $ref: '#/components/responses/202Accepted'\n '400':\n $ref: '#/components/responses/400BadRequest'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '402':\n description: Tuning has been disabled because subscription has expired.\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n '409':\n $ref: '#/components/responses/409Conflict'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n '502':\n $ref: '#/components/responses/502BadGateway'\n '504':\n $ref: '#/components/responses/504GatewayTimeout'\n security:\n - basic: []\n '/engines/{id}/cancel':\n parameters:\n - name: id\n in: path\n required: true\n schema:\n type: integer\n post:\n tags:\n - Engines\n summary: Cancel the training of an engine\n responses:\n '204':\n $ref: '#/components/responses/204NoContent'\n '400':\n $ref: '#/components/responses/400BadRequest'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n /groups:\n get:\n tags:\n - Groups\n summary: List groups\n description: Returns a collection of groups the user is member of.\n parameters:\n - $ref: '#/components/parameters/permissions'\n - $ref: '#/components/parameters/limit'\n - $ref: '#/components/parameters/offset'\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GroupCollection'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n /groups/{id}:\n get:\n tags:\n - Groups\n summary: Show the details of a group\n description: Returns a single group.\n parameters:\n - name: id\n in: path\n description: group ID\n required: true\n schema:\n type: integer\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Group'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n /languages:\n get:\n tags:\n - Languages\n summary: List languages\n description: Returns a collection of languages.\n parameters:\n - $ref: '#/components/parameters/limit'\n - $ref: '#/components/parameters/offset'\n - $ref: '#/components/parameters/languageCode'\n - $ref: '#/components/parameters/languageTool'\n - $ref: '#/components/parameters/languageUsage'\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/LanguageCollection'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n /languages/{id}:\n get:\n tags:\n - Languages\n summary: Show the details of a language\n description: Returns a single language.\n parameters:\n - name: id\n in: path\n description: language ID\n required: true\n schema:\n type: string\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Language'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n security:\n - basic: []\n /projects:\n get:\n tags:\n - Projects\n summary: List projects\n description: Returns a collection of projects, optionally filtered.\n parameters:\n - $ref: '#/components/parameters/limitmax100'\n - $ref: '#/components/parameters/offset'\n - $ref: '#/components/parameters/source'\n - $ref: '#/components/parameters/target'\n - $ref: '#/components/parameters/groups'\n - $ref: '#/components/parameters/engineId'\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ProjectCollection'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n post:\n deprecated: true\n tags:\n - Projects\n summary: Create a new project\n responses:\n '201':\n description: Project created\n headers:\n Location:\n schema:\n type: string\n description: |\n URI of the newly created project.\n Example: /projects/53\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Project'\n '400':\n $ref: '#/components/responses/400BadRequest'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n requestBody:\n $ref: '#/components/requestBodies/createProject'\n '/projects/{id}':\n get:\n deprecated: true\n tags:\n - Projects\n summary: Show the details of a project\n description: Returns a single project.\n parameters:\n - name: id\n in: path\n description: Project ID\n required: true\n schema:\n type: integer\n responses:\n '200':\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Project'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n security:\n - basic: []\n patch:\n deprecated: true\n tags:\n - Projects\n summary: Update a project\n parameters:\n - name: id\n in: path\n description: The ID of the project to be updated.\n required: true\n schema:\n type: integer\n responses:\n '200':\n description: Project updated\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Project'\n '400':\n $ref: '#/components/responses/400BadRequest'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n requestBody:\n $ref: '#/components/requestBodies/updateProject'\n delete:\n deprecated: true\n tags:\n - Projects\n summary: Delete a project\n parameters:\n - name: id\n in: path\n description: The ID of the project to be deleted.\n required: true\n schema:\n type: integer\n responses:\n '200':\n $ref: '#/components/responses/200OK'\n '400':\n $ref: '#/components/responses/400BadRequest'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n '/projects/{id}/clone':\n post:\n deprecated: true\n tags:\n - Projects\n summary: Clone a project\n description: |\n **Note:** The cloned project must have an engine assigned to it, as it is not allowed to create a new project without an engine.\n parameters:\n - name: id\n in: path\n description: The ID of the project to be cloned.\n required: true\n schema:\n type: integer\n responses:\n '201':\n description: Created\n headers:\n Location:\n schema:\n type: string\n description: |\n URI of the cloned project.\n Example: /projects/93\n '400':\n $ref: '#/components/responses/400BadRequest'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n requestBody:\n $ref: '#/components/requestBodies/cloneProject'\n /stock-engines:\n get:\n tags:\n - Stock engines\n security:\n - basic: []\n summary: List stock engines\n description: |\n Returns a list of available stock engines, optionally filtered.\n\n Required permission: `MANAGE_ENGINES|MANAGE_PROJECTS|SYSTEM_ADMINISTRATOR`\n parameters:\n - $ref: '#/components/parameters/source'\n - $ref: '#/components/parameters/target'\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/StockEngineCollection'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n /translation-files:\n get:\n deprecated: true\n tags:\n - Translation files\n summary: List translation files\n description: Returns a collection of translation files, optionally filtered.\n parameters:\n - $ref: '#/components/parameters/limitmax100'\n - $ref: '#/components/parameters/offset'\n - $ref: '#/components/parameters/source'\n - $ref: '#/components/parameters/target'\n - $ref: '#/components/parameters/projectId'\n - $ref: '#/components/parameters/groups'\n - $ref: '#/components/parameters/fileStatus'\n responses:\n '200':\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/TranslationFileCollection'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n post:\n deprecated: true\n tags:\n - Translation files\n summary: Create a new translation file entity as a prerequisite before uploading\n description: |\n This is the first of the required two steps for uploading a new translation file.\n The second step is `POST /translation-files/{id}`\n responses:\n '201':\n headers:\n Location:\n schema:\n type: string\n description: |\n URI of the newly created translation file.\n Example: /translation-files/532352e85e0049.37076692\n description: |\n The ID of the newly created translation file.\n The next step **must** be `POST translation-files/{id}`\n content:\n application/json:\n schema:\n type: object\n properties:\n id:\n type: string\n description: The new translation file ID.\n example:\n id: 532352e85e0049.37076692\n '400':\n $ref: '#/components/responses/400BadRequest'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n security:\n - basic: []\n requestBody:\n $ref: '#/components/requestBodies/createTranslationFile'\n '/translation-files/{id}':\n parameters:\n - name: id\n in: path\n required: true\n schema:\n type: string\n get:\n deprecated: true\n tags:\n - Translation files\n summary: Show the details of a translation file\n description: Returns a single translation file.\n responses:\n '200':\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/TranslationFile'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n security:\n - basic: []\n post:\n deprecated: true\n tags:\n - Translation files\n summary: Upload a translation file\n description: |\n This is the second of the required two steps for uploading a new translation file.\n The first step is `POST /translation-files`.\n\n Accepted CAT tool file formats:\n * `.mqxliff`/`.mqxlz` from memoQ\n * `.mxliff` from Memsource\n * `.sdlxliff` from SDL Trados Studio\n * `.txlf` from Wordfast\n * `.xliff`/`.xlf` from Smartcat, XTM, translate5, Wordbee, SDL (Idiom) WorldServer, or any standard XLIFF 1.2\n * `.xlz` from SDL (Idiom) WorldServer\n responses:\n '201':\n description: Created\n headers:\n Location:\n schema:\n type: string\n description: |\n URI of the newly created translation file.\n Example: /translation-files/532352e85e0049.37076692\n '400':\n $ref: '#/components/responses/400BadRequest'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n requestBody:\n required: true\n content:\n text/plain:\n schema:\n type: string\n example: [...]\n delete:\n deprecated: true\n tags:\n - Translation files\n summary: Delete a translation file\n responses:\n '200':\n description: Success\n '400':\n description: Translation file cannot be deleted\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n '/translation-files/{id}/download':\n get:\n deprecated: true\n tags:\n - Translation files\n summary: Download a translation file\n description: Returns a translation file.\n parameters:\n - name: id\n in: path\n required: true\n schema:\n type: string\n - name: state\n in: query\n description: Original or translated state of the file.\n required: true\n schema:\n type: string\n enum:\n - original\n - translated\n - name: zip\n in: query\n description: |\n Whether or not to zip the file before downloading.\n\n Defaults to 'false'.\n required: false\n schema:\n type: boolean\n default: false\n responses:\n '200':\n description: A translation file, optionally zipped.\n content:\n application/octet-stream:\n schema:\n type: string\n example: >-\n [file content]\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n '/translation-files/{id}/translate':\n parameters:\n - name: id\n in: path\n required: true\n schema:\n type: string\n post:\n deprecated: true\n tags:\n - Translation files\n summary: Translate a file\n description: |\n **Note:** A file can only be translated if the engine assigned for the project is ready for translation, i.e. it has the status `trained` or `changed`.\n\n If the engine is not published, it can be used for document translation only by users with at least one of the following permissions:\n - `MANAGE_ENGINES` for the group the engine belongs to\n - `SYSTEM_ADMINISTRATOR`\n responses:\n '200':\n $ref: '#/components/responses/200OK'\n '400':\n $ref: '#/components/responses/400BadRequest'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '402':\n description: Translation has been disabled because subscription has expired.\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n '409':\n $ref: '#/components/responses/409Conflict'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n '502':\n $ref: '#/components/responses/502BadGateway'\n '504':\n $ref: '#/components/responses/504GatewayTimeout'\n security:\n - basic: []\n '/translation-files/{id}/cancel':\n parameters:\n - name: id\n in: path\n required: true\n schema:\n type: string\n post:\n tags:\n - Translation files\n summary: Cancel the translation of a file\n description: |\n Translations can only be cancelled if they are still in the queue.\n responses:\n '200':\n $ref: '#/components/responses/200OK'\n '400':\n $ref: '#/components/responses/400BadRequest'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n /users:\n get:\n tags:\n - Users\n summary: List users\n description: Returns a collection of all users in the system.\n responses:\n '200':\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UserCollection'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '500':\n $ref: '#/components/responses/500InternalServerError'\n security:\n - basic: []\n '/users/{id}':\n get:\n tags:\n - Users\n summary: Show the details of a user\n description: Returns a single user.\n parameters:\n - name: id\n in: path\n description: user ID\n required: true\n schema:\n type: integer\n responses:\n '200':\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/User'\n '401':\n $ref: '#/components/responses/401Unauthorized'\n '403':\n $ref: '#/components/responses/403Forbidden'\n '404':\n $ref: '#/components/responses/404NotFound'\n security:\n - basic: []\ncomponents:\n schemas:\n Corpus:\n type: object\n required:\n - id\n - name\n - source_language\n - target_language\n - format\n - segment_count\n - source_wordcount\n - target_wordcount\n - source_character_count\n - target_character_count\n - groups\n properties:\n id:\n type: string\n name:\n type: string\n source_language:\n description: Source language\n type: string\n target_language:\n description: Target language\n type: string\n format:\n description: Corpus format\n type: string\n enum:\n - csv-comma\n - csv-memoq\n - csv-semicolon\n - tsv\n - tmx\n - tbx\n - xliff-memoq\n - xliff-memsource\n - xliff-sdl\n - xliff-smartcat\n - xliff-translate5\n - xliff-wordbee\n - xliff-xtm\n - xliff\n segment_count:\n type: integer\n source_wordcount:\n type: integer\n target_wordcount:\n type: integer\n source_character_count:\n type: integer\n target_character_count:\n type: integer\n groups:\n type: array\n items:\n type: integer\n engines:\n type: array\n items:\n type: integer\n metadata:\n $ref: '#/components/schemas/CorpusMetadata'\n example:\n id: 5a0ba1267f0571.04642701\n name: English to German DGT.tmx\n source_language: en\n target_language: de-de\n format: tmx\n segment_count: 145952\n source_wordcount: 2819806\n target_wordcount: 3120176\n source_character_count: 24235334\n target_character_count: 29194748\n groups: [1, 3]\n engines: [2, 8, 14]\n metadata:\n domain: \"legal\"\n subject: \"EU treaties\"\n client: \"Very Important Client\"\n project: \"\"\n description: \"created by DGT\"\n CorpusCollection:\n type: array\n items:\n $ref: '#/components/schemas/Corpus'\n example:\n - id: 5a0ba1267f0571.04642701\n name: English to German DGT.tmx\n source_language: en\n target_language: de-de\n format: tmx\n segment_count: 145952\n source_wordcount: 2819806\n target_wordcount: 3120176\n source_character_count: 24819803\n target_character_count: 40481457\n groups: [1, 3]\n engines: [2, 8, 14]\n metadata:\n domain: \"legal\"\n subject: \"EU treaties\"\n client: \"Very Important Client\"\n project: \"\"\n description: \"created by DGT\"\n - id: 5b04a7263fa5c1.a4444792\n name: Dutch to French DGT.tmx\n source_language: nl\n target_language: fr\n format: tmx\n segment_count: 246058\n source_wordcount: 4241985\n target_wordcount: 4924251\n source_character_count: 39240885\n target_character_count: 45437654\n groups: [3]\n engines: [4, 7]\n metadata:\n domain: \"legal\"\n subject: \"EU treaties\"\n client: \"Another Very Important Client\"\n project: \"Communiqués 2017\"\n description: \"created by DGT\"\n createCorpus:\n type: object\n required:\n - name\n - source-language\n - target-language\n - groups\n properties:\n name:\n type: string\n description: |\n The file name of the corpus that is going to be uploaded, **including** the extension.\n source-language:\n type: string\n target-language:\n type: string\n groups:\n type: array\n items:\n type: integer\n metadata:\n $ref: '#/components/schemas/CorpusMetadata'\n example:\n name: New corpus.tmx\n source-language: en\n target-language: es\n groups: [1, 2]\n metadata:\n domain: \"legal\"\n subject: \"EU treaties\"\n client: \"Very Important Client\"\n project: \"Communiqués 2017\"\n description: \"created by DGT\"\n updateCorpus:\n type: object\n properties:\n name:\n type: string\n groups:\n type: array\n items:\n type: integer\n metadata:\n $ref: '#/components/schemas/CorpusMetadata'\n example:\n name: Changed corpus name\n groups: [1, 2, 3]\n metadata:\n domain: \"finance\"\n description: \"curated by Susan from accounting\"\n mergeCorpora:\n type: object\n required:\n - corpora\n - name\n - groups\n properties:\n corpora:\n type: array\n items:\n type: string\n description: |\n The IDs of all corpora to be merged.\n name:\n type: string\n groups:\n type: array\n items:\n type: integer\n metadata:\n $ref: '#/components/schemas/CorpusMetadata'\n example:\n corpora: [\"550b63267f9971.01642883\", \"590ba1388f0571.04616201\", \"5a0c80267f0571.21642798\"]\n name: Newly merged megacorpus\n groups: [2]\n CorpusMetadata:\n type: object\n properties:\n domain:\n type: string\n subject:\n type: string\n client:\n type: string\n project:\n type: string\n description:\n type: string\n Engine:\n type: object\n required:\n - id\n - name\n - source_language\n - target_language\n - group\n - status\n - published\n - ready\n - version\n - stock_engine\n - corpora\n properties:\n id:\n type: integer\n name:\n type: string\n example: Engine 1\n source_language:\n type: string\n example: en\n target_language:\n type: string\n example: it\n group:\n type: integer\n example: 1\n status:\n type: string\n description: Training status\n enum:\n - changed\n - empty\n - error\n - queued\n - trained\n - training\n published:\n type: boolean\n ready:\n type: boolean\n version:\n type: string\n nullable: true\n example: 3.5.5\n stock_engine:\n type: boolean\n description: Whether or not the engine is based on a stock engine\n corpora:\n $ref: '#/components/schemas/EngineCorpora'\n EngineCollection:\n type: array\n items:\n $ref: '#/components/schemas/Engine'\n EngineCorpora:\n type: object\n description: An engine cannot contain more than 500 corpora in total.\n required:\n - core\n - auxiliary\n - stock\n properties:\n auxiliary:\n type: array\n items:\n type: string\n example: ['51fc7ea3fa889.a0027797', '54018363fa5c1.a44227af']\n core:\n type: array\n items:\n type: string\n example: ['5b04a7263fa509.a4444794', '5b0412363fa5c1.a4354792']\n stock:\n type: boolean\n createEngine:\n type: object\n required:\n - name\n - source-language\n - target-language\n - group\n - corpora\n properties:\n name:\n type: string\n source-language:\n type: string\n target-language:\n type: string\n group:\n type: integer\n corpora:\n $ref: '#/components/schemas/EngineCorpora'\n stock-engine:\n type: boolean\n description: Create a new customised engine based on a stock engine.\n example:\n name: Engine 1\n source-language: en\n target-language: de\n group: 1\n corpora:\n core: ['5223a7263fa509.a4644764', '5b0412663fa5c1.a4356792']\n auxiliary: ['51fc7e83fa88c.a0827897', '54018368fa5c1.a46727af']\n stock: false\n stock-engine: false\n updateEngine:\n type: object\n properties:\n name:\n type: string\n corpora:\n $ref: '#/components/schemas/EngineCorpora'\n example:\n name: Changed engine name\n corpora:\n core: ['5223a7263fa509.a4644764']\n auxiliary: ['51fc7e83fa88c.a0827897', '54018368fa5c1.a46727af', '5b12663f5ba5c1.a4e678e8']\n stock: true\n Error:\n type: object\n properties:\n error:\n type: string\n example: \"Error message.\"\n required:\n - error\n Group:\n type: object\n required:\n - id\n - name\n - created_at\n properties:\n id:\n type: integer\n example: 1\n name:\n type: string\n example: Default\n created_at:\n type: string\n format: 'date-time'\n example: '2019-03-09T11:08:38+00:00'\n GroupCollection:\n type: array\n items:\n $ref: '#/components/schemas/Group'\n example:\n - id: 1\n name: Group 1\n created_at: '2019-03-09T11:08:38+00:00'\n - id: 2\n name: Group 2\n created_at: '2019-07-10T10:42:35+00:00'\n Language:\n type: object\n required:\n - id\n - memoq\n - xtm\n properties:\n id:\n type: string\n memoq:\n type: string\n xtm:\n type: string\n example:\n id: en-us\n memoq: eng-US\n xtm: en_US\n LanguageCollection:\n type: array\n items:\n $ref: '#/components/schemas/Language'\n example:\n - id: en-us\n memoq: eng-US\n xtm: en_US\n - id: hu-hu\n memoq: hun\n xtm: hu_HU\n Project:\n type: object\n required:\n - id\n - name\n - source_language\n - target_language\n - group\n - engine_id\n - stock_engine_id\n - stock_engine_uuid\n - status\n - created_at\n properties:\n id:\n type: integer\n example: 1\n name:\n type: string\n example: Project 1\n source_language:\n type: string\n example: en\n target_language:\n type: string\n example: fr-ca\n group:\n type: integer\n example: 3\n engine_id:\n type: integer\n example: 10\n nullable: true\n stock_engine_id:\n type: integer\n example: 15\n nullable: true\n deprecated: true\n stock_engine_uuid:\n description: Stock engine UUID\n nullable: true\n type: string\n example: 77d3a117-43bd-401c-ab8b-75552118b2c5\n status:\n type: string\n enum:\n - empty\n - error\n - new\n - partially_error\n - partially_queued\n - partially_translated\n - partially_translating\n - queued\n - translated\n - translating\n cat_server_type:\n type: string\n description: Type of CAT tool server to associate the project with.\n enum:\n - memoq\n - memsource\n - smartcat\n - xtm\n cat_server_id:\n type: integer\n description: CAT tool server connection ID as stored in Globalese.\n example: 2\n cat_project_id:\n oneOf:\n - type: integer\n - type: string\n description: CAT tool project ID as stored on the CAT tool server.\n example: 5987c27a-da1e-4060-b08d-00aa6dbd0bba\n created_at:\n type: string\n format: 'date-time'\n example: '2019-03-09T11:08:38+00:00'\n updated_at:\n type: string\n format: 'date-time'\n example: '2019-11-16T18:33:02+00:00'\n ProjectCollection:\n type: array\n items:\n $ref: '#/components/schemas/Project'\n createProject:\n type: object\n required:\n - name\n - source-language\n - target-language\n - group\n - engine\n properties:\n name:\n type: string\n example: Project 1\n source-language:\n type: string\n example: en\n target-language:\n type: string\n example: fr-ca\n group:\n type: integer\n example: 3\n engine:\n description: An engine ID, or the string `stock` to use the stock engine for the language combination (if available).\n oneOf:\n - type: integer\n - type: string\n example: 10\n cat-server-id:\n type: integer\n description: CAT tool server connection ID as stored in Globalese.\n example: 2\n cat-project-id:\n oneOf:\n - type: integer\n - type: string\n description: CAT tool project ID as stored on the CAT tool server.\n example: 5987c27a-da1e-4060-b08d-00aa6dbd0bba\n cloneProject:\n type: object\n required:\n - name\n properties:\n name:\n type: string\n example:\n name: Cloned project\n updateProject:\n type: object\n properties:\n name:\n type: string\n example: Updated project name\n engine:\n oneOf:\n - type: integer\n - type: string\n example: 15\n cat-server-id:\n type: integer\n description: CAT tool server connection ID as stored in Globalese.\n example: 2\n cat-project-id:\n oneOf:\n - type: integer\n - type: string\n description: CAT tool project ID as stored on the CAT tool server.\n example: 5987c27a-da1e-4060-b08d-00aa6dbd0bba\n StockEngineCollection:\n type: array\n items:\n $ref: '#/components/schemas/StockEngine'\n StockEngine:\n type: object\n required:\n - source_language\n - target_language\n properties:\n source_language:\n type: string\n example: en\n target_language:\n type: string\n example: it\n TranslationFile:\n type: object\n required:\n - id\n - name\n - source_language\n - target_language\n - project\n - segment_count\n - wordcount\n properties:\n id:\n type: string\n name:\n type: string\n source_language:\n type: string\n target_language:\n type: string\n project:\n type: integer\n status:\n type: string\n description: Translation status\n enum:\n - empty\n - new\n - queued\n - translating\n - translated\n segment_count:\n $ref: '#/components/schemas/SegmentCount'\n wordcount:\n $ref: '#/components/schemas/WordCount'\n example:\n id: 532352e85e0049.37076692\n name: File 1.mqxliff\n source_language: pt-pt\n target_language: it\n project: 5\n status: translated\n segment_count:\n total: 32\n new: 16\n globalese: 16\n wordcount:\n total: 128\n new: 64\n globalese: 64\n TranslationFileCollection:\n type: array\n items:\n $ref: '#/components/schemas/TranslationFile'\n example:\n - id: 532352e85e0049.37076692\n name: File 1.mqxliff\n source_language: pt-pt\n target_language: it\n project: 5\n status: translated\n segment_count:\n total: 32\n new: 16\n globalese: 16\n wordcount:\n total: 128\n new: 64\n globalese: 64\n - id: 53aadc4487a8a9.27387893\n name: File 2.sdlxliff\n source_language: es-es\n target_language: en-us\n project: 6\n status: queued\n segment_count:\n total: 332\n new: 146\n globalese: 0\n wordcount:\n total: 1728\n new: 654\n globalese: 0\n - id: 53aadc4c08b863.74000237\n name: File 3.mxliff\n source_language: es-es\n target_language: en-us\n project: 6\n status: new\n segment_count:\n total: 376\n new: 3358\n globalese: 0\n wordcount:\n total: 6635\n new: 36889\n globalese: 0\n createTranslationFile:\n type: object\n required:\n - project\n - name\n - source-language\n - target-language\n properties:\n project:\n type: integer\n name:\n type: string\n description: |\n **Note:** It is important to include the correct extension.\n Globalese needs this information to decide how to parse a file when it is uploaded in a `POST translation-files/{id}` request.\n source-language:\n type: string\n target-language:\n type: string\n example:\n project: 3\n name: New file.xliff\n source-language: en\n target-language: es\n SegmentCount:\n type: object\n required:\n - total\n - new\n - globalese\n properties:\n total:\n type: integer\n new:\n type: integer\n globalese:\n type: integer\n WordCount:\n type: object\n required:\n - total\n - new\n - globalese\n properties:\n total:\n type: integer\n new:\n type: integer\n globalese:\n type: integer\n User:\n type: object\n required:\n - id\n - username\n - name\n - email\n - groups\n - active\n properties:\n id:\n type: integer\n active:\n type: boolean\n email:\n type: string\n groups:\n type: array\n items:\n type: integer\n name:\n type: string\n username:\n type: string\n example:\n id: 1\n active: true\n groups: [1, 3, 4]\n email: john.doe@globalese.com\n name: John Doe\n username: john.doe\n UserCollection:\n type: array\n items:\n $ref: '#/components/schemas/User'\n example:\n - id: 1\n active: true\n email: john.doe@globalese.com\n groups: [1, 3, 4]\n name: John Doe\n username: john.doe\n - id: 2\n active: true\n email: jane.doe@globalese.com\n groups: [1, 3]\n name: Jane Doe\n username: jane.doe\n - id: 3\n active: true\n email: andrew.smith@globalese.com\n groups: [3]\n name: andrew.smith\n username: Andrew Smith\n parameters:\n engineId:\n name: engine\n in: query\n description: |\n Engine ID for filtering.\n Examples: `1`, `2`\n schema:\n type: integer\n engineStatus:\n name: status\n in: query\n description: Engine status.\n schema:\n type: string\n enum:\n - changed\n - empty\n - error\n - queued\n - trained\n - training\n fileStatus:\n name: status\n in: query\n description: Translation file status.\n schema:\n type: string\n enum:\n - empty\n - new\n - queued\n - queueing\n - translating\n - translated\n groups:\n name: groups\n in: query\n description: |\n Group ID(s) for filtering.\n Examples: `1`, `1,3,5`\n schema:\n type: array\n items:\n type: integer\n minItems: 1\n languageCode:\n name: code\n in: query\n description: |\n Language code as used by a CAT tool.\n Must be used together with `tool`.\n example: eng\n schema:\n type: string\n languageTool:\n name: tool\n in: query\n description: |\n CAT tool for looking up a language code in Globalese.\n Must be used together with `code`.\n example: memoq\n schema:\n type: string\n enum:\n - memoq\n - xtm\n languageUsage:\n name: usage\n in: query\n description: |\n Filter for languages used in corpora, engines or projects.\n\n Optionally, the `:source` or `:target` modifier may be appended to the parameter value to filter for languages used on the source or target language side only.\n\n `usage=corpora:source` will return a list of languages used as corpus source languages.\n\n `usage=engines` will return a list of languages used as engine languages, either source or target.\n schema:\n type: string\n enum:\n - archived_engines\n - corpora\n - engines\n - projects\n limit:\n name: limit\n in: query\n description: |\n Limit for results. *May* be used together with `offset`.\n Examples: `25`, `50`\n schema:\n type: integer\n limitmax100:\n name: limit\n in: query\n description: |\n Limit for results. It cannot be greater than 100. *May* be used together with `offset`.\n\n Examples: `25`, `50`\n\n If not provided, it will automatically be set to 100.\n schema:\n type: integer\n metadataClient:\n name: client\n in: query\n description: |\n Client metadata descriptor.\n Examples: `Very Important Client`\n schema:\n type: string\n metadataDescription:\n name: description\n in: query\n description: |\n Description metadata descriptor.\n Examples: `used for 2018 campaign`\n schema:\n type: string\n metadataDomain:\n name: domain\n in: query\n description: |\n Domain metadata descriptor.\n Examples: `legal`\n schema:\n type: string\n metadataProject:\n name: project\n in: query\n description: |\n Project metadata descriptor.\n Examples: `0192 EC Project`\n schema:\n type: string\n metadataSubject:\n name: subject\n in: query\n description: |\n Subject metadata descriptor.\n Examples: `EU treaties`\n schema:\n type: string\n offset:\n name: offset\n in: query\n description: |\n Offset to start query from. **Must** be used together with `limit`.\n Examples: `50`, `100`\n schema:\n type: integer\n permissions:\n name: permissions\n in: query\n description: |\n Filter results by one or more permissions the user has in a group.\n\n Examples: `corpora`, `engines,projects`\n schema:\n type: string\n enum:\n - corpora\n - engines\n - projects\n projectId:\n name: project\n in: query\n description: |\n Project ID.\n Examples: `1`, `2`\n schema:\n type: string\n source:\n name: source\n in: query\n description: |\n Source language.\n Examples: `en`, `fr`\n schema:\n type: string\n target:\n name: target\n in: query\n description: |\n Target language.\n Examples: `en`, `fr`\n schema:\n type: string\n requestBodies:\n createCorpus:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/createCorpus'\n required: true\n updateCorpus:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/updateCorpus'\n required: true\n mergeCorpora:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/mergeCorpora'\n required: true\n createEngine:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/createEngine'\n required: true\n updateEngine:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/updateEngine'\n required: true\n createProject:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/createProject'\n required: true\n cloneProject:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/cloneProject'\n required: true\n updateProject:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/updateProject'\n required: true\n createTranslationFile:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/createTranslationFile'\n required: true\n responses:\n 200OK:\n description: Success\n 202Accepted:\n description: Accepted\n 204NoContent:\n description: No Content\n 400BadRequest:\n description: Bad Request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n 401Unauthorized:\n description: Unauthorized\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n 403Forbidden:\n description: Insufficient permissions\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n 404NotFound:\n description: Entity not found (invalid ID)\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n 409Conflict:\n description: Conflict\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n 500InternalServerError:\n description: Internal server error while processing the request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n 502BadGateway:\n description: Bad Gateway\n 504GatewayTimeout:\n description: Gateway Timeout\n securitySchemes:\n basic:\n type: http\n description: Username and corresponding API key\n scheme: basic\n"}},"macroMetadata":{"macroId":{"value":"0f6a0efe-f4e6-433d-864c-d788c0029ed4"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://confluence-open-api.oharagroup.net/images/open-api-icon.png"}}],"title":"Open API (Swagger) Documentation"}},"localId":"107cead6-a123-41a8-9053-76e6d87f5457"}}],"version":1}