{ "openapi": "3.1.0", "info": { "title": "Trados Cloud Platform API", "description": "The Trados Cloud Platform API", "version": "1.0", "contact": {}, "x-extensions": { "x-default-field": { "description": "When true, this property is included in the response by default — even when the `fields` query parameter is omitted. Properties without this annotation are only returned when explicitly requested via `fields`. The `id` property is always returned regardless." } } }, "servers": [ { "url": "https://api.eu.cloud.trados.com/public-api/v1", "description": "EU Region Server" }, { "url": "https://api.ca.cloud.trados.com/public-api/v1", "description": "CA Region Server" } ], "tags": [ { "name": "Account", "description": "Account" }, { "name": "Connected AI", "description": "Connected AI" }, { "name": "Custom Field", "description": "Custom Field" }, { "name": "Customer", "description": "Customer" }, { "name": "File", "description": "File" }, { "name": "File Processing Configuration", "description": "File Processing Configuration" }, { "name": "Folder", "description": "Folder" }, { "name": "Group", "description": "Group" }, { "name": "Integration", "description": "Integration" }, { "name": "Language", "description": "Language" }, { "name": "Language Processing", "description": "Language Processing" }, { "name": "Machine Translation", "description": "Machine Translation" }, { "name": "PerfectMatch Mapping", "description": "PerfectMatch Mapping" }, { "name": "Pricing Model", "description": "Pricing Model" }, { "name": "Project", "description": "Project" }, { "name": "Project Group", "description": "Project Group" }, { "name": "Project Template", "description": "Project Template" }, { "name": "Public Keys", "description": "Public Keys" }, { "name": "Quote", "description": "Quote" }, { "name": "Quote Template", "description": "Quote Template" }, { "name": "Rate Limits", "description": "Rate Limits" }, { "name": "Role and Permission", "description": "Role and Permission" }, { "name": "Schedule Template", "description": "Schedule Template" }, { "name": "Source File", "description": "Source File" }, { "name": "Target File", "description": "Target File" }, { "name": "Task", "description": "Task" }, { "name": "Task Type", "description": "Task Type" }, { "name": "Termbase", "description": "Termbase" }, { "name": "Termbase Export", "description": "Termbase Export" }, { "name": "Termbase Import", "description": "Termbase Import" }, { "name": "Termbase Template", "description": "Termbase Template" }, { "name": "TQA Profile", "description": "TQA Profile" }, { "name": "Translation", "description": "Translation" }, { "name": "Translation Domain", "description": "Translation Domain" }, { "name": "Translation Engine", "description": "Translation Engine" }, { "name": "Translation Memory", "description": "Translation Memory" }, { "name": "Translation Memory Export", "description": "Translation Memory Export" }, { "name": "Translation Memory Import", "description": "Translation Memory Import" }, { "name": "User", "description": "User" }, { "name": "Vendor", "description": "Vendor." }, { "name": "Workflow", "description": "Workflow" } ], "paths": { "/accounts": { "get": { "tags": [ "Account" ], "summary": "List my Accounts", "description": "Retrieves the accounts the authenticated user is part of. \n\n> For service users only the account where the user is defined is returned.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-my-accounts-response" }, "examples": { "ListAccountsWithDefaultFields": { "value": { "itemCount": 2, "items": [ { "id": "test-account-id-1", "name": "test-account-name-1" }, { "id": "test-account-id-1", "name": "test-account-name-2" } ] } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" }, "examples": { "Unauthorized": { "value": { "message": "test-unauthorized-error-message", "errorCode": "test-unauthorized-error-code", "name": "test-unauthorized-error-name", "value": "test-unauthorized-error-value", "details": [ { "name": "test-unauthorized-error-details-message", "code": "test-unauthorized-error-details-code", "value": "test-unauthorized-error-details-value" } ] } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListMyAccounts" } }, "/applications": { "post": { "summary": "Create Application", "tags": [ "Integration" ], "responses": { "201": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application" } } } }, "400": { "description": "Error codes:\r\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\r\n* \"maxSize\": The maximum size was exceeded for the value mentioned in the \"name\" field\r\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\r\n", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "CreateApplication", "description": "Creates a new integration application.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-create-request" } } } }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ] }, "get": { "summary": "List Applications", "tags": [ "Integration" ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-applications-response" } } } }, "400": { "description": "Error codes:\r\n* \"invalid\": Invalid input in the query parameter mentioned in the \"name\" field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "ListApplications", "description": "Retrieves a list of applications the authenticated user has access to.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" } ] } }, "/applications/{applicationId}": { "parameters": [ { "$ref": "#/components/parameters/applicationId" } ], "put": { "summary": "Update Application", "tags": [ "Integration" ], "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\r\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\r\n* \"notFound\": the resource could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "UpdateApplication", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "description": "Updates an integration application.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application-update-request" } } } } }, "get": { "summary": "Get Application", "tags": [ "Integration" ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/application" } } } }, "400": { "description": "Error codes:\r\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\r\n* \"notFound\": the resource could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "GetApplication", "description": "Retrieves an integration application by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ] }, "delete": { "summary": "Delete Application", "tags": [ "Integration" ], "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\r\n* \"notFound\": The resource could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "DeleteApplication", "description": "Deletes an integration application.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ] } }, "/connected-ai/llm-configurations": { "get": { "summary": "List LLM Configurations", "tags": [ "Connected AI" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-llm-configurations-response" } } } }, "400": { "description": "\"invalid\": Invalid input in the query parameter mentioned in the \"name\" field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "ListLlmConfigurations", "description": "List the account configured Large Language Models.", "parameters": [ { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/fields" } ] } }, "/customers/{customerId}": { "put": { "tags": [ "Customer" ], "summary": "Update Customer", "description": "Updates a customer by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer-update-request" } } }, "required": true }, "responses": { "204": { "description": "No Content\n", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes: \n* “invalid”: Invalid input in “name” field on the error response.\n* \"deleted\": Some of the selected values were deleted and cannot be selected for some values of the \"customFields\" field.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.\n\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes: \n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"duplicate\": duplicate name of a customer is not allowed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "UpdateCustomer" }, "get": { "tags": [ "Customer" ], "summary": "Get Customer", "description": "Retrieves a customer by identifier.", "parameters": [ { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes: \n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.\n\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes: \n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetCustomer" }, "delete": { "tags": [ "Customer" ], "summary": "Delete Customer", "description": "Deletes a customer.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the customer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the customer could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"conflict\": there might be resources that are still `attached`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "DeleteCustomer" }, "parameters": [ { "$ref": "#/components/parameters/customerId" } ] }, "/customers": { "get": { "tags": [ "Customer" ], "summary": "List Customers", "description": "Retrieves a list of all the customers in an account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-customers-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListCustomers" }, "post": { "tags": [ "Customer" ], "summary": "Create Customer", "description": "Create customer in a tenant.\n\nFor adding a customer to a tenant the authenticated user must have 'Create Customer' permission.\n\nTo also create an account for the key contact, you need to have the specific entitlements.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer-create-request" } } }, "required": true }, "responses": { "201": { "description": "The customer was successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" }, "examples": { "minimal": { "value": { "id": "string" } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error responses:\n\n* “invalid”: invalid input specified in the error details.\n* \"empty\": empty input for required field specified in the error details.\n* \"maxSize\": The maximum size was exceeded for the value mentioned in the \"name\" field. \n* \"deleted\": Some of the selected values were deleted and cannot be selected for some values of the \"customFields\" field.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n\"forbidden\": \n- The authenticated user is not allowed to create a customer or if you intend to create the key contact account, you might not have sufficient permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "408": { "description": "Error responses:\n\n * \"timeout\": The request took longer than expected. The system might be overloaded. You might try again.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "409": { "description": "Error responses:\n\n* “duplicate”: duplicate value for the field mentioned in the error details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "CreateCustomer" } }, "/custom-field-definitions": { "get": { "summary": "List Custom Field Definitions", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-custom-field-definitions-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified. ", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListCustomFields", "description": "Retrieves a list of all the custom field definitions.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/resourceType" } ], "tags": [ "Custom Field" ] } }, "/custom-field-definitions/{customFieldDefinitionId}": { "get": { "summary": "Get Custom Field Definition", "tags": [ "Custom Field" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-field-definition" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to get the custom field definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetCustomField", "description": "Retrieves a Custom Field by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ] }, "parameters": [ { "$ref": "#/components/parameters/customFieldDefinitionId" } ] }, "/file-processing-configurations/{fileProcessingConfigurationId}": { "get": { "tags": [ "File Processing Configuration" ], "summary": "Get File Processing Configuration", "description": "Retrieves a file processing configuration by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file-processing-configuration" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": not allowed to read file processing configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes\n* \"notFound\": file processing configuration could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetFileProcessingConfiguration" }, "parameters": [ { "$ref": "#/components/parameters/fileProcessingConfigurationId" } ] }, "/file-processing-configurations": { "get": { "tags": [ "File Processing Configuration" ], "summary": "List File Processing Configurations", "description": "Retrieves a list of all the file processing configurations in an account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-file-processing-configurations-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": the requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListFileProcessingConfigurations" } }, "/file-processing-configurations/{fileProcessingConfigurationId}/file-type-settings/{fileTypeSettingId}": { "get": { "tags": [ "File Processing Configuration" ], "summary": "Get File Type Setting", "description": "Retrieves a file type setting by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file-type-setting" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": not allowed to read file type setting.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes\n* \"notFound\": file type setting could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetFileTypeSetting" }, "parameters": [ { "name": "fileProcessingConfigurationId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The file processing configuration identifier." }, { "schema": { "type": "string" }, "name": "fileTypeSettingId", "in": "path", "required": true, "description": "The file type setting identifier." } ] }, "/file-processing-configurations/{fileProcessingConfigurationId}/file-type-settings": { "get": { "tags": [ "File Processing Configuration" ], "summary": "List File Type Settings", "description": "Retrieves a list of all the file type settings in a file processing configuration.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-file-type-settings-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListFileTypeSettings" }, "parameters": [ { "schema": { "type": "string" }, "name": "fileProcessingConfigurationId", "in": "path", "required": true, "description": "The file processing configuration identifier." } ] }, "/files": { "post": { "summary": "Upload Zip File", "description": "Uploads an archive containing source files in `.zip` format, which will be extracted and used during project creation.\n\nStatus of the upload operation can be tracked using the [Poll Upload Zip File](#/operations/PollUploadZipFile) endpoint.\n\nOnce this Upload Zip File operation has finished extracting the files, they can be added to the desired project using the [Attach Source Files](#/operations/AddSourceFiles) endpoint. Alternatively, they can be used to [Request File Analysis](#/operations/RequestFileAnalysis) details like word counts and estimated costs.\n\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", "operationId": "UploadZipFile", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "format": "byte", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary", "description": "The .zip file to be uploaded (binary string). " } } } } }, "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file-upload-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error code “invalid” in case of:\n * Empty or missing file in request\n * Not valid multipart request\n * File parameter contains other extension than the one expected by specification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "tags": [ "File" ] }, "parameters": [] }, "/files/analysis": { "post": { "summary": "Request File Analysis", "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file-analysis-operation-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\r\n* “invalid”: Invalid input in the request body parameter mentioned in the “name” field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\r\n* \"forbidden\": the authenticated user is not allowed to read resource.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\r\n* \"notFound\": the resource could not be found.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "RequestFileAnalysis", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "fileIds", "sourceLanguage", "languageProcessingRuleId" ], "properties": { "fileIds": { "type": "array", "description": "The file identifiers for which the analysis will be performed.", "items": { "type": "string" } }, "sourceLanguage": { "$ref": "#/components/schemas/source-language-request", "description": "The source language." }, "languageProcessingRuleId": { "type": "string", "description": "The identifier of the Language Processing Rule to be used when determining word count." }, "fileProcessingConfigurationId": { "type": "string", "description": "The identifier of the File Processing Configuration to be used when converting a file for analysis.
\r\nA default configuration will be used if not specified." }, "quotingOptions": { "type": "object", "description": "Set these resources to calculate an estimated translation cost.", "required": [ "pricingModelId", "targetLanguages" ], "properties": { "pricingModelId": { "type": "string", "description": "The identifier of the Pricing Model to be used when calculating the cost." }, "targetLanguages": { "type": "array", "description": "The target languages for which the cost will be calculated.", "items": { "$ref": "#/components/schemas/target-language-request" } } } } } } } } }, "description": "This endpoint allows you to request the word count and an estimated cost for your files. \r\n\r\nUse the [Upload Zip File](#/operations/UploadZipFile) / [Poll Upload Zip File](#/operations/PollUploadZipFile) endpoints to upload your files and get the `fileIds`. Send these `fileIds` together with the `languageProcessingRuleId` and `sourceLanguage` to receive the word count.\r\n\r\nOptionally, send the `quotingOptions` object to receive the `estimatedCosts`.\r\n\r\nUse the [Poll File Analysis](#/operations/PollFileAnalysis) endpoint to monitor the operation and receive the analysis results.\r\n\r\n> File analysis results will be available for 24 hours after generation.", "tags": [ "File" ] }, "parameters": [] }, "/files/analysis/{operationId}": { "parameters": [ { "schema": { "type": "string" }, "name": "operationId", "in": "path", "required": true, "description": "The file analysis operation identifier." } ], "get": { "summary": "Poll File Analysis", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file-analysis-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\r\n* “invalid”: invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\r\n* \"forbidden\": the authenticated user is not allowed to read resource.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\r\n* \"notFound\": the quoting operation could not be found.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "PollFileAnalysis", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "description": "Monitor the [File Analysis](#/operations/RequestFileAnalysis) operation and receive the analysis results.\r\n\r\n> File analysis results will be available for 24 hours after generation.", "tags": [ "File" ] } }, "/files/{fileId}": { "parameters": [ { "schema": { "type": "string" }, "name": "fileId", "in": "path", "required": true, "description": "The uploaded file id" } ], "get": { "summary": "Poll Upload Zip File", "operationId": "PollUploadZipFile", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file-metadata-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read uploaded files.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the file could not be found by id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "description": "Monitors the unzipping operation for a previously uploaded archive and retrieves details about the extracted files.\r\n\r\nOnce the [Upload Zip File](#/operations/UploadZipFile) operation has finished extracting the files, they can be added to the desired project using the [Attach Source Files](#/operations/AddSourceFiles) endpoint.\r\n Alternatively, they can be used to [Request File Analysis](#/operations/RequestFileAnalysis) details like word counts and estimated costs.\r\n", "tags": [ "File" ] } }, "/folders/{folderId}": { "get": { "tags": [ "Folder" ], "summary": "Get Folder", "description": "Retrieves a folder by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/folder" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the folder.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the Folder could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetFolder" }, "parameters": [ { "$ref": "#/components/parameters/folderId" } ] }, "/folders/root": { "get": { "tags": [ "Folder" ], "summary": "Get Root Folder", "description": "Retrieves the Root folder in the account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/folder" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetRootFolder" } }, "/folders": { "get": { "tags": [ "Folder" ], "summary": "List Folders", "description": "Retrieves a list of all the folders in an account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "name": "name", "in": "query", "description": "Filter folders by name.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-folders-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "ListFolders" } }, "/groups/{groupId}": { "get": { "tags": [ "Group" ], "summary": "Get Group", "description": "Retrieves a group by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/group" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the Group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the Group could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetGroup" }, "put": { "tags": [ "Group" ], "summary": "Update Group", "description": "Updates a group. We recommend reading this page too [Updating data with PUT](../docs/Updating-data-with-PUT.html).", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/group-update-request" } } }, "required": true }, "responses": { "204": { "description": "No Content\n", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* “maxSize”: Character number or List size exceeds the maximum allowed value for the “name” field on the error response.\n* “minSize”: Character number or List size insufficient for the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the Group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the Group could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"conflict\": the request is conflicting with existing data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "UpdateGroup" }, "delete": { "tags": [ "Group" ], "summary": "Delete Group", "description": "Deletes a group by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "204": { "description": "No Content\n", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the Group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "DeleteGroup" }, "parameters": [ { "$ref": "#/components/parameters/groupId" } ] }, "/groups": { "get": { "tags": [ "Group" ], "summary": "List Groups", "description": "Retrieves a list of all the groups in an account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-groups-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListGroups" }, "post": { "tags": [ "Group" ], "summary": "Create Group", "description": "Creates a group. Group roles will take effect based on the location, where the group is being created. Read more at [How to use location and folders](../docs/How-to-use-location-and-folders.html).", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/group-create-request" } } }, "required": true }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/group" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the parameter mentioned in the “name” field on the error response.\n* “maxSize”: Character number or List size exceeds the maximum allowed value for the “name” field on the error response.\n* “minSize”: Character number or List size insufficient for the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed create a group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the Location/Roles could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"conflict\": the request is conflicting with existing data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "CreateGroup" } }, "/languages": { "get": { "tags": [ "Language" ], "summary": "List Languages", "description": "Retrieves a list of all the languages.\n\nThe supported values for language `type` filter are: \"all\", \"specific\" or \"neutral\".\\\nThe \"neutral\" languages are the generic languages, e.g.: en -> English.\\\nThe \"specific\" languages are the sub-languages, e.g.: en-150 -> English (Europe), en-us -> English (United States).", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "name": "languageCodes", "in": "query", "description": "Filter by language codes.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "name": "type", "in": "query", "description": "Filter by type.", "schema": { "type": "string", "enum": [ "all", "specific", "neutral" ], "example": "specific" } }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-languages-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "ListLanguages" } }, "/language-processing-rules": { "get": { "summary": "List Language Processing Rules", "tags": [ "Language Processing" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-language-processing-rules" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListLanguageProcessingRules", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/fields" } ], "description": "Returns a list of Language Processing Rules." } }, "/language-processing-rules/{languageProcessingRuleId}": { "get": { "summary": "Get Language Processing Rule", "tags": [ "Language Processing" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/language-processing-rule" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetLanguageProcessingRule", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "description": "Returns a Language Processing Rule by identifier." }, "parameters": [ { "schema": { "type": "string" }, "name": "languageProcessingRuleId", "in": "path", "required": true, "description": "The language processing rule identifier" } ] }, "/perfect-match-mappings": { "post": { "summary": "Create PerfectMatch Mapping", "tags": [ "PerfectMatch Mapping" ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/perfect-match-mapping-create-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes: \r\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\r\n* \"missing\": Missing required field for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes: \r\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\r\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\r\n* \"conflict\": the project has no source files.", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "CreatePerfectMatchMapping", "description": "For more details on the PerfectMatch feature please consult the [official documentation](https://docs.rws.com/791595/1155478/trados-enterprise---accelerate/perfectmatch-general-information).\r\n\r\nAfter creating a mapping, target files from the `matchingProjects` are automatically matched to the source files in the new project. This is a long-running background operation, and its `status` can be tracked by polling the [Get PerfectMatch Mapping](#/operations/GetPerfectMatchMapping) endpoint.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/perfect-match-mapping-create-request" } } }, "description": "" }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ] }, "parameters": [] }, "/perfect-match-mappings/{mappingId}": { "get": { "summary": "Get PerfectMatch Mapping", "tags": [ "PerfectMatch Mapping" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/perfect-match-mapping-response" } } } }, "400": { "description": "Error codes: \r\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes: \r\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\r\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetPerfectMatchMapping", "description": "Retrieves the details of a PerfectMatch mapping.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ] }, "parameters": [ { "schema": { "type": "string" }, "name": "mappingId", "description": "The mapping identifier", "in": "path", "required": true } ] }, "/perfect-match-mappings/{mappingId}/batch-mappings": { "parameters": [ { "schema": { "type": "string" }, "name": "mappingId", "description": "The mapping identifier", "in": "path", "required": true } ], "post": { "summary": "Add PerfectMatch Batch Mapping", "tags": [ "PerfectMatch Mapping" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/perfect-match-mapping-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes: \r\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes: \r\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\r\n* \"notFound\": the resource could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "409": { "description": "Error codes: \r\n* “conflict”: A pending batch mapping already exists.", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "AddPerfectMatchBatchMapping", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/perfect-match-batch-mapping-update-request" } } } }, "description": "Adds a new PerfectMatch batch mapping.\r\n\r\nWhen new source files are introduced to a mid-project, a new batch must be added to the current mapping to leverage PerfectMatch. This action triggers a background operation that identifies matching candidates for the newly added files." } }, "/perfect-match-mappings/{mappingId}/batch-mappings/{batchMappingId}": { "parameters": [ { "schema": { "type": "string" }, "name": "mappingId", "description": "The mapping identifier", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "batchMappingId", "in": "path", "required": true, "description": "The batch mapping identifier" } ], "put": { "summary": "Update PerfectMatch Batch Mapping", "tags": [ "PerfectMatch Mapping" ], "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes: \r\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes: \r\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\r\n* \"notFound\": the resource could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "409": { "description": "Error codes:\r\n* \"updateNotAllowed\": the resource could not be updated at this time.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "UpdatePerfectMatchBatchMapping", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/perfect-match-batch-mapping-update-request" } } } }, "description": "Updates a PerfectMatch batch mapping.\r\n\r\nPay special attention to how [updating works](../docs/Updating-data-with-PUT.html)." } }, "/perfect-match-mappings/{mappingId}/batch-mappings/{batchMappingId}/file-mappings/{fileMappingId}/project-file": { "parameters": [ { "schema": { "type": "string" }, "name": "mappingId", "description": "The mapping identifier", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "batchMappingId", "description": "The batch mapping identifier", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "fileMappingId", "description": "The file mapping identifier", "in": "path", "required": true } ], "put": { "summary": "Update File Mapping With Project File", "tags": [ "PerfectMatch Mapping" ], "responses": { "204": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": {} }, "400": { "description": "Error codes: \r\n* \"missing\": Missing required field for the value mentioned in the \"name\" field on the error response.\r\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes: \r\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\r\n* \"notFound\": the resource could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "UpdatePerfectMatchFileMappingWithProjectFile", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/perfect-match-project-file-mapping-request" } } } }, "description": "Updates a PerfectMatch file mapping with an existing target file from a PerfectMatch candidate. Only valid candidates can be used to request an update.\r\n\r\nUse the [Candidates](#/operations/GetPerfectMatchCandidates) endpoint to retrieve a list of valid `fileId` and `projectId` to provide as matching data. " } }, "/perfect-match-mappings/{mappingId}/batch-mappings/{batchMappingId}/file-mappings/{fileMappingId}/file": { "parameters": [ { "schema": { "type": "string" }, "name": "mappingId", "description": "The mapping identifier", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "batchMappingId", "description": "The batch mapping identifier", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "fileMappingId", "description": "The file mapping identifier", "in": "path", "required": true } ], "post": { "summary": "Update File Mapping With Manually Uploaded File", "tags": [ "PerfectMatch Mapping" ], "responses": { "204": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes: \r\n* \"missing\": Missing required field for the value mentioned in the \"name\" field on the error response.\r\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes: \r\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\r\n* \"notFound\": the resource could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "UpdatePerfectMatchFileMappingWithManuallyUploadedFile", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "properties", "file" ], "properties": { "properties": { "$ref": "#/components/schemas/perfect-match-custom-file-mapping-request" }, "file": { "type": "string", "format": "binary", "description": "The source file (binary string). Only SDLXLIFF files are accepted." } } } } } }, "description": "Updates a PerfectMatch file mapping with a manually uploaded file." } }, "/perfect-match-mappings/{mappingId}/batch-mappings/{batchMappingId}/file-mappings/{fileMappingId}/target-languages/{targetLanguage}": { "parameters": [ { "schema": { "type": "string" }, "name": "mappingId", "description": "The mapping identifier", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "batchMappingId", "description": "The batch mapping identifier", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "fileMappingId", "description": "The file mapping identifier", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "targetLanguage", "description": "The target language code", "in": "path", "required": true } ], "delete": { "summary": "Delete PerfectMatch File Mapping For a File", "tags": [ "PerfectMatch Mapping" ], "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes: \r\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\r\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "DeletePerfectMatchFileMappingForFile", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "description": "Deletes a PerfectMatch file mapping for a specific file and target language." } }, "/perfect-match-mappings/{mappingId}/batch-mappings/{batchMappingId}/file-mappings/{fileMappingId}/target-languages/{targetLanguage}/candidates": { "parameters": [ { "schema": { "type": "string" }, "name": "mappingId", "description": "The mapping identifier", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "batchMappingId", "description": "The batch mapping identifier", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "fileMappingId", "description": "The file mapping identifier", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "targetLanguage", "description": "The target language code", "in": "path", "required": true } ], "get": { "summary": "Get PerfectMatch Candidates", "description": "Retrieves a list of file candidates that can be selected for PerfectMatch.", "tags": [ "PerfectMatch Mapping" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-perfect-match-candidates-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes: \r\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes: \r\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\r\n* \"notFound\": the resource could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "GetPerfectMatchCandidates", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ] } }, "/machine-translation": { "parameters": [], "get": { "summary": "List Machine Translations", "operationId": "ListMachineTranslations", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-machine-translations-response" } } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "description": "Retrieves a list of machine translations that can be used in a translation engine.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "schema": { "type": "string" }, "in": "query", "name": "sourceLanguage", "required": true, "description": "Language code expressed as generic language (example: \"en\") or specific language (example: \"en-US\")" }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "targetLanguage", "required": true, "description": "List of language codes separated by comma, values can be generic language code or specific language code." } ], "tags": [ "Machine Translation" ] } }, "/pricing-models": { "get": { "tags": [ "Pricing Model" ], "summary": "List Pricing Models", "description": "Retrieves a list of all the pricing models in an account.\r\n\r\nSorting is supported for the following fields: `name`, `description`, `currencyCode` and `location`.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-pricing-models-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListPricingModels" }, "post": { "summary": "Create Pricing Model", "tags": [ "Pricing Model" ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pricing-model" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\r\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\r\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\r\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\r\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response. \r\n", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\r\n* “forbidden”: The authenticated user is not allowed to create the pricing model\r\n", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "CreatePricingModel", "description": "Creates a new pricing model.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pricing-model-create-request" } } } } } }, "/pricing-models/{pricingModelId}": { "get": { "tags": [ "Pricing Model" ], "summary": "Get Pricing Model", "description": "Retrieves a pricing model by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pricing-model" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the pricing model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetPricingModel" }, "parameters": [ { "$ref": "#/components/parameters/pricingModelId" } ], "put": { "summary": "Update Pricing Model", "tags": [ "Pricing Model" ], "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\r\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\r\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\r\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\r\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\r\n* \"missing\": Missing required field for the value mentioned in the \"name\" field on the error response. ", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\r\n* \"forbidden\": the authenticated user is not allowed to update the pricing model.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\r\n* \"notFound\": the pricing model could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "UpdatePricingModel", "description": "Updates a pricing model.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pricing-model-update-request" } } } } }, "delete": { "summary": "Delete Pricing Model", "tags": [ "Pricing Model" ], "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\r\n* \"forbidden\": the authenticated user is not allowed to delete the pricing model.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\r\n* \"notFound\": the pricing model could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "DeletePricingModel", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "description": "Deletes a pricing model." } }, "/projects": { "get": { "tags": [ "Project" ], "summary": "List Projects", "description": "Retrieves a list of all the projects in the account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/fields" }, { "schema": { "type": "boolean" }, "in": "query", "name": "excludeOnline", "description": "Excludes projects that are being worked on exclusively in the Online Editor" }, { "schema": { "type": "string", "enum": [ "created", "inProgress", "completed", "archived" ] }, "in": "query", "name": "status", "description": "Filter the list to include projects that have this status." }, { "schema": { "type": "string", "format": "date-time", "example": "2022-11-28T16:46:00.00Z" }, "in": "query", "name": "createdFrom", "description": "Filter the list to include only projects created after the specified date and time." }, { "schema": { "type": "string", "format": "date-time", "example": "2022-11-28T16:46:00.00Z" }, "in": "query", "name": "createdTo", "description": "Filter the list to include only projects created before the specified date and time." }, { "schema": { "type": "string" }, "in": "query", "name": "createdBy", "description": "Filter the list of projects to projects that were created by this user." }, { "schema": { "type": "string" }, "in": "query", "name": "projectTemplateId", "description": "Filter the list of projects to projects that were created using this project template." }, { "schema": { "type": "array", "items": { "type": "string" } }, "in": "query", "name": "projectIds", "description": "Filter the list of projects to projects have these project identifiers." }, { "schema": { "type": "string" }, "in": "query", "name": "sourceLanguage", "description": "Filter the list of projects to projects that were created using this source language." }, { "schema": { "type": "string" }, "in": "query", "name": "targetLanguage", "description": "Filter the list of projects to projects that were created using this target language." }, { "schema": { "type": "string" }, "in": "query", "name": "projectName", "description": "Filter the list of projects to projects that were created using this project name." }, { "schema": { "type": "string" }, "in": "query", "name": "dueFrom", "description": "Filter the list of projects to projects that are due after this date and time.
Accepted format: ISO-8601 `YYYY-MM-DDThh:mm:ss.sssZ`" }, { "schema": { "type": "string" }, "in": "query", "name": "dueTo", "description": "Filter the list of projects to projects that are due before this date and time.
Accepted format: ISO-8601 `YYYY-MM-DDThh:mm:ss.sssZ`" }, { "schema": { "type": "string" }, "in": "query", "name": "lastModifiedFrom", "description": "Filter the list of projects to projects that are last modified after this date and time.
Accepted format: ISO-8601 `YYYY-MM-DDThh:mm:ss.sssZ`" }, { "schema": { "type": "string" }, "in": "query", "name": "lastModifiedTo", "description": "Filter the list of projects to projects that are last modified before this date and time.
Accepted format: ISO-8601 `YYYY-MM-DDThh:mm:ss.sssZ`" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-projects-response" }, "examples": { "numbers": { "value": { "itemCount": 1, "items": [ { "id": "test-id", "quote": { "additionalCosts": [ { "name": "test-additional-cost-name", "count": 1, "runningTotal": 1 } ] } } ] } }, "missing-required-integer": { "value": { "items": [ { "id": "test-id", "quote": { "additionalCosts": [ { "name": "test-additional-cost-name", "count": 1, "runningTotal": 1 } ] } } ] } }, "missing-optional-integer": { "value": { "itemCount": 1, "items": [ { "id": "test-id", "quote": { "additionalCosts": [ { "name": "test-additional-cost-name", "runningTotal": 1 } ] } } ] } }, "missing-optional-double": { "value": { "itemCount": 1, "items": [ { "id": "test-id", "quote": { "additionalCosts": [ { "name": "test-additional-cost-name", "count": 1 } ] } } ] } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListProjects" }, "post": { "tags": [ "Project" ], "summary": "Create Project", "description": "Creates a new project.\n\nWhen creating a project using a project template that supports multiple source languages, you must supply the `languageDirections`.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when creating projects.\n\nThe values from a selected project template will take precedence over the individual resources when creating a new project.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-create-request" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project" }, "examples": { "minimal": { "value": { "id": "string" } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"missing\": Missing required field for the value mentioned in the \"name\" field on the error response. \n* \"deleted\": Some of the selected values were deleted and cannot be selected for some values of the \"customFields\" field.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n\"forbidden\": \n- The authenticated user is not allowed to create the project in the specified location.\n- Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "CreateProject" } }, "/projects/{projectId}": { "get": { "tags": [ "Project" ], "summary": "Get Project", "description": "Retrieves a project by identifier.\n\nFor detailed information about Translation Memory advanced configuration including filters and field updates, see [Translation Memory Advanced Configuration](../docs/translation-memory/Translation-memory-advanced-configuration.html).", "parameters": [ { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project" }, "examples": { "valid-response": { "value": { "id": "test-id", "name": "test-name", "description": "test-description", "dueBy": "2042-07-28T11:13:36.000Z", "createdAt": "2021-07-28T11:13:36.000Z", "status": "completed", "languageDirections": [ { "id": "language-direction-id", "sourceLanguage": { "languageCode": "test-source-languageCode", "isNeutral": false }, "targetLanguage": { "languageCode": "test-target-languageCode", "isNeutral": true } } ] } }, "missing-required-string": { "value": { "name": "test-name", "description": "test-description", "dueBy": "2042-07-28T11:13:36.000Z", "createdAt": "2021-07-28T11:13:36.000Z", "status": "completed" } }, "missing-optional-string": { "value": { "id": "test-id", "description": "test-description", "dueBy": "2042-07-28T11:13:36.000Z", "createdAt": "2021-07-28T11:13:36.000Z", "status": "completed" } }, "missing-optional-datetime": { "value": { "id": "test-id", "name": "test-name", "description": "test-description", "createdAt": "2021-07-28T11:13:36.000Z", "status": "completed" } }, "missing-optional-enum": { "value": { "id": "test-id", "name": "test-name", "description": "test-description", "dueBy": "2042-07-28T11:13:36.000Z", "createdAt": "2021-07-28T11:13:36.000Z" } }, "missing-optional-boolean": { "value": { "id": "test-id", "languageDirections": [ { "id": "language-direction-id", "sourceLanguage": { "languageCode": "test-source-languageCode" }, "targetLanguage": { "languageCode": "test-target-languageCode" } } ] } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetProject" }, "put": { "tags": [ "Project" ], "summary": "Update Project", "description": "Updates the project in terms of: name, description, due date, quote, and project resources. Observe the rules of [JSON Merge Patch Semantics](https://tools.ietf.org/html/rfc7386). \n\nProject rescheduling (updating dueBy) is permitted only if: \n* there is no Customer Quote Approval task in the associated flow \n* at least one Customer Quote Approval was closed(in case multiple project batches) \n\nUpdate `projectPlan.taskConfigurations` are now permitted before project is started. Elements are now pre-populated at project creation time.\n\nFor detailed information about Translation Memory advanced configuration including filters and field updates, see [Translation Memory Advanced Configuration](../docs/translation-memory/Translation-memory-advanced-configuration.html).", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-update-request" } } }, "required": true }, "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error responses:\n\n* “invalid”: invalid input on update quote model\n* “invalidStatus”: the quote cannot be edited, the project is in a phase which doesn't allow the quote to be edited\n* \"conflict\": the project does not have a quote to be updated\n* \"limit.exceeded\": a maximum number of users per task was assigned\n \n* \"deleted\": Some of the selected values were deleted and cannot be selected for some values of the \"customFields\" field.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the Project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the Project could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error responses:\n\n* “invalidStatus”: a field cannot be edited, because the project is in a status which doesn't allow the field to be edited. `details.name` will provide the field name which is not allowed to be edited.\n\n* updateNotAllowed: a field of the project cannot be edited before the completion of customer approval.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "UpdateProject" }, "delete": { "tags": [ "Project" ], "summary": "Delete Project", "description": "Deletes a project.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the project could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "DeleteProject" }, "parameters": [ { "$ref": "#/components/parameters/projectId" } ] }, "/projects/{projectId}/configuration": { "get": { "summary": "Get Project Configuration", "description": "Get the configuration settings of an existing project.", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-configuration" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to get the project configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetProjectConfiguration", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "tags": [ "Project" ] }, "put": { "summary": "Update Project Configuration", "description": "Updates the configuration settings for an existing project.", "operationId": "UpdateProjectConfiguration", "tags": [ "Project" ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the project configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-configuration-request" } } } }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ] }, "parameters": [ { "$ref": "#/components/parameters/projectId" } ] }, "/projects/{projectId}/pricing-model": { "put": { "tags": [ "Project" ], "summary": "Update Project Pricing Model", "description": "Update project pricing model only during Customer Quote Review task type.", "operationId": "UpdateProjectPricingModel", "responses": { "204": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalidPricingModel”: There is mismatch configuration between the project and the new pricing model.\n* \"differentCurrencyCode\": There is a mismatch between the provided pricing model currency and the pricing model currency in the project.\n* “differentFuzzyBands”: There is a mismatch between the provided pricing model fuzzy bands and the pricing model fuzzy bands in the project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the project configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-pricing-model-update-request" } } }, "required": true }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ] }, "parameters": [ { "$ref": "#/components/parameters/projectId" } ] }, "/projects/{projectId}/start": { "put": { "tags": [ "Project" ], "summary": "Start Project", "description": "Starts a project. Translatable files should be uploaded before starting the project. If the action is executed on an already started project, the new translatable files should be uploaded first.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "202": { "description": "Accepted", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to start the project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"invalidStatus\": the project's status doesn't permit the start operation.\n* \"missingTranslatableFile\": there was no translatable file attached to the project.\n* \"missingWorkflow\": there was no workflow associated with the project.\n* \"invalidWorkflow\" : the workflow associated with the project is invalid or has errors.\n* \"missingConfigurations\": not all manual task templates have configurations.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "StartProject" }, "parameters": [ { "$ref": "#/components/parameters/projectId" } ] }, "/projects/{projectId}/complete": { "put": { "tags": [ "Project" ], "summary": "Complete Project", "description": "Marks a project as \"completed\".", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to complete the project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"projectAlreadyCompleted\": the project it is already in completed state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "CompleteProject" }, "parameters": [ { "$ref": "#/components/parameters/projectId" } ] }, "/projects/{projectId}/files/exports": { "post": { "tags": [ "Project" ], "summary": "Export Project Files", "operationId": "ExportProjectFiles", "description": "Generates an asynchronous export operation. To monitor the progress until completion, use the [Poll Project Files Export](../api/Public-API.v1-fv.html#/operations/ExportProjectFilesStatus) endpoint. \n\nThis operation triggers the packaging of the project files into a `zip` format.\n> [!WARNING] \n> The export ID has a time-to-live (TTL) of 20 minutes, starting from when this export operation is initiated (not when the underlying async operation completes). Ensure you poll and download the export within this timeframe, or you will receive a `404 Not Found` error.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "Export Operation was triggered successfully", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zip-file-export-response" } } } }, "400": { "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to trigger an export on the specified project, or does not have access to the project.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\n* \"notFound\": the project could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zip-file-export-request" } } } } }, "parameters": [ { "$ref": "#/components/parameters/projectId" } ] }, "/projects/{projectId}/files/exports/{exportId}": { "get": { "tags": [ "Project" ], "summary": "Poll Project Files Export", "operationId": "ExportProjectFilesStatus", "description": "Retrieves the state of the export operation. \n\n Once the state is marked as `done`, you can download the generated `zip` file using the following endpoint: [Download Exported Project Files](../api/Public-API.v1-fv.html#/operations/DownloadFile).\n\n> [!WARNING] \n> The export ID has a time-to-live (TTL) of 20 minutes, starting from when the export operation was initiated (not when the underlying async operation completes). If the TTL expires, this endpoint will return a `404 Not Found` error. Ensure you poll and download the export within this timeframe.", "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zip-file-export-response" } } } }, "400": { "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to retrieve the details of the export.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\n* \"notFound\": the export operation could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "schema": { "type": "string" }, "name": "exportId", "in": "path", "required": true, "description": "The export identifier." } ] }, "parameters": [ { "$ref": "#/components/parameters/projectId" } ] }, "/projects/{projectId}/files/exports/{exportId}/download": { "get": { "tags": [ "Project" ], "summary": "Download Exported Project Files", "description": "Downloads the generated `zip` file containing the files according to initial export operation parameters. \n\nThe final ZIP file will be named using the project name. \n\n When the export operation is performed with `downloadFlat=true` and one target language specified, the resulting ZIP file name will be a combination of the project name and the target language code, as defined by the [Export Project Files](#/operations/ExportProjectFiles) endpoint.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the file could not be found by identifier.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"conflict\": the export operation is not done yet.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "x-codegen-download": true, "operationId": "DownloadFile" }, "parameters": [ { "schema": { "type": "string" }, "name": "projectId", "in": "path", "required": true, "description": "The identifier of the project." }, { "schema": { "type": "string" }, "name": "exportId", "in": "path", "required": true, "description": "The identifier of the export operation." } ] }, "/projects/{projectId}/source-files": { "get": { "tags": [ "Source File" ], "summary": "List Source Files", "description": "Retrieves the source files in a project.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-source-files-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": not authorized to retrieve source files on the project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the project could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListSourceFiles" }, "post": { "tags": [ "Source File" ], "summary": "Add Source File", "description": "Adds a source file to the project. Files can be uploaded before starting a project or after the project has started. When adding a `translatable` file after the project started, a new start project request should be performed.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.\n\n> Note: The maximum character size of the sum between the `name` and the `path` fields must not exceed 255. Otherwise the request cannot be validated.\n\n> Note: Zip files will be added as reference files. If you want to upload zip files, please use the [Upload Zip File](#/operations/UploadZipFile) endpoint.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "properties", "file" ], "properties": { "properties": { "$ref": "#/components/schemas/source-file-request" }, "file": { "type": "string", "format": "binary", "description": "The source file (binary string)." } } } } }, "required": true, "description": "For details on how to send multipart/form-data with `properties` see this [article](../docs/How-to-multipart.html)." }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source-file" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error responses:\n* \"invalid\": invalid input on for the value mentioned in the “name” field on the error response.\n* \"empty\": missing input for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": maximum size exceeded for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to add a source file to the project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"duplicate\": duplicate source file name inside a project is not allowed.\n* \"projectAlreadyCompleted\": resource can not be added because the project it is in completed state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "AddSourceFile" }, "parameters": [ { "$ref": "#/components/parameters/projectId" } ], "put": { "tags": [ "Source File" ], "summary": "Update Source Files", "operationId": "UpdateSourceFiles", "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to update the source file.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\n* \"notFound\": the project could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "409": { "description": "Error codes:\n* \"duplicate\": a file with the same name already exists." } }, "description": "Updates multiple source files. If any of the files fails to be updated, an error will be returned for each file. ", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source-files-update-request" } } } } } }, "/projects/{projectId}/source-files/attach-files": { "post": { "tags": [ "Source File" ], "summary": "Attach Source Files", "description": "This endpoint can only be used after files have been uploaded via the [Upload Zip File](#/operations/UploadZipFile) endpoint. It allows you to add multiple source files to a project. \n\n Each file must be individually attached by setting the `fileUrl` to the `associatedFiles.id` returned by the [Poll Upload Zip File](#/operations/PollUploadZipFile) endpoint, once the `unzipStatus` is `extracted`. \n\nIf a file is attached after the project has already been started, a new start project request must be made.\n\n> Note: The maximum character size of the sum between the `name` and the `path` fields must not exceed 255. Otherwise the request cannot be validated.\n", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source-file-attachment-request" } } }, "required": true, "description": "" }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source-file-attachment-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": invalid input on for the value mentioned in the “name” field on the error response.\n* \"empty\": missing input for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": maximum size exceeded for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to attach a source file on the project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"duplicate\": duplicate source file name inside a project is not allowed.\n* \"duplicate\": duplicate fileUrl inside a project is not allowed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "AddSourceFiles" }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The project identifier." } ] }, "/projects/{projectId}/source-files/{sourceFileId}": { "get": { "tags": [ "Source File" ], "summary": "Get Source File", "description": "Retrieves a source file from the project.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source-file" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the project or the source file could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetSourceFile" }, "put": { "tags": [ "Source File" ], "summary": "Update Source File", "operationId": "UpdateSourceFile", "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to update the target file.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\n* \"notFound\": the project or the source file could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "409": { "description": "Error codes:\n* \"duplicate\": a file with the same name already exists." } }, "description": "Updates a source file.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source-file-rename-request" } } } }, "parameters": [] }, "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/sourceFileId" } ] }, "/projects/{projectId}/source-files/{sourceFileId}/versions": { "get": { "tags": [ "Source File" ], "summary": "List Source File Versions", "description": "Retrieves all the versions of a source file.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-source-file-versions-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to retrieve the source file versions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the project or the source file could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListSourceFileVersions" }, "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/sourceFileId" } ] }, "/tasks/{taskId}/source-files/{sourceFileId}/versions": { "parameters": [ { "name": "sourceFileId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The source file identifier." }, { "schema": { "type": "string" }, "name": "taskId", "in": "path", "required": true, "description": "The task identifier." } ], "post": { "summary": "Add Source File Version", "tags": [ "Source File" ], "operationId": "AddSourceFileVersion", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source-file-version-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"invalid\": the provided document is not a valid BCM file.\n* \"invalid\": invalid file format\n* \"multiPartOrder\": the multipart order in body is not correct. `properties` must be the first, followed by `file`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": \\\n \\- the specified task or the source file was not found.\\\n \\- the request is performed in a task that doesn't have the input file type as source file and is used a target file identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"noOwner\": the task has no owner.\n* \"differentOwner\": the authenticated user is not the owner of the task.\n* \"differentServiceUserOwner\": the authenticated service user is not the owner of the task.\n* \"taskCompleted\": adding source file version is not allowed when the task is completed.\n* \"unsupported\" : you cannot add a source file version for this task.\n* \"duplicate\": a file with the same name already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "properties", "file" ], "properties": { "properties": { "$ref": "#/components/schemas/source-file-version-properties-create-request", "description": "Source file properties sent as a JSON inside a text part." }, "file": { "type": "string", "format": "binary", "description": "The source file (binary string)." } } } } }, "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." }, "description": "Adds a new version of the source file in [BCM](../../BCM/BCM.NET_client_API.html) or native format. More information about file formats can be found on the [File formats](../docs/File-formats.html) page.\n\nThe version is added on the task represented by `taskId`. To successfully execute the add operation the task should already be assigned and accepted by a user. If the task is automatic, it's possible to add a source file version only when the status of task is `inProgress`.\n\nThe file versions added need to respect the output file type declared by the task type of the enclosing task. On the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page from the official RWS Documentation Center, you can find out what output file type is supported by each task.\n\nFor adding a source file version using an extension task, the configuration of the task must declare the `scope`'s value as \"file\".\n\nIf the file type of the new added file is different than the supported source file type, the new `fileTypeSettingsId` must be specified in the body or an update of file type should be performed after the add operation, using the [Update Source File Properties](#/operations/UpdateSourceProperties).\n\nThe value of `fileTypeSettingsId` is one of the identifiers listed by the [List File Type Settings](#/operations/ListFileTypeSettings) endpoint.\n\nThe [List File Type Settings](#/operations/ListFileTypeSettings) endpoint must be called with the File Processing Configuration identifier of your project.\n\nThe File Processing Configuration of your project can be retrieved from [Get Project](#/operations/GetProject) endpoint.\n\nThe multipart parameters in the body should respect and strictly follow the order specified in our documentation. \n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when adding files.\n", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ] } }, "/projects/{projectId}/source-files/{sourceFileId}/versions/{fileVersionId}/download": { "get": { "tags": [ "Source File" ], "summary": "Download Source File Version", "description": "Downloads a source file version.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the project, the source file or the file version could not be found by identifier.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "422": { "description": "error codes:\n* \"maliciousContent\": the file contains malicious content. The infected file cannot be downloaded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "x-codegen-download": true, "operationId": "DownloadSourceFileVersion" }, "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/sourceFileId" }, { "$ref": "#/components/parameters/fileVersionId" } ] }, "/tasks/{taskId}/source-files/{sourceFileId}": { "get": { "tags": [ "Source File" ], "summary": "Get Source File Properties", "description": "Retrieves the properties for a source file.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source-file-properties-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the task or source file could not be found by id.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetSourceFileProperties" }, "parameters": [ { "schema": { "type": "string" }, "name": "taskId", "in": "path", "required": true, "description": "The task identifier." }, { "schema": { "type": "string" }, "name": "sourceFileId", "in": "path", "required": true, "description": "The source file identifier." } ], "put": { "summary": "Update Source File Properties", "tags": [ "Source File" ], "operationId": "UpdateSourceProperties", "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error responses:\n* “invalid”: invalid input on update source file properties.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": - the specified task or the source file was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"noOwner\": the task has no owner.\n* \"differentOwner\": the authenticated user is not the owner of the task.\n* \"taskCompleted\": updating the source file properties is not allowed when the task is completed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "description": "Updates the properties of the source file.\n\n\nThe value of `fileTypeSettingsId` should be one of the identifiers listed by the [List File Type Settings](#/operations/ListFileTypeSettings) endpoint called with an identifier of a File Processing Configuration that exists on the project. The list of File Processing Configurations from a project can be retrieved by using the [List File Processing Configurations](#/operations/ListFileProcessingConfigurations) endpoint.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/source-file-properties-update-request" } } } }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ] } }, "/projects/{projectId}/target-files/{targetFileId}": { "get": { "tags": [ "Target File" ], "summary": "Get Target File", "description": "Retrieves a target file from a project.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/target-file" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the project or the target file could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetTargetFile" }, "put": { "tags": [ "Target File" ], "summary": "Update Target File", "operationId": "UpdateTargetFile", "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to update the target file.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\n* \"notFound\": the target file could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "409": { "description": "Error codes:\n* \"duplicate\": a file with the same name already exists." } }, "description": "Updates a target file.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/target-file-rename-request" } } } } }, "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/targetFileId" } ] }, "/projects/{projectId}/target-files": { "get": { "tags": [ "Target File" ], "summary": "List Target Files", "description": "Retrieves the target files for a project.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "name": "targetFileIds", "in": "query", "description": "Filter target files by identifiers.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sourceFileIds", "in": "query", "description": "Filter target files by the identifiers of the source file they were generated from.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-target-files-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the target files on the project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the project could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListTargetFiles" }, "put": { "tags": [ "Target File" ], "summary": "Update Target Files", "operationId": "UpdateTargetFiles", "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to update the file.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\n* \"notFound\": the target file could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "409": { "description": "Error codes:\n* \"duplicate\": a file with the same name already exists." } }, "description": "Updates multiple target files. If any of the files fails to be updated, an error will be returned for each file. ", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/target-files-update-request" } } } } }, "parameters": [ { "$ref": "#/components/parameters/projectId" } ] }, "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}": { "get": { "tags": [ "Target File" ], "summary": "Get Target File Version", "description": "Retrieves one version of a target file.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/target-file-version" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the project, the target file or its version could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetTargetFileVersion" }, "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/targetFileId" }, { "$ref": "#/components/parameters/fileVersionId" } ] }, "/projects/{projectId}/target-files/{targetFileId}/versions": { "get": { "tags": [ "Target File" ], "summary": "List Target File Versions", "description": "Retrieves the versions of a target file.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-target-file-versions-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to retrieve versions on the target file.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the project or the target file could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListTargetFileVersions" }, "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/targetFileId" } ] }, "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/exports": { "post": { "tags": [ "Target File" ], "summary": "Export Target File Version", "description": "Generates an asynchronous export operation. Use the [Get Target File Version Export](#/operations/PollTargetFileVersionExport) endpoint to poll until the export is completed. Used only for [BCM](../../BCM/BCM.NET_client_API.html) file versions.\n\nThis operation triggers a conversion of the BCM target file version in a native or SDLXLIFF format, based on the value of the `format` query parameter used.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/export-format" } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file-version-export" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to export the target file version.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the project, the target file or the version could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"invalidType\": The type of the target file doesn't allow the export operation.\n* \"conflict\": A target file version export is already in progress.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ExportTargetFileVersion" }, "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/targetFileId" }, { "$ref": "#/components/parameters/fileVersionId" } ] }, "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/exports/{exportId}": { "get": { "tags": [ "Target File" ], "summary": "Poll Target File Version Export", "description": "Polls a target file version via an export operation. The new version can be downloaded once the status is \"completed\".", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file-version-export" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to retrieve the export.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "PollTargetFileVersionExport" }, "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/targetFileId" }, { "$ref": "#/components/parameters/fileVersionId" }, { "$ref": "#/components/parameters/exportId" } ] }, "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/exports/{exportId}/download": { "get": { "tags": [ "Target File" ], "summary": "Download Exported Target File Version", "description": "Downloads a completed target file version via an export operation.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": not allowed to download the exported target file", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"invalidStatus\": the export is not completed\n* \"conflict\": the export is not in a downloadable state due to another export, or the workflow has progressed since this export was requested", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "x-codegen-download": true, "operationId": "DownloadExportedTargetFileVersion" }, "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/targetFileId" }, { "$ref": "#/components/parameters/fileVersionId" }, { "$ref": "#/components/parameters/exportId" } ] }, "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/download": { "get": { "tags": [ "Target File" ], "summary": "Download Target File Version", "description": "Downloads the file version (native or BCM). \n\nIf the `fileVersionId` path parameter represents a native file version, the native file will be downloaded. If the `fileVersionId` is an identifier of a version in [BCM format](../../BCM/BCM.NET_client_API.html), the BCM file will be downloaded.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": not allowed to download the file version.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the file version could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "error codes:\n* \"invalidType\": the type of the file version cannot be downloaded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "422": { "description": "error codes:\n* \"maliciousContent\": the file contains malicious content. The infected file cannot be downloaded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "x-codegen-download": true, "operationId": "DownloadFileVersion" }, "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/targetFileId" }, { "$ref": "#/components/parameters/fileVersionId" } ] }, "/projects/{projectId}/target-files/{targetFileId}/versions/imports": { "post": { "tags": [ "Target File" ], "summary": "Import Target File Version", "description": "Generates an asynchronous import operation. Use [Poll Target File Version Import endpoint](#/operations/PollTargetFileVersionImport) to poll until the import is completed. Only `sdlxliff` files can be imported.\n\nImport should be used when a file is downloaded as an `sdlxliff`, processed and then, replaced. \nThe import operation triggers internally the update of the [BCM](../../BCM/BCM.NET_client_API.html) file associated with the imported file. It should mostly be used for offline work.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary", "description": "The target file (binary string)." } } } } }, "required": true, "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file-version-import" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error code “invalid” in case of:\n * Empty or missing file in request\n * Not valid multipart request\n * File parameter contains other extension than the one expected by specification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to execute operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": - the specified project or target file was not found.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "x-codegen-request-body-name": "body", "operationId": "ImportTargetFileVersion" }, "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/targetFileId" } ] }, "/projects/{projectId}/target-files/{targetFileId}/versions/imports/{importId}": { "get": { "tags": [ "Target File" ], "summary": "Poll Target File Version Import", "description": "Polls a target file version via an import operation. The new version can be seen on the file versions once the status is \"completed\".", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/file-version-import" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": - the specified project or target file was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "PollTargetFileVersionImport" }, "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/targetFileId" }, { "$ref": "#/components/parameters/importId" } ] }, "/tasks/{taskId}/target-files/{targetFileId}/versions": { "parameters": [ { "schema": { "type": "string" }, "name": "taskId", "in": "path", "required": true, "description": "The task identifier." }, { "schema": { "type": "string" }, "name": "targetFileId", "in": "path", "required": true, "description": "The target file identifier." } ], "post": { "summary": "Add Target File Version", "tags": [ "Target File" ], "operationId": "AddTargetFileVersion", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/target-file-version-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n\n* \"invalid\": invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"invalid\": the provided document is not a valid BCM file.\n* \"invalid\": invalid file format\n* \"multiPartOrder\": the multipart order in the body is not correct. The `properties` must be first and then, file.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to add a version for the target file.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": \\\n \\- the specified task or the target file was not found.\\\n \\- the request is performed in a task that doesn't have the input file type as target file and is used a source file identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"noOwner\": the task has no owner.\n* \"differentOwner\": the authenticated user is not the owner of the task.\n* \"differentServiceUserOwner\": the authenticated service user is not the owner of the task.\n* \"taskCompleted\": adding target file version is not allowed when the task is completed.\n* \"duplicate\": a file with the same name already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "properties", "file" ], "properties": { "properties": { "$ref": "#/components/schemas/target-file-version-properties-create-request", "description": "Target file properties sent as a JSON inside a text part." }, "file": { "type": "string", "format": "binary", "description": "The target file (binary string)." } } } } }, "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." }, "description": "Adds a new version of the target file. Only the `native` and `bcm` file formats are accepted. For the `sdlxliff` files, you should use the [Import Target File endpoint](#/operations/ImportTargetFileVersion). More information about file formats can be found on the [File formats](../docs/File-formats.html) page. Additional details on BCM files can be found [here](../../BCM/BCM.NET_client_API.html).\n\nThe version is added on the task represented by `taskId`. To be able to execute the add operation the task should be assigned and accepted by user. If the task is automatic, it is possible to add a target file version only if the status is `inProgress`.\n\nThe added file versions need to respect the output file type declared by the task type of the enclosing task. On the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page from the official RWS Documentation Center, you can find out what output file type is supported by each task.\n\nFor adding a target file version using an extension task, the configuration of the task type must declare the `scope`'s value as \"file\".\n\nThe multipart parameters in the body should respect and strictly follow the order specified in our documentation.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ] } }, "/projects/{projectId}/files/{fileId}/cancel": { "put": { "summary": "Cancel Project File", "operationId": "CancelProjectFile", "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\r\n* \"alreadyCanceled\": the file was already cancelled.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/error-response" } } } } }, "description": "Cancels a project file.\n\nThe `fileId` path parameter can be either a source file identifier or a target file identifier. Use the [List Source Files](#/operations/ListSourceFiles) endpoint to obtain source file identifiers, or the [List Target Files](#/operations/ListTargetFiles) endpoint to obtain target file identifiers.", "tags": [ "Project" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ] }, "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/fileId" } ] }, "/projects/{projectId}/quote-report/export": { "post": { "summary": "Export Quote Report", "operationId": "ExportQuoteReport", "responses": { "202": { "description": "Accepted", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/export-quote-report-response", "description": "Export quote report response.\n\nThe field is optional and will be returned only if a custom quote template is associated with the project.t.\n\nWe currently have this known issue: when the export is not using a Quote Template, the response for this call will be empty. It will be addressed in the future.e." } } } }, "400": { "description": "Error codes:\n* “invalid”: invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the project could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"conflict\": the project is in a phase which doesn’t allow the quote to be exported.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "description": "Generates an asynchronous quote export operation for the project in either PDF or Excel format. Use the [polling endpoint](../api/Public-API.v1-fv.html#/operations/PollQuoteReportExport) to check when the export is completed.

\nBuilt-in quotes are only available in the same languages as the user interface. See [this page](https://docs.rws.com/791595/1084405/trados-enterprise---accelerate/ui-languages) for more information.
\nCustomers who use non-default quote templates are responsible for the implementation of a suitable localization approach.\n\n> [!WARNING] \n> The export ID has a time-to-live (TTL) of 20 minutes, starting from when this export operation is initiated (not when the underlying async operation completes). Ensure you poll and download the export within this timeframe, or you will receive a `404 Not Found` error.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/quote-report-format" }, { "$ref": "#/components/parameters/language-id" } ], "tags": [ "Quote" ] }, "get": { "summary": "Poll Quote Report Export", "operationId": "PollQuoteReportExport", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "inProgress", "completed" ] } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the project could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "description": "Polls a quote report via an export operation. The quote report can be [downloaded](../api/Public-API.v1-fv.html#/operations/DownloadQuoteReport) once the status is \"completed\". The recommended polling interval is 20 seconds.\n\nIf the `exportId` query parameter is not provided, the polling action will return the status for the last generated export.\n\n> [!WARNING] \n> The export ID has a time-to-live (TTL) of 20 minutes, starting from when the export operation was initiated (not when the underlying async operation completes). If the TTL expires, this endpoint will return a `404 Not Found` error. Ensure you poll and download the export within this timeframe.\n", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/quote-report-format" }, { "schema": { "type": "string" }, "in": "query", "name": "exportId", "description": "The export identifier." } ], "tags": [ "Quote" ] }, "parameters": [ { "$ref": "#/components/parameters/projectId" } ] }, "/projects/{projectId}/quote-report/download": { "get": { "summary": "Download Exported Quote Report", "operationId": "DownloadQuoteReport", "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the project could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "description": "Downloads a quote report generated by the [asynchronous export operation](#/operations/ExportQuoteReport). \n\nIf the `exportId` query parameter is not provided, the last generated export quote will be downloaded.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/quote-report-format" }, { "schema": { "type": "string" }, "in": "query", "name": "exportId", "description": "The export identifier." } ], "tags": [ "Quote" ] }, "parameters": [ { "$ref": "#/components/parameters/projectId" } ] }, "/projects/{projectId}/tasks": { "get": { "tags": [ "Project" ], "summary": "List Project's Tasks", "description": "Lists the tasks of a specific project.", "parameters": [ { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-tasks-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListProjectTasks" }, "parameters": [ { "$ref": "#/components/parameters/projectId" } ] }, "/projects/{projectId}/tasks/reschedule": { "patch": { "tags": [ "Project" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reschedule-tasks-request" } } }, "required": true }, "summary": "Reschedule Project Tasks", "description": "Reschedules the tasks of a specific project.", "responses": { "200": { "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "description": "OK" }, "400": { "description": "Error codes:\n* “invalid”: Invalid input mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "RescheduleProjectTasks", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ] }, "parameters": [ { "$ref": "#/components/parameters/projectId" } ] }, "/project-groups": { "get": { "tags": [ "Project Group" ], "summary": "List Project Groups", "description": "Retrieves a list of all the project groups in an account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-project-groups-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListProjectGroups" }, "post": { "tags": [ "Project Group" ], "summary": "Create Project Group", "description": "Creates a new project group.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-group-create-request" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-group-create-response" }, "examples": {} } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to create the project group in the specified location.\n* \"benefitNotAvailable\": Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"duplicate\": Project group with the same name already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "CreateProjectGroup" }, "parameters": [] }, "/project-groups/{projectGroupId}": { "get": { "tags": [ "Project Group" ], "summary": "Get Project Group", "description": "Retrieves a project group by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-group" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the project group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": The project group could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetProjectGroup" }, "put": { "tags": [ "Project Group" ], "summary": "Update Project Group", "description": "Updates the project group.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-group-update-request" } } }, "required": true, "description": "" }, "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error responses:\n\n* “invalid”: Invalid input on update project group model.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the project group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the project group could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"duplicate\": Project group with the same name already exists.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "UpdateProjectGroup" }, "delete": { "tags": [ "Project Group" ], "summary": "Delete Project Group", "description": "Deletes a project group.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the project group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the project group could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"conflict\": there might be projects that are still `attaching`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "DeleteProjectGroup" }, "parameters": [ { "schema": { "type": "string" }, "name": "projectGroupId", "in": "path", "required": true, "description": "The project group identifier." } ] }, "/project-groups/{projectGroupId}/projects": { "post": { "tags": [ "Project Group" ], "summary": "Add Projects To Group", "description": "Adds projects to the project group.\n\nThe projects are not added instantly. To check the status use the [Get Project Group](#/operations/GetProjectGroup) endpoint.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/add-projects-to-group-request" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/add-projects-to-group-response" } } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to add the projects to group.\n* \"forbidden\": The projects are not found or the authenticated user does not have acces to them.\n* \"benefitNotAvailable\": Your subscription does not include access to the requested type of benefit.\n* \"quotaReached\": The maximum number of projects allowed for your project group has already been reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": The project group could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* “conflict”: A project with status \"detaching\" cannot be added.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "AddProjectsToGroup" }, "delete": { "tags": [ "Project Group" ], "summary": "Remove Projects From Group", "description": "Removes projects from the project group.\n\nThe projects are not removed instantly. To check the status use the [Get Project Group](#/operations/GetProjectGroup) endpoint.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "202": { "description": "Accepted", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to remove the projects from the project group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": The project group could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* “conflict”: A project with status \"attaching\" cannot be removed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "RemoveProjectsFromGroup", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/remove-projects-from-group-request" } } } } }, "parameters": [ { "schema": { "type": "string" }, "name": "projectGroupId", "in": "path", "required": true, "description": "The Project Group identifier." } ] }, "/project-templates/{projectTemplateId}": { "get": { "tags": [ "Project Template" ], "summary": "Get Project Template", "description": "Retrieves a project template by identifier.\n\nFor detailed information about Translation Memory advanced configuration including filters and field updates, see [Translation Memory Advanced Configuration](../docs/translation-memory/Translation-memory-advanced-configuration.html).", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-template-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the project template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the project template could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetProjectTemplate" }, "parameters": [ { "$ref": "#/components/parameters/projectTemplateId" } ], "put": { "summary": "Update Project Template", "operationId": "UpdateProjectTemplate", "description": "Updates a project template by id.\n\nFor detailed information about Translation Memory advanced configuration including filters and field updates, see [Translation Memory Advanced Configuration](../docs/translation-memory/Translation-memory-advanced-configuration.html).", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-template-update-request" } } }, "required": true }, "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input mentioned in the “name” field on the error response. \n* \"deleted\": Some of the selected values were deleted and cannot be selected for some values of the \"customFields\" field.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the project template.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\n* \"notFound\": the project template could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "tags": [ "Project Template" ] }, "delete": { "summary": "Delete Project Template", "operationId": "DeleteProjectTemplate", "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the project template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the project template could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "description": "Deletes a project template by id.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "tags": [ "Project Template" ] } }, "/project-templates": { "get": { "tags": [ "Project Template" ], "summary": "List Project Templates", "description": "Retrieves a list of all the project templates in an account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/name" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-project-templates-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListProjectTemplates" }, "post": { "tags": [ "Project Template" ], "summary": "Create Project Template", "description": "Creates a new project template.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-template-create-request" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-template-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input mentioned in the “name” field on the error response. \n* \"deleted\": Some of the selected values were deleted and cannot be selected for some values of the \"customFields\" field.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to create a project template.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "409": { "description": "Error codes:\n* \"duplicate\": A project template with the same name already exists in the same location.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "CreateProjectTemplate" } }, "/quote-templates": { "get": { "tags": [ "Quote Template" ], "summary": "List Quote Templates", "description": "Retrieves a list of all the quote templates in an account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-quote-templates-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListQuoteTemplates" } }, "/quote-templates/{quoteTemplateId}": { "get": { "tags": [ "Quote Template" ], "summary": "Get Quote Template", "description": "Retrieves a quote template by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-quote-template" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the quote template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetQuoteTemplate" }, "parameters": [ { "name": "quoteTemplateId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The identifier of the quote template." } ] }, "/rate-limits": { "get": { "tags": [ "Rate Limits" ], "summary": "List Rate Limits", "description": "Retrieves a list of all rate limits applicable for an account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-rate-limits-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListRateLimits" } }, "/roles": { "get": { "tags": [ "Role and Permission" ], "summary": "List Roles", "description": "Retrieves a list of all roles available for the account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-roles-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListRoles" }, "post": { "tags": [ "Role and Permission" ], "summary": "Create Role", "description": "Creates a custom role.\n\nSee [List Permissions](#/operations/ListPermissions) for available permission names.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/role-create-request" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/role" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the request mentioned in the “name” field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"missing\": Missing required field for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes: \n* \"forbidden\": the authenticated user is not allowed to create the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "409": { "description": "Error codes:\n* “duplicate”: Role with the same name already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "CreateRole" } }, "/roles/{roleId}": { "parameters": [ { "schema": { "type": "string" }, "name": "roleId", "in": "path", "required": true, "description": "The role identifier." } ], "get": { "summary": "Get Role", "description": "Retrieves a role by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/role" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* “empty”: Empty input for the “roleId” path parameter variable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the role.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the role could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetRole", "tags": [ "Role and Permission" ] }, "put": { "summary": "Update Role", "description": "Updates a role by identifier. Pay special attention to how [updating](../docs/Updating-data-with-PUT.html) works.\n\nSee [List Permissions](#/operations/ListPermissions) for available permission names.\n\n> Note: Only custom roles can be updated. Provisioned roles cannot be modified.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/role-update-request" } } } }, "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the \"name\" field on the error response, or provisioned roles cannot be updated.\n* \"empty\": Empty input for the \"roleId\" path parameter variable.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"missing\": Missing required field for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the role.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the role could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"duplicate\" Role with the same name already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "UpdateRole", "tags": [ "Role and Permission" ] }, "delete": { "summary": "Delete Role", "description": "Deletes a role by identifier.\n\n> Note: Only custom roles can be deleted. Provisioned roles cannot be removed.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the \"name\" field on the error response, or provisioned roles cannot be deleted.\n* \"empty\": Empty input for the \"roleId\" path parameter variable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the role.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the role could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "DeleteRole", "tags": [ "Role and Permission" ] } }, "/permissions": { "get": { "tags": [ "Role and Permission" ], "summary": "List Permissions", "description": "Retrieves a list of all permissions available for the account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-permissions-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListPermissions" } }, "/schedule-templates": { "get": { "summary": "List Schedule Templates", "description": "Retrieves a list of all the schedule templates in an account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/name" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-schedule-templates-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListScheduleTemplates", "tags": [ "Schedule Template" ] }, "parameters": [], "post": { "summary": "Create Schedule Template", "operationId": "CreateScheduleTemplate", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedule-template" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error responses:\n\n* “invalid”: invalid input on update schedule template model.\n* \"invalidLanguage\": The language used in configurations is invalid. Check the error message for more details.\n* \"maxSize\": The maximum size was exceeded for the value mentioned in the \"name\" or in the \"description\" fields.\n* \"invalidType\": The value provided for the \"taskTypeId\" field is invalid.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to create a schedule template.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "409": { "description": "Error codes:\n* \"duplicate\": A schedule template with the same name already exists in the same location.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "description": "Creates a new schedule template.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedule-template-create-request" } } } }, "tags": [ "Schedule Template" ] } }, "/schedule-templates/{scheduleTemplateId}": { "get": { "summary": "Get Schedule Template", "description": "Retrieves a schedule template by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedule-template" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* “empty”: Empty input for the “scheduleTemplateId” path parameter variable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the schedule template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the schedule template could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetScheduleTemplate", "tags": [ "Schedule Template" ] }, "parameters": [ { "schema": { "type": "string" }, "name": "scheduleTemplateId", "in": "path", "required": true, "description": "The id of the schedule template." } ], "delete": { "summary": "Delete Schedule Template", "operationId": "DeleteScheduleTemplate", "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the schedule template.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\n* \"notFound\": the schedule template could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "description": "Deletes a schedule template.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "tags": [ "Schedule Template" ] }, "put": { "summary": "Update Schedule Template", "operationId": "UpdateScheduleTemplate", "responses": { "204": { "description": "No content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error responses:\n\n* “invalid”: invalid input on update schedule template model.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response or in “scheduleTemplateId” path variable.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" or in the \"description\" fields. \n* \"invalidType\": The value provided for the \"taskTypeId\" field is invalid.", "headers": { "X-LC-TraceId": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the schedule template.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\n* \"notFound\": the schedule template could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "409": { "description": "Error codes:\n* \"duplicate\": A schedule template with the same name already exists in the same location.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "description": "Updates the schedule template identified by `scheduleTemplateId`.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schedule-template-update-request" } } } }, "tags": [ "Schedule Template" ] } }, "/tasks/{taskId}": { "get": { "tags": [ "Task" ], "summary": "Get Task", "description": "Retrieves a task.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task" }, "examples": { "simple": { "value": { "id": "df680285-adcd-4bda-8f79-0bba4a857287", "status": "created" } }, "unexpected-enum": { "value": { "id": "df680285-adcd-4bda-8f79-0bba4a857287", "status": "unexpectedEnumValue" } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the task.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetTask" }, "parameters": [ { "$ref": "#/components/parameters/taskId" } ] }, "/tasks/assigned": { "get": { "tags": [ "Task" ], "summary": "List Tasks assigned to me", "description": "Retrieves the tasks assigned to the authenticated user.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "name": "status", "in": "query", "description": "If specified, this filters tasks by status.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-tasks-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListTasksAssignedToMe" } }, "/tasks/{taskId}/accept": { "put": { "tags": [ "Task" ], "summary": "Accept Task", "description": "Accepts a task. The authenticated user becomes the owner of the accepted task and can start work on it. Optionally, the task can be accepted on behalf of a group by providing the `onBehalfOfGroup` query parameter. In this case, the authenticated user must be a member of the specified group, and the group must be present in the task's assignee list. The `onBehalfOfGroup` parameter is allowed only if the [task](#/operations/GetTask) has `configuration.CONCURRENT_EDITING_ENABLED = true`.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "name": "onBehalfOfGroup", "in": "query", "required": false, "description": "The identifier of the group on behalf of which the task is being accepted. The authenticated user must be a member of the specified group, and the group must be present in the task's assignee list.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"alreadyOwned\": the task is already owned\n* \"invalidStatus\": the task status doesn't permit the accept operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "AcceptTask" }, "parameters": [ { "$ref": "#/components/parameters/taskId" } ] }, "/tasks/{taskId}/reject": { "put": { "tags": [ "Task" ], "summary": "Reject Task", "description": "Rejects a task. The authenticated user will be removed from the task's list of available assignee users.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"alreadyOwned\": The task is already owned. It can't be rejected.\n* \"invalidStatus\": The task status doesn't permit the reject operation.\n* \"singleAssignee\": The authenticated user is the single assignee of the task, therefore the task can't be rejected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "RejectTask" }, "parameters": [ { "$ref": "#/components/parameters/taskId" } ] }, "/tasks/{taskId}/complete": { "put": { "tags": [ "Task" ], "summary": "Complete Task", "description": "Completes a task. The task is required to be in \"inProgress\" state and will be marked as \"completed\".", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task-complete-request" } } }, "required": true }, "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “maxSize“: Maximum size exceeded for the value mentioned in the “name“ field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to complete the task.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"invalidStatus\": The current task status doesn't permit this operation.\n* \"noOwner\": The current task was not accepted in advance.\n* \"differentOwner\": The current task is accepted by another user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "CompleteTask" }, "parameters": [ { "$ref": "#/components/parameters/taskId" } ] }, "/tasks/{taskId}/release": { "put": { "tags": [ "Task" ], "summary": "Release Task", "description": "Releases the task from its owner so that other task assignees will be able to accept it.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to release the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"noOwner\": the task currently has no owner.\n* \"differentOwner\": the authenticated user is not the owner of the task.\n* \"invalidStatus\": the task's status does not permit this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ReleaseTask" }, "parameters": [ { "$ref": "#/components/parameters/taskId" } ] }, "/tasks/{taskId}/reclaim": { "put": { "tags": [ "Task" ], "summary": "Reclaim Task", "description": "The current owner of task is removed so that other assignees can accept it. \nThe task is not reassigned automatically.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty value for variable mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to reclaim the task.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"invalidStatus\": the current task's status doesn't permit this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ReclaimTask" }, "parameters": [ { "$ref": "#/components/parameters/taskId" } ] }, "/tasks/{taskId}/assign": { "put": { "tags": [ "Task" ], "summary": "Assign Task", "description": "Assigns a task. The task assignees will be updated.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task-assign-request" } } }, "required": true }, "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input mentioned in the “name” field on the error response.\n* \"limit.exceeded\": a maximum number of users per task was assigned\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to assign the task.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"invalidStatus\": the current task's status doesn't permit the operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "AssignTask" }, "parameters": [ { "$ref": "#/components/parameters/taskId" } ] }, "/task-types/{taskTypeId}": { "get": { "tags": [ "Task Type" ], "summary": "Get Task Type", "description": "Retrieves a task type by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task-type" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the task type.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetTaskType" }, "parameters": [ { "$ref": "#/components/parameters/taskTypeId" } ] }, "/task-types": { "get": { "tags": [ "Task Type" ], "summary": "List Task Types", "description": "Retrieves all the task types in an account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "name": "key", "in": "query", "description": "Filter by keys.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "automatic", "in": "query", "description": "Filter by automatic or human tasks.", "schema": { "type": "boolean" } }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-task-types-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListTaskTypes" } }, "/translation-engines/{translationEngineId}": { "get": { "tags": [ "Translation Engine" ], "summary": "Get Translation Engine", "description": "Retrieves a translation engine.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-engine" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n\n* \"forbidden\": - The authenticated user is not allowed to read resource.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\n* \"notFound\": The translation engine could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "GetTranslationEngine" }, "parameters": [ { "$ref": "#/components/parameters/translationEngineId" } ], "put": { "summary": "Update Translation Engine", "operationId": "UpdateTranslationEngine", "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty input in the update translation engine model. Check error details.\n* \"invalidLanguage\": Invalid language code used in language-pair", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to update the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n\n * \"updateNotAllowed\": Property specified in error response can not be updated because the translation engine provided is a copy assigned to a project.\n* \"duplicate\": Duplicate resources found for the language pair specified in the error details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "description": "Updates a translation engine. \n\nIt can be used to update a stand-alone translation engine or a project's translation engine. \nThe identifier of a project's translation engine can be retrieved only by calling [Get Project](#/operations/GetProject) endpoint.\n\nPay special attention that some properties can not be changed for a project's translation engine. These include: name, description, definition.languageProcessingId, and language pairs can not be added/removed from definition.languagePairDefinitions. \n\nPay special attention to how [updating](../docs/Updating-data-with-PUT.html) works.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-engine-update-request" } } }, "description": "" }, "tags": [ "Translation Engine" ] } }, "/translation-engines": { "get": { "tags": [ "Translation Engine" ], "summary": "List Translation Engines", "description": "Retrieves all the translation engines in an account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-translation-engines-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListTranslationEngines" } }, "/termbase-templates": { "get": { "summary": "List Termbase Templates", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-termbase-templates-response" }, "examples": { "termbase-templates-list": { "value": { "items": [ { "id": "test-id-1", "name": "test-name-1", "location": { "id": "test-location-id-1", "name": "test-location-name-1" }, "type": "system", "languages": [ { "languageCode": "test-language-code-1" } ], "fields": [ { "id": "test-field-id-1", "name": "test-field-name-1", "type": "system", "level": "entry", "dataType": "text" } ] }, { "id": "test-id-2", "name": "test-name-2", "location": { "id": "test-location-id-2", "name": "test-location-name-2" }, "type": "userDefined", "languages": [ { "languageCode": "test-language-code-2" } ], "fields": [ { "id": "test-field-id-2", "name": "test-field-name-2", "type": "userDefined", "level": "language", "dataType": "boolean" } ] } ], "itemCount": 2 } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the resources.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListTermbaseTemplates", "description": "List termbase templates.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "in": "query", "name": "location", "description": "The identifiers of the resource folders. ", "schema": { "type": "array", "items": { "type": "string" } } }, { "$ref": "#/components/parameters/fields" }, { "schema": { "type": "string", "enum": [ "system", "userDefined" ] }, "in": "query", "name": "type", "description": "The type of the termbase template to retrieve. If not specified, both types will be returned" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" } ], "tags": [ "Termbase Template" ] }, "parameters": [], "post": { "summary": "Create Termbase Template", "operationId": "CreateTermbaseTemplate", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/termbase-template" }, "examples": { "Example 1": { "value": { "id": "string", "name": "string", "description": "string", "copyright": "string", "location": { "id": "string", "name": "string", "hasParent": true, "path": [ { "id": "string", "name": "string", "location": "string", "hasParent": true } ] }, "createdAt": "2022-01-12T12:00:00Z", "lastModifiedAt": "2022-01-12T12:00:00Z", "type": "system", "languages": [ { "languageCode": "string", "englishName": "string", "direction": "string", "parentLanguageCode": "string", "defaultSpecificLanguageCode": "string", "isNeutral": true } ], "fields": [ { "id": "string", "name": "string", "description": "string", "type": "system", "level": "entry", "dataType": "text", "pickListValues": [ "string" ], "allowCustomValues": true, "allowMultiple": true, "isMandatory": true } ] } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"duplicate\": The field name must be unique within the list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to create a termbase template in the specified location.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": - The specified location was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"duplicate\": There is already a termbase template with the same name.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "description": "Creates a new termbase template.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/termbase-template-create-request" } } } }, "tags": [ "Termbase Template" ] } }, "/termbase-templates/{termbaseTemplateId}": { "get": { "summary": "Get Termbase Template", "tags": [ "Termbase Template" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/termbase-template" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n\n* \"forbidden\": - The authenticated user is not allowed to read resource\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the termbase template could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetTermbaseTemplate", "description": "Get a termbase template by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ] }, "delete": { "summary": "Delete Termbase Template", "operationId": "DeleteTermbaseTemplate", "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the termbase template\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the termbase template could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"conflict\": cannot delete system termbase templates", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "description": "Deletes a termbase template by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "tags": [ "Termbase Template" ] }, "put": { "summary": "Update Termbase Template", "operationId": "UpdateTermbaseTemplate", "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"duplicate\": The field name must be unique within the list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to update the termbase template.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"duplicate\": There is already a termbase template with the same name.\n* \"conflict\": cannot update system termbase template", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/termbase-template-update-request" } } } }, "description": "Updates the termbase template.", "tags": [ "Termbase Template" ] }, "parameters": [ { "$ref": "#/components/parameters/termbaseTemplateId" } ] }, "/termbase-templates/convert-xdt": { "post": { "summary": "Convert XDT to Termbase Structure", "operationId": "ConvertTermbaseTemplate", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/termbase-structure" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error code “invalid” in case of:\r\n * Empty or missing file in request\r\n * Not valid multipart request\r\n * File parameter contains other extension than the one expected by specification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "description": "Converts a termbase definition (XDT file) to a termbase structure that will be returned in the response.
\nThe structure will not be stored in the Trados Cloud Platform.", "parameters": [ { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary", "description": "The .xdt file (binary string) used for conversion." } } } } }, "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." }, "tags": [ "Termbase Template" ] }, "parameters": [] }, "/termbases": { "get": { "summary": "List Termbases", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-termbases-response" }, "examples": { "termbases-list": { "value": { "items": [ { "id": "test-id-1", "name": "test-name-1", "location": { "id": "test-location-id-1", "name": "test-location-name-1" }, "termbaseStructure": { "languages": [ { "languageCode": "test-language-code-1" } ], "fields": [ { "id": "test-field-id-1", "name": "test-field-name-1", "type": "system", "level": "entry", "dataType": "text" } ] }, "numberOfEntries": 1, "status": "ready" }, { "id": "test-id-2", "name": "test-name-2", "location": { "id": "test-location-id-2", "name": "test-location-name-2" }, "termbaseStructure": { "languages": [ { "languageCode": "test-language-code-2" } ], "fields": [ { "id": "test-field-id-2", "name": "test-field-name-2", "type": "userDefined", "level": "language", "dataType": "boolean" } ] }, "numberOfEntries": 2, "status": "ready" } ], "itemCount": 2 } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListTermbase", "description": "List termbases.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" } ], "tags": [ "Termbase" ] }, "post": { "summary": "Create Termbase", "operationId": "CreateTermbase", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/termbase" }, "examples": { "Example 1": { "value": { "id": "string", "name": "string", "description": "string", "copyright": "string", "location": { "id": "string", "name": "string", "hasParent": true, "path": [ { "id": "string", "name": "string", "location": "string", "hasParent": true } ] }, "termbaseStructure": { "languages": [ { "languageCode": "string", "englishName": "string", "direction": "string", "parentLanguageCode": "string", "defaultSpecificLanguageCode": "string", "isNeutral": true } ], "fields": [ { "id": "string", "name": "string", "description": "string", "type": "system", "level": "entry", "dataType": "text", "pickListValues": [ "string" ], "allowCustomValues": true, "allowMultiple": true, "isMandatory": true } ] }, "numberOfEntries": 0, "status": "ready", "createdAt": "2022-01-12T12:00:00Z", "lastModifiedAt": "2022-01-12T12:00:00Z" } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to create a termbase.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.\n* \"quotaReached\": - You have reached the maximum allowable number of termbases for your account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": - The specified location was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"duplicate\": There is already a termbase with the same name.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "description": "Creates a new termbase.\nThe termbase can be created with a termbase template by providing the templateId or by providing a custom termbaseStructure. \nIf only a `termbaseTemplateId` was provided, the termbase will be created using data from the template. \nIf only a `termbaseStructure` was provided, the termbase will be created using data from the structure. \nIf both, `termbaseTemplateId` and `termbaseStructure` are added in the request, the `termbaseStructure` takes precedence.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/termbase-create-request" } } }, "description": "" }, "tags": [ "Termbase" ] } }, "/termbases/{termbaseId}": { "get": { "summary": "Get Termbase", "tags": [ "Termbase" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/termbase" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the resource.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetTermbase", "description": "Retrieves a termbase by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ] }, "delete": { "summary": "Delete Termbase", "operationId": "DeleteTermbase", "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the termbase\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the termbase could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"invalidStatus\": The termbase cannot be deleted as is currently being processed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "description": "Deletes a termbase by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "tags": [ "Termbase" ] }, "put": { "summary": "Update Termbase", "operationId": "UpdateTermbase", "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"duplicate\": The field name must be unique within the list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to update the termbase.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": - The specified termbase identifier was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"duplicate\": There is already a termbase with the same name.\n* \"invalidStatus\": The termbase cannot be updated as is currently being processed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/termbase-update-request" } } } }, "description": "Updates the termbase.\nThe termbase can be updated with a termbase template by providing the termbaseTemplateId or by providing a custom termbaseStructure. \n\nIf only a `termbaseTemplateId ` was provided, the termbase will be updated using data from the template. \nIf only a `termbaseStructure` was provided, the termbase will be updated using data from the structure. \nIf both, `termbaseTemplateId` and `termbaseStructure` are added in the request, the `termbaseStructure` takes precedence.", "tags": [ "Termbase" ] }, "parameters": [ { "$ref": "#/components/parameters/termbaseId" } ] }, "/termbases/{termbaseId}/entries": { "post": { "summary": "Create Termbase Entry", "operationId": "CreateTermbaseEntry", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/termbase-entry" }, "examples": { "termbase-entry-create": { "value": { "id": "string", "humanReadableId": "string", "languages": [ { "id": "string", "language": { "languageCode": "string", "englishName": "string", "direction": "string", "parentLanguageCode": "string", "defaultSpecificLanguageCode": "string", "isNeutral": true }, "terms": [ { "id": "string", "text": "string", "termbaseFieldValues": [ { "id": "string", "name": "string", "termbaseFieldId": "string", "value": "string", "fieldValueLinks": [ { "type": "term", "value": "string" } ], "createdAt": "2019-08-24T14:15:22Z", "createdBy": { "id": "string", "email": "string", "firstName": "string", "lastName": "string", "anonymized": true, "anonymizedUserName": "string", "location": { "id": "string", "name": "string" }, "groups": [ { "id": "string", "name": "string", "description": "string", "location": { "id": "string", "name": "string" }, "users": [ { "id": "string" } ] } ] }, "lastModifiedAt": "2019-08-24T14:15:22Z", "lastModifiedBy": { "id": "string", "email": "string", "firstName": "string", "lastName": "string", "anonymized": true, "anonymizedUserName": "string", "location": { "id": "string", "name": "string" }, "groups": [ { "id": "string", "name": "string", "description": "string", "location": { "id": "string", "name": "string" }, "users": [ { "id": "string" } ] } ] } } ], "createdAt": "2019-08-24T14:15:22Z", "createdBy": { "id": "string", "email": "string", "firstName": "string", "lastName": "string", "anonymized": true, "anonymizedUserName": "string", "location": { "id": "string", "name": "string" }, "groups": [ { "id": "string", "name": "string", "description": "string", "location": { "id": "string", "name": "string" }, "users": [ { "id": "string" } ] } ] }, "lastModifiedAt": "2019-08-24T14:15:22Z", "lastModifiedBy": { "id": "string", "email": "string", "firstName": "string", "lastName": "string", "anonymized": true, "anonymizedUserName": "string", "location": { "id": "string", "name": "string" }, "groups": [ { "id": "string", "name": "string", "description": "string", "location": { "id": "string", "name": "string" }, "users": [ { "id": "string" } ] } ] } } ], "termbaseFieldValues": [ { "id": "string", "name": "string", "termbaseFieldId": "string", "value": "string", "fieldValueLinks": [ { "type": "term", "value": "string" } ], "createdAt": "2019-08-24T14:15:22Z", "createdBy": { "id": "string", "email": "string", "firstName": "string", "lastName": "string", "anonymized": true, "anonymizedUserName": "string", "location": { "id": "string", "name": "string" }, "groups": [ { "id": "string", "name": "string", "description": "string", "location": { "id": "string", "name": "string" }, "users": [ { "id": "string" } ] } ] }, "lastModifiedAt": "2019-08-24T14:15:22Z", "lastModifiedBy": { "id": "string", "email": "string", "firstName": "string", "lastName": "string", "anonymized": true, "anonymizedUserName": "string", "location": { "id": "string", "name": "string" }, "groups": [ { "id": "string", "name": "string", "description": "string", "location": { "id": "string", "name": "string" }, "users": [ { "id": "string" } ] } ] } } ], "createdAt": "2019-08-24T14:15:22Z", "createdBy": { "id": "string", "email": "string", "firstName": "string", "lastName": "string", "anonymized": true, "anonymizedUserName": "string", "location": { "id": "string", "name": "string" }, "groups": [ { "id": "string", "name": "string", "description": "string", "location": { "id": "string", "name": "string" }, "users": [ { "id": "string" } ] } ] }, "lastModifiedAt": "2019-08-24T14:15:22Z", "lastModifedBy": { "id": "string", "email": "string", "firstName": "string", "lastName": "string", "anonymized": true, "anonymizedUserName": "string", "location": { "id": "string", "name": "string" }, "groups": [ { "id": "string", "name": "string", "description": "string", "location": { "id": "string", "name": "string" }, "users": [ { "id": "string" } ] } ] } } ], "termbaseFieldValues": [ { "id": "string", "name": "string", "termbaseFieldId": "string", "value": "string", "fieldValueLinks": [ { "type": "term", "value": "string" } ], "createdAt": "2019-08-24T14:15:22Z", "createdBy": { "id": "string", "email": "string", "firstName": "string", "lastName": "string", "anonymized": true, "anonymizedUserName": "string", "location": { "id": "string", "name": "string" }, "groups": [ { "id": "string", "name": "string", "description": "string", "location": { "id": "string", "name": "string" }, "users": [ { "id": "string" } ] } ] }, "lastModifiedAt": "2019-08-24T14:15:22Z", "lastModifiedBy": { "id": "string", "email": "string", "firstName": "string", "lastName": "string", "anonymized": true, "anonymizedUserName": "string", "location": { "id": "string", "name": "string" }, "groups": [ { "id": "string", "name": "string", "description": "string", "location": { "id": "string", "name": "string" }, "users": [ { "id": "string" } ] } ] } } ], "createdAt": "2019-08-24T14:15:22Z", "createdBy": { "id": "string", "email": "string", "firstName": "string", "lastName": "string", "anonymized": true, "anonymizedUserName": "string", "location": { "id": "string", "name": "string" }, "groups": [ { "id": "string", "name": "string", "description": "string", "location": { "id": "string", "name": "string" }, "users": [ { "id": "string" } ] } ] }, "lastModifiedAt": "2019-08-24T14:15:22Z", "lastModifiedBy": { "id": "string", "email": "string", "firstName": "string", "lastName": "string", "anonymized": true, "anonymizedUserName": "string", "location": { "id": "string", "name": "string" }, "groups": [ { "id": "string", "name": "string", "description": "string", "location": { "id": "string", "name": "string" }, "users": [ { "id": "string" } ] } ] } } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"invalidLevel\" : The termbaseFieldId is invalid for the current termbaseField type\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to create an entry.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"invalidStatus\": The termbase cannot be updated as is currently being processed.\n* \"duplicate\" : An entry with the same value already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "description": "Creates a new termbase entry. For more information about how to use `fieldValueLinks` see [`Create termbase entry`](../docs/termbase/Termbase-entries.html#creating-a-termbase-entry).", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/termbase-entry-create-request" } } } }, "tags": [ "Termbase" ] }, "get": { "summary": "List Termbase Entries", "operationId": "ListTermbaseEntries", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-termbase-entries-response" }, "examples": { "termbase-entries-list": { "value": { "items": [ { "id": "test-id-1", "humanReadableId": "test-humanReadableId-1", "languages": [ { "id": "test-languages-id-1", "language": { "languageCode": "test-language-code-1" }, "terms": [ { "id": "test-terms-id-1", "text": "test-terms-test-1" } ] } ], "termbaseFieldValues": [ { "id": "test-termbaseFieldValues-id-1", "name": "test-termbaseFieldValues-name-1", "termbaseFieldId": "test-termbaseFieldValues-termbaseFieldId-1", "value": "test-termbaseFieldValues-value-1", "fieldValueLinks": [ { "type": "term", "value": "test-value-1" } ] } ] }, { "id": "test-id-2", "humanReadableId": "test-humanReadableId-2", "languages": [ { "id": "test-languages-id-2", "language": { "languageCode": "test-language-code-2" }, "terms": [ { "id": "test-terms-id-2", "text": "test-terms-test-2" } ] } ], "termbaseFieldValues": [ { "id": "test-termbaseFieldValues-id-2", "name": "test-termbaseFieldValues-name-2", "termbaseFieldId": "test-termbaseFieldValues-termbaseFieldId-2", "value": "test-termbaseFieldValues-value-2", "fieldValueLinks": [ { "type": "term", "value": "test-value-2" } ] } ] } ], "itemCount": 2 } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the entries.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "description": "Retrieves a list of all the entries in a termbase.", "tags": [ "Termbase" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/humanReadableIds" } ] }, "delete": { "summary": "Delete Termbase Entries", "operationId": "DeleteTermbaseEntries", "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to delete an entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "description": "Deletes all the entries in the termbase.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "tags": [ "Termbase" ] }, "parameters": [ { "$ref": "#/components/parameters/termbaseId" } ] }, "/termbases/{termbaseId}/entries/{entryId}": { "get": { "summary": "Get Termbase Entry", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/termbase-entry" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the entry could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetTermbaseEntry", "description": "Retrieves a termbase entry by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "tags": [ "Termbase" ] }, "put": { "summary": "Update Termbase Entry", "operationId": "UpdateTermbaseEntry", "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to update the entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"invalidStatus\": The termbase cannot be updated as is currently being processed.\n* \"duplicate\" : An entry with the same value already exists.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "description": "Updates a termbase entry by identifier.\nThe request body will overwrite the existing data.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "tags": [ "Termbase" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/termbase-entry-update-request" } } } } }, "delete": { "summary": "Delete Termbase Entry", "operationId": "DeleteTermbaseEntry", "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to delete the termbase entries.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "description": "Deletes a termbase entry.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "tags": [ "Termbase" ] }, "parameters": [ { "$ref": "#/components/parameters/termbaseId" }, { "$ref": "#/components/parameters/entryId" } ] }, "/termbases/{termbaseId}/exports": { "parameters": [ { "$ref": "#/components/parameters/termbaseId" } ], "post": { "summary": "Export Termbase", "operationId": "ExportTermbase", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/termbase-export-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": - The specified termbase was not found.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "format": { "type": "string", "enum": [ "xml", "tbx" ], "default": "tbx", "description": "The file format used to export the termbase." }, "properties": { "$ref": "#/components/schemas/termbase-export-properties-request" } } } } } }, "description": "Generates an asynchronous export operation.
\nUse the [Poll Export Termbase](#/operations/PollExportTermbase) endpoint to poll until the export status is `done`.", "tags": [ "Termbase Export" ] } }, "/termbases/{termbaseId}/exports/{exportId}": { "parameters": [ { "$ref": "#/components/parameters/termbaseId" }, { "$ref": "#/components/parameters/exportId" } ], "get": { "summary": "Poll Termbase Export", "operationId": "PollExportTermbase", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/termbase-export-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": - The specified export was not found." } }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "description": "Polls a termbase via an export operation. The exported termbase can be downloaded once the status is `done`.", "tags": [ "Termbase Export" ] } }, "/termbases/{termbaseId}/exports/{exportId}/download": { "parameters": [ { "$ref": "#/components/parameters/termbaseId" }, { "$ref": "#/components/parameters/exportId" } ], "get": { "summary": "Download Exported Termbase", "operationId": "DownloadExportedTermbase", "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": - The specified termbase or export was not found.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "description": "Downloads the exported termbase when the poll operation status is `done`.", "tags": [ "Termbase Export" ] } }, "/termbases/{termbaseId}/export-template": { "parameters": [ { "name": "termbaseId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The termbase identifier." } ], "get": { "summary": "Export Termbase Template", "tags": [ "Termbase Export" ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "DownloadTermbaseDefinition", "description": "Downloads the termbase definition.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ] } }, "/termbases/{termbaseId}/terms/{sourceLanguageCode}": { "get": { "summary": "List Termbase Terms", "operationId": "ListTermbaseTerms", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-termbase-terms-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the entries.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "schema": { "type": "string", "maxLength": 100 }, "in": "query", "name": "search", "description": "The text to search for." }, { "schema": { "type": "string", "enum": [ "normal", "linguistic", "fuzzy" ], "default": "normal" }, "in": "query", "name": "searchType", "description": "The type of the search performed." }, { "schema": { "type": "string" }, "in": "query", "name": "targetLanguageCode", "description": "The target language code used to list the terms." } ], "description": "Retrieves a list of all the terms of the termbase.\nSearch types:\n- normal: Use normal search to look for terms that match the text exactly as entered.\n- linguistic: Use linguistic search to look for terms that are similar to the search term. Linguistic search is based on stemming and other language-dependent aspects.\n- fuzzy: Use fuzzy search to look for terms that are similar to the search term. Fuzzy search is more fault-tolerant than linguistic search.", "tags": [ "Termbase" ] }, "parameters": [ { "$ref": "#/components/parameters/termbaseId" }, { "schema": { "type": "string" }, "name": "sourceLanguageCode", "in": "path", "required": true, "description": "The source language code used to list the terms." } ] }, "/termbases/{termbaseId}/imports": { "parameters": [ { "$ref": "#/components/parameters/termbaseId" } ], "get": { "summary": "Get Termbase Import History", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-termbase-import-history" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetImportHistory", "description": "Gets the import history for a termbase.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" } ], "tags": [ "Termbase Import" ] }, "post": { "summary": "Import Termbase", "operationId": "ImportTermbase", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/termbase-import-response" }, "examples": { "import-termbase-ok": { "value": { "id": "test-import-id", "status": "queued" } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"invalidStatus\": Cannot import as the termbase is currently being processed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "schema": { "type": "boolean", "default": true }, "in": "query", "name": "strictImport", "description": "Specifies if the entries are only imported into the exact language that matches your imported file.
`true` - The import will only occur if the language in your import file matches exactly with a language in your termbase.
`false` - The import will occur even there are non-matching languages, by trying to match them to a relevant main language or language variant, if available." }, { "schema": { "type": "string", "enum": [ "ignore", "merge", "overwrite" ], "default": "overwrite" }, "in": "query", "name": "duplicateEntriesStrategy", "description": "The strategy for duplicate entries. Determines how the duplicate entries will be handled.
`ignore` - The content of the current entry with the same identifier will be kept, and the new entry will be ignored
`merge` - The content of the current entry with the same identifier will be merged with the imported entry. If the identifier is not provided the content will be merged by text.
`overwrite` - The content of the current entry with the same identifier will be replaced by the imported entry." } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "properties": { "$ref": "#/components/schemas/termbase-import-request" }, "file": { "type": "string", "format": "binary", "description": "The file (binary string) to import into the termbase.
\nAccepted file types: .xml, .tbx\n
" } } }, "examples": {} } }, "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." }, "description": "Generates an asynchronous import operation.
\nUse the Poll Import Termbase endpoint to poll until the import status is `done`.
", "tags": [ "Termbase Import" ] } }, "/termbases/{termbaseId}/imports/{importId}": { "parameters": [ { "$ref": "#/components/parameters/termbaseId" }, { "$ref": "#/components/parameters/importId" } ], "get": { "summary": "Poll Termbase Import", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/termbase-poll-import-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "PollTermbaseImport", "description": "Polls a termbase import operation.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "tags": [ "Termbase Import" ] } }, "/termbases/{termbaseId}/imports/{importId}/logs": { "parameters": [ { "$ref": "#/components/parameters/termbaseId" }, { "$ref": "#/components/parameters/importId" } ], "get": { "summary": "Download Termbase Import Logs", "operationId": "DownloadTermbaseImportLog", "description": "Downloads the termbase import logs.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "tags": [ "Termbase Import" ], "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error code: \n * \"invalid\": the value specified in the field \"name\" of the errorDetails is not an accepted value." }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } } } }, "/tqa-profiles": { "get": { "summary": "List TQA Profiles", "tags": [ "TQA Profile" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-tqa-profiles-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListTqaProfiles", "description": "List TQA Profiles.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/fields" } ] } }, "/tqa-profiles/{profileId}": { "get": { "summary": "Get TQA Profile", "tags": [ "TQA Profile" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tqa-profile" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the User could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetTqaProfile", "description": "Get a TQA Profile By identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ] }, "parameters": [ { "$ref": "#/components/parameters/profileId" } ] }, "/translation-memory/{translationMemoryId}": { "get": { "summary": "Get Translation Memory", "tags": [ "Translation Memory" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-memory" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetTranslationMemory", "description": "Get a single Translation Memory by identifier.", "parameters": [ { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/fields" } ] }, "put": { "summary": "Update Translation Memory", "operationId": "UpdateTranslationMemory", "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"minSize\": Minimum size not met for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "description": "Updates a Translation Memory. We recommend reading this page too [Updating data with PUT](../docs/Updating-data-with-PUT.html).", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-memory-update-request" } } } }, "parameters": [ { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/Authorization" } ], "tags": [ "Translation Memory" ] }, "delete": { "summary": "Delete Translation Memory", "operationId": "DeleteTranslationMemory", "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "description": "Deletes a Translation Memory.", "parameters": [ { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/Authorization" } ], "tags": [ "Translation Memory" ] }, "parameters": [ { "schema": { "type": "string" }, "name": "translationMemoryId", "in": "path", "required": true, "description": "The identifier of the translation memory" } ] }, "/translation-memory/{translationMemoryId}/copy": { "post": { "summary": "Copy Translation Memory", "tags": [ "Translation Memory" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-memory" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "CopyTranslationMemory", "description": "Creates a copy of a Translation Memory. The name will be suffixed with ' (Copy) '", "parameters": [ { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/fields" } ] }, "parameters": [ { "schema": { "type": "string" }, "name": "translationMemoryId", "in": "path", "required": true, "description": "The identifier of the translation memory" } ] }, "/translation-memory": { "get": { "summary": "List Translation Memories", "tags": [ "Translation Memory" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-translation-memories-reposne" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListTranslationMemories", "description": "Retrieves all the Translation Memories.", "parameters": [ { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/fields" } ] }, "post": { "summary": "Create Translation Memory", "operationId": "CreateTranslationMemory", "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-memory-base" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"minSize\": Minimum size not met for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "description": "Create a new Translation Memory.", "parameters": [ { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/fields" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-memory-create-request" } } } }, "tags": [ "Translation Memory" ] } }, "/translation-memory/field-templates": { "get": { "summary": "List Field Templates", "tags": [ "Translation Memory" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-translation-memory-field-templates" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListFieldTemplates", "parameters": [ { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "description": "Retrieves all the Field Templates." }, "parameters": [] }, "/translation-memory/field-templates/{fieldTemplateId}": { "parameters": [ { "schema": { "type": "string" }, "name": "fieldTemplateId", "in": "path", "required": true, "description": "The field template identifier" } ], "get": { "summary": "Get Field Template", "tags": [ "Translation Memory" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-memory-field-template" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetFieldTemplate", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "description": "Get a single Field Template by identifier." } }, "/translation-memory/{translationMemoryId}/imports": { "parameters": [ { "schema": { "type": "string" }, "name": "translationMemoryId", "description": "The identifier of the Translation Memory.", "in": "path", "required": true } ], "get": { "summary": "Get Translation Memory Import History", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-translation-memory-import-history" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the entry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetTMImportHistory", "description": "Gets the import history for a translation memory. It returns the history of last 7 days.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" } ], "tags": [ "Translation Memory Import" ] }, "post": { "summary": "Import Translation Memory", "operationId": "ImportTranslationMemory", "responses": { "200": { "description": "OK - returned when the `status` field has one of the following values: `failed`, `done`, `cancelled`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-memory-import-response" }, "examples": { "import-termbase-ok": { "value": { "id": "test-import-id", "status": "queued" } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "202": { "description": "Accepted - returned when the `status` field has one of the following values: `queued`, `inProgress`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-memory-import-response" }, "examples": { "import-termbase-ok": { "value": { "id": "test-import-id", "status": "queued" } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query/form parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"multiPartOrder\": The multipart order in the body is not correct. The `properties` must be first and then, file.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": Not authorized to import translation memories.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "properties", "file" ], "properties": { "properties": { "$ref": "#/components/schemas/translation-memory-import-request" }, "file": { "type": "string", "format": "binary", "description": "The file (binary string) to import into the translation memory.
Accepted file types: .tmx, .sdltm, .zip, .tmx.gz, .sdlxliff" } } }, "examples": {} } }, "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." }, "description": "Generates an asynchronous import operation. \n
\n
Read more about prerequisites and limitations on the [official documentation center](https://docs.rws.com/791595/741139/trados-enterprise/importing-tm-content).\n
\nNote: The order of the multipart form parameter must be implemented as such: properties first, file second.\n
\nUse the Poll Translation Memory Import endpoint to poll until the import status is `done`.
\nTo track the progress of the import please refer to [Poll Translation Memory Import](#/operations/PollTMImport).", "tags": [ "Translation Memory Import" ] } }, "/translation-memory/imports/{importId}": { "parameters": [ { "name": "importId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The import identifier." } ], "get": { "summary": "Poll Translation Memory Import", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-memory-import-poll-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the path parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the entry.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "PollTMImport", "description": "Polls a Translation Memory import operation. The import is finished when the status is `done`.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "tags": [ "Translation Memory Import" ] } }, "/translation-memory/{translationMemoryId}/exports": { "parameters": [ { "$ref": "#/components/parameters/translationMemoryId" } ], "post": { "summary": "Export Translation Memory", "operationId": "ExportTranslationMemory", "responses": { "200": { "description": "OK - returned when the `status` field has one of the following values: `failed`, `done`, `cancelled`", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-memory-export-response" } } } }, "202": { "description": "Accepted - returned when the `status` field has one of the following values: `queued`, `inProgress`", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-memory-export-response" } } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the request parameters. Either the `translationMemoryId` or the `sourceLanguageCode`/`targetLanguageCode` are invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to export the translation memory.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "description": "Generates an asynchronous export operation.\nUse the [Poll Translation Memory Export](#/operations/PollTranslationMemoryExport) endpoint to poll until the export status is `done`.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-memory-export-request" } } } }, "tags": [ "Translation Memory Export" ] } }, "/translation-memory/exports/{exportId}": { "parameters": [ { "$ref": "#/components/parameters/exportId" } ], "get": { "summary": "Poll Translation Memory Export", "tags": [ "Translation Memory Export" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-memory-poll-export-response" } } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid `exportId` in the path parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "PollTranslationMemoryExport", "description": "Polls a translation memory via an export operation. The exported translation memory can be downloaded once the status is `done`.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ] } }, "/translation-memory/exports/{exportId}/download": { "parameters": [ { "$ref": "#/components/parameters/exportId" } ], "get": { "summary": "Download Exported Translation Memory", "tags": [ "Translation Memory Export" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid `exportId` in the path parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "DownloadExportedTranslationMemory", "description": "Downloads the exported translation memory in the `tmx.gz` format when the poll operation status is `done`.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ] } }, "/translations/lookup": { "post": { "summary": "Lookup", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-search-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response. \n\n * \"invalid\": Invalid input mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Unauthorized to use translation engine.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": - translation engine not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "TranslationsLookup", "tags": [ "Translation" ], "description": "Translates a phrase in plain text or a BCM fragment containing a single segment. The translated content will be returned as a BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html) or [term](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Skeleton.Term.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.html) page.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-search-request" } } }, "description": "Learn more about Translation Memory standard penalties [here](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/trados-tm-penalties-1159224).\r\n
\r\nLearn more about Translation Unit status penalties [here](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/editing-project-tm-and-verification-settings-800732)." }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ] }, "parameters": [] }, "/translations/concordance": { "post": { "summary": "Concordance", "tags": [ "Translation" ], "responses": { "200": { "description": "OK.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-concordance-search-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response. \n\n * \"invalid\": Invalid input mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Unauthorized to use translation engine.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": - translation engine not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "TranslationsConcordanceSearch", "description": "Performs a concordance search for a given text within the TM linked to the specified translation engine. The translated content will be returned as a BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html) or [term](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Skeleton.Term.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.html) page.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-concordance-search-request" } } }, "description": "Learn more about Translation Memory standard penalties [here](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/trados-tm-penalties-1159224).\r\n
\r\nLearn more about Translation Unit status penalties [here](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/editing-project-tm-and-verification-settings-800732)." }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ] }, "parameters": [] }, "/translations/translation-unit": { "put": { "summary": "Update Translation Unit", "tags": [ "Translation" ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-unit-add-update-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response. \n\n * \"invalid\": Invalid input mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Unauthorized to use translation engine.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": - translation engine not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "TranslationsUpdate", "description": "Updates a translation unit. The system identifies matching translation units in the TM based on the provided BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.html) page.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-update-request" } } } } }, "post": { "summary": "Add Translation Unit", "tags": [ "Translation" ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-unit-add-update-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response. \n\n * \"invalid\": Invalid input mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Unauthorized to use translation engine.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": - translation engine not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "TranslationsAdd", "description": "Adds a translation unit. The system identifies matching translation units in the TM based on the provided BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.html) page.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/translation-add-request" } } } } } }, "/users/me": { "get": { "tags": [ "User" ], "summary": "Get my User", "description": "Retrieves the authenticated user.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetMyUser" } }, "/users": { "get": { "tags": [ "User" ], "summary": "List Users", "description": "Retrieves a list of all the users in an account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/fields" }, { "$ref": "#/components/parameters/email" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-users-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListUsers" }, "post": { "summary": "Create User", "tags": [ "User" ], "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes: \r\n* “invalid”: Invalid input in “name” field on the error response.\r\n* “maxSize“: The maximum size was exceeded for the value mentioned in the \"name\" field.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes: \r\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "409": { "description": "Error responses:\r\n* “duplicate”: duplicate value for the field mentioned in the error details.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "CreateUser", "description": "Creates a new user in an account.", "parameters": [ { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/fields" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user-create-request" } } } } } }, "/users/{userId}": { "get": { "tags": [ "User" ], "summary": "Get User", "description": "Retrieves a user by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "error codes:\n* \"notFound\": the User could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetUser" }, "parameters": [ { "$ref": "#/components/parameters/userId" } ], "put": { "summary": "Update User", "tags": [ "User" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes: \r\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\r\n* \"forbidden\": the authenticated user is not allowed to update the user.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\r\n* \"notFound\": the user could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "UpdateUser", "description": "Updates a user within the account.\r\n\r\nPlease follow the update rules detailed on the [Updating data with PUT](../docs/Updating-data-with-PUT.html) page.\r\n\r\nWhen performing an update, fields that are related to a different type of user will be ignored.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/user-update-request" } } } }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ] }, "delete": { "summary": "Delete User", "tags": [ "User" ], "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Invalid input in userId field.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "DeleteUser", "description": "Deletes a user.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ] } }, "/.well-known/jwks.json": { "get": { "summary": "List Public Keys", "tags": [ "Public Keys" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/well-known-jwks-response" }, "examples": { "list-keys-ok": { "value": { "keys": [ { "kty": "test-kty-1", "n": "test-n-1", "e": "test-e-1", "alg": "test-alg-1", "kid": "test-kid-1", "use": "test-use-1" }, { "kty": "test-kty-2", "n": "test-n-2", "e": "test-e-2", "alg": "test-alg-2", "kid": "test-kid-2", "use": "test-use-2" } ] } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListPublicKeys", "description": "List all available Public Keys." } }, "/.well-known/jwks.json/{kid}": { "get": { "summary": "Get Public Key", "tags": [ "Public Keys" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/jwk" }, "examples": { "get-key-ok": { "value": { "kty": "test-kty", "n": "test-n", "e": "test-e", "alg": "test-alg", "kid": "test-kid", "use": "test-use" } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the public key could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetPublicKey", "description": "Retrieves a public key by it's identifier." }, "parameters": [ { "schema": { "type": "string" }, "name": "kid", "in": "path", "required": true, "description": "The key identifier." } ] }, "/vendors": { "get": { "operationId": "ListVendors", "summary": "List Vendors", "description": "Retrieves a list of all the vendors in an account.", "tags": [ "Vendor" ], "parameters": [ { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-vendors-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } } }, "post": { "operationId": "CreateVendor", "summary": "Create Vendor", "description": "Creates a new vendor organization. A vendor represents an external LSP that can be assigned translation tasks. The key contact provided will become the primary point of contact for the vendor.\n\nCreating a vendor automatically provisions a dedicated folder and a `VendorProjectManager` group within the account hierarchy.\n\n**Managing vendor members:** Users can be added to a vendor by inviting them via the [Create User](#/operations/CreateUser) endpoint, specifying the auto-created `VendorProjectManager` group as one of the `groups` in the request. Users can be removed from the vendor by removing them from that group using the [Update Group](#/operations/UpdateGroup) or [Update User](#/operations/UpdateUser) endpoints.", "tags": [ "Vendor" ], "parameters": [ { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vendor-create-request" }, "examples": { "selfManagedVendor": { "summary": "Self-managed vendor with quote template and custom fields", "value": { "name": "Lionbridge", "description": "Leading global LSP specializing in translation and localization.", "keyContact": { "firstName": "John", "lastName": "Doe", "email": "john.doe@lionbridge.com" }, "selfManaged": true, "quoteTemplateId": "ab49e078-8ea1-45fc-b469-475c38a1d20b", "customFields": [ { "key": "vendor_tier", "value": "premium" } ] } }, "managedVendorMinimal": { "summary": "Externally managed vendor, no quote template", "value": { "name": "TransPerfect", "keyContact": { "firstName": "Jane", "lastName": "Smith", "email": "jane.smith@transperfect.com" }, "selfManaged": false } } } } } }, "responses": { "201": { "description": "Vendor created successfully.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vendor" }, "examples": { "selfManagedVendor": { "summary": "Self-managed vendor with quote template", "value": { "id": "69e693d00000000000000000", "name": "Lionbridge", "description": "Leading global LSP specializing in translation and localization.", "keyContact": { "id": "69e693d00000000000000001", "firstName": "John", "lastName": "Doe", "email": "john.doe@lionbridge.com" }, "vendorFolder": { "id": "a91ec1bdc70be40ad55bfb34d76c0026", "name": "vendors" }, "groups": [ { "id": "69e693d00000000000000002", "name": "VendorProjectManager" } ], "selfManaged": true, "quoteTemplate": { "id": "ab49e078-8ea1-45fc-b469-475c38a1d20b", "name": "Standard Quote Template" } } }, "managedVendorMinimal": { "summary": "Externally managed vendor, no quote template", "value": { "id": "69e693d00000000000000003", "name": "TransPerfect", "keyContact": { "id": "69e693d00000000000000004", "firstName": "Jane", "lastName": "Smith", "email": "jane.smith@transperfect.com" }, "vendorFolder": { "id": "b82fd2cec81cf51be66agc45e87d1137", "name": "vendors" }, "groups": [ { "id": "69e693d00000000000000005", "name": "VendorProjectManager" } ], "selfManaged": false } } } } }, "links": { "GetVendorById": { "operationId": "GetVendor", "parameters": { "vendorId": "$response.body#/id" }, "description": "Use the returned vendor `id` to retrieve the full vendor resource." }, "CreateVendorOrderTemplate": { "operationId": "CreateVendorOrderTemplate", "description": "Associate this vendor with a vendor order template to enable task assignment." } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the field mentioned in the \"name\" field on the error response.\n* \"empty\": Empty input in the body parameter mentioned in the \"name\" field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"missing\": Missing required field for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to create vendor order templates.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* “duplicate”: duplicate value for the field mentioned in the error details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } } } }, "/vendors/{vendorId}": { "get": { "operationId": "GetVendor", "summary": "Get Vendor", "description": "Retrieves a vendor by identifier.\n\nUse the `fields` query parameter to include optional nested resources such as `members`. The `members` field returns the users in the vendor's `VendorProjectManager` group. To manage vendor members, use the [Create User](#/operations/CreateUser), [Update User](#/operations/UpdateUser), or [Update Group](#/operations/UpdateGroup) endpoints.", "tags": [ "Vendor" ], "parameters": [ { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vendor" }, "examples": { "selfManagedVendor": { "summary": "Self-managed vendor with quote template and members", "value": { "id": "69e693d00000000000000000", "name": "Lionbridge", "description": "Leading global LSP specializing in translation and localization.", "keyContact": { "id": "69e693d00000000000000001", "firstName": "John", "lastName": "Doe", "email": "john.doe@lionbridge.com" }, "vendorFolder": { "id": "a91ec1bdc70be40ad55bfb34d76c0026", "name": "vendors" }, "groups": [ { "id": "69e693d00000000000000002", "name": "VendorProjectManager" } ], "selfManaged": true, "quoteTemplate": { "id": "ab49e078-8ea1-45fc-b469-475c38a1d20b", "name": "Standard Quote Template" }, "members": [ { "id": "69e693d00000000000000010", "firstName": "Alice", "lastName": "Translator", "email": "alice@lionbridge.com" } ] } }, "externallyManagedVendor": { "summary": "Externally managed vendor, no quote template", "value": { "id": "69e693d00000000000000003", "name": "TransPerfect", "keyContact": { "id": "69e693d00000000000000004", "firstName": "Jane", "lastName": "Smith", "email": "jane.smith@transperfect.com" }, "vendorFolder": { "id": "b82fd2cec81cf51be66agc45e87d1137", "name": "vendors" }, "groups": [ { "id": "69e693d00000000000000005", "name": "VendorProjectManager" } ], "selfManaged": false } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the vendor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the vendor could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } } }, "put": { "operationId": "UpdateVendor", "summary": "Update Vendor", "description": "Updates a vendor by identifier. Only fields included in the request body are updated. We recommend reading [Updating data with PUT](../docs/Updating-data-with-PUT.html) before using this endpoint.\n\n**Member management is not part of this endpoint.** To add a user to a vendor, invite them via the [Create User](#/operations/CreateUser) endpoint specifying the vendor's `VendorProjectManager` group. To remove a user from the vendor, remove them from that group using the [Update Group](#/operations/UpdateGroup) or [Update User](#/operations/UpdateUser) endpoints.", "tags": [ "Vendor" ], "parameters": [ { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/Authorization" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vendor-update-request" } } }, "required": true }, "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the field mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the vendor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the vendor could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"duplicate\": duplicate value for the field mentioned in the error details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } } } }, "delete": { "operationId": "DeleteVendor", "summary": "Delete Vendor", "description": "Deletes a vendor by identifier.", "tags": [ "Vendor" ], "parameters": [ { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/Authorization" } ], "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the vendor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the vendor could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\n* \"conflict\": the vendor cannot be deleted because its folder contains resources that must be removed first. The error details describe which resources are blocking deletion.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } } }, "parameters": [ { "schema": { "type": "string" }, "name": "vendorId", "in": "path", "required": true, "description": "The vendor identifier." } ] }, "/vendors/{vendorId}/order-templates": { "get": { "operationId": "ListVendorOrderTemplates", "summary": "List Vendor Order Templates", "description": "Retrieves a list of vendor order templates for the specified vendor.", "tags": [ "Vendor" ], "parameters": [ { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-vendor-order-templates-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to list vendor order templates for this vendor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the vendor could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } } }, "post": { "operationId": "CreateVendorOrderTemplate", "summary": "Create Vendor Order Template", "description": "Creates a new vendor order template for the specified vendor.\n\nFor more information on creating vendor order templates, see [Creating order templates for vendors](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/creating-order-templates-for-vendors-708439).", "tags": [ "Vendor" ], "parameters": [ { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/fields" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vendor-order-template-create-request" }, "examples": { "singleLanguagePair": { "summary": "Single language pair, with one manager and one assignee, wait for all files (default delay)", "value": { "name": "EN-FR Translation", "pricingModelId": "pm-abc123", "quoteConfiguration": { "behaviour": "waitForAllFiles" }, "languagePairs": [ { "source": "en-US", "target": "fr-FR" } ], "assignments": [ { "languagePair": { "source": "en-US", "target": "fr-FR" }, "managers": [ { "type": "user", "id": "69e693d00000000000000010" } ], "assignees": [ { "type": "user", "id": "69e693d00000000000000011" } ] } ] } }, "multipleLanguagePairs": { "summary": "Multiple language pairs with group assignees and wait for all files with custom holding delay", "value": { "name": "Multilingual Package", "description": "Template covering EN to DE and FR with a group-based assignee.", "pricingModelId": "pm-def456", "quoteConfiguration": { "behaviour": "waitForAllFiles", "holdingDelay": 120 }, "allowQuoteEditing": true, "serviceTypes": [ "st-translation-001" ], "languagePairs": [ { "source": "en-US", "target": "de-DE" }, { "source": "en-US", "target": "fr-FR" } ], "assignments": [ { "languagePair": { "source": "en-US", "target": "de-DE" }, "managers": [ { "type": "user", "id": "69e693d00000000000000010" } ], "assignees": [ { "type": "group", "id": "69e693d00000000000000002" } ] }, { "languagePair": { "source": "en-US", "target": "fr-FR" }, "managers": [ { "type": "user", "id": "69e693d00000000000000010" } ], "assignees": [ { "type": "user", "id": "69e693d00000000000000011" } ] } ] } } } } }, "required": true }, "responses": { "201": { "description": "Vendor Order Template created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vendor-order-template-response" }, "examples": { "singleLanguagePair": { "summary": "Single language pair template", "value": { "id": "vot-abc123", "name": "EN-FR Translation", "quoteConfiguration": { "behaviour": "waitForAllFiles" }, "allowQuoteEditing": false, "pricingModel": { "id": "pm-abc123", "name": "Standard Rate" }, "languagePairs": [ { "source": "en-US", "target": "fr-FR" } ], "assignments": [ { "languagePair": { "source": "en-US", "target": "fr-FR" }, "managers": [ { "type": "user", "id": "69e693d00000000000000010" } ], "assignees": [ { "type": "user", "id": "69e693d00000000000000011" } ] } ] } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the field mentioned in the \"name\" field on the error response.\n* \"empty\": Empty input in the body parameter mentioned in the \"name\" field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response. \n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to create vendor order templates.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the vendor could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } } }, "parameters": [ { "schema": { "type": "string" }, "name": "vendorId", "in": "path", "required": true, "description": "The vendor identifier." } ] }, "/vendors/{vendorId}/order-templates/{orderTemplateId}": { "get": { "operationId": "GetVendorOrderTemplate", "summary": "Get Vendor Order Template", "description": "Retrieves a vendor order template by identifier.", "tags": [ "Vendor" ], "parameters": [ { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vendor-order-template-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the field mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the vendor order template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the vendor order template could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } } }, "put": { "operationId": "UpdateVendorOrderTemplate", "summary": "Update Vendor Order Template", "description": "Updates a vendor order template by identifier. Only fields included in the request body are updated. We recommend reading [Updating data with PUT](../docs/Updating-data-with-PUT.html) before using this endpoint.", "tags": [ "Vendor" ], "parameters": [ { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/Authorization" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vendor-order-template-update-request" } } }, "required": true }, "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the field mentioned in the \"name\" field on the error response.\n* \"empty\": Empty input in the body parameter mentioned in the \"name\" field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response. \n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the vendor order template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the vendor order template could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } } }, "delete": { "operationId": "DeleteVendorOrderTemplate", "summary": "Delete Vendor Order Template", "description": "Deletes a vendor order template by identifier.", "tags": [ "Vendor" ], "parameters": [ { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/Authorization" } ], "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* \"invalid\": Invalid input in the field mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the vendor order template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the vendor order template could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } } }, "parameters": [ { "schema": { "type": "string" }, "name": "vendorId", "in": "path", "required": true, "description": "The vendor identifier." }, { "schema": { "type": "string" }, "name": "orderTemplateId", "in": "path", "required": true, "description": "The vendor order template identifier." } ] }, "/workflows/{workflowId}": { "get": { "tags": [ "Workflow" ], "summary": "Get Workflow", "description": "Retrieves a workflow by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the workflow.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } } }, "404": { "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "GetWorkflow" }, "put": { "tags": [ "Workflow" ], "summary": "Update Workflow", "description": "Updates the workflow in terms of: name, description, task configuration (and its details), and task type configuration values (`configurationValues`). Observe the rules of [JSON Merge Patch Semantics](https://tools.ietf.org/html/rfc7386).", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workflow-update-request" } } }, "required": true }, "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the body parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty input in the body parameter mentioned in the \"name\" field on the error response.\n* \"limit.exceeded\": a maximum number of users per task was assigned\n", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/error-response" } } } }, "401": { "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/error-response" } } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the Workflow.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the Workflow could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "409": { "description": "Error codes:\r\n* \"projectPlanChanged\": The associated project has already been changed at the level of `projectPlan.taskConfigurations`. Updating the workflow is no longer possible; the project should be updated to set the relevant `projectPlan.taskConfigurations` fields. \r\n", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/error-response" } } } } }, "operationId": "UpdateWorkflow" }, "parameters": [ { "$ref": "#/components/parameters/workflowId" } ] }, "/workflows": { "get": { "tags": [ "Workflow" ], "summary": "List Workflows", "description": "Retrieves all the workflows in an account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/location" }, { "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/sort" }, { "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-workflows-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "416": { "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListWorkflows" } }, "/projects/{projectId}/custom-fields/{customFieldKey}": { "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The project identifier." }, { "schema": { "type": "string" }, "name": "customFieldKey", "in": "path", "required": true, "description": "The custom field key." } ], "put": { "summary": "Update Custom Field", "operationId": "UpdateCustomField", "responses": { "204": { "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "description": "Error codes:\n* “invalid”: Invalid input for a readOnly field, with a different value than the deafult one. Also this code is used for invalid input values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "403": { "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the Custom field for the Project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "404": { "description": "Error codes:\n* \"notFound\": the Project could not be found by identifier or Custom field key could not be found or does not belong to the desired resource type.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom-field-update-request", "description": "Thew new value along wit" } } } }, "tags": [ "Project" ], "description": "Allows updating individual custom fields on a project.", "parameters": [] } }, "/translation-domain/service-types": { "get": { "summary": "List Service Types", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-translation-service-types-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "401": { "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } }, "operationId": "ListTranslationServiceTypes", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "tags": [ "Translation Domain" ], "description": "List all available service types." } } }, "components": { "schemas": { "account": { "title": "Account", "type": "object", "properties": { "id": { "type": "string", "description": "The account identifier." }, "name": { "type": "string", "description": "
default
The account name.
", "x-default-field": true } }, "required": [ "id" ] }, "account-membership-type": { "title": "Account Membership Type", "type": "string", "enum": [ "member", "collaborator" ], "description": "Type of membership of this account user." }, "add-projects-to-group-request": { "title": "Add Projects To Group Request", "type": "object", "description": "Input for adding projects to group.", "properties": { "projects": { "type": "array", "description": "The projects to be added to group.", "items": { "$ref": "#/components/schemas/project-group-project-request" } } }, "required": [ "projects" ] }, "add-projects-to-group-response": { "title": "Add Projects To Group Response", "type": "object", "description": "Add Projects To Group response.", "properties": { "id": { "type": "string", "description": "The project group identifier." }, "name": { "type": "string", "description": "The project group name." }, "description": { "type": "string", "description": "The project group description." }, "status": { "type": "string", "description": "The status of the projects in the project group.\n\n- `new`: the group is new created, or all projects in the group have status New\n\n- `inProgress`: at least one project in the group is in progress\n\n- `completed`: all projects in the group have status Completed\n\n- `deleting`: the group is getting deleted and the projects are removing from it", "enum": [ "new", "inProgress", "completed", "deleting" ] }, "projects": { "type": "array", "description": "The projects in the project group.", "items": { "$ref": "#/components/schemas/project-group-project" } }, "location": { "$ref": "#/components/schemas/folder-v2" }, "shortId": { "type": "string" }, "createdAt": { "type": "string", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the project group was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", "format": "date-time" }, "lastModifiedAt": { "type": "string", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the project group was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", "format": "date-time" } }, "required": [ "id" ] }, "analysis-statistics": { "title": "Analysis Statistics", "type": "object", "properties": { "exactMatch": { "$ref": "#/components/schemas/count", "description": "
default
Statistics count.
", "x-default-field": true }, "inContextExactMatch": { "$ref": "#/components/schemas/count", "description": "
default
Statistics count.
", "x-default-field": true }, "perfectMatch": { "$ref": "#/components/schemas/count", "description": "
default
Statistics count.
", "x-default-field": true }, "new": { "$ref": "#/components/schemas/count", "description": "
default
Statistics count.
", "x-default-field": true }, "repetitions": { "$ref": "#/components/schemas/count", "description": "
default
Statistics count.
", "x-default-field": true }, "crossDocumentRepetitions": { "$ref": "#/components/schemas/count", "description": "
default
Statistics count.
", "x-default-field": true }, "machineTranslation": { "$ref": "#/components/schemas/count", "description": "
default
Statistics count.
", "x-default-field": true }, "locked": { "$ref": "#/components/schemas/count", "description": "
default
Statistics count.
", "x-default-field": true }, "fuzzyMatch": { "type": "array", "items": { "$ref": "#/components/schemas/fuzzy-count" }, "description": "
default
Statistics count.
", "x-default-field": true }, "total": { "$ref": "#/components/schemas/count", "description": "
default
Statistics count.
", "x-default-field": true } } }, "analytics": { "title": "Analytics", "type": "object", "properties": { "progress": { "$ref": "#/components/schemas/analytics-progress" }, "overdueStatistics": { "$ref": "#/components/schemas/analytics-overdue-statistics" }, "sourceFileStatistics": { "type": "array", "items": { "$ref": "#/components/schemas/analytics-source-file-statistics" } }, "workloadStatistics": { "$ref": "#/components/schemas/analytics-workload-statistics" }, "taskTypeStatistics": { "type": "array", "items": { "$ref": "#/components/schemas/analytics-task-type-statistics" } }, "phaseStatistics": { "type": "array", "items": { "$ref": "#/components/schemas/analytics-phase-statistics" } } }, "description": "Project analytics." }, "analytics-progress": { "title": "Analytics Progress", "type": "object", "description": "Overall progress.", "properties": { "overall": { "type": "integer", "nullable": true, "description": "
default
The overall progress.
", "x-default-field": true } } }, "analytics-overdue-statistics": { "title": "Analytics Overdue Statistics", "type": "object", "description": "Statistics on overdue work.", "properties": { "overdueTasks": { "type": "integer", "nullable": true, "description": "
default
The number of overdue tasks.
", "x-default-field": true }, "dueDateCloseTasks": { "type": "integer", "nullable": true, "description": "
default
The number of tasks closed after the due date.
", "x-default-field": true } } }, "analytics-source-file-statistics": { "title": "Analytics Source File Statistics", "type": "object", "description": "Source file statistics grouped by role.", "properties": { "role": { "$ref": "#/components/schemas/file-role", "description": "
default
The file role.
", "x-default-field": true }, "count": { "type": "integer", "nullable": true, "description": "
default
The file count.
", "x-default-field": true } } }, "analytics-workload-statistics": { "title": "Analytics Workload Statistics", "type": "object", "description": "Statistics on workload progress.", "properties": { "completed": { "type": "integer", "nullable": true, "description": "
default
", "x-default-field": true }, "total": { "type": "integer", "nullable": true, "description": "
default
", "x-default-field": true } } }, "analytics-task-type-statistics": { "title": "Analytics Task Type Statistics", "type": "object", "description": "Task Type statistics grouped.", "properties": { "id": { "type": "string", "description": "
default
", "x-default-field": true }, "key": { "type": "string", "description": "
default
", "x-default-field": true }, "total": { "type": "integer", "nullable": true, "description": "
default
", "x-default-field": true }, "current": { "type": "integer", "nullable": true, "description": "
default
", "x-default-field": true }, "completed": { "type": "integer", "nullable": true, "description": "
default
", "x-default-field": true }, "error": { "type": "integer", "nullable": true, "description": "
default
", "x-default-field": true } } }, "analytics-phase-statistics": { "title": "Analytics Phase Statistics", "type": "object", "description": "Statistics for phases grouped.", "properties": { "name": { "type": "string", "description": "
default
", "x-default-field": true }, "total": { "type": "integer", "nullable": true, "description": "
default
", "x-default-field": true }, "completed": { "type": "integer", "nullable": true, "description": "
default
", "x-default-field": true } } }, "application-create-request": { "title": "Application Create Request", "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "The application name.", "maxLength": 70, "minLength": 1 }, "description": { "type": "string", "description": "The application description.", "maxLength": 1000 }, "enableApiAccess": { "type": "boolean", "default": true, "description": "Enables oAuth 2.0 API access and provides the application's client credentials." }, "serviceUserId": { "type": "string", "description": "The Service User identifier. Required when `enableApiAccess` is `true`." } } }, "application-update-request": { "title": "Application Update Request", "type": "object", "properties": { "name": { "type": "string", "description": "The application name.", "minLength": 1, "maxLength": 70 }, "description": { "type": "string", "description": "The application description.", "maxLength": 1000 }, "enableApiAccess": { "type": "boolean", "default": true }, "serviceUserId": { "type": "string", "description": "The Service user identifier. The Service User will be used to provide authorization for this application." }, "regenerateSecret": { "type": "boolean", "default": false, "description": "Regenerate the client secret." } } }, "asynchronous-result": { "title": "Asynchronous Result", "type": "object", "description": "Represents the result of an asynchronous operation, including status and potential error information.", "properties": { "id": { "type": "string", "description": "Unique identifier for the asynchronous operation." }, "status": { "type": "string", "description": "The status of the asynchronous operation.", "enum": [ "created", "inProgress", "completed", "failed" ] }, "errorMessage": { "type": "string", "description": "When the status is 'failed', it contains the error message explaining what went wrong." } }, "required": [ "id", "status" ] }, "count": { "title": "Count", "type": "object", "description": "Statistics count.", "properties": { "words": { "type": "integer", "description": "
default
Number of words.
", "nullable": true, "x-default-field": true }, "segments": { "type": "integer", "description": "
default
Number of segments.
", "nullable": true, "x-default-field": true }, "characters": { "type": "integer", "description": "
default
Number of characters.
", "nullable": true, "x-default-field": true }, "placeables": { "type": "integer", "description": "
default
Number of placeables.
", "nullable": true, "x-default-field": true }, "tags": { "type": "integer", "description": "
default
Number of tags.
", "nullable": true, "x-default-field": true } } }, "configuration-resource-request": { "title": "Configuration Resource Request", "type": "object", "description": "Resource configuration properties.", "properties": { "id": { "type": "string", "description": "Configuration resource identifier." }, "strategy": { "type": "string", "description": "\"copy\": A copy of the resource will be used for the project execution. This is the default strategy.\n\n\"use\": The actual resource will be used for the project execution.", "default": "copy", "enum": [ "copy", "use" ] } }, "required": [ "id" ] }, "completion-config-request": { "title": "Completion Configuration", "type": "object", "description": "Completion configuration properties.", "properties": { "completeDays": { "type": "number", "description": "Number of days until automatic completion of the project. Starting from project creation date.", "minimum": 1, "maximum": 365, "default": 90 }, "archiveDays": { "type": "number", "minimum": 1, "maximum": 365, "default": 90, "description": "Number of days after project completion when the project will be \r\narchived.." }, "archiveReminderDays": { "type": "number", "minimum": 1, "maximum": 365, "default": 7, "description": "Number of days before archiving when a reminder will be sent." } } }, "completion-config-response": { "title": "Completion Configuration", "type": "object", "description": "Completion configuration properties.", "properties": { "completeDate": { "$ref": "#/components/schemas/date-time", "description": "
default
" }, "completeDays": { "type": "number", "description": "
default
Number of days until automatic completion of the project. Starting from project creation date.
", "minimum": 1, "maximum": 365, "default": 90 }, "archiveDate": { "$ref": "#/components/schemas/date-time", "description": "
default
" }, "archiveDays": { "type": "number", "minimum": 1, "maximum": 365, "default": 90, "description": "
default
Number of days after project completion when the workflow will be stopped and the project will enter *archived* state.
" }, "archiveReminderDays": { "type": "number", "minimum": 1, "maximum": 365, "default": 7, "description": "
default
Number of days before workflow stoppage when a reminder will be sent.
" } } }, "conditional-cost-operator": { "title": "Conditional Cost Operator", "type": "string", "enum": [ "less", "lessOrEqual", "greater", "greaterOrEqual" ] }, "conditional-cost-type": { "title": "Conditional Cost Type", "type": "string", "enum": [ "absolute", "relative", "percentage" ] }, "conditional-cost-variable": { "title": "Conditional Cost Variable", "type": "string", "enum": [ "wordCount", "runningTotal" ] }, "customer": { "title": "Customer", "type": "object", "description": "Customer resource.", "properties": { "id": { "type": "string", "description": "Customer identifier." }, "name": { "type": "string", "description": "
default
Customer name.
", "x-default-field": true }, "keyContact": { "$ref": "#/components/schemas/user" }, "location": { "$ref": "#/components/schemas/folder-v2" }, "ragStatus": { "type": "string", "enum": [ "green", "amber", "red" ] }, "customFieldDefinitions": { "type": "array", "description": "The custom field definitions.", "items": { "$ref": "#/components/schemas/custom-field-resource" } } }, "required": [ "id" ] }, "custom-field": { "title": "Custom Field", "type": "object", "description": "A Custom Field model.", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Custom Field identifier." }, "name": { "type": "string", "description": "Custom Field name. (Not available for List Projects, Get Project Template and List Project Templates endpoints)" }, "key": { "type": "string", "description": "Custom Field friendly key." }, "value": { "type": "object", "description": "The value of the custom property. A date will be serialized as an ISO_8601 string." } } }, "customer-create-request": { "title": "Customer Create Request", "type": "object", "description": "Input for Customer creation.\n\n It will create an invitation for an account user account.", "properties": { "name": { "type": "string", "description": "The name of the customer.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", "maxLength": 50 }, "location": { "type": "string", "description": "The identifier of the parent folder for the customer." }, "firstName": { "type": "string", "description": "Key contact first name. If you provide this field, pleaase also provide email and last name" }, "lastName": { "type": "string", "description": "Key contact last name. If you provide this field, pleaase also provide email and first name" }, "email": { "type": "string", "description": "Key contact email.. If you provide this field, pleaase also provide first name and last name" } }, "required": [ "name" ] }, "customer-update-request": { "title": "Customer Update Request", "type": "object", "description": "Input for Customer update.\n\n", "properties": { "name": { "type": "string", "description": "The name of the customer.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", "maxLength": 50 }, "keyContactId": { "type": "string", "description": "The ID of the account user set as key contact." }, "ragStatus": { "type": "string", "description": "The color tag used to mark-up a customer in the UI.", "enum": [ "green", "amber", "red" ] }, "customFieldDefinitions": { "description": "The Custom Fields", "type": "array", "items": { "$ref": "#/components/schemas/custom-field-resource" } }, "folderVisibility": { "type": "string", "description": "The folder visibility to its subfolders.", "enum": [ "default", "private" ] } } }, "custom-field-resource": { "title": "Custom Field Resource", "type": "object", "description": "A Custom Field resource model.", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "description": "Custom Field friendly key." }, "value": { "type": "object", "description": "The value of the custom property. A date will be serialized as an ISO_8601 string." } } }, "custom-field-definition": { "title": "Custom Field Definition", "type": "object", "description": "The Custom Field definition.", "properties": { "id": { "type": "string", "description": "The identifier of the Custom Field Definition, generated by the service." }, "name": { "type": "string", "description": "
default
The display name of the Custom Field.
", "x-default-field": true }, "key": { "type": "string", "description": "The key of the Custom Field, used for querying purposes." }, "description": { "type": "string", "description": "The description of the Custom Field." }, "type": { "type": "string", "description": "The value type supported by this Custom Field.", "enum": [ "long", "double", "boolean", "date", "string", "checkbox", "longtext", "picklist", "multiSelectPicklist" ], "nullable": true }, "pickListOptions": { "type": "array", "description": "Possible values if the type selected is \"picklist\" or \"multiSelectPicklist\".", "uniqueItems": true, "items": { "type": "string" } }, "resourceType": { "type": "string", "description": "The resource type to which this Custom Field can be applied.", "enum": [ "project", "customer", "vendor", "vendorOrderTemplate" ] }, "isReadOnly": { "type": "boolean", "nullable": true }, "defaultValue": { "type": "string", "description": "Specifies a default value for this Custom Field. This is required if the \"isReadOnly\" field is True." }, "isMandatory": { "type": "boolean", "description": "Specifies if this Custom Field is mandatory when creating a resource of the supported type.", "nullable": true }, "location": { "$ref": "#/components/schemas/folder-v2" } }, "required": [ "id" ] }, "custom-field-request": { "title": "Custom Field Request", "type": "object", "description": "A Custom Field model used at project creation or project update.", "properties": { "key": { "type": "string", "description": "Custom Field friendly key." }, "value": { "type": "object", "description": "The value of the custom field. A date will be serialized as a ISO_8601 string. For read only custom fields (`isReadOnly`), it must be set exactly as the `defaultValue` from custom field definition. " } }, "required": [ "key" ] }, "custom-field-update-request": { "title": "Custom Field Update Request", "type": "object", "description": "", "properties": { "value": { "type": "object", "description": "The value of the custom field. A date will be serialized as a ISO_8601 string. For read only custom fields (`isReadOnly`), it must be set exactly as the `defaultValue` from custom field definition. " } }, "required": [ "value" ] }, "date-time": { "type": "string", "title": "DateTime", "example": "2022-01-12T12:00:00Z", "description": "UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", "format": "date-time", "nullable": true }, "error-response": { "title": "Error Response", "type": "object", "description": "Error response properties.", "properties": { "message": { "type": "string", "description": "Retrieves a descriptive message that shows what went wrong." }, "errorCode": { "type": "string", "description": "Concise code that describes the nature of the error." }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/error-detail-response" } } }, "required": [ "message", "errorCode" ] }, "error-detail-response": { "title": "Error Detail Response", "type": "object", "description": "Error detail response properties.", "properties": { "name": { "type": "string", "description": "" }, "code": { "type": "string", "description": "" }, "value": { "type": "string" } } }, "translation-error-detail-response": { "title": "Translation Errors Response", "type": "object", "description": "Translation error details response properties.", "properties": { "name": { "type": "string", "description": "
default
", "x-default-field": true }, "code": { "type": "string", "description": "
default
", "x-default-field": true }, "value": { "type": "string", "description": "
default
", "x-default-field": true } } }, "export-quote-report-response": { "title": "Export Quote Report Response", "type": "object", "description": "Export quote report response.", "properties": { "id": { "type": "string", "description": "The export quote report identifier." } } }, "failed-task": { "title": "Failed Task", "type": "object", "description": "Failed Task.", "properties": { "id": { "type": "string", "description": "The failed task identifier." }, "name": { "type": "string", "description": "The failed task name." }, "errors": { "type": "array", "description": "The failed task errors.", "items": { "$ref": "#/components/schemas/task-error" } } }, "required": [ "id", "name" ] }, "file-analysis-response": { "title": "File Analysis Response", "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "description": "The status of the file analysis operation.\r\n\r\n`converting` - The files are being converted for analysis.
\r\n`analysis` - Extracting the word count from the files.
\r\n`costEstimation` - Estimating the cost.
\r\n`completed` - The file analysis is completed.
\r\n`error` - The file analysis was unsuccessful. See the `errorMessage` field for more details.", "enum": [ "converting", "analysis", "costCalculation", "completed", "error" ] }, "wordCount": { "type": "integer", "description": "
default
The total word count of the files.
", "x-default-field": true }, "estimatedCosts": { "$ref": "#/components/schemas/file-analysis-cost-response", "description": "The estimated costs." }, "fileStatistics": { "description": "
default
The word count breakdown by files.
", "x-default-field": true, "type": "array", "items": { "$ref": "#/components/schemas/file-analysis-file-statistics" } }, "errorMessage": { "type": "string", "description": "The cause of the error when the status is `error`." } } }, "file-analysis-operation-response": { "title": "File Analysis Operation Response", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The analysis operation id. Use this to poll it's status." } } }, "file-analysis-cost-response": { "title": "File Analysis Cost Response", "type": "object", "required": [ "total" ], "properties": { "currencyCode": { "type": "string", "description": "The currency code (ISO 4217)." }, "total": { "type": "number", "description": "The total cost calculated for the provided files and language pairs.
\r\nIt represents the sum of the `translationCosts`, `languageCosts` and `additionalCosts`." }, "translationCosts": { "type": "number", "description": "The base translation costs." }, "languageCosts": { "type": "number", "description": "The additional language costs." }, "additionalCosts": { "type": "number", "description": "The additional translation costs." } } }, "file-analysis-file-statistics": { "title": "File Analysis File Statistics", "type": "object", "required": [ "fileId", "wordCount" ], "properties": { "fileId": { "type": "string", "description": "The file identifier." }, "wordCount": { "type": "integer", "description": "The number of words in this file." } } }, "file-processing-configuration": { "title": "File Processing Configuration", "type": "object", "description": "File Processing Configuration resource. (Not available for List Projects endpoint)", "properties": { "id": { "type": "string", "description": "The file processing configuration identifier." }, "name": { "type": "string", "description": "
default
The file processing configuration name.
", "x-default-field": true }, "location": { "$ref": "#/components/schemas/folder-v2" } }, "required": [ "id" ] }, "file-type-setting": { "title": "File Type Setting", "type": "object", "properties": { "id": { "type": "string", "description": "The file type setting identifier." }, "name": { "type": "string", "description": "
default
The file type name.
", "x-default-field": true }, "description": { "type": "string" }, "typeId": { "type": "string", "description": "A short string representation of the file type identifier. The ID displayed in the Trados Cloud Platform UI." }, "enabled": { "type": "boolean", "description": "
default
Is this file type setting enabled. Disabled file types will not be included in operations (ex. Scan)
", "nullable": true, "x-default-field": true }, "excluded": { "type": "boolean", "description": "Is this file type setting included in the file processing configuration. \n\nFile types will be added to a configuration as excluded = true by default and can be included by a consumer when needed (via the Trados Cloud Platform UI)\n\nExcluded file types will not be included in operations (ex. Scan)", "nullable": true }, "deprecated": { "type": "boolean", "description": "This file type setting is planned for deprecation and will be removed in the future.", "nullable": true }, "orderNumber": { "type": "integer", "description": "The order of the setting in the file type configuration." }, "extensions": { "type": "array", "description": "A collection of extensions supported by this file type. Ex: \"*.xlsx\"", "items": { "type": "string" } } }, "required": [ "id" ], "description": "" }, "file-upload-response": { "title": "File Upload Response", "type": "object", "properties": { "id": { "type": "string", "description": "The identifier of the uploaded file" }, "fileName": { "type": "string", "description": "The name of the uploaded file" }, "unzipStatus": { "type": "string", "enum": [ "queued", "extracting", "extracted", "unzipError" ], "description": "The status of the unzipping operation. You can use this to determine if your .zip file has been extracted successfully." } }, "required": [ "id", "fileName" ] }, "file-metadata-response": { "title": "File Metadata Response", "type": "object", "properties": { "id": { "type": "string", "description": "The identifier of the uploaded file" }, "fileName": { "type": "string", "description": "The name of the uploaded file" }, "unzipStatus": { "type": "string", "enum": [ "queued", "extracting", "extracted", "unzipError" ], "description": "The status of the unzipping operation. You can use this to determine if your .zip file has been extracted successfully." }, "associatedFiles": { "type": "array", "description": "The files that were extracted from the uploaded .zip archive.", "items": { "$ref": "#/components/schemas/file-extracted-response" } } }, "required": [ "id", "fileName" ] }, "file-extracted-response": { "title": "File Extracted Response", "type": "object", "properties": { "id": { "type": "string", "description": "The identifier of the extracted file." }, "fileName": { "type": "string", "description": "The name of the extracted file." }, "filePath": { "type": "string", "description": "The file path of the extracted file. This is relative to the archive root." } }, "required": [ "id", "fileName", "filePath" ] }, "file-role": { "type": "string", "title": "File-Role", "enum": [ "translatable", "reference", "localizable", "unknown" ], "nullable": true }, "file-version-export": { "title": "File Version Export", "description": "File Version Export. The resulted version can be downloaded once the status is completed.", "allOf": [ { "$ref": "#/components/schemas/asynchronous-result" }, { "type": "object", "properties": { "downloadUrl": { "type": "string", "description": "The url where the file can be downloaded." } } } ] }, "file-version-import": { "title": "File Version Import", "allOf": [ { "$ref": "#/components/schemas/asynchronous-result" }, { "type": "object", "properties": { "fileVersionId": { "type": "string" } } } ] }, "folder": { "title": "Folder", "type": "object", "description": "Folder used for resource storage.", "examples": [ { "id": "1de8f71c357c4bb5a32626faf5f53ef1", "name": "consumer_A", "path": [ { "id": "7fb808326daa4bb1988ckedcd0734aa6", "location": "0e6d1f1aa8df46e6b9b111ca9f388c9e", "name": "dexters_extensibility_consumer", "hasParent": true }, { "id": "0e6d1f1aa8df46e6b9b111ca9f388c9e", "location": "61e801fa3d600fe2cfs12dd08", "name": "Customers", "hasParent": true }, { "id": "61e801fa3d600fe2cfs12dd08", "name": "61e801fa3d600fe2cfs12dd08", "hasParent": false } ] } ], "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The folder identifier." }, "name": { "type": "string", "description": "
default
The name of the folder.
", "x-default-field": true }, "hasParent": { "type": "boolean", "description": "Indicates if the folder has a parent folder.", "nullable": true }, "path": { "type": "array", "description": "The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.", "items": { "$ref": "#/components/schemas/folder-path" } } } }, "folder-v2": { "title": "Folder", "type": "object", "description": "Folder used for resource storage.", "properties": { "id": { "type": "string", "description": "The folder identifier." }, "name": { "type": "string", "description": "
default
The name of the folder.
", "x-default-field": true }, "hasParent": { "type": "boolean", "description": "Indicates if the folder has a parent folder.", "nullable": true }, "path": { "type": "array", "description": "The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.", "items": { "$ref": "#/components/schemas/folder-path" } } }, "required": [ "id" ] }, "folder-path": { "title": "Folder Path", "type": "object", "description": "Path of a folder.", "properties": { "id": { "type": "string", "description": "The folder identifier." }, "name": { "type": "string", "description": "The name of the folder." }, "location": { "type": "string", "description": "
default
The location identifier." }, "hasParent": { "type": "boolean", "description": "
default
Indicates if the folder has a parent folder.", "nullable": true } }, "required": [ "id", "name" ] }, "fuzzy-category": { "title": "Fuzzy Category", "type": "object", "description": "Fuzzy category range. Example of Fuzzy bands: 100-100%, 95-99%, 85-94%, 75-84%, 50-74%.", "properties": { "minimum": { "type": "integer", "description": "
default
The minimum of the range.
", "nullable": true, "x-default-field": true }, "maximum": { "type": "integer", "description": "
default
The maximum of the range.
", "nullable": true, "x-default-field": true } } }, "fuzzy-count": { "title": "Fuzzy Count", "type": "object", "description": "Statistics count for fuzzy matches.", "properties": { "count": { "$ref": "#/components/schemas/count", "description": "
default
Statistics count.
", "x-default-field": true }, "category": { "$ref": "#/components/schemas/fuzzy-category", "description": "
default
Fuzzy category range.
", "x-default-field": true } } }, "fuzzy-match-category": { "title": "Fuzzy Match Category", "type": "object", "description": "Fuzzy match category range.", "properties": { "minimumMatchValue": { "type": "integer", "nullable": true, "description": "Minimum matching value of this range." }, "maximumMatchValue": { "type": "integer", "nullable": true, "description": "Maximum matching value of this range." } }, "required": [ "minimumMatchValue", "maximumMatchValue" ] }, "fuzzy-match": { "title": "Fuzzy Match", "type": "object", "description": "Fuzzy match model.", "properties": { "price": { "type": "number", "description": "Fuzzy match price for the range expressed in the category field." }, "category": { "$ref": "#/components/schemas/fuzzy-match-category" } }, "required": [ "price", "category" ] }, "group": { "title": "Group", "type": "object", "description": "Group of Users.", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The group identifier." }, "name": { "type": "string", "description": "
default
The group name.
", "x-default-field": true }, "description": { "type": "string", "description": "The group description." }, "location": { "$ref": "#/components/schemas/folder-v2" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/user" } }, "roles": { "type": "array", "description": "**Note**: The identifier of `Administrator` role will not be exposed publicly and a `********` placeholder will be returned on this endpoint for the role.", "items": { "$ref": "#/components/schemas/role" } }, "additionalRoles": { "type": "array", "items": { "$ref": "#/components/schemas/group-additional-roles" } }, "groupType": { "type": "string", "enum": [ "default", "custom", "vendor", "customer" ], "description": "- default : groups in the Root folder (location) provisioned by the system, automatically. Examples: Administrator, Project Manager, Engineer, Terminologist.\r\n- customer : groups provisioned by the system, automatically, for each customer location you add. Examples: Customer Requester, Customer Reviewer.\r\n- vendor : group provisioned by the system, automatically, for each vendor location you add. Examples: Vendor Project Manager.\r\n- custom : groups you can create in a location of your choice. Examples: Project Manager, Translator." }, "metadata": { "title": "Metadata", "description": "Additional metadata values in a key–value pair format", "additionalProperties": true, "example": { "colour": "green", "flag-enabled": true, "max value": 3 } } } }, "group-additional-roles": { "title": "Group Additional Roles", "type": "object", "description": "Roles granted to the group in addition to the group location.", "required": [ "location", "roles" ], "properties": { "location": { "$ref": "#/components/schemas/folder-v2" }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/role" } } } }, "group-additional-roles-request": { "title": "Group Additional Roles Request", "type": "object", "description": "Roles granted to the group in addition to the group location.", "required": [ "location", "roles" ], "properties": { "location": { "type": "string", "description": "Additional roles granted to this location identifier." }, "roles": { "type": "array", "minItems": 1, "maxItems": 10, "uniqueItems": true, "description": "The identifiers of the roles granted to the specified location.", "items": { "type": "string" } } } }, "group-create-request": { "title": "Group Create Request", "type": "object", "description": "Group of users.", "required": [ "name", "location", "roles" ], "allOf": [ { "$ref": "#/components/schemas/group-update-request" }, { "type": "object", "properties": { "location": { "type": "string", "description": "The folder identifier where the group will be created." } } } ] }, "group-update-request": { "title": "Group Update Request", "type": "object", "description": "Group of users.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100, "description": "The group name." }, "description": { "type": "string", "minLength": 1, "maxLength": 200, "description": "The group description." }, "roles": { "description": "The identifiers of the roles associated with the group.", "type": "array", "minItems": 1, "uniqueItems": true, "items": { "type": "string" } }, "additionalRoles": { "type": "array", "items": { "$ref": "#/components/schemas/group-additional-roles-request" } }, "users": { "type": "array", "description": "The identifiers of the users who will be part of the group.", "items": { "type": "string" } }, "metadata": { "title": "Metadata", "description": "Additional metadata values in a key–value pair format", "additionalProperties": true, "example": { "colour": "green", "flag-enabled": true, "max value": 3 } } } }, "jwk": { "title": "JWK", "type": "object", "description": "A Json Web Key. \n
\nSee https://datatracker.ietf.org/doc/html/rfc7517 for details.", "properties": { "kty": { "type": "string", "description": "The cryptographic algorithm\n family used with the key." }, "n": { "type": "string", "description": "The RSA public modulus n." }, "e": { "type": "string", "description": "The RSA public exponent e." }, "alg": { "type": "string", "description": "The algorithm intended for use with the key." }, "kid": { "type": "string", "description": "The \"kid\" (key ID) parameter is used to match a specific key." }, "use": { "type": "string", "description": "The \"use\" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data." } } }, "language": { "title": "Language", "type": "object", "description": "The language object.", "properties": { "languageCode": { "type": "string", "description": "Language code. ex: \"en-US\", \"de-DE\"." }, "englishName": { "type": "string", "description": "
default
Human readable name.
", "x-default-field": true }, "direction": { "type": "string" }, "parentLanguageCode": { "type": "string" }, "defaultSpecificLanguageCode": { "type": "string" }, "isNeutral": { "type": "boolean", "nullable": true } }, "required": [ "languageCode" ] }, "language-cost": { "title": "Language Cost", "type": "object", "required": [ "name", "type", "index", "costPerUnit", "unitCount" ], "properties": { "name": { "type": "string", "description": "The name of the additional cost. " }, "type": { "$ref": "#/components/schemas/language-cost-type", "description": "The type of the additional cost." }, "index": { "type": "number", "description": "The number of the additional cost." }, "costPerUnit": { "type": "number", "description": "The cost of a unit." }, "unitCount": { "type": "number", "description": "The number of units for which a cost is applied." }, "volumeUnitType": { "$ref": "#/components/schemas/volume-unit-type", "description": "The unit type of the 'volume' cost, used as reference for the unit cost." }, "conditionalCostType": { "$ref": "#/components/schemas/conditional-cost-type", "description": "Only for the Conditional type." }, "costOperator": { "$ref": "#/components/schemas/conditional-cost-operator", "description": "Only for the Conditional type." }, "costVariable": { "$ref": "#/components/schemas/conditional-cost-variable", "description": "
default
Only for the Conditional type." }, "operand": { "type": "number", "description": "
default
Operand of the Conditional type cost." }, "serviceTypes": { "type": "array", "description": "
default
Array of Service Type identifiers where this additional cost is applied. ", "items": { "type": "string" } }, "customUnitName": { "type": "string", "description": "The name of the custom unit." } } }, "language-cost-request": { "title": "Language Cost Request", "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string", "description": "The name of the additional cost. " }, "type": { "$ref": "#/components/schemas/language-cost-type", "description": "The type of the cost." }, "index": { "type": "number", "description": "The number of the cost." }, "costPerUnit": { "type": "number", "description": "The cost of a unit." }, "unitCount": { "type": "number", "description": "The number of units for which a cost is applied." }, "volumeUnitType": { "$ref": "#/components/schemas/volume-unit-type", "description": "The unit type of the 'volume' cost, used as reference for the unit cost." }, "conditionalCostType": { "$ref": "#/components/schemas/conditional-cost-type", "description": "Only for the Conditional type." }, "conditionalCostOperator": { "$ref": "#/components/schemas/conditional-cost-operator", "description": "Only for the Conditional type." }, "conditionalCostVariable": { "$ref": "#/components/schemas/conditional-cost-variable", "description": "Only for the Conditional type." }, "operand": { "type": "number", "description": "Operand of the Conditional type cost." }, "serviceTypes": { "type": "array", "description": "Array of Service Type identifiers where this cost is applied.", "items": { "type": "string" } }, "customUnitName": { "type": "string", "maxLength": 100, "description": "The name of the custom unit. Required when `volumeUnitType` is `custom`." } } }, "language-cost-type": { "title": "Language Cost Type", "type": "string", "enum": [ "volume", "hourly", "percentage", "perPage", "conditional", "adhoc", "adhocVolume" ] }, "language-direction": { "title": "Language Direction", "type": "object", "description": "A Language Direction.", "properties": { "id": { "type": "string", "description": "The language direction identifier." }, "sourceLanguage": { "$ref": "#/components/schemas/language" }, "targetLanguage": { "$ref": "#/components/schemas/language" }, "analysisStatistics": { "$ref": "#/components/schemas/analysis-statistics" } }, "required": [ "id", "sourceLanguage", "targetLanguage" ] }, "language-direction-cost-request": { "title": "Language Direction Cost Request", "type": "object", "required": [ "sourceLanguage", "targetLanguage" ], "properties": { "sourceLanguage": { "type": "string", "description": "The source language code. For example: \"en-US\", \"de-DE\"." }, "targetLanguage": { "type": "string", "description": "The target language code. For example: \"en-US\", \"de-DE\"." }, "contextMatch": { "type": "number", "description": "The price of context matches.", "x-default-field": true }, "exactMatch": { "type": "number", "description": "The price of exact matches.", "x-default-field": true }, "new": { "description": "The price of new matches.", "type": "number", "x-default-field": true }, "perfectMatch": { "type": "number", "description": "The price of PerfectMatches.", "x-default-field": true }, "repetition": { "type": "number", "description": "The price of repetition matches.", "x-default-field": true }, "machineTranslation": { "type": "number", "description": "The price of machine translation matches.", "x-default-field": true }, "pricingUnit": { "$ref": "#/components/schemas/pricing-unit-type", "x-default-field": true, "description": "The type of the pricing unit. If not specified, `words` will be used as the default value." }, "fuzzyMatches": { "type": "array", "x-default-field": true, "description": "All fuzzyMatches categories should be the same for all the language directions.", "items": { "$ref": "#/components/schemas/fuzzy-match" } }, "additionalCosts": { "x-default-field": true, "description": "Additional costs applied at language level.", "type": "array", "items": { "$ref": "#/components/schemas/language-cost-request" } } } }, "language-direction-no-statistics": { "title": "Language Direction", "type": "object", "description": "A Language Direction.", "properties": { "id": { "type": "string", "description": "The language direction identifier." }, "sourceLanguage": { "$ref": "#/components/schemas/language" }, "targetLanguage": { "$ref": "#/components/schemas/language" } }, "required": [ "id", "sourceLanguage", "targetLanguage" ] }, "language-direction-item": { "title": "Language Direction Item", "type": "object", "description": "", "properties": { "id": { "type": "string", "description": "The language direction identifier." } }, "required": [ "id" ] }, "language-direction-cost": { "title": "Language Direction Cost", "type": "object", "required": [ "sourceLanguage", "targetLanguage" ], "properties": { "sourceLanguage": { "type": "string", "description": "The source language code. For example: \"en-US\", \"de-DE\"." }, "targetLanguage": { "type": "string", "description": "The target language code. For example: \"en-US\", \"de-DE\"." }, "contextMatch": { "type": "number", "description": "
default
The price of context matches.", "x-default-field": true }, "exactMatch": { "type": "number", "description": "
default
The price of exact matches.", "x-default-field": true }, "new": { "description": "
default
The price of new matches.", "type": "number", "x-default-field": true }, "perfectMatch": { "type": "number", "description": "
default
The price of PerfectMatches.", "x-default-field": true }, "repetition": { "type": "number", "description": "
default
The price of repetition matches.", "x-default-field": true }, "machineTranslation": { "type": "number", "description": "
default
The price of machine translation matches.", "x-default-field": true }, "pricingUnit": { "$ref": "#/components/schemas/pricing-unit-type", "description": "
default
", "x-default-field": true, "nullable": true }, "fuzzyMatches": { "type": "array", "description": "
default
", "x-default-field": true, "items": { "$ref": "#/components/schemas/fuzzy-match" } }, "additionalCosts": { "type": "array", "description": "
default
", "x-default-field": true, "items": { "$ref": "#/components/schemas/language-cost" } } } }, "language-direction-request": { "title": "Language Direction Request", "type": "object", "description": "The language directions model used for creating or updating a project.", "properties": { "sourceLanguage": { "$ref": "#/components/schemas/source-language-request" }, "targetLanguage": { "$ref": "#/components/schemas/target-language-request" } }, "required": [ "sourceLanguage", "targetLanguage" ] }, "language-processing-rule": { "title": "Language Processing Rule", "type": "object", "properties": { "id": { "type": "string", "description": "The language processing rule identifier." }, "name": { "type": "string", "description": "
default
The language processing rule name.
", "x-default-field": true }, "description": { "type": "string", "description": "The language processing rule description." } }, "required": [ "id" ] }, "language-request": { "title": "Language Request", "type": "object", "properties": { "languageCode": { "type": "string" } }, "required": [ "languageCode" ] }, "language-pair": { "title": "Language Pair", "type": "object", "properties": { "source": { "type": "string", "description": "Language code. ex: \"en-US\", de-DE\"." }, "target": { "type": "string", "description": "Language code. ex: \"en-US\", de-DE\"." } }, "required": [ "source", "target" ], "description": "" }, "language-pair-resource": { "title": "Language Pair Resource", "type": "object", "description": "Resource describing a Translation Memory, Termbase or Machine Translation used in a Translation Engine.", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "description": "The identifier of the Translation Memory, Termbase, Machine Translation or LLM." }, "systemId": { "type": "string", "description": "Required only for neural Machine Translation resources." }, "type": { "type": "string", "description": "The resource type. ", "enum": [ "TM", "MT", "TB", "LLM" ] }, "penalty": { "type": "integer", "description": "Only for TM" }, "lookup": { "type": "boolean", "description": "Only for TM, TB" }, "concordance": { "type": "boolean", "description": "Only for TM" }, "update": { "type": "boolean", "description": "Only for TM, TB" }, "generativeTranslation": { "type": "boolean", "description": "Only for LLM" }, "smartReview": { "type": "boolean", "description": "Only for LLM" } } }, "list-applications-response": { "title": "List Applications Response", "type": "object", "description": "A response for the List Applications endpoint.", "required": [ "itemCount", "items" ], "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/application" } } } }, "list-customers-response": { "title": "List Customers Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/customer" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List Customers endpoint." }, "list-vendors-response": { "title": "List Vendors Response", "type": "object", "properties": { "items": { "type": "array", "description": "The list of vendors.", "items": { "$ref": "#/components/schemas/vendor" } }, "itemCount": { "type": "integer", "description": "The number of items returned in this response." } }, "required": ["items", "itemCount"], "description": "A response for the List Vendors endpoint." }, "list-quote-templates-response": { "title": "List Quote Templates Response", "type": "object", "properties": { "itemCount": { "type": "integer", "description": "The total number of quote templates matching the query." }, "items": { "type": "array", "description": "The list of quote templates.", "items": { "$ref": "#/components/schemas/project-quote-template" } } }, "required": ["itemCount", "items"], "description": "A response for the List Quote Templates endpoint." }, "list-custom-field-definitions-response": { "title": "List Custom Field Definitions Response", "type": "object", "description": "A response for the List Custom Field Definitions endpoint.", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/custom-field-definition" } } }, "required": [ "itemCount", "items" ] }, "list-file-processing-configurations-response": { "title": "List File Processing Configurations Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/file-processing-configuration" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List File Processing Configurations endpoint." }, "list-file-type-settings-response": { "title": "List File Type Settings Response", "type": "object", "description": "A response for the List File Type Settings endpoint.", "required": [ "itemCount", "items" ], "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/file-type-setting" } } } }, "list-folders-response": { "title": "List Folders Response", "type": "object", "description": "A response for the List Folders endpoint.", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/folder" } } }, "required": [ "itemCount", "items" ] }, "list-groups-response": { "title": "List Groups Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/group" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List Groups endpoint." }, "list-jwks": { "title": "List JWKs Response", "type": "array", "items": { "$ref": "#/components/schemas/jwk" } }, "list-languages-response": { "title": "List Languages Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/language" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List Languages endpoint." }, "list-language-processing-rules": { "title": "List Language Processing Rules", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/language-processing-rule" } }, "itemCount": { "type": "string" } }, "required": [ "items", "itemCount" ] }, "list-machine-translations-response": { "title": "List Machine Translations Response", "type": "object", "description": "A response for the List Machine Translations endpoint.", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/machine-translation" } } }, "required": [ "itemCount", "items" ] }, "list-my-accounts-response": { "title": "List My Accounts Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/account" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List My Accounts endpoint." }, "list-pricing-models-response": { "title": "List Pricing Models Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/pricing-model" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List Pricing Models endpoint." }, "list-project-templates-response": { "title": "List Project Templates Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/project-template-response" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List Project Templates endpoint." }, "list-schedule-templates-response": { "title": "List Schedule Templates Response", "type": "object", "description": "A response for the List Schedule Templates endpoint.", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/schedule-template" } } }, "required": [ "itemCount", "items" ] }, "list-rate-limits-response": { "title": "List Rate Limits Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/rate-limit" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List Rate Limits endpoint." }, "list-roles-response": { "title": "List Roles Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/role" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List Roles endpoint." }, "list-permissions-response": { "title": "List Permissions Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/permission" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List Permissions endpoint." }, "list-perfect-match-candidates-response": { "title": "List PerfectMatch Candidates Response", "type": "object", "description": "A response for the Get PerfectMatch Candidates endpoint.", "required": [ "itemCount", "items" ], "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/perfect-match-candidate" } } } }, "list-project-groups-response": { "title": "List Project Groups Response", "type": "object", "description": "A response for the List Project Groups endpoint.", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/project-group" } } }, "required": [ "itemCount", "items" ] }, "list-projects-response": { "title": "List Projects Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/project" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List Projects endpoint." }, "list-source-files-response": { "title": "List Source Files Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/source-file" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List Source Files endpoint." }, "list-source-file-versions-response": { "title": "List Source File Versions Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/source-file-version" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List Source File Versions endpoint." }, "list-target-files-response": { "title": "List Target Files Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/target-file" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List Target Files endpoint." }, "list-target-file-versions-response": { "title": "List Target File Versions Response", "type": "object", "description": "A response for the List Target Files Versions endpoint.", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/target-file-version" } } }, "required": [ "itemCount", "items" ] }, "list-tasks-response": { "title": "List Tasks Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/task" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List Tasks endpoint." }, "list-task-types-response": { "title": "List Task Types Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/task-type" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List Task types endpoint." }, "list-tqa-profiles-response": { "title": "List TQA Profiles Response", "type": "object", "description": "", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/tqa-profile" } }, "itemCount": { "type": "integer" } }, "required": [ "items", "itemCount" ] }, "list-termbase-templates-response": { "title": "List Termbase Templates Response", "type": "object", "description": "The termbase templates response.", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-template" } }, "itemCount": { "type": "integer" } }, "required": [ "items", "itemCount" ] }, "list-termbases-response": { "title": "List Termbases Response", "type": "object", "description": "The list termbases response.", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/termbase" } }, "itemCount": { "type": "integer" } }, "required": [ "items", "itemCount" ] }, "list-termbase-terms-response": { "title": "List Termbase Terms Response", "type": "object", "description": "The list termbase terms response.", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-term" } }, "itemCount": { "type": "integer" } }, "required": [ "items", "itemCount" ] }, "list-termbase-entries-response": { "title": "List Termbase Entries Response", "type": "object", "description": "The list termbase entries response.", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-entry" } }, "itemCount": { "type": "integer" } }, "required": [ "items", "itemCount" ] }, "list-termbase-import-history": { "title": "Get Termbase Import History", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-import-history-response" } }, "itemCount": { "type": "integer" } } }, "list-translation-engines-response": { "title": "List Translation Engines Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/translation-engine" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List Translation Engines endpoint." }, "list-translation-memories-reposne": { "title": "List Translation Memories Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/translation-memory" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List Translation Memories endpoint." }, "list-translation-memory-import-history": { "title": "Get Translation Memory Import History", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/translation-memory-import-history-response" } }, "itemCount": { "type": "integer" } } }, "list-translation-memory-field-templates": { "title": "List Translation Memory Field Templates", "type": "object", "description": "A response for the List Translation Memory Field Templates endpoint.", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/translation-memory-field-template" } } }, "required": [ "itemCount", "items" ] }, "list-translation-service-types-response": { "title": "List Translation Service Types Response", "type": "object", "description": "A response for the List Translation Service Types endpoint.", "required": [ "itemCount", "items" ], "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/translation-service-type" } } } }, "list-users-response": { "title": "List Users Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/user" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List Users endpoint." }, "list-workflows-response": { "title": "List Workflows Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/workflow" } } }, "required": [ "itemCount", "items" ], "description": "A response for the List Workflows endpoint." }, "llm-configuration-response": { "title": "LLM Configuration Response", "type": "object", "description": "The LLM configuration details", "required": [ "id", "model", "type", "isDefault", "isActive" ], "properties": { "id": { "type": "string", "description": "The LLM configuraiton identifier." }, "description": { "type": "string", "description": "The configuration description." }, "model": { "type": "string", "description": "The model name." }, "type": { "type": "string", "enum": [ "azureOpenAI", "awsBedrock" ], "description": "The LLM provider type." }, "isDefault": { "type": "boolean", "description": "Flag representing whether the LLM configuration is default." }, "isActive": { "type": "boolean", "description": "Flag representing whether the LLM configuration is active." } } }, "list-llm-configurations-response": { "title": "List LLM Configurations Response", "type": "object", "required": [ "itemCount", "items" ], "properties": { "itemCount": { "type": "integer", "description": "The total item count." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/llm-configuration-response" } } }, "description": "A response for the List LLM Configurations endpoint." }, "machine-translation": { "title": "Machine Translation", "type": "object", "description": "Machine translation resource.", "properties": { "id": { "type": "string" }, "provider": { "type": "string", "description": "
Provider of the machine translation.
", "x-default-field": true }, "type": { "type": "string", "description": "Type of the machine translation. Can be generic or neural." }, "systemId": { "type": "string", "description": "
default
Appears if the machine translation is neural." }, "modelSourceLanguage": { "type": "string", "description": "Model Source language" }, "modelTargetLanguage": { "type": "string", "description": "Model Target language" }, "matchingSourceLanguage": { "type": "string", "description": "Specific source language supported by the model, matching the query " }, "matchingTargetLanguages": { "type": "array", "description": "Specific target languages supported by the model, matching the query ", "items": { "type": "string" } } }, "required": [ "id", "provider", "type", "modelSourceLanguage", "modelTargetLanguage", "matchingSourceLanguage", "matchingTargetLanguages" ] }, "object-id": { "title": "Object Identifier", "type": "object", "description": "An object with identifier.", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "object-id-request": { "title": "Object Identifier Request", "type": "object", "description": "An object with identifier.", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "perfect-match-candidate": { "title": "PerfectMatch Candidate", "type": "object", "x-internal": false, "required": [ "score", "fileId" ], "properties": { "score": { "type": "number", "format": "double", "description": "The match score.", "minimum": 0, "maximum": 100 }, "fileId": { "type": "string", "description": "The file identifier:\r\n- `targetFileId` if file is a project file\r\n- `fileId` if file is user provided" }, "project": { "$ref": "#/components/schemas/project", "description": "The project from where the candidate was selected." } }, "description": "A project file that can be used as a match for PerfectMatch" }, "perfect-match-custom-file-mapping-request": { "title": "PerfectMatch Custom File Mapping Request", "description": "Provide you own matching file.", "type": "object", "required": [ "name", "targetLanguage" ], "properties": { "name": { "type": "string", "description": "The file name." }, "targetLanguage": { "type": "string" } } }, "perfect-match-mapping-create-request": { "title": "PerfectMatch Mapping Create Request", "type": "object", "description": "A request to create a new PerfectMatch mapping.", "required": [ "projectId" ], "properties": { "projectId": { "type": "string", "description": "The project identifier this mapping will be used on." }, "matchingProjects": { "type": "array", "description": "A collection of projects that will be used to find matches and candidates for PerfectMatch mapping.", "minItems": 0, "maxItems": 10, "items": { "type": "string" } } } }, "perfect-match-mapping-response": { "type": "object", "x-examples": { "Example 1": { "id": "string", "projectId": "string", "createdBy": "string", "mappings": [ { "id": "string", "projectMappingId": "string", "batch": 1073741824, "mappingStatus": "GENERATED", "mappingProviders": [ { "projectId": "string" } ], "files": [ { "id": "string", "fileId": "string", "fileStorageId": "string", "fileName": "string", "path": [ "string" ], "languageMappings": [ { "targetLanguage": "string", "match": { "fileName": "string", "path": [ "string" ], "origin": { "fileId": "string", "projectId": "string", "matchSource": "USER", "type": "BCM" } } } ] } ] } ] } }, "title": "PerfectMatch Mapping Response", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The mapping identifier." }, "project": { "$ref": "#/components/schemas/project", "description": "The project id where this mapping is used." }, "createdBy": { "$ref": "#/components/schemas/user", "description": "The account user who created the mapping." }, "batchMappings": { "type": "array", "description": "A collection of mappings per project batches.", "items": { "$ref": "#/components/schemas/perfect-match-batch-mapping" } } } }, "perfect-match-mapping-simple-response": { "type": "object", "x-examples": { "Example 1": { "id": "string", "projectId": "string", "createdBy": "string", "mappings": [ { "id": "string", "projectMappingId": "string", "batch": 1073741824, "mappingStatus": "GENERATED", "mappingProviders": [ { "projectId": "string" } ], "files": [ { "id": "string", "fileId": "string", "fileStorageId": "string", "fileName": "string", "path": [ "string" ], "languageMappings": [ { "targetLanguage": "string", "match": { "fileName": "string", "path": [ "string" ], "origin": { "fileId": "string", "projectId": "string", "matchSource": "USER", "type": "BCM" } } } ] } ] } ] } }, "title": "PerfectMatch Mapping Response", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The mapping identifier." }, "createdBy": { "$ref": "#/components/schemas/user", "description": "The account user who created the mapping." }, "batchMappings": { "type": "array", "description": "A collection of mappings per project batches.", "items": { "$ref": "#/components/schemas/perfect-match-batch-mapping" } } }, "description": "PerfectMatch Mapping (Not available for List Projects endpoint)" }, "perfect-match-mapping-create-response": { "type": "object", "x-examples": { "Example 1": { "id": "string", "projectId": "string", "createdBy": "string", "mappings": [ { "id": "string", "projectMappingId": "string", "batch": 1073741824, "mappingStatus": "GENERATED", "mappingProviders": [ { "projectId": "string" } ], "files": [ { "id": "string", "fileId": "string", "fileStorageId": "string", "fileName": "string", "path": [ "string" ], "languageMappings": [ { "targetLanguage": "string", "match": { "fileName": "string", "path": [ "string" ], "origin": { "fileId": "string", "projectId": "string", "matchSource": "USER", "type": "BCM" } } } ] } ] } ] } }, "title": "PerfectMatch Mapping Create Response", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The mapping identifier." }, "project": { "$ref": "#/components/schemas/project", "description": "The project id where this mapping is used." }, "createdBy": { "$ref": "#/components/schemas/user", "description": "The account user who created the mapping." }, "batchMappings": { "type": "array", "description": "A collection of mappings per project batches.", "items": { "$ref": "#/components/schemas/perfect-match-batch-mapping-created-response" } } } }, "perfect-match-project-file-mapping-request": { "type": "object", "title": "PerfectMatch Project File Mapping Request", "description": "Provide a matching file from an existing project.", "required": [ "fileId", "projectId" ], "properties": { "fileId": { "type": "string", "description": "The `targetFileId` from the referenced project. Must be from a PerfectMatch Candidate." }, "projectId": { "type": "string", "description": "Specifies which project the matching file belongs to. Must be from a PerfectMatch Candidate." } } }, "perfect-match-batch-mapping-created-response": { "title": "PerfectMatch Batch Mapping Created Response", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The identifier of this batch mapping." }, "batch": { "type": "integer", "minimum": 1, "description": "The project batch associated with this mapping." }, "status": { "description": "The status of the matching operation.\r\n\r\n- `pending` - The matching background operation has not started yet.\r\n- `generating` - The system is currently matching candidates.\r\n- `generated` - The matching background operation has finished and any possible candidates have been found.", "type": "string", "enum": [ "generating", "generated", "pending" ] }, "matchingProjects": { "type": "array", "items": { "$ref": "#/components/schemas/project" } } } }, "perfect-match-batch-mapping-update-request": { "title": "PerfectMatch Batch Mapping Update Request", "type": "object", "required": [ "languageDirections", "files" ], "properties": { "languageDirections": { "type": "array", "items": { "$ref": "#/components/schemas/language-direction-request" } }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/perfect-match-file-mapping-request" } }, "matchingProjects": { "type": "array", "maxItems": 10, "description": "A collection of project identifiers that will be used to find matches and candidates for PerfectMatch mapping.", "items": { "type": "string" } } } }, "perfect-match-batch-mapping": { "title": "PerfectMatch Batch Mapping", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The identifier of this batch mapping." }, "batch": { "type": "integer", "minimum": 1, "description": "The project batch associated with this mapping." }, "status": { "description": "The status of the matching operation.\r\n\r\n- `pending` - The matching background operation has not started yet.\r\n- `generating` - The system is currently matching candidates.\r\n- `generated` - The matching background operation has finished and any possible candidates have been found.", "type": "string", "enum": [ "generating", "generated", "pending" ] }, "matchingProjects": { "type": "array", "items": { "$ref": "#/components/schemas/project" } }, "matchingFiles": { "type": "array", "description": "The file matches identified based on this mapping. Matching files will be available when status is `generated`.", "items": { "$ref": "#/components/schemas/perfect-match-file-mapping" } } } }, "perfect-match-file-match": { "title": "PerfectMatch File Match", "type": "object", "required": [ "fileName", "targetLanguage" ], "properties": { "fileName": { "type": "string", "description": "The file name." }, "targetLanguage": { "$ref": "#/components/schemas/language", "description": "The target language this is matched to." }, "origin": { "$ref": "#/components/schemas/perfect-match-file-origin", "description": "The source of this match." } } }, "perfect-match-file-mapping": { "title": "PerfectMatch File Mapping", "type": "object", "required": [ "fileMappingId", "targetLanguages", "matches" ], "properties": { "fileMappingId": { "type": "string", "description": "The identifier of this file mapping." }, "fileId": { "type": "string", "description": "The file identifier." }, "fileName": { "type": "string", "description": "The file name." }, "targetLanguages": { "type": "array", "description": "File target languages.", "items": { "$ref": "#/components/schemas/language" } }, "matches": { "type": "array", "description": "The file matches.", "items": { "$ref": "#/components/schemas/perfect-match-file-match" } } } }, "perfect-match-file-mapping-request": { "title": "PerfectMatch File Mapping Request", "type": "object", "required": [ "sourceFileId", "fileName" ], "properties": { "sourceFileId": { "type": "string", "description": "The source file identifier." }, "fileName": { "type": "string", "description": "The file name." }, "targetLanguages": { "type": "array", "description": "File target languages. If no languages are specified, all language directions from the batch mapping will be used.", "items": { "$ref": "#/components/schemas/target-language-request" } } } }, "perfect-match-file-origin": { "title": "PerfectMatch File Origin", "type": "object", "required": [ "fileId" ], "properties": { "fileId": { "type": "string" }, "matchSource": { "type": "string", "enum": [ "userUpload", "perfectMatch", "candidateConfirm", "userSelection" ] }, "projectId": { "type": "string" }, "type": { "type": "string", "enum": [ "bcm", "sdlXliff" ] } } }, "pricing-model": { "title": "Pricing Model", "type": "object", "description": "Pricing Model resource. (Not available for List Projects endpoint)", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The pricing model identifier." }, "name": { "type": "string", "description": "
default
The name of the Pricing Model.
" }, "description": { "type": "string", "description": "The description of the Pricing Model. " }, "currencyCode": { "type": "string", "description": "
default
The currency code (ISO 4217).
", "x-default-field": true }, "location": { "$ref": "#/components/schemas/folder-v2", "x-default-field": true }, "languageDirectionPricing": { "type": "array", "description": "Costs applied for languages.", "items": { "$ref": "#/components/schemas/language-direction-cost" } }, "additionalCosts": { "description": "Additional costs applied at project level.", "type": "array", "items": { "$ref": "#/components/schemas/project-cost" } } } }, "pricing-model-create-request": { "title": "Pricing Model Create Request", "type": "object", "required": [ "name", "currencyCode", "location", "languageDirectionPricing" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100, "description": "The name of the Pricing Model. " }, "description": { "type": "string", "maxLength": 1000, "description": "The description of the Pricing Model. " }, "currencyCode": { "type": "string", "description": "The currency code (ISO 4217)." }, "location": { "type": "string", "description": "The location of the pricing model." }, "languageDirectionPricing": { "type": "array", "description": "Costs applied for languages.", "items": { "$ref": "#/components/schemas/language-direction-cost-request" } }, "additionalCosts": { "type": "array", "description": "Additional costs applied at project level.", "items": { "$ref": "#/components/schemas/project-cost-request" } } } }, "pricing-model-update-request": { "title": "Pricing Model Update Request", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Pricing Model. ", "minLength": 1, "maxLength": 100 }, "description": { "type": "string", "description": "The description of the Pricing Model. ", "maxLength": 1000 }, "currencyCode": { "type": "string", "description": "The currency code (ISO 4217)." }, "languageDirectionPricing": { "description": "Costs applied for languages.", "type": "array", "items": { "$ref": "#/components/schemas/language-direction-cost-request" } }, "additionalCosts": { "description": "Additional costs applied at project level.", "type": "array", "items": { "$ref": "#/components/schemas/project-cost-request" } } } }, "project-pricing-model-update-request": { "title": "Update project pricing model request", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The pricing model identifier." }, "strategy": { "type": "string", "description": "\"copy\": A copy of the resource will be used for the project execution. This is the default strategy.\n\n\"use\": The actual resource will be used for the project execution.", "default": "copy", "enum": [ "copy", "use" ] } } }, "pricing-unit-type": { "title": "Pricing Unit Type", "type": "string", "enum": [ "words", "characters" ] }, "project": { "title": "Project", "type": "object", "description": "Project resource.", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The project identifier." }, "shortId": { "type": "string", "description": "The short identifier of the project." }, "name": { "type": "string", "description": "
default
The project name.
", "x-default-field": true }, "description": { "type": "string", "description": "The project description." }, "dueBy": { "type": "string", "example": "2022-01-12T12:00:00Z", "description": "The project due date.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", "format": "date-time", "nullable": true }, "deliveredBy": { "type": "string", "example": "2022-01-12T12:00:00Z", "description": " UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "example": "2022-01-12T12:00:00Z", "description": "The project's creation date and time.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", "format": "date-time", "nullable": true }, "status": { "type": "string", "description": "The project's status.", "enum": [ "created", "inProgress", "completed", "archived" ], "nullable": true }, "statusHistory": { "type": "array", "description": "The project's status history.", "nullable": true, "items": { "$ref": "#/components/schemas/project-status-history" } }, "languageDirections": { "type": "array", "description": "
default
The project's language directions.
", "x-default-field": true, "items": { "$ref": "#/components/schemas/language-direction" } }, "customer": { "$ref": "#/components/schemas/customer" }, "createdBy": { "$ref": "#/components/schemas/user" }, "location": { "$ref": "#/components/schemas/folder-v2", "description": "
default
The resource folder.
", "x-default-field": true }, "projectTemplate": { "$ref": "#/components/schemas/project-template-response" }, "translationEngine": { "$ref": "#/components/schemas/translation-engine" }, "fileProcessingConfiguration": { "$ref": "#/components/schemas/file-processing-configuration" }, "pricingModel": { "$ref": "#/components/schemas/pricing-model" }, "workflow": { "$ref": "#/components/schemas/workflow" }, "projectPlan": { "$ref": "#/components/schemas/project-plan" }, "analytics": { "$ref": "#/components/schemas/analytics" }, "analysisStatistics": { "$ref": "#/components/schemas/analysis-statistics" }, "quote": { "$ref": "#/components/schemas/quote" }, "customFields": { "type": "array", "description": "The Custom Fields", "items": { "$ref": "#/components/schemas/custom-field" } }, "tqaProfile": { "$ref": "#/components/schemas/tqa-profile" }, "forceOnline": { "type": "boolean", "description": "This forces the project to be translated using the Trados Cloud Platform Online Editor exclusively." }, "quoteTemplate": { "$ref": "#/components/schemas/project-quote-template" }, "projectGroup": { "$ref": "#/components/schemas/project-group" }, "projectManagers": { "type": "array", "items": { "$ref": "#/components/schemas/project-manager-response" } }, "scheduleTemplate": { "$ref": "#/components/schemas/schedule-template" }, "perfectMatchMapping": { "$ref": "#/components/schemas/perfect-match-mapping-simple-response" }, "settings": { "$ref": "#/components/schemas/project-settings-response" } } }, "project-create-request": { "title": "Project Create Request", "type": "object", "description": "Input for Project creation.\n\nBefore starting the project, the required configuration resources (translation engine, file processing configuration and workflow) should be set either explicitly or through a project template that contains references to these configuration resources.", "required": [ "name", "dueBy", "languageDirections", "location" ], "properties": { "name": { "type": "string", "description": "The project name.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", "minLength": 1, "maxLength": 100 }, "description": { "type": "string", "description": "The project description.", "maxLength": 1000 }, "dueBy": { "$ref": "#/components/schemas/date-time" }, "projectTemplate": { "$ref": "#/components/schemas/object-id-request" }, "languageDirections": { "type": "array", "description": "The language directions.\n\nWhen creating a project using a project template that supports multiple source languages, you must supply the `languageDirections`.
Note: The values for source and targe language must have the same value as the source and target language from project template.", "items": { "$ref": "#/components/schemas/language-direction-request" } }, "location": { "type": "string", "description": "The folder identifier where the project should be created." }, "translationEngine": { "$ref": "#/components/schemas/configuration-resource-request" }, "fileProcessingConfiguration": { "$ref": "#/components/schemas/configuration-resource-request" }, "workflow": { "$ref": "#/components/schemas/configuration-resource-request" }, "pricingModel": { "$ref": "#/components/schemas/configuration-resource-request" }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/custom-field-request" } }, "tqaProfile": { "$ref": "#/components/schemas/configuration-resource-request" }, "forceOnline": { "type": "boolean", "description": "This forces the project to be translated using the Trados Cloud Platform Online Editor exclusively." }, "projectManagers": { "type": "array", "items": { "$ref": "#/components/schemas/project-manager-request" } }, "scheduleTemplate": { "$ref": "#/components/schemas/configuration-resource-request" }, "settings": { "$ref": "#/components/schemas/project-settings-create-request" } } }, "project-configuration": { "title": "Project Configuration", "description": "The configuration settings for a project.", "type": "object", "properties": { "translationMemoryFields": { "$ref": "#/components/schemas/translation-memory-fields", "description": "
default
", "x-default-field": true }, "updateTranslationMemory": { "$ref": "#/components/schemas/update-translation-memory" } } }, "project-configuration-request": { "title": "Project Configuration Request", "type": "object", "description": "A request used to update the configuration settings for a project.", "properties": { "translationMemoryFieldsSettings": { "$ref": "#/components/schemas/translation-memory-fields-update-request" }, "updateTranslationMemory": { "$ref": "#/components/schemas/update-translation-memory" }, "perfectMatchMappingId": { "type": "string", "description": "The PerfectMatch mapping to be associated with the project." } } }, "project-cost": { "title": "Project Cost", "type": "object", "required": [ "name", "type", "index", "costPerUnit", "unitCount" ], "properties": { "name": { "type": "string", "description": "The name of the additional cost. " }, "type": { "$ref": "#/components/schemas/project-cost-type", "description": "The type of the additional cost." }, "index": { "type": "number", "description": "The number of the additional cost." }, "costPerUnit": { "type": "number", "description": "The cost of a unit." }, "unitCount": { "type": "number", "description": "The number of units for which a cost is applied." }, "volumeUnitType": { "$ref": "#/components/schemas/volume-unit-type", "description": "The unit type of the 'volume' cost, used as reference for the unit cost." }, "conditionalCostType": { "$ref": "#/components/schemas/conditional-cost-type", "description": "Only for the Conditional type." }, "costOperator": { "$ref": "#/components/schemas/conditional-cost-operator", "description": "Only for the Conditional type." }, "costVariable": { "$ref": "#/components/schemas/conditional-cost-variable", "description": "Only for the Conditional type." }, "operand": { "type": "number", "description": "Operand of the Conditional type cost." }, "serviceTypes": { "type": "array", "description": "
default
Array of Service Type identifiers where this additional cost is applied. ", "items": { "type": "string" } }, "customUnitName": { "type": "string", "description": "The name of the custom unit." } } }, "translation-memory-settings-request": { "title": "Translation Memory Settings Request", "type": "object", "description": "Translation Memory settings Request", "properties": { "filters": { "$ref": "#/components/schemas/translation-memory-filters-request" }, "updateTranslationMemoryFields": { "type": "array", "items": { "$ref": "#/components/schemas/translation-memory-update-TM-fields-request" } } } }, "translation-memory-filters-request": { "type": "object", "title": "Translation Memory Filters Request", "description": "Translation Memory filter settings request", "properties": { "hardFilter": { "$ref": "#/components/schemas/translation-memory-hard-filter-request" } } }, "translation-memory-hard-filter-request": { "title": "Translation Memory Hard Filter Request", "type": "object", "description": "Hard filter configuration for Translation Memory matching request", "required": [ "expression", "fields" ], "properties": { "expression": { "type": "string", "example": "(NOT \"TU confirmation level\" = \"Not Translated\" OR \"Last modified on\" > 2024-02-29T10:00:00.000Z\") AND \"Source segment length\" >= 10", "description": "The filter expression is a set of atomic expressions connected by logical operators.
An atomic expression describes the relationship of a field to a value." } } }, "project-cost-request": { "title": "Project Cost Request", "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string", "description": "The name of the additional cost. " }, "type": { "$ref": "#/components/schemas/project-cost-type", "description": "The type of the additional cost." }, "index": { "type": "number", "description": "The number of the additional cost." }, "costPerUnit": { "type": "number", "description": "The cost of a unit." }, "unitCount": { "type": "number", "description": "The number of units for which a cost is applied." }, "volumeUnitType": { "$ref": "#/components/schemas/volume-unit-type", "description": "The unit type of the 'volume' cost, used as reference for the unit cost." }, "conditionalCostType": { "$ref": "#/components/schemas/conditional-cost-type", "description": "Only for the Conditional type." }, "costOperator": { "$ref": "#/components/schemas/conditional-cost-operator", "description": "Only for the Conditional type." }, "costVariable": { "$ref": "#/components/schemas/conditional-cost-variable", "description": "Only for the Conditional type." }, "operand": { "type": "number", "description": "Operand of the Conditional type cost." }, "serviceTypes": { "type": "array", "description": "Array of Service Type identifiers where this additional cost is applied.", "items": { "type": "string" } }, "customUnitName": { "type": "string", "maxLength": 100, "description": "The name of the custom unit. Required when `volumeUnitType` is `custom`." } } }, "project-cost-type": { "title": "Project Cost Type", "type": "string", "enum": [ "volume", "perTargetLanguage", "perFile", "hourly", "percentage", "perPage", "conditional", "adhoc", "adhocVolume" ] }, "project-group": { "title": "Project Group", "type": "object", "description": "Project Group resource. (Not available for List Projects endpoint)", "properties": { "id": { "type": "string", "description": "The project group identifier." }, "shortId": { "type": "string", "description": "The short identifier of the project group." }, "name": { "type": "string", "description": "
default
The project group name.
", "x-default-field": true }, "description": { "type": "string", "description": "The project group description." }, "status": { "type": "string", "description": "The status of the projects in the project group.\n\n- `new`: the group is new created, or all projects in the group have status New\n\n- `inProgress`: at least one project in the group is in progress\n\n- `completed`: all projects in the group have status Completed\n\n- `deleting`: the group is getting deleted and the projects are removing from it", "enum": [ "new", "inProgress", "completed", "deleting" ] }, "projects": { "type": "array", "description": "The projects in the project group.", "items": { "$ref": "#/components/schemas/project-group-project" } }, "location": { "$ref": "#/components/schemas/folder-v2" }, "createdAt": { "type": "string", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the project group was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\" ", "format": "date-time" }, "lastModifiedAt": { "type": "string", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the project group was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", "format": "date-time" } }, "required": [ "id" ] }, "project-group-create-response": { "title": "Project Group Create Response", "type": "object", "description": "The Project Group Create response. ", "properties": { "id": { "type": "string", "description": "The project group identifier." }, "name": { "type": "string", "description": "The project group name." }, "description": { "type": "string", "description": "The project group description." }, "status": { "type": "string", "description": "The status of the projects in the project group.\n\n- `new`: the group is newly created, or all the projects in the group have the \"New\" status \n\n- `inProgress`: at least one project in the group is in progress\n\n- `completed`: all projects in the group have the \"Completed\" status \n\n- `deleting`: the group is being deleted and the projects will be removed", "enum": [ "new", "inProgress", "completed", "deleting" ] }, "location": { "$ref": "#/components/schemas/folder-v2" }, "shortId": { "type": "string" }, "createdAt": { "type": "string", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the project group was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", "format": "date-time" }, "lastModifiedAt": { "type": "string", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the project group was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", "format": "date-time" } }, "required": [ "id" ] }, "project-group-project": { "title": "Project Group Project", "type": "object", "description": "Project resource for project group.", "properties": { "id": { "type": "string", "description": "The project identifier." }, "status": { "type": "string", "description": "The project's status.", "enum": [ "attaching", "attached", "detaching", "updating", "failed" ] } }, "required": [ "id" ] }, "project-group-project-request": { "title": "Project Group Project Request", "type": "object", "properties": { "id": { "type": "string", "description": "A project id." } }, "required": [ "id" ] }, "project-group-create-request": { "title": "Project Group Create Request", "type": "object", "description": "Input for project group creation.", "properties": { "name": { "type": "string", "description": "The project group name.\\\nMust be unique per location.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", "minLength": 1, "maxLength": 100 }, "description": { "type": "string", "description": "The project group description.", "maxLength": 1000 }, "location": { "type": "string", "description": "The folder identifier where the project group should be created. If it isn't mentioned, it will be created in the Root folder. If the user does not have access in Root, the request will fail with forbidden error. " } }, "required": [ "name" ] }, "project-group-update-request": { "title": "Project Group Update Request", "type": "object", "properties": { "name": { "type": "string", "description": "The project group name.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", "minLength": 1, "maxLength": 100 }, "description": { "type": "string", "description": "The project group description.", "maxLength": 1000 } } }, "project-manager-request": { "title": "Project Manager Request", "type": "object", "properties": { "id": { "type": "string", "description": "Depending on the type, User identifier or Group identifier." }, "type": { "type": "string", "enum": [ "group", "user" ] } }, "required": [ "id", "type" ] }, "project-manager-response": { "title": "Project Manager Response", "type": "object", "description": "", "properties": { "type": { "type": "string", "enum": [ "group", "user" ] }, "user": { "$ref": "#/components/schemas/user" }, "group": { "$ref": "#/components/schemas/group" } } }, "project-settings-create-request": { "title": "Project Settings Create Request", "type": "object", "properties": { "general": { "$ref": "#/components/schemas/project-settings-general-request" } } }, "project-settings-update-request": { "title": "Project Settings Update Request", "type": "object", "properties": { "general": { "$ref": "#/components/schemas/project-settings-general-request" }, "translationMemorySettings": { "$ref": "#/components/schemas/translation-memory-settings-request" } } }, "project-batch-tasks-settings": { "title": "Project Batch Tasks Settings", "type": "object", "description": "Project Batch Tasks Settings", "properties": { "preProcessing": { "$ref": "#/components/schemas/project-batch-pre-processing-settings", "description": "Pre-Processing Settings" } } }, "project-batch-pre-processing-settings": { "title": "Project Batch Pre-Processing Settings", "type": "object", "properties": { "reportCrossFileRepetition": { "type": "boolean", "default": true, "description": "
default
" } } }, "project-settings-response": { "title": "Project Settings", "type": "object", "properties": { "general": { "$ref": "#/components/schemas/project-settings-general-response", "description": "
default
\r\n" }, "translationMemorySettings": { "$ref": "#/components/schemas/project-translation-memory-settings-response", "description": "(Not available for List Projects endpoint)" }, "batchTasks": { "$ref": "#/components/schemas/project-batch-tasks-settings" } } }, "project-settings-general-request": { "title": "Project General Settings", "type": "object", "properties": { "completionConfiguration": { "$ref": "#/components/schemas/completion-config-request" } } }, "project-settings-general-response": { "title": "Project General Settings", "type": "object", "properties": { "completionConfiguration": { "$ref": "#/components/schemas/completion-config-response", "description": "
default
" } } }, "project-update-request": { "title": "Project Update Request", "type": "object", "properties": { "name": { "type": "string", "description": "The project name.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", "minLength": 1, "maxLength": 100 }, "description": { "type": "string", "description": "The project description.", "maxLength": 1000 }, "dueBy": { "$ref": "#/components/schemas/date-time" }, "deliveredBy": { "$ref": "#/components/schemas/date-time", "description": "Value used to automatically update dueBy of the project at the Customer Quote Approval step, if this step exists in the project workflow." }, "translationEngine": { "$ref": "#/components/schemas/configuration-resource-request" }, "fileProcessingConfiguration": { "$ref": "#/components/schemas/configuration-resource-request" }, "pricingModel": { "$ref": "#/components/schemas/configuration-resource-request", "description": "Resource configuration properties. Pricing model can only be updated for projects that are not started." }, "workflow": { "$ref": "#/components/schemas/configuration-resource-request" }, "projectPlan": { "$ref": "#/components/schemas/project-plan-update-request" }, "tqaProfile": { "$ref": "#/components/schemas/configuration-resource-request" }, "quote": { "$ref": "#/components/schemas/quote-update-request" }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/custom-field-request" } }, "projectManagers": { "type": "array", "items": { "$ref": "#/components/schemas/project-manager-request" } }, "settings": { "$ref": "#/components/schemas/project-settings-update-request" } } }, "project-template-create-request": { "title": "Project Template Create Request", "type": "object", "description": "Input for Project Template creation.", "required": [ "name", "location", "fileProcessingConfiguration" ], "properties": { "name": { "type": "string", "description": "The project template name.", "minLength": 1, "maxLength": 100 }, "description": { "type": "string", "description": "The project description.", "maxLength": 1000 }, "location": { "type": "string", "description": "The folder identifier where the project should be created." }, "fileProcessingConfiguration": { "$ref": "#/components/schemas/configuration-resource-request" }, "projectManagers": { "type": "array", "items": { "$ref": "#/components/schemas/project-manager-request" } }, "scheduleTemplate": { "$ref": "#/components/schemas/configuration-resource-request" }, "languageDirections": { "type": "array", "description": "The language directions.\n\nWhen creating a project using a project template that supports multiple source languages, you must supply the `languageDirections`.
Note: The values for source and targe language must have the same value as the source and target language from project template.", "items": { "$ref": "#/components/schemas/language-direction-request" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/custom-field-request" } }, "translationEngine": { "$ref": "#/components/schemas/configuration-resource-request" }, "pricingModel": { "$ref": "#/components/schemas/configuration-resource-request" }, "workflow": { "$ref": "#/components/schemas/configuration-resource-request" }, "settings": { "$ref": "#/components/schemas/project-template-settings-request" } } }, "project-template-update-request": { "title": "Project Template Update Request", "type": "object", "description": "Input for Project Template creation.", "properties": { "name": { "type": "string", "description": "The project template name.", "minLength": 1, "maxLength": 100 }, "description": { "type": "string", "description": "The project description.", "maxLength": 1000 }, "fileProcessingConfiguration": { "$ref": "#/components/schemas/configuration-resource-request" }, "projectManagers": { "type": "array", "items": { "$ref": "#/components/schemas/project-manager-request" } }, "scheduleTemplate": { "$ref": "#/components/schemas/configuration-resource-request" }, "languageDirections": { "type": "array", "description": "The language directions.\n\nWhen creating a project using a project template that supports multiple source languages, you must supply the `languageDirections`.
Note: The values for source and targe language must have the same value as the source and target language from project template.", "items": { "$ref": "#/components/schemas/language-direction-request" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/custom-field-request" } }, "translationEngine": { "$ref": "#/components/schemas/configuration-resource-request" }, "pricingModel": { "$ref": "#/components/schemas/configuration-resource-request" }, "workflow": { "$ref": "#/components/schemas/configuration-resource-request" }, "settings": { "$ref": "#/components/schemas/project-template-settings-update-request" } } }, "project-template-response": { "title": "Project Template", "type": "object", "description": "Project Template resource. (Not available for List Projects endpoint)", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The project template identifier." }, "name": { "type": "string", "description": "
default
The project template name.
", "x-default-field": true }, "description": { "type": "string", "description": "The project template description." }, "languageDirections": { "type": "array", "items": { "$ref": "#/components/schemas/language-direction-no-statistics" } }, "location": { "$ref": "#/components/schemas/folder-v2" }, "translationEngine": { "$ref": "#/components/schemas/translation-engine" }, "fileProcessingConfiguration": { "$ref": "#/components/schemas/file-processing-configuration" }, "pricingModel": { "$ref": "#/components/schemas/pricing-model" }, "workflow": { "$ref": "#/components/schemas/workflow" }, "customFields": { "type": "array", "description": "The Custom Fields.", "items": { "$ref": "#/components/schemas/custom-field" } }, "forceOnline": { "type": "boolean", "description": "(Deprecated) Moved under settings.general.forceOnline", "deprecated": true }, "projectManagers": { "type": "array", "items": { "$ref": "#/components/schemas/project-manager-response" } }, "quoteTemplate": { "$ref": "#/components/schemas/project-quote-template-deprecated" }, "scheduleTemplate": { "$ref": "#/components/schemas/schedule-template" }, "settings": { "$ref": "#/components/schemas/project-template-settings-response" }, "lastModifiedAt": { "type": "string", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the project template was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", "format": "date-time" } } }, "project-template-settings-request": { "title": "Project Template Settings", "type": "object", "description": "Input for Project Template settings.", "properties": { "general": { "$ref": "#/components/schemas/project-template-general-settings-request" }, "qualityManagement": { "$ref": "#/components/schemas/project-template-quality-management-settings" } } }, "project-template-settings-update-request": { "title": "Project Template Settings", "type": "object", "description": "Input for Project Template settings.", "properties": { "general": { "$ref": "#/components/schemas/project-template-general-settings-update" }, "qualityManagement": { "$ref": "#/components/schemas/project-template-quality-management-settings" }, "translationMemorySettings": { "$ref": "#/components/schemas/translation-memory-settings-request" } } }, "project-template-settings-response": { "title": "Project Template Settings", "type": "object", "description": "Project Template settings. See detailed description of options on the Official Documentation page. \n\n (Not available for List Project Templates endpoint)", "properties": { "general": { "$ref": "#/components/schemas/project-template-general-settings-response", "x-default-field": true, "description": "
default
General settings, are detailed in section 10.a
" }, "batchTasks": { "$ref": "#/components/schemas/project-template-batch-tasks-settings" }, "verification": { "$ref": "#/components/schemas/project-template-verification-settings" }, "qualityManagement": { "$ref": "#/components/schemas/project-template-quality-management-settings-response" }, "termbaseSettings": { "$ref": "#/components/schemas/project-template-termbase-settings-response" }, "translationMemorySettings": { "$ref": "#/components/schemas/project-template-translation-memory-settings-response" } } }, "project-template-general-settings-request": { "title": "General settings", "type": "object", "description": "General settings", "properties": { "forceOnline": { "type": "boolean", "description": "This forces the project to be translated using the Trados Cloud Platform Online Editor exclusively.", "default": false }, "quoteTemplate": { "$ref": "#/components/schemas/configuration-resource-request" }, "customerPortalVisibility": { "type": "boolean", "description": "Customer Portal visibility", "default": true }, "completionConfiguration": { "$ref": "#/components/schemas/completion-config-request" } } }, "project-template-general-settings-update": { "title": "General settings", "type": "object", "description": "General settings", "properties": { "forceOnline": { "type": "boolean", "description": "This forces the project to be translated using the Trados Cloud Platform Online Editor exclusively.", "default": false }, "quoteTemplate": { "$ref": "#/components/schemas/configuration-resource-request" }, "customerPortalVisibility": { "type": "boolean", "description": "Customer Portal visibility", "default": true }, "completionConfiguration": { "$ref": "#/components/schemas/completion-config-request" } } }, "project-template-general-settings-response": { "title": "General settings", "type": "object", "description": "General settings, are detailed in section 10.a", "properties": { "forceOnline": { "type": "boolean", "description": "
default
Restrict file downloads.", "x-default-field": true, "default": false }, "allowSourceEdit": { "type": "boolean", "description": "
default
Allow editing of source text in segments.", "x-default-field": true, "default": false }, "quoteTemplate": { "$ref": "#/components/schemas/project-quote-template", "x-default-field": true, "description": "
default
" }, "customerPortalVisibility": { "type": "boolean", "description": "
default
Customer Portal visibility", "x-default-field": true, "default": true }, "completionConfiguration": { "$ref": "#/components/schemas/completion-config-request", "description": "
default
\r\n" } } }, "project-template-batch-tasks-settings": { "title": "Project Template Batch Tasks Settings", "type": "object", "description": "Project Template Batch Tasks Settings", "properties": { "preProcessing": { "$ref": "#/components/schemas/project-template-batch-tasks-preprocessing-settings", "x-default-field": true, "description": "
default
Pre-Processing Settings, configure how TMs are applied, are detailed in section 10.b
" }, "updateTranslationMemory": { "$ref": "#/components/schemas/update-translation-memory-settings", "x-default-field": true, "description": "
default
Configure how TMs are updated throughout the project workflow depending on the status of the segments. Are detailed in section 10.c
" } } }, "project-template-verification-settings": { "title": "Project Template Verification Settings", "type": "object", "description": "", "properties": { "tagVerifier": { "$ref": "#/components/schemas/project-template-verification-tag-verifier-settings", "x-default-field": true, "description": "
default
Tag Verifier Settings, are detailed in section 10.d
" }, "qaChecker": { "$ref": "#/components/schemas/project-template-verification-qa-checker-settings", "x-default-field": true, "description": "
default
QA Checker Settings, are detailed in section 10.e
" } } }, "project-template-quality-management-settings": { "title": "Quality Managment", "type": "object", "properties": { "tqaProfile": { "$ref": "#/components/schemas/configuration-resource-request" } } }, "project-template-quality-management-settings-response": { "title": "Quality Managment", "type": "object", "properties": { "tqaProfile": { "$ref": "#/components/schemas/tqa-profile" } } }, "project-template-translation-memory-settings-response": { "title": "Translation Memory settings", "type": "object", "description": "Translation Memory settings", "properties": { "penalties": { "$ref": "#/components/schemas/project-template-TM-penalties", "description": "
default
" }, "filters": { "$ref": "#/components/schemas/translation-memory-settings-filters-response", "description": "
default
" }, "updateTranslationMemoryFields": { "type": "array", "items": { "$ref": "#/components/schemas/translation-memory-settings-update-field-response" } } } }, "project-translation-memory-settings-response": { "title": "Translation Memory settings", "type": "object", "description": "Translation Memory settings", "properties": { "filters": { "$ref": "#/components/schemas/translation-memory-settings-filters-response", "description": "
default
" }, "updateTranslationMemoryFields": { "type": "array", "items": { "$ref": "#/components/schemas/translation-memory-settings-update-field-response" } } } }, "project-template-batch-tasks-preprocessing-settings": { "title": "Pre-Processing Settings", "type": "object", "description": "Pre-Processing Settings, configure how TMs are applied, are detailed in section 10.b", "properties": { "minimumMatchValue": { "type": "integer", "minimum": 50, "maximum": 100, "default": 70, "description": "
default
", "x-default-field": true }, "translationOverwriteMode": { "type": "string", "enum": [ "keepExisting", "overwriteIfBetter", "overwriteAlways", "overwriteExceptPerfectMatch" ], "description": "
default
Options: \r\n- `keepExisting`: no segments are overwritten, existing segments are kept;\r\n- `overwriteIfBetter`: unlocked segments (including confirmed segments) are overwritten, while unlocked PerfectMatch segments and locked segments are not overwritten; \r\n- `overwriteAlways`: PerfectMatch segments (both locked and unlocked) are overwritten, while other locked segments are not overwritten;\r\n- `overwriteExceptPerfectMatch`: unlocked segments (including confirmed segments) and locked segments are overwritten, while unlocked PerfectMatch segments are not overwritten;
", "x-default-field": true, "default": "overwriteIfBetter" }, "afterApplyingTranslations": { "type": "array", "x-default-field": true, "description": "
default
Default: `confirmExactMatches`, `confirmContextMatches`
", "items": { "type": "string", "enum": [ "confirmExactMatches", "confirmContextMatches", "lockExactMatches", "lockContextMatches", "lockGreenSegments", "lockAmberSegments", "lockRedSegments" ], "default": "confirmContextMatches" } }, "noMatchFoundAction": { "type": "string", "enum": [ "leaveTargetSegmentsEmpty", "copySourceToTarget" ], "description": "
default
", "x-default-field": true, "default": "leaveTargetSegmentsEmpty" }, "reportCrossFileRepetition": { "type": "boolean", "default": false, "description": "If enabled repetitions are identified and included in analysis reports." }, "excludeLockedSegments": { "type": "boolean", "default": false, "description": "If enabled locked segments (content that must not be translated) are excluded from translation. " } } }, "project-template-termbase-general-settings": { "title": "General Settings", "type": "object", "properties": { "showRecognizedTermsWithNoTranslation": { "type": "boolean" }, "enableRecognitionOfTwoLetterTerms": { "type": "boolean" }, "allowOverlappingTerms": { "type": "boolean" }, "minimumScore": { "type": "number", "minimum": 0, "maximum": 100, "default": 70 }, "termLength": { "type": "number", "minimum": 0, "default": 2 } } }, "project-template-termbase-settings-response": { "title": "Termbase Settings", "type": "object", "properties": { "general": { "x-default-field": true, "$ref": "#/components/schemas/project-template-termbase-general-settings", "description": "
default
" } } }, "project-template-verification-tag-verifier-settings": { "title": "Tag Verifier Settings", "type": "object", "description": "Tag Verifier Settings, are detailed in section 10.d", "properties": { "enabled": { "type": "boolean" }, "checkAddedTags": { "type": "boolean", "x-default-field": true, "default": true, "description": "
default
" }, "addedTagsSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "error" }, "checkDeletedTags": { "type": "boolean", "x-default-field": true, "default": true, "description": "
default
" }, "deletedTagsSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "error" }, "checkTagOrderChanged": { "type": "boolean", "x-default-field": true, "default": true, "description": "
default
" }, "tagOrderChangedSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "warning" }, "checkSpacingAroundTags": { "type": "boolean", "x-default-field": true, "default": true, "description": "
default
" }, "spaceAroundTagsSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "note" }, "ignoreFormattingTags": { "type": "boolean", "x-default-field": true, "default": true, "description": "
default
" }, "ignoreLockedSegments": { "type": "boolean", "x-default-field": true, "default": false, "description": "
default
" }, "ignoreDifferenceBetweenNormalAndNonBreakingSpace": { "type": "boolean", "x-default-field": true, "default": true, "description": "
default
" } }, "required": [ "enabled" ] }, "project-template-verification-qa-checker-settings": { "title": "QA checker", "type": "object", "description": "QA Checker Settings, are detailed in section 10.e", "properties": { "enabled": { "type": "boolean", "default": true }, "allLanguages": { "$ref": "#/components/schemas/project-template-verification-qa-checker-all-languages", "x-default-field": true, "description": "
default
" }, "perTargetLanguage": { "type": "array", "items": { "$ref": "#/components/schemas/project-template-verification-qa-checker-per-target-language" } } }, "required": [ "enabled" ] }, "project-template-verification-qa-checker-all-languages": { "title": "All Languages settings", "type": "object", "properties": { "segmentsVerification": { "$ref": "#/components/schemas/project-template-verification-qa-checker-segments-verification", "x-default-field": true, "description": "
default
" }, "segmentsToExclude": { "$ref": "#/components/schemas/project-template-verification-qa-checker-segments-to-exclude", "x-default-field": true, "description": "
default
" }, "inconsistencies": { "$ref": "#/components/schemas/project-template-verification-qa-checker-inconsistencies", "x-default-field": true, "description": "
default
" }, "punctuation": { "$ref": "#/components/schemas/project-template-verification-qa-checker-punctuation", "x-default-field": true, "description": "
default
" }, "numbers": { "$ref": "#/components/schemas/project-template-verification-qa-checker-numbers", "x-default-field": true, "description": "
default
" }, "wordList": { "$ref": "#/components/schemas/project-template-verification-qa-checker-word-list", "x-default-field": true, "description": "
default
" }, "regularExpressions": { "$ref": "#/components/schemas/project-template-verification-qa-checker-regular-expressions", "x-default-field": true, "description": "
default
" }, "trademarkCheck": { "$ref": "#/components/schemas/project-template-verification-qa-checker-trademark-check", "x-default-field": true, "description": "
default
" }, "lengthVerification": { "$ref": "#/components/schemas/project-template-verification-qa-checker-length-verification", "x-default-field": true, "description": "
default
" } } }, "project-template-verification-qa-checker-per-target-language": { "title": "Per Language Settings", "type": "object", "properties": { "targetLanguage": { "$ref": "#/components/schemas/language" }, "punctuation": { "$ref": "#/components/schemas/project-template-verification-qa-checker-punctuation", "x-default-field": true, "description": "
default
" }, "numbers": { "$ref": "#/components/schemas/project-template-verification-qa-checker-numbers", "x-default-field": true, "description": "
default
" }, "wordList": { "$ref": "#/components/schemas/project-template-verification-qa-checker-word-list", "x-default-field": true, "description": "
default
" }, "regularExpressions": { "$ref": "#/components/schemas/project-template-verification-qa-checker-regular-expressions", "x-default-field": true, "description": "
default
" } }, "required": [ "targetLanguage" ] }, "project-template-verification-qa-checker-segments-verification": { "title": "Segments Verification", "type": "object", "properties": { "checkForgottenTranslation": { "type": "boolean", "default": true, "x-default-field": true, "description": "
default
" }, "forgottenTranslationSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "error" }, "checkSourceTargetIdentical": { "type": "boolean", "x-default-field": true, "default": true, "description": "
default
" }, "sourceTargetIdenticalSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "warning" }, "identicalSegmentsIgnoreTags": { "type": "boolean", "default": false }, "identicalSegmentsIgnoreCase": { "type": "boolean", "default": false }, "checkTargetLonger": { "type": "boolean", "x-default-field": true, "default": false, "description": "
default
" }, "longerByValue": { "type": "number", "x-default-field": true, "default": 50, "description": "
default
" }, "checkTargetShorter": { "type": "boolean", "x-default-field": true, "default": false, "description": "
default
" }, "shorterByValue": { "type": "number", "x-default-field": true, "default": 50, "description": "
default
" }, "ignoreSegmentsFewerThanCount": { "type": "number", "x-default-field": true, "default": 2, "description": "
default
" }, "ignoreSegmentsFewerThanBase": { "type": "string", "enum": [ "words", "characters" ], "default": "characters", "x-default-field": true, "description": "
default
" }, "checkForbiddenChars": { "type": "boolean", "x-default-field": true, "default": false, "description": "
default
" }, "forbiddenChars": { "type": "string", "x-default-field": true, "description": "
default
" }, "forbiddenCharsSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "error" } } }, "project-template-verification-qa-checker-segments-to-exclude": { "title": "Segments to Exclude", "type": "object", "properties": { "excludePerfectMatchSegments": { "type": "boolean", "default": true, "x-default-field": true, "description": "
default
" }, "excludeExactMatches": { "type": "boolean", "x-default-field": true, "default": false, "description": "
default
" }, "excludeFuzzyMatches": { "type": "boolean", "x-default-field": true, "default": false, "description": "
default
" }, "excludeFuzzyMatchesValue": { "type": "number", "x-default-field": true, "default": 99, "description": "
default
" }, "excludeNewTranslation": { "type": "boolean", "x-default-field": true, "default": false, "description": "
default
" }, "excludeConfirmedTranslations": { "type": "boolean", "x-default-field": true, "default": false, "description": "
default
" }, "excludeLockedSegments": { "type": "boolean", "x-default-field": true, "description": "
default
" }, "excludeIdentical": { "type": "boolean", "x-default-field": true, "default": false, "description": "
default
" }, "elementContextExclusion": { "type": "boolean", "x-default-field": true, "default": false, "description": "
default
" }, "exclusionContextList": { "type": "array", "x-default-field": true, "items": { "type": "string" }, "description": "
default
" }, "reportAllNonExcluded": { "type": "boolean", "x-default-field": true, "default": false, "description": "
default
" }, "reportAllNonExcludedSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "note" } } }, "project-template-verification-qa-checker-inconsistencies": { "title": "QA Checker Inconsistencies", "type": "object", "properties": { "checkInconsistentTranslations": { "type": "boolean", "default": false, "x-default-field": true, "description": "
default
" }, "checkInconsistentTranslationsSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "warning" }, "checkInconsistentTranslationsIgnoreTags": { "type": "boolean", "default": false }, "checkInconsistentTranslationsIgnoreCase": { "type": "boolean", "default": false }, "checkRepeatedWords": { "type": "boolean", "x-default-field": true, "default": true, "description": "
default
" }, "checkRepeatedWordsSeverity": { "type": "string", "enum": [ "error", "warning", " Note" ], "default": "warning" }, "checkRepeatedWordsIgnoreNumbers": { "type": "boolean", "default": false }, "checkRepeatedWordsIgnoreCase": { "type": "boolean", "default": false }, "checkUneditedSegmentsFuzzy": { "type": "boolean", "x-default-field": true, "default": true, "description": "
default
" }, "checkUneditedSegmentsFuzzySeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "warning" }, "checkOnlyConfirmedSegments": { "type": "boolean", "default": false }, "checkIfMatchScoresBelow": { "type": "boolean", "default": false }, "checkIfMatchScoresBelowValue": { "type": "number", "default": 99 } } }, "project-template-verification-qa-checker-punctuation": { "title": "QA Checker Punctuation", "type": "object", "properties": { "checkIdenticalPunctuation": { "type": "boolean", "default": true, "x-default-field": true, "description": "
default
" }, "checkIdenticalPunctuationSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "warning" }, "checkSpanishPunctuation": { "x-default-field": true, "default": false, "type": "boolean", "description": "
default
" }, "checkSpanishPunctuationSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "warning" }, "checkUnintentionalSpacesBeforePunctuation": { "type": "boolean", "x-default-field": true, "default": true, "description": "
default
" }, "checkUnintentionalSpacesBeforePunctuationSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "warning" }, "checkUnintentionalSpacesBeforePunctuationValues": { "type": "string", "default": ":!?;" }, "punctuationSpacesFrench": { "type": "boolean", "default": false }, "checkMultipleSpaces": { "type": "boolean", "x-default-field": true, "default": true, "description": "
default
" }, "checkMultipleSpacesSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "note" }, "checkMultipleDots": { "type": "boolean", "x-default-field": true, "default": true, "description": "
default
" }, "checkMultipleDotsSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "note" }, "ignoreThreeDots": { "type": "boolean", "x-default-field": true, "default": true, "description": "
default
" }, "checkExtraSpace": { "type": "boolean", "x-default-field": true, "default": true, "description": "
default
" }, "checkExtraSpaceSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "warning" }, "checkCapitalizationOfInitials": { "type": "boolean", "x-default-field": true, "default": false, "description": "
default
" }, "checkCapitalizationOfInitialsSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "warning" }, "checkConsistencyOfGlobalCapitalization": { "type": "boolean", "x-default-field": true, "default": false, "description": "
default
" }, "checkConsistencyOfGlobalCapitalizationSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "warning" }, "checkBrackets": { "type": "boolean", "x-default-field": true, "default": true, "description": "
default
" }, "checkBracketsSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "warning" } } }, "project-template-verification-qa-checker-numbers": { "title": "QA Checker Numbers", "type": "object", "properties": { "checkNumbers": { "type": "boolean", "default": false, "x-default-field": true, "description": "
default
" }, "checkNumbersSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "error" }, "checkTimes": { "type": "boolean", "x-default-field": true, "default": false, "description": "
default
" }, "checkTimesSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "error" }, "checkDates": { "type": "boolean", "x-default-field": true, "default": false, "description": "
default
" }, "checkDatesSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "error" }, "checkMeasurements": { "type": "boolean", "x-default-field": true, "default": false, "description": "
default
" }, "checkMeasurementsSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "error" } } }, "project-template-verification-qa-checker-word-list": { "title": "QA Checker Word list", "type": "object", "properties": { "enabled": { "type": "boolean", "default": false }, "searchWholeWords": { "type": "boolean", "x-default-field": true, "default": false, "description": "
default
" }, "ignoreCase": { "type": "boolean", "x-default-field": true, "default": false, "description": "
default
" }, "checkWordListSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "warning" }, "wordList": { "type": "array", "x-default-field": true, "items": { "type": "object", "properties": { "wrongForm": { "type": "string", "x-default-field": true }, "correctForm": { "type": "string", "x-default-field": true } } }, "description": "
default
" } }, "required": [ "enabled" ] }, "project-template-verification-qa-checker-regular-expressions": { "title": "QA Checker Regular Expressions", "type": "object", "properties": { "checkRegularExpressions": { "type": "boolean", "default": false, "description": "" }, "regularExpressionSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "warning" }, "regularExpressions": { "type": "array", "x-default-field": true, "items": { "$ref": "#/components/schemas/project-template-verification-qa-checker-regular-expressions-model" }, "description": "
default
" } }, "required": [ "checkRegularExpressions" ] }, "project-template-verification-qa-checker-regular-expressions-model": { "title": "Regular Expressions Model", "type": "object", "properties": { "description": { "type": "string", "x-default-field": true, "description": "
default
" }, "regexSource": { "type": "string", "x-default-field": true, "description": "
default
" }, "regexTarget": { "type": "string", "x-default-field": true, "description": "
default
" }, "ignoreCase": { "type": "boolean", "x-default-field": true, "default": false, "description": "
default
" }, "condition": { "type": "string", "enum": [ "targetAndSource", "targetNotSource", "sourceNotTarget", "sourceOnly", "targetOnly", "differentCount", "groupedTargetAndSource" ], "x-default-field": true, "description": "
default
" } } }, "project-template-verification-qa-checker-trademark-check": { "title": "QA Checker Trademark check", "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "trademarkSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "error" }, "trademarkSymbols": { "type": "array", "x-default-field": true, "items": { "type": "string" }, "default": [ "®", "©", "™", "(c)", "(r)", "(tm)" ], "description": "
default
" } }, "required": [ "enabled" ] }, "project-template-verification-qa-checker-length-verification": { "title": "QA Checker Length Verification", "type": "object", "properties": { "checkLengthLimitation": { "type": "boolean", "default": true, "x-default-field": true, "description": "
default
" }, "checkLengthLimitationSeverity": { "type": "string", "enum": [ "error", "warning", "note" ], "default": "error" }, "targetSegmentsVerificationType": { "x-default-field": true, "type": "string", "enum": [ "fileSpecificLimit", "absoluteCharacterCount" ], "default": "fileSpecificLimit", "description": "
default
" }, "absoluteCharCountValue": { "type": "number", "x-default-field": true, "description": "
default
Used in case `targetSegmentsVerificationType = absoluteCharacterCount`
", "default": 50 } } }, "project-template-TM-penalties": { "title": "Translation Memory Penalties", "type": "object", "description": "Translation Memory Penalties", "properties": { "standardPenalties": { "$ref": "#/components/schemas/project-template-TM-standard-penalties", "description": "
default
", "x-default-field": true, "type": "object" }, "translationUnitStatusPenalties": { "$ref": "#/components/schemas/project-template-TM-translation-unit-status-penalties", "description": "
default
", "x-default-field": true, "type": "object" } } }, "project-template-TM-standard-penalties": { "title": "Translation Memory Standard Penalties", "type": "object", "description": "Translation Memory Standard Penalties", "properties": { "missingFormatting": { "description": "
default
", "x-default-field": true, "type": "integer", "minimum": 0, "maximum": 20, "default": 1 }, "differentFormatting": { "description": "
default
", "x-default-field": true, "type": "integer", "minimum": 0, "maximum": 20, "default": 1 }, "multipleTranslations": { "description": "
default
", "x-default-field": true, "type": "integer", "minimum": 0, "maximum": 20, "default": 1 }, "autoLocalization": { "description": "
default
", "x-default-field": true, "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "textReplacement": { "description": "
default
", "x-default-field": true, "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "alignment": { "description": "
default
", "x-default-field": true, "type": "integer", "minimum": 0, "maximum": 20, "default": 1 }, "characterWidthDifference": { "description": "
default
", "x-default-field": true, "type": "integer", "minimum": 0, "maximum": 20, "default": 1 } } }, "project-template-TM-translation-unit-status-penalties": { "title": "Translation Memory Translation Unit Status Penalties", "type": "object", "description": "Translation Memory Translation Unit Status Penalties", "properties": { "translated": { "description": "
default
", "x-default-field": true, "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "rejectedTranslation": { "description": "
default
", "x-default-field": true, "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "approvedTranslation": { "description": "
default
", "x-default-field": true, "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "rejectedSignOff": { "description": "
default
", "x-default-field": true, "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "approvedSignOff": { "description": "
default
", "x-default-field": true, "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "notTranslated": { "description": "
default
", "x-default-field": true, "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "draft": { "description": "
default
", "x-default-field": true, "type": "integer", "minimum": 0, "maximum": 20, "default": 0 } } }, "project-plan": { "title": "Project Plan", "type": "object", "description": "The configurations of the tasks that will be created in the future.\n\nAvailable now directly after project creation, project does not need to be started to be populated. \n\n(Not available for List Projects endpoint)", "properties": { "taskConfigurations": { "type": "array", "items": { "$ref": "#/components/schemas/project-plan-task-configuration" } } } }, "project-plan-task-configuration": { "title": "Project Plan Task Configuration", "type": "object", "description": "The configuration of a task that will be created in the future.", "properties": { "taskTemplate": { "$ref": "#/components/schemas/workflow-task-template" }, "scope": { "$ref": "#/components/schemas/task-configuration-scope" }, "assignees": { "type": "array", "items": { "$ref": "#/components/schemas/workflow-task-assignee" } }, "isSkipped": { "type": "boolean", "description": "
default
Specifies if the task will be skipped.
", "nullable": true, "x-default-field": true }, "dueBy": { "type": "string", "format": "date-time", "example": "2022-01-12T12:00:00Z", "description": "The due date of the future task.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", "nullable": true }, "configurationValues": { "type": "array", "description": "The task type configuration values set on this task. Each item corresponds to a configuration key defined in `taskTemplate.taskType.configurationDefinitions`.", "items": { "$ref": "#/components/schemas/workflow-task-type-config-value" } } }, "required": [ "taskTemplate", "scope" ] }, "project-plan-task-assignee-request": { "title": "Project Plan Task Assignee Request", "type": "object", "properties": { "type": { "type": "string", "enum": [ "user", "group", "vendorOrderTemplate", "projectCreator" ] }, "id": { "type": "string", "description": "The user, group or vendor identifier, depending on the type chosen. It is not required for `projectCreator`." } }, "required": [ "type" ] }, "project-plan-update-request": { "title": "Project Plan Update Request", "type": "object", "description": "Updates the configurations of the tasks that will be created in the future. \nFor example, you can change the assignee of the \"translation\" task while the project is in the \"preprocessing\" phase.", "properties": { "taskConfigurations": { "type": "array", "minItems": 1, "items": { "$ref": "#/components/schemas/project-plan-task-configuration-request" } } }, "required": [ "taskConfigurations" ] }, "project-plan-task-configuration-request": { "title": "Project Plan Task Configuration Request", "type": "object", "description": "A project plan task configuration request. Used to update a task that will be created in the future.", "properties": { "taskTemplate": { "$ref": "#/components/schemas/object-id-request" }, "isSkipped": { "type": "boolean", "description": "Specifies if the task will be skipped. \n If you want to skip all the target languages for the given task, set the scope as \"global\"." }, "assignees": { "type": "array", "description": "Specifies the list of assignees for the future task. \n
When the 'isSkipped' field is set to 'true', an empty list of assignees should be specified.\r\n
Total assignee count is limited. See more at [Assigning users and groups to workflow tasks](https://docs.rws.com/791595/743481/trados-enterprise---accelerate/assigning-users-and-groups-to-workflow-tasks) point 5e.", "items": { "$ref": "#/components/schemas/project-plan-task-assignee-request" } }, "scope": { "$ref": "#/components/schemas/task-configuration-scope-request" }, "dueBy": { "$ref": "#/components/schemas/date-time" }, "configurationValues": { "type": "array", "items": { "$ref": "#/components/schemas/workflow-task-type-config-value" } } }, "required": [ "taskTemplate", "isSkipped", "assignees", "scope" ] }, "project-status-history": { "title": "Project Status History Item", "type": "object", "description": "An Item which describes a change in the status of the project.", "properties": { "from": { "type": "string", "description": "Specifies the project status previous to the change.", "enum": [ "none", "created", "inProgress", "completed" ] }, "to": { "type": "string", "description": "Specifies the project status post change.", "enum": [ "created", "inProgress", "completed" ] }, "by": { "$ref": "#/components/schemas/user" }, "timestamp": { "$ref": "#/components/schemas/date-time", "x-default-field": true, "description": "The time and date when the status history was updated.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"" } }, "required": [ "from", "to" ] }, "quote": { "title": "Quote", "type": "object", "description": "Project quote.", "properties": { "totalAmount": { "type": "number", "description": "
default
Total translation fee.
", "nullable": true, "x-default-field": true }, "currencyCode": { "type": "string", "description": "
default
The currency code (ISO 4217).
", "x-default-field": true }, "translationCosts": { "type": "array", "items": { "$ref": "#/components/schemas/quote-translation-cost" } }, "languageCosts": { "type": "array", "items": { "$ref": "#/components/schemas/quote-language-cost" } }, "additionalCosts": { "type": "array", "items": { "$ref": "#/components/schemas/quote-additional-cost" } }, "notes": { "type": "string", "description": "A message associated with the quote." } } }, "quote-additional-cost": { "title": "Quote Additional Cost", "type": "object", "description": "Other extra fees not captured by translationCosts and languageCosts.", "properties": { "name": { "type": "string", "description": "
default
The name of the additional cost.
" }, "count": { "type": "number", "description": "The number of units used to compute the total. Used only for 'volume', 'hourly', 'perPage' and 'percentage' cost types.", "nullable": true }, "total": { "type": "number", "description": "
default
The computed cost.
", "nullable": true, "x-default-field": true }, "cost": { "type": "number", "description": "The cost of a unit.", "nullable": true }, "costType": { "$ref": "#/components/schemas/project-cost-type", "description": "The type of the additional cost." }, "volumeUnitType": { "$ref": "#/components/schemas/volume-unit-type", "description": "The unit type of the 'volume' cost, used as a reference for the unit cost." }, "costOrder": { "type": "integer", "description": "Indicates the order in which the additional cost is computed.", "nullable": true }, "conditionalCostType": { "$ref": "#/components/schemas/conditional-cost-type", "description": "Describes how the cost of type 'conditional' will be added to total cost." }, "conditionalCostOperator": { "$ref": "#/components/schemas/conditional-cost-operator", "description": "The operator applied between the 'costVariable' and 'operand'." }, "conditionalCostVariable": { "$ref": "#/components/schemas/conditional-cost-variable", "description": "The variable that is evaluated against the 'operand' based on the 'costOperator'." }, "conditionalCostThreshold": { "description": "The value that is evaluated against the 'costVariable' based on the 'costOperator'.", "type": "number", "nullable": true }, "runningTotal": { "type": "number", "description": "The sum of all the previously computed costs.", "nullable": true }, "customUnitName": { "type": "string", "description": "The name of the custom unit." } } }, "quote-additional-cost-request": { "title": "Quote Additional Cost Request", "type": "object", "required": [ "name", "count", "cost", "costOrder", "conditionalCostThreshold" ], "properties": { "name": { "type": "string", "description": "The name of the additional cost." }, "count": { "type": "number", "description": "The number of units used to compute the total. Used only for 'volume', 'hourly', 'perPage' and 'percentage' cost types." }, "cost": { "type": "number", "description": "The cost of a unit." }, "costType": { "$ref": "#/components/schemas/project-cost-type", "description": "The type of the additional cost.", "nullable": true }, "volumeUnitType": { "$ref": "#/components/schemas/volume-unit-type", "description": "The unit type of the 'volume' cost, used for counting the units.", "nullable": true }, "costOrder": { "type": "integer", "description": "Indicates the order in which the additional cost is computed." }, "conditionalCostType": { "$ref": "#/components/schemas/conditional-cost-type", "description": "Describes how the cost of type 'conditional' will be added to total cost.", "nullable": true }, "conditionalCostOperator": { "$ref": "#/components/schemas/conditional-cost-operator", "description": "The operator applied between the 'costVariable' and 'operand'.", "nullable": true }, "conditionalCostVariable": { "$ref": "#/components/schemas/conditional-cost-variable", "description": "The variable that is evaluated against the 'operand' based on the 'costOperator'.", "nullable": true }, "conditionalCostThreshold": { "description": "The value that is evaluated against the 'costVariable' based on the 'costOperator'.", "type": "number" } } }, "quote-language-cost": { "title": "Quote Language Cost", "type": "object", "description": "Fees relevant for a specific target language.", "properties": { "name": { "type": "string", "description": "
default
The name of the additional cost.
", "x-default-field": true }, "count": { "type": "number", "description": "The number of units used to compute the total. Used only for 'volume', 'hourly', 'perPage' and 'percentage' cost types.", "nullable": true }, "total": { "type": "number", "description": "
default
The computed cost.
", "nullable": true, "x-default-field": true }, "cost": { "type": "number", "description": "The cost of a unit.", "nullable": true }, "costType": { "$ref": "#/components/schemas/language-cost-type", "description": "The type of the additional cost." }, "volumeUnitType": { "$ref": "#/components/schemas/volume-unit-type", "description": "The unit type of the 'volume' cost, used as a reference for the unit cost." }, "targetLanguage": { "$ref": "#/components/schemas/language" }, "costOrder": { "type": "integer", "description": "Indicates the order in which the additional cost is computed.", "nullable": true }, "conditionalCostType": { "$ref": "#/components/schemas/conditional-cost-type", "description": "The condition type of the conditional cost." }, "conditionalCostOperator": { "$ref": "#/components/schemas/conditional-cost-operator", "description": "The operator applied between the 'costVariable' and 'operand'." }, "conditionalCostVariable": { "$ref": "#/components/schemas/conditional-cost-variable", "description": "The variable that is evaluated against the 'operand' based on the 'costOperator'." }, "conditionalCostThreshold": { "description": "The value that is evaluated against the 'costVariable' based on the 'costOperator'.", "type": "number", "nullable": true }, "runningTotal": { "type": "number", "description": "The sum of all the previously computed costs.", "nullable": true }, "customUnitName": { "type": "string", "description": "The name of the custom unit." } } }, "quote-language-cost-request": { "title": "Quote Language Cost Request", "type": "object", "required": [ "name", "count", "cost", "costOrder", "conditionalCostThreshold" ], "properties": { "name": { "type": "string", "description": "The name of the additional cost." }, "count": { "type": "number", "description": "The number of units used to compute the total. Used only for 'volume', 'hourly', 'perPage' and 'percentage' cost types." }, "cost": { "type": "number", "description": "The cost of a unit." }, "costType": { "$ref": "#/components/schemas/language-cost-type", "description": "The type of the additional cost.", "nullable": true }, "volumeUnitType": { "$ref": "#/components/schemas/volume-unit-type", "description": "The unit type of the 'volume' cost, used for counting the units.", "nullable": true }, "targetLanguage": { "$ref": "#/components/schemas/target-language-request" }, "costOrder": { "type": "integer", "description": "Indicates the order in which the additional cost is computed." }, "conditionalCostType": { "$ref": "#/components/schemas/conditional-cost-type", "description": "Describes how the cost of type 'conditional' will be added to total cost.", "nullable": true }, "conditionalCostOperator": { "$ref": "#/components/schemas/conditional-cost-operator", "description": "The operator applied between the 'costVariable' and 'operand'.", "nullable": true }, "conditionalCostVariable": { "$ref": "#/components/schemas/conditional-cost-variable", "description": "The variable that is evaluated against the 'operand' based on the 'costOperator'.", "nullable": true }, "conditionalCostThreshold": { "description": "The value that is evaluated against the 'costVariable' based on the 'costOperator'.", "type": "number" } } }, "quote-translation-cost": { "title": "Quote Translation Cost", "type": "object", "description": "Fees calculated based on segment status (new, translated, signed off) and previous leverage (100% match and identical context, 100% match, <100%match, cross-file repetitions).", "properties": { "total": { "type": "number", "description": "
default
The total cost for the current target language.
", "nullable": true, "x-default-field": true }, "targetLanguage": { "$ref": "#/components/schemas/language" }, "exactMatch": { "$ref": "#/components/schemas/translation-cost-item" }, "inContextExactMatch": { "$ref": "#/components/schemas/translation-cost-item" }, "new": { "$ref": "#/components/schemas/translation-cost-item" }, "perfectMatch": { "$ref": "#/components/schemas/translation-cost-item" }, "repetitions": { "$ref": "#/components/schemas/translation-cost-item" }, "machineTranslation": { "$ref": "#/components/schemas/translation-cost-item" }, "fuzzyMatch": { "type": "array", "items": { "$ref": "#/components/schemas/translation-cost-fuzzy-item" } }, "runningTotal": { "type": "number", "description": "
default
The sum of all the previously computed costs.
", "nullable": true, "x-default-field": true } } }, "quote-update-request": { "title": "Quote Update Request", "type": "object", "properties": { "languageCosts": { "type": "array", "items": { "$ref": "#/components/schemas/quote-language-cost-request" } }, "additionalCosts": { "type": "array", "items": { "$ref": "#/components/schemas/quote-additional-cost-request" } }, "notes": { "type": "string", "description": "A message associated with the quote.", "maxLength": 3000 } } }, "project-quote-template": { "title": "Project Quote Template", "type": "object", "description": "Project Quote Template resource.", "properties": { "id": { "type": "string", "description": "The identifier of the quote template." }, "name": { "type": "string", "description": "The name of the quote template." }, "description": { "type": "string", "description": "The description of the quote template." }, "location": { "$ref": "#/components/schemas/folder-v2" } }, "required": [ "id" ] }, "project-quote-template-deprecated": { "title": "Project Quote Template", "type": "object", "description": "(Deprecated) moved under settings.general.quoteTemplate", "deprecated": true, "properties": { "id": { "type": "string", "description": "The identifier of the quote template." }, "name": { "type": "string", "description": "The name of the quote template." }, "description": { "type": "string", "description": "The description of the quote template." }, "location": { "$ref": "#/components/schemas/folder-v2" } }, "required": [ "id" ] }, "rate-limit": { "title": "Rate Limit", "type": "object", "description": "Rate Limit entry", "properties": { "policyName": { "type": "string", "description": "Name of the rate limit policy." }, "description": { "type": "string", "description": "Describes which endpoints are affected by this limit, and for which time frame." }, "limit": { "type": "integer", "description": "The limit in effect for the endpoint and time frame." }, "remainingQuota": { "type": "integer", "description": "The remaining quota in effect for the endpoint and time frame." } }, "required": [ "policyName", "description", "limit", "remainingQuota" ] }, "reschedule-tasks-request": { "description": "Reschedule tasks.", "properties": { "dueBy": { "description": "The task due date.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", "example": "2022-01-12T12:00:00Z", "format": "date-time", "type": "string" }, "taskIds": { "description": "Identifiers of the tasks to be rescheduled.", "items": { "type": "string" }, "type": "array" } }, "title": "Reschedule Tasks Request", "type": "object" }, "remove-projects-from-group-request": { "title": "Remove Projects From Group Request", "type": "object", "description": "Input for removing projects from group.", "properties": { "projects": { "type": "array", "description": "The projects to be removed from group.", "items": { "$ref": "#/components/schemas/project-group-project-request" } } }, "required": [ "projects" ] }, "role": { "title": "Role", "type": "object", "description": "Role in the account.", "required": [ "id", "type", "name" ], "properties": { "id": { "type": "string", "description": "The identifier of the role." }, "type": { "type": "string", "description": "The role type.", "enum": [ "provisioned", "custom" ] }, "name": { "type": "string", "description": "Name of the role." }, "description": { "type": "string", "description": "Description of the role." }, "permissions": { "type": "array", "description": "List of permissions associated with role.", "minItems": 1, "items": { "$ref": "#/components/schemas/permission" } } } }, "role-update-request": { "title": "Role Update Request", "type": "object", "description": "Role update request.", "properties": { "name": { "type": "string", "description": "Name of the role.", "minLength": 1, "maxLength": 100 }, "description": { "type": "string", "description": "Description of the role.", "maxLength": 1000 }, "permissions": { "type": "array", "description": "List of permission names associated with role.", "minItems": 1, "items": { "type": "string", "examples": [ "projectCreate", "identityGroupCreate", "accountUserRead" ] } } } }, "role-create-request": { "title": "Role Create Request", "type": "object", "description": "Role create request.", "required": [ "name", "permissions" ], "allOf": [ { "$ref": "#/components/schemas/role-update-request" } ] }, "permission": { "title": "Permission", "type": "object", "description": "A single permission which governs access to resources.", "required": [ "name", "description", "category", "entityType", "dependsOn" ], "properties": { "name": { "type": "string", "description": "Name of the permission.", "examples": [ "projectCreate", "identityGroupCreate", "accountUserRead" ] }, "description": { "type": "string", "description": "Human-readable description of the permission." }, "category": { "type": "string", "description": "The category a permission belongs to.", "examples": [ "Projects", "User Management", "Resources" ] }, "entityType": { "$ref": "#/components/schemas/permission-entity-type" }, "dependsOn": { "type": "array", "description": "List of permission names that this permission depends on. Empty array if no dependencies.", "examples": [ [ "projectRead" ], [ "identityGroupRead" ], [] ], "items": { "type": "string", "description": "Name of a dependent permission.", "examples": [ "projectRead", "identityGroupRead", "accountUserRead" ] } } } }, "permission-entity-type": { "title": "Entity Type", "type": "object", "description": "The entity type a permission applies to.", "required": [ "name", "description" ], "properties": { "name": { "type": "string", "description": "Name of the entity type.", "examples": [ "Projects", "Groups", "Users" ] }, "description": { "type": "string", "description": "Human-readable description of the entity type." } } }, "schedule-template": { "title": "Schedule Template", "type": "object", "description": "Schedule Template resource", "properties": { "id": { "type": "string" }, "name": { "type": "string", "description": "
default
Schedule Template name.
", "x-default-field": true }, "description": { "type": "string", "description": "Schedule Template description." }, "location": { "$ref": "#/components/schemas/folder-v2" }, "configurations": { "type": "array", "items": { "$ref": "#/components/schemas/schedule-template-configuration" } }, "projectScheduleConfiguration": { "$ref": "#/components/schemas/schedule-template-project-configuration" } }, "required": [ "id" ] }, "schedule-template-configuration": { "title": "Schedule Template Configuration", "type": "object", "description": "Schedule Template Configuration resource", "properties": { "taskTypeId": { "type": "string", "description": "The identifier of the human task type. " }, "taskTypeName": { "type": "string", "description": "The name of the task type." }, "schedules": { "type": "array", "items": { "$ref": "#/components/schemas/schedule-template-configuration-schedules" } } }, "required": [ "taskTypeId" ] }, "schedule-template-project-configuration": { "title": "Schedule Template Project Configuration", "type": "object", "description": "Schedule Template Project Configuration resource", "properties": { "duration": { "type": "integer", "description": "
default
Expressed in minutes.
", "default": 0, "minimum": 0 }, "reminder": { "description": "
default
Expressed in minutes.
", "enum": [ 15, 30, 60, 120, 480, 1440, 2880 ] } } }, "schedule-template-configuration-request": { "title": "Schedule Template Configuration Request", "type": "object", "description": "Schedule Template Configuration resource", "properties": { "taskTypeId": { "type": "string", "description": "The identifier of the human task type. " }, "schedules": { "type": "array", "items": { "$ref": "#/components/schemas/schedule-template-configuration-schedules" } } }, "required": [ "taskTypeId" ] }, "schedule-template-configuration-schedules": { "title": "Schedule Template Configuration Schedules", "type": "object", "description": "The Configuration Schedules resource.", "properties": { "scope": { "type": "string", "description": "The scope of this configuration schedule. \\\r\nglobal -> schedule of the task \\\r\nsourceLanguage -> schedule of the specific task when the sourceLanguage matches this object's sourceLanguage\\\r\nlanguageDirection -> schedule of the specific task when the languageDirection matches this object's languageDirection", "enum": [ "global", "sourceLanguage", "languageDirection" ] }, "duration": { "type": "integer", "description": "Expressed in minutes.", "minimum": 0 }, "reminder": { "description": "Expressed in minutes.\r\n\r\n", "enum": [ 15, 30, 60, 120, 480, 1440, 2880 ] }, "sourceLanguage": { "type": "string", "example": " \"en-US\", de-DE\"" }, "targetLanguage": { "type": "string", "example": " \"en-US\", de-DE\"" } }, "required": [ "scope" ] }, "schedule-template-update-request": { "title": "Schedule Template Update Request", "type": "object", "description": "Schedule Template update request model", "properties": { "name": { "type": "string", "description": "
Schedule Template name.
", "maxLength": 50 }, "description": { "type": "string", "description": "Schedule Template description.", "maxLength": 1000 }, "configurations": { "type": "array", "items": { "$ref": "#/components/schemas/schedule-template-configuration-request" } }, "projectScheduleConfiguration": { "$ref": "#/components/schemas/schedule-template-project-configuration" } } }, "schedule-template-create-request": { "title": "Schedule Template Create Request", "type": "object", "description": "Schedule Template create request model", "properties": { "name": { "type": "string", "description": "
Schedule Template name.
", "maxLength": 50 }, "description": { "type": "string", "description": "Schedule Template description.", "maxLength": 1000 }, "location": { "type": "string", "description": "The folder identifier where the schedule template should be created. " }, "configurations": { "type": "array", "items": { "$ref": "#/components/schemas/schedule-template-configuration-request" } }, "projectScheduleConfiguration": { "$ref": "#/components/schemas/schedule-template-project-configuration" } }, "required": [ "name" ] }, "simple-language-direction": { "title": "Simple Language Direction", "type": "object", "description": "A basic language direction.", "properties": { "id": { "type": "string", "description": "The language direction identifier." }, "sourceLanguage": { "$ref": "#/components/schemas/language", "description": "
default
The language object.
", "x-default-field": true }, "targetLanguage": { "$ref": "#/components/schemas/language", "description": "
default
The language object.
", "x-default-field": true } } }, "source-file": { "title": "Source File", "type": "object", "description": "Source File.", "required": [ "id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string", "description": "
default
The file name.
", "x-default-field": true }, "role": { "$ref": "#/components/schemas/file-role", "description": "
default
The file role.
", "x-default-field": true }, "language": { "$ref": "#/components/schemas/language" }, "versions": { "type": "array", "description": "The source file versions. (Not available for List endpoints).", "items": { "$ref": "#/components/schemas/source-file-version" } }, "targetLanguages": { "type": "array", "items": { "$ref": "#/components/schemas/language" } }, "path": { "type": "array", "items": { "type": "string" } }, "totalWords": { "type": "integer", "description": "Word count in the source file. \r\n
\r\nAvailable only for translatable source files, and only after the workflow task with Task Type `convert` (File Format Conversion) was executed on the source file.\r\n
\r\nAvailable only on the List Source Files endpoint." } } }, "source-file-request": { "type": "object", "title": "Source File Request", "description": "Source file properties sent as a JSON inside a text part.", "required": [ "name", "role", "type", "language" ], "properties": { "name": { "type": "string", "description": "The name of the source file. For example `Finance_2021_dummy_EN.txt`.\n\n\nThe character limit is calculated together with the `path` length.", "minLength": 1, "maxLength": 255 }, "role": { "type": "string", "enum": [ "translatable", "reference", "unknown" ], "description": "The role of the source file. When set to unknown or translatable, the system will try to detect the file type." }, "type": { "type": "string", "enum": [ "native", "bcm", "sdlxliff" ], "description": "The type of the file." }, "language": { "$ref": "#/components/schemas/language-request", "description": "The language of the file in code 5 (ex. en-US)" }, "targetLanguages": { "type": "array", "description": "A list of target languages in code 5 (ex. en-US)", "items": { "$ref": "#/components/schemas/language-request" } }, "path": { "type": "array", "description": "Path represents the hierarchy of the source file inside the project.\n\nFor example `/ZipWithFolders/Finance/2021/Finance_2021_dummy_EN.txt` would be sent as: \n\n```json \n\"path\": [ \n \"ZipWithFolders\", \n \"Finance\", \n \"2021\"\n]\n```\n\nThe character limit is calculated together with the `name` length.", "items": { "type": "string", "minLength": 0, "maxLength": 200 } } } }, "source-file-rename-request": { "title": "Source File Rename Request", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the source file.\\\nThe name should not contain the extension.\\\nUnsupported characters in the name: `<`, `>`, `:`, `\"`, `/`, `\\`, `|`, `?`, `*`.", "minLength": 1 }, "updateTargetFilesName": { "type": "boolean", "default": false, "description": "Option for renaming also the target files." } }, "required": [ "name" ] }, "source-files-update-request": { "title": "Source Files Update Request", "type": "object", "properties": { "files": { "type": "array", "items": { "$ref": "#/components/schemas/source-file-update-request" } } }, "required": [ "files" ] }, "source-file-update-request": { "title": "Source File Update Request", "type": "object", "properties": { "id": { "type": "string", "description": "The source file identifier.", "minLength": 1 }, "name": { "type": "string", "description": "The source file name.\\\nThe name should not contain the extension.\\\nUnsupported characters in the name: `<`, `>`, `:`, `\"`, `/`, `\\`, `|`, `?`, `*`.", "minLength": 1 }, "updateTargetFilesName": { "type": "boolean", "default": false, "description": "Option for renaming the target files too." } }, "required": [ "id", "name" ] }, "source-file-attachment-request": { "title": "Source File Attachment Request", "type": "object", "description": "", "properties": { "sourceFilesAttachment": { "type": "array", "description": "List of Attached Source File properties referencing previously uploaded file", "items": { "$ref": "#/components/schemas/source-file-attachment-request-item" } } } }, "source-file-attachment-response": { "title": "Source File Attachment Response", "type": "object", "description": "", "properties": { "sourceFiles": { "type": "array", "items": { "$ref": "#/components/schemas/source-file" } } } }, "source-file-attachment-request-item": { "title": "Source File Attachment Request Item", "type": "object", "description": "Attached Source File properties referencing previously uploaded file", "required": [ "name", "role", "fileUrl", "type", "language" ], "properties": { "name": { "type": "string", "description": "The name of the source file. For example `Finance_2021_dummy_EN.txt`. \n\nThe character limit is calculated together with the `path` length.", "maxLength": 200, "minLength": 1 }, "role": { "type": "string", "enum": [ "translatable", "reference", "unknown" ], "description": "The role of the source file. When set to unknown or translatable, the system will try to detect the file type." }, "fileUrl": { "type": "string", "description": "The identifier of the previously uploaded file." }, "type": { "type": "string", "enum": [ "native", "bcm", "sdlxliff" ], "description": "The type of the file." }, "language": { "$ref": "#/components/schemas/source-language-request" }, "targetLanguages": { "type": "array", "description": "A list of target languages in code 5 (ex. en-US)", "items": { "$ref": "#/components/schemas/target-language-request" } }, "path": { "type": "array", "description": "Path represents the hierarchy of the source file inside the project.\n\nFor example `/ZipWithFolders/Finance/2021/Finance_2021_dummy_EN.txt` would be sent as: \n\n```json \n\"path\": [ \n \"ZipWithFolders\", \n \"Finance\", \n \"2021\" \n]\n```\n\nThe character limit is calculated together with the `name` length.", "items": { "type": "string", "maxLength": 200, "minLength": 0 } } } }, "source-file-properties-response": { "title": "Source File Properties Response", "type": "object", "description": "", "properties": { "fileRole": { "type": "string", "description": "The file's role.", "enum": [ "translatable", "reference" ] }, "fileTypeSettingsId": { "type": "string", "description": "The file type settings identifier." } }, "required": [ "fileRole", "fileTypeSettingsId" ] }, "source-file-properties-update-request": { "title": "Source File Properties Update Request", "type": "object", "description": "", "properties": { "fileRole": { "type": "string", "description": "The file role.", "enum": [ "translatable", "reference" ] }, "fileTypeSettingsId": { "type": "string", "description": "The file type settings identifier." } } }, "source-file-version-properties-create-request": { "title": "Source File Version Properties Create Request", "type": "object", "description": "", "properties": { "type": { "type": "string", "description": "The version type.", "enum": [ "bcm", "native" ] }, "fileTypeSettingsId": { "type": "string", "description": "The file type settings identifier." } }, "required": [ "type" ] }, "source-file-version": { "title": "Source File Version", "type": "object", "description": "Source File Version.", "properties": { "id": { "type": "string", "description": "The source file version identifier." }, "type": { "type": "string", "enum": [ "native", "bcm" ], "description": "
default
The version type.
", "nullable": true, "x-default-field": true }, "name": { "type": "string", "description": "
default
The file version name. This is a synthetic value, typically constructed from the version number and the originating task name.
", "x-default-field": true }, "version": { "type": "integer", "description": "A numeric value, incremented for each new version." }, "originatingTaskId": { "type": "string", "description": "The identifier of the task that generated the file." } }, "required": [ "id", "version" ] }, "source-file-version-response": { "title": "Source File Version Response", "type": "object", "description": "", "properties": { "id": { "type": "string", "description": "The source file version identifier." }, "type": { "type": "string", "description": "
default
The version type.
", "enum": [ "native", "bcm" ], "x-default-field": true } }, "required": [ "id" ] }, "source-language-request": { "title": "Source Language Request", "type": "object", "properties": { "languageCode": { "type": "string", "description": "The language code." } }, "required": [ "languageCode" ] }, "target-file-version-properties-create-request": { "title": "Target File Version Properties Create Request", "type": "object", "description": "", "properties": { "type": { "type": "string", "description": "The version type.", "enum": [ "bcm", "native" ] } }, "required": [ "type" ] }, "target-file-version-response": { "title": "Target File Version Response", "type": "object", "description": "", "properties": { "id": { "type": "string", "description": "The target file version identifier." }, "type": { "type": "string", "description": "
default
The version type.
", "enum": [ "native", "bcm" ], "x-default-field": true } }, "required": [ "id" ] }, "task": { "title": "Task", "type": "object", "description": "Task.", "properties": { "id": { "type": "string" }, "status": { "type": "string", "description": "
default
The task status.
", "enum": [ "created", "inProgress", "completed", "failed", "skipped", "canceled" ], "x-default-field": true, "nullable": true }, "taskType": { "$ref": "#/components/schemas/task-type" }, "input": { "$ref": "#/components/schemas/task-input" }, "inputFiles": { "type": "array", "items": { "$ref": "#/components/schemas/task-input-file" } }, "owner": { "$ref": "#/components/schemas/task-owner" }, "assignees": { "type": "array", "items": { "$ref": "#/components/schemas/task-assignee" } }, "dueBy": { "type": "string", "format": "date-time", "example": "2022-01-12T12:00:00Z", "description": "The task due date.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the task was created.
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\" ", "nullable": true }, "applicableOutcomes": { "type": "array", "items": { "$ref": "#/components/schemas/task-outcome" } }, "outcome": { "type": "string", "description": "The outcome of the task type. It is retrieved only if the task is completed. It should match one of the legal outcomes in the task type." }, "comment": { "type": "string", "description": "The comment associated with this task at completion." }, "project": { "$ref": "#/components/schemas/project" }, "failedTask": { "$ref": "#/components/schemas/failed-task" }, "completedAt": { "$ref": "#/components/schemas/date-time", "description": "The completion timestamp of the task.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"" }, "configurationValues": { "type": "array", "description": "The task type configuration values set on this task. Each item corresponds to a configuration key defined in `taskType.configurationDefinitions`.", "items": { "$ref": "#/components/schemas/workflow-task-type-config-value" } } }, "required": [ "id" ] }, "task-error": { "title": "Task Error", "type": "object", "description": "Task Error.", "properties": { "name": { "type": "string", "description": "The task error name." }, "code": { "type": "string", "description": "The task error code." }, "value": { "type": "string", "description": "The task error value." } } }, "task-assignee": { "title": "Task Assignee", "type": "object", "description": "Task assignee. Based on the \"type\", the following properties can be retrieved: \"user\", \"group\" or \"vendorOrderTemplate\". For \"projectCreator\" and \"projectManager\" no other properties are available.", "properties": { "type": { "type": "string", "enum": [ "user", "group", "vendorOrderTemplate", "projectCreator" ], "description": "Type \"projectCreator\" - reserved for future use. Should be able to handle it and ignore it if received." }, "user": { "$ref": "#/components/schemas/user", "description": "
default
A user.
", "x-default-field": true }, "group": { "$ref": "#/components/schemas/group", "description": "
default
A group of users.
", "x-default-field": true }, "vendorOrderTemplate": { "$ref": "#/components/schemas/vendor-order-template" } }, "required": [ "type" ] }, "task-assignee-request": { "title": "Task Assignee Request", "type": "object", "properties": { "id": { "type": "string", "description": "The identifier of the assignee that should correspond to a resource based on the “type” field.
Only required for the `user`, `group`, and `vendorOrderTemplate` types." }, "type": { "type": "string", "enum": [ "user", "group", "vendorOrderTemplate", "projectManager", "projectCreator" ], "description": "The assignee type." } }, "required": [ "type" ] }, "task-assign-request": { "title": "Task Assign Request", "type": "object", "description": "Properties of task assignment.\r\n
Total assignee count is limited. See more at [Maximum number of task assignees](https://docs.rws.com/791595/1137562/trados-enterprise---accelerate/maximum-number-of-task-assignees).", "properties": { "assignees": { "type": "array", "items": { "$ref": "#/components/schemas/task-assignee-request" } } } }, "task-complete-request": { "title": "Task Complete Request", "type": "object", "description": "Properties of task completion.", "properties": { "outcome": { "type": "string", "description": "The outcome should be one of the valid applicable outcomes of the task. If not specified, the default one will be taken." }, "comment": { "type": "string", "description": "The comment associated with this task completion.", "maxLength": 1000 } }, "required": [ "outcome" ] }, "task-input": { "title": "Task Input", "type": "object", "description": "Task input. Based on the \"type\", the following fields can be retrieved: \"project\", \"sourceFile\", \"targetFile\".", "properties": { "type": { "type": "string", "description": "The input type.", "enum": [ "project", "sourceFile", "targetFile", "languageDirection" ] }, "project": { "$ref": "#/components/schemas/project", "description": "
default
Project resource
", "x-default-field": true }, "sourceFile": { "$ref": "#/components/schemas/source-file", "description": "
default
Source file.
", "x-default-field": true }, "targetFile": { "$ref": "#/components/schemas/target-file", "description": "
default
Target file.
", "x-default-field": true }, "languageDirection": { "$ref": "#/components/schemas/language-direction", "description": "
default
A language direction.
", "x-default-field": true }, "vendorOrder": { "$ref": "#/components/schemas/vendor-order", "description": "
default
A vendor order resource.
", "x-default-field": true } }, "required": [ "type" ] }, "task-input-file": { "title": "Task Input File", "type": "object", "description": "Task input file. Based on the \"type\", only the \"sourceFile\" or \"targetFile\" can be retrieved.", "properties": { "type": { "type": "string", "enum": [ "sourceFile", "targetFile" ], "nullable": true, "description": "
default
", "x-default-field": true }, "sourceFile": { "$ref": "#/components/schemas/source-file", "description": "
default
Source file.
", "x-default-field": true }, "targetFile": { "$ref": "#/components/schemas/target-file", "description": "
default
Target file.
", "x-default-field": true } } }, "task-type": { "title": "Task Type", "type": "object", "description": "Task type.", "properties": { "id": { "type": "string" }, "key": { "type": "string", "description": "
default
Identifier key for the task.
", "x-default-field": true }, "name": { "type": "string", "description": "
default
", "x-default-field": true }, "apiInternalId": { "type": "string", "description": "
default
Unique identifier of custom task types set in the workflow. If no custom id is set, it will return the default identifier for the custom task type." }, "description": { "type": "string" }, "automatic": { "type": "boolean", "description": "This indicates whether the task is automatic or human.", "nullable": true }, "scope": { "type": "string", "description": "The resource type scope for the task.", "enum": [ "file", "targetLanguage", "batch", "vendorOrder", "task" ], "nullable": true }, "outcomes": { "type": "array", "items": { "$ref": "#/components/schemas/task-type-outcome" } }, "configurationDefinitions": { "type": "array", "description": "Defines the configurable options available for this task type. Each entry describes one configuration option including its data type, default value, allowed values and constraints.", "items": { "$ref": "#/components/schemas/task-type-configuration-definition" } }, "location": { "$ref": "#/components/schemas/folder-v2" } }, "required": [ "id" ] }, "task-type-configuration-definition": { "title": "Task Type Configuration Definition", "type": "object", "description": "Describes a single configurable option for a task type.", "properties": { "id": { "type": "string", "description": "The identifier for the configuration option (e.g. `FORCE_CLOSE_MAX_AGE`)." }, "name": { "type": "string", "description": "Human-readable name for the configuration option." }, "description": { "type": "string", "description": "Explanation of what this configuration option controls." }, "dataType": { "type": "string", "description": "The data type of the configuration value.", "enum": [ "integer", "boolean", "string" ] }, "optional": { "type": "boolean", "description": "Whether this configuration option is optional. If `false`, a value must always be supplied." }, "defaultValue": { "description": "The default value applied when no value is explicitly set. The type matches `dataType`. May be `null` when no default is defined.", "nullable": true, "type": "object" }, "options": { "type": "array", "nullable": true, "description": "Enumerated list of accepted string values. Present only when `dataType` is `string` and the value is restricted to a fixed set. `null` when any value is allowed.", "items": { "type": "string" } }, "constraints": { "type": "array", "description": "Validation constraints applied to the value (e.g. minimum/maximum for numeric types).", "items": { "$ref": "#/components/schemas/task-type-configuration-constraint" } } }, "required": [ "id", "name", "dataType", "optional" ] }, "task-type-configuration-constraint": { "title": "Task Type Configuration Constraint", "type": "object", "description": "A validation constraint applied to a task type configuration value.", "properties": { "type": { "type": "string", "description": "The kind of constraint.", "enum": [ "minValue", "maxValue" ] }, "value": { "description": "The constraint threshold. Type matches the parent configuration option's `dataType`.", "type": "object" } }, "required": [ "type", "value" ] }, "task-outcome": { "title": "Task Outcome", "type": "object", "description": "Outcome a task can be completed with. List will be populated after the task is accepted.", "properties": { "name": { "type": "string", "description": "
default
Outcome to be used with complete endpoint.", "x-default-field": true }, "description": { "type": "string", "description": "A human-friendly form of the outcome." }, "default": { "type": "boolean", "description": "
default
Specifies if the outcome is the default one for the task.", "x-default-field": true } } }, "task-owner": { "title": "Task Owner", "type": "object", "description": "Task owner. Based on the \"type\", the following properties can be retrieved: \"user\" or \"group\".", "properties": { "type": { "type": "string", "enum": [ "user", "group" ], "description": "The owner type." }, "user": { "$ref": "#/components/schemas/user", "description": "
default
The user who owns this task.
" }, "group": { "$ref": "#/components/schemas/group", "description": "
default
The group that owns this task.
" }, "id": { "type": "string", "description": "User account identifier.", "deprecated": true }, "description": { "type": "string", "description": "Description of this account user. For Service account users only.", "deprecated": true }, "email": { "type": "string", "description": "
default
The user's email address. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
", "deprecated": true }, "name": { "type": "string", "description": "
default
The user's name. Retrieved only for Service users (not RWS ID users) that the authenticated entity is authorized to read.
", "deprecated": true }, "firstName": { "type": "string", "description": "
default
The user's first name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
", "deprecated": true }, "lastName": { "type": "string", "description": "
default
The user's last name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
", "deprecated": true }, "anonymized": { "type": "boolean", "description": "
default
This shows if the authenticated entity has access to read the details of the user or not. If true, then the 'anonymizedUserName' should be retrieved.
", "deprecated": true }, "anonymizedUserName": { "type": "string", "description": "
default
Retrieved if the authenticated entity does not have access to read the User.
", "deprecated": true }, "account": { "allOf": [{ "$ref": "#/components/schemas/account" }], "description": "The account the user is part of.", "deprecated": true }, "location": { "allOf": [{ "$ref": "#/components/schemas/folder-v2" }], "deprecated": true }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/group" }, "deprecated": true }, "userType": { "allOf": [{ "$ref": "#/components/schemas/user-type" }], "deprecated": true }, "status": { "allOf": [{ "$ref": "#/components/schemas/user-status" }], "deprecated": true }, "invitationLink": { "type": "string", "description": "The user's invitation link. Retrieved only for RWS ID (formerly SDL ID) users—not service users. It is available only if the user has not yet accepted the invitation (status is `inactive`).", "deprecated": true }, "membership": { "allOf": [{ "$ref": "#/components/schemas/account-membership-type" }], "deprecated": true } }, "required": [ "type" ] }, "task-type-outcome": { "title": "Task Type Outcome", "type": "object", "description": "The task type outcome.", "properties": { "name": { "type": "string", "description": "
default
", "x-default-field": true }, "description": { "type": "string" }, "default": { "type": "boolean", "nullable": true, "description": "
default
", "x-default-field": true } } }, "task-configuration-scope": { "title": "Workflow Task Configuration Scope", "type": "object", "properties": { "type": { "type": "string", "description": "The applicability impact of the workflow configuration:\n- global: used for global tasks which are not associated to a target language\n- sourceLanguage: changes affect only the task associated to the source language specified in **sourceLanguage** field\n- targetLanguage: changes affect only the task associated to the target language specified in **targetLanguage** field\n- languageDirection: changes affect only the task associated to the language direction specified in **languageDirection** field", "enum": [ "global", "sourceLanguage", "targetLanguage", "languageDirection" ] }, "sourceLanguage": { "$ref": "#/components/schemas/language" }, "targetLanguage": { "$ref": "#/components/schemas/language" }, "languageDirection": { "$ref": "#/components/schemas/language-direction-item" } }, "required": [ "type" ] }, "task-configuration-scope-request": { "title": "Workflow Task Configuration Scope Request", "type": "object", "description": "", "properties": { "type": { "type": "string", "description": "The applicability impact of the workflow configuration:\n- global: used for global tasks, that are not associated to a target language \n- sourceLanguage: changes affect only the task associated to the source language specified in `sourceLanguage` field. For using this type, must include the `sourceLanguage` field.\n- targetLanguage: changes affect only the task associated to the target language specified in `targetLanguage` field. For using this type, must include the `targetLanguage` field.\n- languageDirection: changes affect only the task associated to the language direction specified in `languageDirection` field. For using this type, must include the `languageDirection` field.", "enum": [ "global", "sourceLanguage", "targetLanguage", "languageDirection" ] }, "sourceLanguage": { "$ref": "#/components/schemas/source-language-request" }, "targetLanguage": { "$ref": "#/components/schemas/target-language-request" }, "languageDirection": { "$ref": "#/components/schemas/language-direction-item" } }, "required": [ "type" ] }, "target-file": { "title": "Target File", "type": "object", "description": "Target File.", "properties": { "id": { "type": "string" }, "name": { "type": "string", "description": "
default
The target file name.
", "x-default-field": true }, "languageDirection": { "$ref": "#/components/schemas/language-direction", "description": "
default
A basic language direction.
", "x-default-field": true }, "sourceFile": { "$ref": "#/components/schemas/source-file" }, "latestVersion": { "$ref": "#/components/schemas/target-file-latest-version" }, "analysisStatistics": { "$ref": "#/components/schemas/analysis-statistics" }, "status": { "type": "string", "description": "Shows if the file is still being processed (inProgress) or if it has been fully processed (finished) by the workflow. A target file is automatically marked as finished by the workflow engine, once there are no more tasks to be performed on it.", "enum": [ "inProgress", "finished", "canceled" ], "nullable": true } }, "required": [ "id" ] }, "target-file-rename-request": { "title": "Target File Rename Request", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the target file.\\\nThe name should not contain the extension.\\\nUnsupported characters in the name: `<`, `>`, `:`, `\"`, `/`, `\\`, `|`, `?`, `*`.", "minLength": 1 } }, "required": [ "name" ] }, "target-files-update-request": { "title": "Target Files Update Request", "type": "object", "properties": { "files": { "type": "array", "items": { "$ref": "#/components/schemas/target-file-update-request" } } }, "required": [ "files" ] }, "target-file-update-request": { "title": "Target File Update Request", "type": "object", "properties": { "id": { "type": "string", "description": "The target file identifier.", "minLength": 1 }, "name": { "type": "string", "description": "The target file name.\\\nThe name should not contain the extension.\\\nUnsupported characters in the name: `<`, `>`, `:`, `\"`, `/`, `\\`, `|`, `?`, `*`.", "minLength": 1 } }, "required": [ "id", "name" ] }, "target-file-version": { "title": "Target File Version", "type": "object", "description": "Target File Version.", "properties": { "id": { "type": "string", "description": "The target file version identifier." }, "type": { "type": "string", "enum": [ "native", "bcm" ], "description": "
default
The version type.
", "nullable": true, "x-default-field": true }, "name": { "type": "string", "description": "
default
The file version name. This is a synthetic value, typically constructed from the version number and the originating task name.
", "x-default-field": true }, "version": { "type": "integer", "description": "A numeric value, incremented for each new version." }, "originatingTaskId": { "type": "string", "description": "The identifier of the task that generated the file." } }, "required": [ "id", "version" ] }, "target-file-latest-version": { "title": "Target File Latest Version", "type": "object", "description": "Target File Latest Version.", "properties": { "id": { "type": "string", "description": "The target file version identifier." }, "type": { "type": "string", "enum": [ "native", "bcm" ], "description": "
default
The version type.
", "nullable": true, "x-default-field": true }, "version": { "type": "integer", "description": "A numeric value, incremented for each new version." } }, "required": [ "id", "version" ] }, "target-language-request": { "title": "Target Language Request", "type": "object", "properties": { "languageCode": { "type": "string", "description": "The language code." } }, "required": [ "languageCode" ], "description": "" }, "termbase-template": { "title": "Termbase Template", "type": "object", "description": "The termbase template.", "properties": { "id": { "type": "string", "description": "The identifier of the termbase template." }, "name": { "type": "string", "description": "
default
The name of the termbase template.
", "x-default-field": true }, "description": { "type": "string", "description": "The description of the termbase template.", "nullable": true }, "copyright": { "type": "string", "description": "The copyright of the termbase template.", "nullable": true }, "location": { "$ref": "#/components/schemas/folder-v2", "description": "
default
The resource folder.
", "x-default-field": true }, "createdAt": { "type": "string", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the termbase template was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", "format": "date-time" }, "lastModifiedAt": { "type": "string", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the termbase template was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", "format": "date-time" }, "type": { "type": "string", "description": "The type of the termbase template.", "enum": [ "system", "userDefined" ] }, "languages": { "type": "array", "description": "The languages of the termbase template.", "items": { "$ref": "#/components/schemas/language" } }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-field" } } }, "required": [ "id", "type" ] }, "termbase-template-update-request": { "title": "Termbase Template Update Request", "type": "object", "description": "The termbase template update request.", "properties": { "name": { "type": "string", "description": "The name of the Termbase template.", "maxLength": 50, "minLength": 1 }, "description": { "type": "string", "description": "The description of the Termbase template.", "minLength": 0, "maxLength": 200, "nullable": true }, "copyright": { "type": "string", "description": "The copyright of the Termbase template.", "minLength": 0, "maxLength": 50, "nullable": true }, "languages": { "type": "array", "description": "The languages of the termbase template.", "items": { "$ref": "#/components/schemas/language-request" } }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-field-update-request" } } } }, "termbase-template-create-request": { "title": "Termbase Template Create Request", "type": "object", "description": "The termbase template create request.", "properties": { "name": { "type": "string", "description": "The name of the termbase template.", "minLength": 0, "maxLength": 50 }, "description": { "type": "string", "description": "The description of the termbase template.", "minLength": 0, "maxLength": 200, "nullable": true }, "copyright": { "type": "string", "description": "The copyright of the termbase template.", "minLength": 0, "maxLength": 50, "nullable": true }, "location": { "type": "string", "description": "The folder identifier where the termbase template should be created. If not mentioned, it will be created in the Root folder. If the user does not have access in Root, the request will fail with forbidden error." }, "languages": { "type": "array", "description": "The languages of the termbase template.", "items": { "$ref": "#/components/schemas/language-request" } }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-field-create-request" } } }, "required": [ "name" ] }, "termbase-structure": { "title": "Termbase Structure", "type": "object", "description": "The termbase structure.", "properties": { "languages": { "type": "array", "description": "
default
The languages of the termbase.
", "items": { "$ref": "#/components/schemas/language" }, "x-default-field": true }, "fields": { "type": "array", "description": "
default
The termbase fields. (Not available for List Termbases endpoint).
", "items": { "$ref": "#/components/schemas/termbase-field" }, "x-default-field": true } } }, "termbase-structure-create-request": { "title": "Termbase Structure Create Request", "type": "object", "description": "The termbase structure create request.", "properties": { "languages": { "type": "array", "description": "The languages of the termbase. If not supplied, the termbase will be created using the languages from the specified template. Otherwise it will override the languages from the template.", "items": { "$ref": "#/components/schemas/language-request" } }, "fields": { "type": "array", "description": "Describes the field structure. If not supplied, the termbase will be created using the fields from the specified template. Otherwise it will override the fields from the template.", "items": { "$ref": "#/components/schemas/termbase-field-create-request" } } } }, "termbase-structure-update-request": { "title": "Termbase Structure Update Request", "type": "object", "description": "The termbase structure update request.", "properties": { "languages": { "type": "array", "description": "The languages of the termbase. If not supplied, the termbase will be updated using the languages from the specified template. Otherwise it will override the languages from the template.", "items": { "$ref": "#/components/schemas/language-request" } }, "fields": { "type": "array", "description": "Describes the field structure. If not supplied, the termbase will be updated using the fields from the specified template. Otherwise it will override the fields from the template.", "items": { "$ref": "#/components/schemas/termbase-field-update-request" } } } }, "termbase-field": { "title": "Termbase Field", "type": "object", "description": "The termbase field.", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The identifier of the termbase field." }, "name": { "type": "string", "description": "
default
The name of the termbase field.
", "x-default-field": true }, "description": { "type": "string", "description": "The description of the termbase field", "nullable": true }, "type": { "type": "string", "description": "The type of the termbase field - system or userDefined.", "enum": [ "system", "userDefined" ] }, "level": { "type": "string", "enum": [ "entry", "language", "term" ], "description": "
default
The level of which this field applies.
", "x-default-field": true }, "dataType": { "type": "string", "enum": [ "text", "double", "date", "picklist", "boolean" ], "description": "
default
The data type of the field.
", "x-default-field": true }, "pickListValues": { "type": "array", "uniqueItems": false, "description": "The pick list options. Only if dataType is \"picklist\".", "items": { "type": "string" } }, "allowCustomValues": { "type": "boolean", "description": "Specifies if the field allows custom values." }, "allowMultiple": { "type": "boolean", "description": "Specifies if the field can be used multiple times." }, "isMandatory": { "type": "boolean", "description": "Specifies if the field is mandatory." } } }, "termbase-field-update-request": { "title": "Termbase Field Update Request", "type": "object", "description": "The termbase field update request.\n\nIf dataType is `picklist` and pickListValues array is empty `allowCustomValues` must be true.", "properties": { "id": { "type": "string", "description": "The identifier of the termbase field to updated. If missing will add a new field." }, "name": { "type": "string", "description": "The name of the termbase field. Must be unique.", "minLength": 1, "maxLength": 50 }, "description": { "type": "string", "description": "The description of the termbase field.", "minLength": 1, "maxLength": 200, "nullable": true }, "level": { "type": "string", "enum": [ "entry", "language", "term" ], "description": "The level of which this field applies." }, "dataType": { "type": "string", "enum": [ "text", "double", "date", "picklist", "boolean" ], "description": "The data type of the field." }, "pickListValues": { "type": "array", "uniqueItems": true, "description": "The pick list options. Only if dataType is \"picklist\".", "items": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "allowCustomValues": { "type": "boolean", "description": "Specifies if the field allows custom values. Must be true if pickListValues is empty.", "default": false }, "allowMultiple": { "type": "boolean", "description": "Specifies if the field can be used multiple times.", "default": true }, "isMandatory": { "type": "boolean", "description": "Specifies if the field is mandatory.", "default": false } }, "required": [ "name", "level", "dataType" ] }, "termbase-field-create-request": { "title": "Termbase Field Create Request", "type": "object", "description": "The termbase field request.\n\nIf dataType is `picklist` and pickListValues array is empty `allowCustomValues` must be true.", "properties": { "name": { "type": "string", "description": "The name of the termbase field. Must be unique.", "minLength": 1, "maxLength": 50 }, "description": { "type": "string", "description": "The description of the termbase field.", "minLength": 1, "maxLength": 200, "nullable": true }, "level": { "type": "string", "enum": [ "entry", "language", "term" ], "description": "The level of which this field applies." }, "dataType": { "type": "string", "enum": [ "text", "double", "date", "picklist", "boolean" ], "description": "The data type of the field." }, "pickListValues": { "type": "array", "uniqueItems": true, "description": "The pick list values. Only if dataType is \"picklist\". Values must be unique.", "items": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "allowCustomValues": { "type": "boolean", "description": "Specifies if the field allows custom values. Must be true if pickListValues is empty.", "default": false }, "allowMultiple": { "type": "boolean", "description": "Specifies if the field can be used multiple times.", "default": true }, "isMandatory": { "type": "boolean", "description": "Specifies if the field is mandatory.", "default": false } }, "required": [ "name", "level", "dataType" ] }, "termbase": { "title": "Termbase", "type": "object", "description": "The termbase.", "properties": { "id": { "type": "string", "description": "The identifier of the termbase." }, "name": { "type": "string", "description": "
default
The name of the termbase.
", "x-default-field": true }, "description": { "type": "string", "description": "The description of the termbase.", "nullable": true }, "copyright": { "type": "string", "description": "The copyright of the termbase.", "nullable": true }, "location": { "$ref": "#/components/schemas/folder-v2", "description": "
default
The resource folder.
", "x-default-field": true }, "termbaseStructure": { "$ref": "#/components/schemas/termbase-structure" }, "numberOfEntries": { "type": "number", "description": "The number of entries included in the termbase. (Not available for List Termbases endpoint)" }, "status": { "type": "string", "enum": [ "ready", "processingContent", "exportingContent", "deletingContent" ], "description": "The status of the termbase. (Not available for List Termbases endpoint)" }, "createdAt": { "type": "string", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the termbase was created. (Not available for List Termbases endpoint)
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", "format": "date-time" }, "lastModifiedAt": { "type": "string", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the termbase was last updated. (Not available for List Termbases endpoint)
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", "format": "date-time" } }, "required": [ "id" ] }, "termbase-create-request": { "title": "Termbase Create Request", "type": "object", "description": "Termbase create request.", "properties": { "name": { "type": "string", "description": "The name of the termbase.", "minLength": 1, "maxLength": 50 }, "description": { "type": "string", "description": "The description of the termbase.", "minLength": 0, "maxLength": 200, "nullable": true }, "copyright": { "type": "string", "description": "The copyright of the termbase.", "minLength": 0, "maxLength": 50, "nullable": true }, "location": { "type": "string", "description": "The folder identifier where the termbase should be created. If not specified, it will be created in the Root folder. If the user does not have access in Root, the request will fail with forbidden error." }, "termbaseTemplateId": { "type": "string", "description": "The termbase template identifier." }, "termbaseStructure": { "$ref": "#/components/schemas/termbase-structure-create-request" } }, "required": [ "name" ] }, "termbase-update-request": { "title": "Termbase Update Request", "type": "object", "description": "Termbase update request.", "properties": { "name": { "type": "string", "description": "The name of the termbase.", "minLength": 1, "maxLength": 50 }, "description": { "type": "string", "description": "The description of the termbase.", "minLength": 0, "maxLength": 200, "nullable": true }, "copyright": { "type": "string", "description": "The copyright of the termbase.", "minLength": 0, "maxLength": 50, "nullable": true }, "termbaseTemplateId": { "type": "string", "description": "The termbase template identifier." }, "termbaseStructure": { "$ref": "#/components/schemas/termbase-structure-update-request" } } }, "termbase-field-value-link": { "title": "Termbase Field Value Link", "type": "object", "description": "The field value link.", "properties": { "type": { "type": "string", "enum": [ "term", "entry", "external" ], "description": "The type of the link." }, "value": { "type": "string", "description": "The value of the link." } }, "required": [ "type", "value" ] }, "termbase-field-value-link-update-request": { "title": "Termbase Field Value Link Update Request", "type": "object", "description": "The field value link update request.", "properties": { "type": { "type": "string", "enum": [ "term", "entry", "external" ], "description": "The type of the link." }, "value": { "type": "string", "description": "The value of the link." } } }, "termbase-field-value-link-create-request": { "title": "Termbase Field Value Link Create Request", "type": "object", "description": "The field value link create request.", "properties": { "type": { "type": "string", "enum": [ "term", "entry", "external" ], "description": "The type of link." }, "value": { "type": "string", "description": "The value of the link.", "minLength": 1 } }, "required": [ "type", "value" ] }, "termbase-field-value": { "title": "Termbase Field Value", "type": "object", "description": "The termbase field value.", "properties": { "id": { "type": "string", "description": "The field value identifier." }, "name": { "type": "string", "description": "The field value name." }, "termbaseFieldId": { "type": "string", "description": "The termbase field identifier." }, "value": { "type": "string", "description": "The value of the field." }, "fieldValueLinks": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-field-value-link" } }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the termbase field value was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", "nullable": true }, "createdBy": { "$ref": "#/components/schemas/user" }, "lastModifiedAt": { "type": "string", "format": "date-time", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the termbase field value was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", "nullable": true }, "lastModifiedBy": { "$ref": "#/components/schemas/user" } }, "required": [ "id", "name", "termbaseFieldId", "value" ] }, "termbase-field-value-update-request": { "title": "Termbase Field Value Update request", "type": "object", "description": "The termbase field value update request.", "properties": { "id": { "type": "string", "description": "The field value identifier. Either the `id` or the `name` is mandatory to be provided." }, "name": { "type": "string", "description": "The field value name. Either the `id` or the `name` is mandatory to be provided." }, "termbaseFieldId": { "type": "string", "description": "The termbase field value identifier. Must match with the fieldId from the termbase." }, "value": { "type": "string", "description": "The value of the field.", "minLength": 1, "maxLength": 4096 }, "fieldValueLinks": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-field-value-link-update-request" } } }, "required": [ "termbaseFieldId", "value" ] }, "termbase-field-value-create-request": { "title": "Termbase Field Value Create Request", "type": "object", "description": "The termbase field value create request.", "properties": { "termbaseFieldId": { "type": "string", "description": "The termbase field identifier. It must match the `fieldId` from the termbase." }, "value": { "type": "string", "description": "The value of the field.", "minLength": 1, "maxLength": 4096 }, "fieldValueLinks": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-field-value-link-create-request" } } }, "required": [ "termbaseFieldId", "value" ] }, "termbase-entry-term": { "title": "Termbase Entry Term", "type": "object", "description": "The termbase entry term.", "required": [ "id", "text" ], "properties": { "id": { "type": "string", "description": "The term identifier." }, "text": { "type": "string", "description": "The term text." }, "termbaseFieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-field-value" } }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the term entry was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", "nullable": true }, "createdBy": { "$ref": "#/components/schemas/user" }, "lastModifiedAt": { "type": "string", "format": "date-time", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the term entry was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", "nullable": true }, "lastModifiedBy": { "$ref": "#/components/schemas/user" }, "systemStatus": { "$ref": "#/components/schemas/termbase-entry-term-system-status" } } }, "termbase-entry-term-update-request": { "title": "Termbase Entry Term Update Request", "type": "object", "description": "The termbase entry term update request.", "required": [ "text" ], "properties": { "id": { "type": "string", "description": "The term identifier that will be updated. If not supplied, a new term will be created." }, "text": { "type": "string", "description": "The term text.", "minLength": 1, "maxLength": 1024 }, "systemStatus": { "$ref": "#/components/schemas/termbase-entry-term-system-status-request" }, "termbaseFieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-field-value-update-request" } } } }, "termbase-term-create-request": { "title": "Termbase Entry Term Create Request", "type": "object", "description": "The termbase entry term request.", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "The term text.", "maxLength": 1024, "minLength": 1 }, "systemStatus": { "$ref": "#/components/schemas/termbase-entry-term-system-status-request" }, "termbaseFieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-field-value-create-request" } } } }, "termbase-entry-language": { "title": "Termbase Entry Language", "type": "object", "description": "The termbase entry language.", "properties": { "id": { "type": "string", "description": "The termbase language identifier." }, "language": { "$ref": "#/components/schemas/language" }, "terms": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-entry-term" } }, "termbaseFieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-field-value" } }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the language entry was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", "nullable": true }, "createdBy": { "$ref": "#/components/schemas/user" }, "lastModifiedAt": { "type": "string", "format": "date-time", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the language entry was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", "nullable": true }, "lastModifedBy": { "$ref": "#/components/schemas/user" } }, "required": [ "id", "language" ] }, "termbase-entry-language-update-request": { "title": "Termbase Entry Language Update Request", "type": "object", "description": "The termbase entry language update request.", "properties": { "id": { "type": "string", "description": "The termbase language identifier." }, "language": { "$ref": "#/components/schemas/language-request" }, "terms": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-entry-term-update-request" } }, "termbaseFieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-field-value-update-request" } } }, "required": [ "language", "terms" ] }, "termbase-entry-language-create-request": { "title": "Termbase Entry Language Create Request", "type": "object", "description": "The termbase entry language create request.", "properties": { "language": { "$ref": "#/components/schemas/language-request" }, "terms": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-term-create-request" } }, "termbaseFieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-field-value-create-request" } } }, "required": [ "language", "terms" ] }, "termbase-entry": { "title": "Termbase Entry", "type": "object", "description": "The termbase entry.", "properties": { "id": { "type": "string", "description": "The termbase entry identifier." }, "humanReadableId": { "type": "string", "description": "An identifier that can be provided externally, or generated automatically by the Trados Cloud Platform, used for creating cross-references. You can use it to set its value to be correlated to your system. The format of the generated value is not guaranteed." }, "languages": { "description": "The termbase entry languages.", "type": "array", "items": { "$ref": "#/components/schemas/termbase-entry-language" } }, "termbaseFieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-field-value" } }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the termbase entry was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", "nullable": true }, "createdBy": { "$ref": "#/components/schemas/user" }, "lastModifiedAt": { "type": "string", "format": "date-time", "example": "2022-01-12T12:00:00Z", "description": "The date and time when the termbase entry was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", "nullable": true }, "lastModifiedBy": { "$ref": "#/components/schemas/user" } }, "required": [ "id", "languages" ] }, "termbase-entry-update-request": { "title": "Termbase Entry Update Request", "type": "object", "description": "The termbase entry update request.", "properties": { "humanReadableId": { "type": "string", "description": "An identifier that can be provided externally, or generated automatically by the Trados Cloud Platform, used for creating cross-references. You can use it to set its value to be correlated to your system. The format of the generated value is not guaranteed." }, "languages": { "description": "The termbase entry languages.", "type": "array", "items": { "$ref": "#/components/schemas/termbase-entry-language-update-request" } }, "termbaseFieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-field-value-update-request" } } }, "required": [ "languages" ] }, "termbase-entry-create-request": { "title": "Termbase Entry Create Request", "type": "object", "description": "The termbase entry create request.", "properties": { "humanReadableId": { "type": "string", "description": "An identifier that can be provided externally, or generated automatically by the Trados Cloud Platform, used for creating cross-references. You can use it to set its value to be correlated to your system.\nThe format of the generated value is not guaranteed." }, "languages": { "description": "The termbase entry languages.", "type": "array", "items": { "$ref": "#/components/schemas/termbase-entry-language-create-request" } }, "termbaseFieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-field-value-create-request" } } }, "required": [ "languages" ] }, "termbase-entry-term-system-status": { "title": "Termbase Entry Term System Status", "type": "string", "nullable": true, "enum": [ "preferred", "draft", "inReview", "deprecated", "recommended", "admitted", "forbidden", "rejected", "superseded" ] }, "termbase-entry-term-system-status-request": { "title": "Termbase Entry Term System Status", "type": "string", "enum": [ "preferred", "draft", "inReview", "deprecated", "recommended", "admitted", "forbidden", "rejected", "superseded" ] }, "termbase-export-properties-request": { "title": "Termbase Export Properties Request", "type": "object", "properties": { "downloadCompressed": { "type": "boolean", "description": "Download compressed ( zipped ).", "default": false } } }, "termbase-export-response": { "title": "Termbase Export Response", "type": "object", "properties": { "id": { "type": "string", "description": "The termbase export identifier." }, "status": { "type": "string", "description": "The status of the export operation.
\n`queued` - The export passed the structural validation and it's waiting to be processed.
\n`processing` - The export is in progress.
\n`done` - The export was successfully processed .
\n`canceled` - The export process was interrupted.
\n`error` - The export was unsuccessful due to an internal error.", "enum": [ "queued", "processing", "done", "cancelled", "error" ] }, "errorMessage": { "type": "string", "description": "When status is 'error', contains the error message explaining what went wrong." }, "downloadUrl": { "type": "string", "description": "The url where the file can be downloaded." } }, "required": [ "id", "status" ] }, "termbase-term": { "title": "Termbase Term Response", "type": "object", "description": "The termbase term.", "properties": { "id": { "type": "string", "description": "The term identifier." }, "entryId": { "type": "string", "description": "The entry identifier." }, "text": { "type": "string", "description": "The term text." } }, "required": [ "id", "entryId", "text" ] }, "termbase-import-response": { "title": "Termbase Import Response", "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the import operation." }, "status": { "type": "string", "description": "The status of the import operation.
\n`queued` - The import passed the structural validation and it's waiting to be processed.
\n`processing` - The import is in progress.
\n`done` - The import was successfully processed and at least an entry changed its structure ( either inserted or modified )
\n`cancelled` - The import process was interrupted.
\n`failed` - The import was unsuccessful. Either one of the import files is not compliant with the TBX structure or no entry changed during the import process.
\n`error` - The import was unsuccessful due to an internal error.", "enum": [ "queued", "processing", "done", "cancelled", "failed", "error" ] } }, "required": [ "id", "status" ] }, "termbase-poll-import-response": { "title": "Termbase Poll Import Response", "type": "object", "description": "The termbase poll import response.
\nThe import was successfully processed when the status is `done`.", "properties": { "id": { "type": "string", "description": "The unique identifier of the import operation." }, "status": { "type": "string", "description": "The status of the import operation.
\n`queued` - The import passed the structural validation and it's waiting to be processed.
\n`processing` - The import is in progress.
\n`done` - The import was successfully processed and at least an entry changed its structure ( either inserted or modified )
\n`cancelled` - The import process was interrupted.
\n`failed` - The import was unsuccessful. Either one of the import files is not compliant with the TBX structure or no entry changed during the import process.
\n`error` - The import was unsuccessful due to an internal error.", "enum": [ "queued", "processing", "done", "cancelled", "failed", "error" ] } }, "required": [ "id", "status" ] }, "termbase-import-history-response": { "title": "Termbase Import History Response", "type": "object", "properties": { "id": { "type": "string", "description": "The termbase import identifier." }, "fileName": { "type": "string", "description": "
default
The file name of the imported file.
", "x-default-field": true }, "fileSize": { "type": "integer", "description": "The file size of the imported file.", "format": "int64" }, "status": { "type": "string", "description": "The status of the import operation.
\n`pending` - The import was just created and it's waiting for user input.
\n`queued` - The import passed the structural validation and it's waiting to be processed.
\n`processing` - The import is in progress.
\n`done` - The import was successfully processed and at least an entry changed its structure ( either inserted or modified )
\n`cancelled` - The import process was interrupted.
\n`failed` - The import was unsuccessful. Either one of the import files is not compliant with the TBX structure or no entry changed during the import process.
\n`error` - The import was unsuccessful due to an internal error.", "enum": [ "pending", "queued", "processing", "done", "cancelled", "failed", "error" ] }, "createdAt": { "$ref": "#/components/schemas/date-time" }, "elapsedTime": { "type": "integer", "description": "The last modified date of the import." } }, "required": [ "id", "status" ] }, "termbase-import-request": { "type": "object", "title": "Termbase Import Properties", "description": "Properties required for system status mapping", "properties": { "statusMapping": { "type": "array", "items": { "$ref": "#/components/schemas/termbase-system-status-mapping" } } } }, "termbase-system-status-mapping": { "title": "Termbase System Status Mapping", "type": "object", "description": "A mapping between a termbase term system status and termbase statuses.", "required": [ "systemStatusValue", "statuses" ], "properties": { "systemStatusValue": { "$ref": "#/components/schemas/termbase-entry-term-system-status-request" }, "statuses": { "type": "array", "minItems": 1, "items": { "type": "string" } } } }, "tqa-profile": { "title": "TQA Profile", "type": "object", "description": "As a project manager, you choose a TQA configuration and use it to automatically assess the quality of a translation document.\n\nThe TQA configuration specifies:\n - Categories and subcategories that reviewers will use to classify the translation issues in a document.\n - Severities to define custom metrics you want to use to assess translation quality.\n - Score to measure the importance of each category or subcategory of an issue.\n - Pass/Fail Threshold to define the maximum number of penalty points admitted before failing the translation document.", "properties": { "id": { "type": "string", "description": "The identifier of the TQA profile." }, "name": { "type": "string", "description": "
default
The name of the TQA Profile.
", "x-default-field": true }, "description": { "type": "string", "description": "
default
The TQA Profile description.
", "x-default-field": true }, "location": { "$ref": "#/components/schemas/folder-v2" }, "passFailThreshold": { "$ref": "#/components/schemas/tqa-profile-passFailThreshold", "description": "
default
Pass/Fail Threshold is used to define the maximum number of penalty points admitted before failing the translation document.
", "x-default-field": true }, "categories": { "type": "array", "description": "Categories and subcategories are assessment options that reviewers can use to classify any translation-related issue that they find in a file.", "items": { "$ref": "#/components/schemas/tqa-profile-category" } }, "severities": { "type": "array", "description": "Severities are custom metrics that reviewers can use to measure the importance of any translation-related issues that they find in a file.", "items": { "$ref": "#/components/schemas/tqa-profile-severity" } }, "scores": { "type": "array", "description": "The TQA scoring indicates whether translations pass or fail the acceptance threshold.", "items": { "$ref": "#/components/schemas/tqa-profile-score" } }, "path": { "type": "array", "deprecated": true, "items": { "$ref": "#/components/schemas/folder" } } }, "required": [ "id" ] }, "tqa-profile-category": { "title": "TQA Profile Category", "type": "object", "properties": { "id": { "type": "string", "description": "The category identifier." }, "name": { "type": "string", "description": "
default
The category name.
", "x-default-field": true }, "description": { "type": "string", "description": "The category description." }, "abbreviation": { "type": "string", "description": "The category abbreviation." } } }, "tqa-profile-severity": { "title": "TQA Profile Severity", "type": "object", "description": "Severities are custom metrics that reviewers can use to measure the importance of any translation-related issues that they find in a file.", "properties": { "id": { "type": "string", "description": "The severity identifier." }, "name": { "type": "string", "description": "
default
The severity name.
", "x-default-field": true }, "type": { "type": "string", "description": "The severity type." } } }, "tqa-profile-passFailThreshold": { "title": "TQA Profile PassFailThreshold", "type": "object", "description": "Pass/Fail Threshold is used to define the maximum number of penalty points admitted before failing the translation document.", "properties": { "points": { "type": "integer", "description": "
default
The penalty points.
", "x-default-field": true }, "quantity": { "type": "integer", "description": "
default
The quantity against which the points are measured.
", "x-default-field": true }, "scope": { "type": "string", "description": "
default
Words or characters.
", "x-default-field": true } } }, "tqa-profile-score": { "title": "TQA Profile Score", "type": "object", "description": "The TQA scoring indicates whether translations pass or fail the acceptance threshold.", "properties": { "category": { "$ref": "#/components/schemas/tqa-profile-category", "description": "
default
The TQA category.
", "x-default-field": true }, "severity": { "$ref": "#/components/schemas/tqa-profile-severity", "description": "
default
Severities are custom metrics that reviewers can use to measure the importance of any translation-related issues that they find in a file.
", "x-default-field": true }, "penalty": { "type": "integer", "description": "
default
The associated penalty for this score's category and severity.
", "x-default-field": true } } }, "translation-search-request": { "title": "Translation Search Request", "type": "object", "required": [ "input", "languageDirection", "definition" ], "properties": { "input": { "$ref": "#/components/schemas/translation-lookup-input-request" }, "languageDirection": { "$ref": "#/components/schemas/language-direction-general-request" }, "definition": { "$ref": "#/components/schemas/translation-definition" }, "settings": { "$ref": "#/components/schemas/translation-search-settings" } } }, "translation-search-response": { "title": "Translation Search Response", "type": "object", "required": [ "translations" ], "properties": { "translations": { "type": "array", "description": "Translations from different resource origins such as `TM`. The origin information is found in the BCM fragment.", "items": { "$ref": "#/components/schemas/translation" } }, "appliedResourcesStatus": { "type": "array", "items": { "$ref": "#/components/schemas/translation-applied-resource-status" } } } }, "translation-concordance-search-response": { "title": "Translation Concordance Search Response", "type": "object", "required": [ "translations" ], "properties": { "translations": { "type": "array", "description": "Translations from different resource origins such as `TM`. The origin information is found in the BCM fragment. Only the top 5 matches are displayed", "items": { "$ref": "#/components/schemas/translation-concordance" } }, "appliedResourcesStatus": { "type": "array", "items": { "$ref": "#/components/schemas/translation-concordance-search-applied-resource-status" } } } }, "translation-unit-add-update-response": { "title": "Translation Unit Response", "type": "object", "required": [ "success" ], "properties": { "success": { "type": "boolean", "description": "A flag indicating whether the overall operation was successful executed" }, "insights": { "type": "array", "description": "
default
The operation insights.
", "x-default-field": true, "items": { "$ref": "#/components/schemas/translation-unit-insight-model" } }, "errorInsights": { "type": "array", "description": "
default
The operation error insights.
", "x-default-field": true, "items": { "$ref": "#/components/schemas/translation-error-detail-response" } } } }, "translation-unit-insight-model": { "title": "Translation Unit Insight Model", "type": "object", "description": "Detailed insight information about the processed translation unit.", "required": [ "resourceId", "translationHash", "action" ], "properties": { "resourceId": { "type": "string", "description": "The translation memory identifier." }, "translationHash": { "type": "string", "description": "The translation unit hash code." }, "action": { "type": "string", "description": "The action performed", "enum": [ "discard", "add", "merge", "overwrite", "error", "delete" ] } } }, "translation-applied-resource-status": { "title": "Translation Applied Resource Status", "type": "object", "properties": { "resourceId": { "type": "string", "description": "
default
The resource identifier." }, "resourceType": { "$ref": "#/components/schemas/translation-resource-type", "description": "
default
The type of resource applied." }, "status": { "type": "string", "enum": [ "successful", "unsuccessful" ], "description": "
default
The status of the applied resource." }, "message": { "type": "string", "description": "A message describing the applied resource." }, "translationErrors": { "type": "array", "description": "Details of possible errors.", "items": { "$ref": "#/components/schemas/translation-error-detail-response" } } } }, "translation-concordance-search-applied-resource-status": { "title": "Translation Concordance Search Applied Resource Status", "type": "object", "properties": { "resourceId": { "type": "string", "description": "
default
The resource identifier." }, "resourceType": { "type": "string", "description": "
default
The type of resource applied.", "enum": [ "TM" ] }, "status": { "type": "string", "enum": [ "successful", "unsuccessful" ], "description": "
default
The status of the applied resource." }, "message": { "type": "string", "description": "A message describing the applied resource." }, "translationErrors": { "type": "array", "description": "Details of possible errors.", "items": { "$ref": "#/components/schemas/translation-error-detail-response" } } } }, "translation-definition": { "title": "Translation Definition", "type": "object", "required": [ "translationEngineId" ], "properties": { "translationEngineId": { "type": "string", "description": "The translation engine identifier." } } }, "translation-concordance-search-definition": { "title": "Translation Concordance Search Definition", "type": "object", "required": [ "translationEngineId" ], "properties": { "translationEngineId": { "type": "string", "description": "The translation engine identifier." } } }, "translation-resource-type": { "title": "Translation Resource Type", "type": "string", "description": "The translation resource type", "enum": [ "TM", "MT", "TB" ] }, "translation-concordance-resource-type": { "title": "Translation Resource Type", "type": "string", "description": "The translation resource type", "enum": [ "TM" ] }, "translation": { "title": "Translation", "type": "object", "required": [ "translationProposal", "resourceType" ], "properties": { "translationProposal": { "type": "string", "description": "The translation content serialized as JSON. BCM fragment for `TM` and `MT`. BCM term for `TB`." }, "resourceType": { "$ref": "#/components/schemas/translation-resource-type" }, "sourceLocation": { "$ref": "#/components/schemas/translation-source-locations", "description": "The source location is only available for `TB`." } } }, "translation-concordance": { "title": "Translation", "type": "object", "required": [ "translationProposal", "resourceType" ], "properties": { "translationProposal": { "type": "string", "description": "The translation content serialized as JSON. BCM fragment for `TM`." }, "resourceType": { "$ref": "#/components/schemas/translation-concordance-resource-type" } } }, "translation-source-locations": { "title": "sourceLocations", "type": "array", "items": { "$ref": "#/components/schemas/translation-source-location" } }, "translation-source-location": { "title": "sourceLocation", "type": "object", "properties": { "start": { "type": "integer" }, "length": { "type": "integer" } } }, "translation-concordance-search-request": { "title": "Translation Concordance Search Request", "type": "object", "required": [ "input", "languageDirection", "definition" ], "properties": { "input": { "$ref": "#/components/schemas/translation-concordance-input-request" }, "languageDirection": { "$ref": "#/components/schemas/language-direction-general-request" }, "definition": { "$ref": "#/components/schemas/translation-concordance-search-definition" }, "targetOnly": { "type": "boolean", "default": false, "description": "Indicates whether the search should be performed only in the target segments." }, "settings": { "$ref": "#/components/schemas/concordance-search-settings" } } }, "translation-add-request": { "title": "Translation Add Request", "type": "object", "required": [ "input", "definition" ], "properties": { "input": { "$ref": "#/components/schemas/translation-tu-update-input-request" }, "definition": { "$ref": "#/components/schemas/translation-update-definition" }, "settings": { "$ref": "#/components/schemas/translation-add-settings" } } }, "translation-update-request": { "title": "Translation Update Request", "type": "object", "required": [ "input", "definition" ], "properties": { "input": { "$ref": "#/components/schemas/translation-tu-update-input-request" }, "definition": { "$ref": "#/components/schemas/translation-update-definition" }, "settings": { "$ref": "#/components/schemas/translation-update-settings" } } }, "translation-add-settings": { "title": "Translation Add Settings", "type": "object", "properties": { "fields": { "type": "array", "description": "The Translation Unit fields to update. They are defined in the Field Template associated to your Translation Memory.", "items": { "$ref": "#/components/schemas/translation-update-field" } }, "ifTargetSegmentsDiffer": { "type": "string", "enum": [ "addNew", "overwrite", "leaveUnchanged", "keepMostRecent", "merge" ], "description": "Update behavior when the translation unit already exists but target differs." } } }, "translation-update-settings": { "title": "Translation Update Settings", "type": "object", "properties": { "fields": { "type": "array", "description": "The Translation Unit fields to update. They are defined in the Field Template associated to your Translation Memory.", "items": { "$ref": "#/components/schemas/translation-update-field" } } } }, "translation-cost-item": { "title": "Translation Cost Item", "type": "object", "properties": { "count": { "type": "number", "description": "
default
The total number of units.
", "nullable": true, "x-default-field": true }, "rate": { "type": "number", "description": "
default
The cost of a unit.
", "nullable": true, "x-default-field": true }, "total": { "type": "number", "description": "
default
The total cost for the current item.
", "nullable": true, "x-default-field": true }, "runningTotal": { "type": "number", "description": "
default
The sum of all the previously computed costs.
", "nullable": true, "x-default-field": true } } }, "translation-cost-fuzzy-item": { "title": "Translation Cost Fuzzy Item", "type": "object", "properties": { "count": { "type": "number", "description": "
default
The total number of units.
", "nullable": true, "x-default-field": true }, "rate": { "type": "number", "description": "
default
The cost of a unit.
", "nullable": true, "x-default-field": true }, "total": { "type": "number", "description": "
default
The total cost for the current item.
", "nullable": true, "x-default-field": true }, "runningTotal": { "type": "number", "description": "
default
The sum of all the previously computed costs.
", "nullable": true, "x-default-field": true }, "fuzzyCategory": { "$ref": "#/components/schemas/fuzzy-category", "description": "
default
Fuzzy category range.
", "x-default-field": true } } }, "translation-engine": { "title": "Translation Engine", "type": "object", "description": "Translation Engine resource. (Not available for List Projects endpoint)", "properties": { "id": { "type": "string", "description": "The translation engine identifier." }, "name": { "type": "string", "description": "
default
The translation engine name.
", "x-default-field": true }, "description": { "type": "string" }, "location": { "$ref": "#/components/schemas/folder-v2" }, "definition": { "$ref": "#/components/schemas/translation-engine-definition" } }, "required": [ "id" ] }, "translation-engine-update-request": { "title": "Translation Engine Update Request", "type": "object", "description": "Translation Engine resource update request", "properties": { "name": { "type": "string", "description": "
default
The translation engine name.
", "x-default-field": true, "minLength": 1, "maxLength": 50 }, "description": { "type": "string", "maxLength": 1000 }, "definition": { "$ref": "#/components/schemas/translation-engine-definition" } } }, "translation-engine-definition": { "title": "Translation Engine Definition", "type": "object", "description": "The definition of a translation engine.", "required": [ "languageProcessingRuleId" ], "properties": { "languageProcessingRuleId": { "type": "string" }, "languagePairDefinitions": { "type": [ "array" ], "items": { "$ref": "#/components/schemas/translation-engine-definition-language-pair" } }, "sequence": { "$ref": "#/components/schemas/remote-translation-engine-sequence" }, "adjacentLanguagePenalty": { "type": "integer", "minimum": 0, "maximum": 30, "default": 0 } } }, "remote-translation-engine-sequence": { "title": "Translation Engine Sequence", "description": "Lists of IDs for Translation Memories, Termbases, Machine Translations and Large Language Models, in order of their use", "properties": { "tm": { "type": "array", "description": "Translation Memories", "items": { "type": "string" } }, "tb": { "type": "array", "description": "Termbases", "items": { "type": "string" } }, "mt": { "type": "array", "description": "Machine Translations", "items": { "type": "string" } }, "llm": { "type": "array", "description": "Large Language Models", "items": { "type": "string" } } } }, "translation-engine-definition-language-pair": { "title": "Language Pair Definition", "type": "object", "properties": { "languagePair": { "$ref": "#/components/schemas/language-pair" }, "resources": { "type": "array", "items": { "$ref": "#/components/schemas/language-pair-resource" } }, "adjacentLanguagePairs": { "type": "array", "items": { "$ref": "#/components/schemas/language-pair" } } }, "required": [ "languagePair", "resources", "adjacentLanguagePair" ] }, "translation-memory-field": { "title": "Translation Memory Field", "type": "object", "description": "The unique identifier of the field.", "properties": { "id": { "type": "string", "description": "The unique identifier of the field." }, "name": { "type": "string", "description": "
default
The name of the field.
", "x-default-field": true }, "type": { "type": "string", "enum": [ "unknown", "singleString", "multipleString", "dateTime", "singlePicklist", "multiplePicklist", "integer" ], "description": "The data type of the field." }, "values": { "type": "array", "description": "A collection of values for this field.", "items": { "$ref": "#/components/schemas/translation-memory-field-value" } } }, "required": [ "id" ] }, "translation-memory-fields": { "title": "Translation Memory Fields", "type": "object", "properties": { "settings": { "type": "array", "items": { "$ref": "#/components/schemas/translation-memory-fields-settings" }, "description": "
default
", "x-default-field": true } } }, "translation-memory-field-template": { "title": "Translation Memory Field Template", "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the translation memory field template." }, "name": { "type": "string", "description": "
default
The name of the field template.
", "x-default-field": true }, "description": { "type": "string", "description": "The field template description." }, "location": { "$ref": "#/components/schemas/folder-v2" }, "fieldDefinitions": { "type": "array", "description": "A collection of translation memory fields.", "items": { "$ref": "#/components/schemas/translation-memory-field" } } }, "required": [ "id" ] }, "translation-memory-field-value": { "title": "Translation Memory Field Value", "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier associated with this value." }, "value": { "type": "string", "description": "A translation memory field value." } }, "required": [ "id" ] }, "translation-memory": { "title": "Translation Memory", "type": "object", "description": "", "properties": { "id": { "type": "string", "description": "Unique identifier of the translation memory." }, "name": { "type": "string", "description": "
default
The translation memory name.
", "x-default-field": true }, "description": { "type": "string", "description": "The translation memory description." }, "copyright": { "type": "string" }, "location": { "$ref": "#/components/schemas/folder" }, "languageDirections": { "type": "array", "items": { "$ref": "#/components/schemas/translation-memory-language-direction" }, "description": "
default
A collection of language directions
", "x-default-field": true }, "languageProcessingRule": { "$ref": "#/components/schemas/language-processing-rule" }, "fieldTemplate": { "$ref": "#/components/schemas/translation-memory-field-template" }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-01-12T12:00:00Z", "description": "The `DateTime` when the translation memory was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", "nullable": true }, "createdBy": { "$ref": "#/components/schemas/user" }, "lastRecomputedAt": { "type": "string", "format": "date-time", "example": "2022-01-12T12:00:00Z", "description": "The `DateTime` when the translation memory statistics were last updated.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", "nullable": true }, "lastReIndexedAt": { "type": "string", "format": "date-time", "example": "2022-01-12T12:00:00Z", "description": "The `DateTime` when the translation memory reindexing was performed.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", "nullable": true } }, "required": [ "id" ] }, "translation-memory-fields-update-request": { "title": "Translation Memory Fields Update Request", "type": "object", "properties": { "settings": { "type": "array", "description": "The configuration settings for Translation Memory Fields.", "items": { "$ref": "#/components/schemas/translation-memory-fields-settings-request" } } }, "required": [ "settings" ] }, "translation-memory-field-update-type": { "type": "string", "title": "Translation Memory Field Update Type", "enum": [ "dateTime", "singlePicklist", "multiplePicklist", "integer", "singleString", "multipleString" ], "description": "The data type of the value." }, "translation-memory-fields-settings-request": { "title": "Translation Memory Fields Settings Request", "type": "object", "description": "", "properties": { "name": { "type": "string", "description": "The name of the translation memory field." }, "values": { "type": "array", "description": "A collection of values.", "items": { "type": "string" } }, "type": { "$ref": "#/components/schemas/translation-memory-field-update-type" } }, "required": [ "name", "values", "type" ] }, "translation-memory-update-TM-fields-request": { "title": "Translation Memory Update TM Fields Request", "type": "object", "required": [ "fieldId", "values" ], "properties": { "fieldId": { "type": "string", "description": "The identifier of the translation memory field." }, "values": { "type": "array", "description": "A single value or a collection of values. Based on field type, can be of different formats for `singleString`, `multipleString`, `singlePicklist`, `multiplePicklist`, `dateTime`, `integer`.", "items": { "type": "string" } } } }, "translation-memory-fields-settings": { "title": "Translation Memory Fields Settings", "type": "object", "description": "The configuration settings for Translation Memory Fields.", "properties": { "name": { "type": "string", "description": "The name of the translation memory field." }, "values": { "type": "array", "description": "A collection of values.", "items": { "type": "string" } }, "type": { "$ref": "#/components/schemas/translation-memory-field-update-type" } }, "required": [ "name", "values", "type" ] }, "translation-memory-base": { "title": "Translation Memory", "type": "object", "description": "", "properties": { "id": { "type": "string", "description": "The unique translation memory identifier." }, "name": { "type": "string", "description": "The translation memory name." }, "description": { "type": "string", "description": "The translation memory description" }, "copyright": { "type": "string" }, "location": { "$ref": "#/components/schemas/folder" }, "languageDirections": { "type": "array", "items": { "$ref": "#/components/schemas/translation-memory-language-direction" } }, "languageProcessingRule": { "$ref": "#/components/schemas/language-processing-rule" }, "fieldTemplate": { "$ref": "#/components/schemas/translation-memory-field-template" }, "createdDateTime": { "type": "string", "format": "date-time", "description": "The `DateTime` when the translation memory was created.", "nullable": true }, "createdBy": { "$ref": "#/components/schemas/user" } }, "required": [ "id" ] }, "translation-memory-create-request": { "title": "Translation Memory Create Request", "type": "object", "description": "The model to use when creating a new Translation Memory.", "properties": { "name": { "type": "string", "maxLength": 151, "minLength": 1, "description": "The Translation Memory name." }, "description": { "type": "string", "maxLength": 1024, "description": "The Translation Memory description." }, "copyright": { "type": "string", "maxLength": 1024 }, "location": { "type": "string", "description": "The folder identifier where the translation memory should be created." }, "languageDirections": { "type": "array", "items": { "$ref": "#/components/schemas/language-direction-request" } }, "languageProcessingRuleId": { "type": "string", "description": "The Language Processing Rule to be associated with the Translation Memory." }, "fieldTemplateId": { "type": "string", "description": "A Field Template to be associated with the Translation Memory." } }, "required": [ "name", "languageDirections", "languageProcessingRuleId", "fieldTemplateId" ] }, "translation-memory-update-request": { "title": "Translation Memory Update Request", "type": "object", "description": "", "properties": { "name": { "type": "string", "description": "The translation memory name", "minLength": 1, "maxLength": 151 }, "description": { "type": "string", "maxLength": 1024, "description": "The translation memory description" }, "copyright": { "type": "string", "maxLength": 1024 }, "languageDirections": { "type": "array", "items": { "$ref": "#/components/schemas/language-direction-request" } }, "languageProcessingRuleId": { "type": "string", "description": "The language processing rule to be associated with the translation memory." }, "fieldTemplateId": { "type": "string", "description": "A field template to be associated with the translation memory." } } }, "translation-memory-language-direction": { "title": "Translation Memory Language Direction", "type": "object", "description": "A language direction representation specific to translation memories.", "properties": { "languageDirection": { "$ref": "#/components/schemas/simple-language-direction", "description": "
default
A basic language direction.
", "x-default-field": true }, "translationUnits": { "type": "integer", "description": "The number of translation units for this language pair. Sum up all language pairs to get the total for the translation memory.", "nullable": true }, "unalignedTranslationUnits": { "type": "integer", "description": "The number of translation units that are unaligned for this language pair. Sum up all language pairs to get the total for the translation memory.", "nullable": true } } }, "translation-memory-import-request": { "title": "Translation Memory Import Properties", "type": "object", "description": "Translation Memory Import properties sent as a JSON inside a text part.", "properties": { "sourceLanguageCode": { "type": "string", "description": "The code of the source language of the translation memory." }, "targetLanguageCode": { "type": "string", "description": "The code of the target language of the translation memory." }, "importAsPlainText": { "description": "(Deprecated) The default value is set for this field, as this property is set internally.", "type": "boolean", "deprecated": true }, "exportInvalidTranslationUnits": { "type": "boolean", "default": true }, "triggerRecomputeStatistics": { "description": "(Deprecated) The default value is set for this field, as this property is set internally.", "type": "boolean", "deprecated": true }, "targetSegmentsDifferOption": { "type": "string", "description": "Option to specify how to handle translation units in the Translation Memory, if target segments differ.", "enum": [ "addNew", "overwrite", "leaveUnchanged", "keepMostRecent" ], "default": "addNew" }, "unknownFieldsOption": { "type": "string", "description": "Option to specify how to handle translation units and unknown fields in the Translation Memory.", "enum": [ "skipTranslationUnit", "ignore", "addToTranslationMemory", "failTranslationUnitImport" ], "default": "addToTranslationMemory" }, "onlyImportSegmentsWithConfirmationLevels": { "description": "Only segments with the these confirmation levels will be imported. Default if the field is not set or null: [translated, approvedSignOff, approvedTranslation]. Empty array will be treated as not specified.", "type": "array", "items": { "type": "string", "enum": [ "translated", "approvedTranslation", "approvedSignOff", "draft", "rejectedTranslation", "rejectedSignOff" ] } } }, "required": [ "sourceLanguageCode", "targetLanguageCode" ] }, "translation-memory-import-response": { "title": "Translation Memory Import Response", "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the import operation." }, "status": { "type": "string", "description": "(Deprecated) The status of the import operation.\n* `queued` - the import has been queued and is waiting to be processed\n* `inProgress` - the import is being processed\n* `failed` - the import has failed due to internal errors\n* `done` - the import has finished successfully\n* `cancelled` - the import has been interrupted", "enum": [ "queued", "inProgress", "failed", "done", "cancelled" ], "deprecated": true } }, "required": [ "id", "status" ] }, "translation-memory-import-poll-response": { "title": "Translation Memory Import Response", "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the import operation." }, "status": { "type": "string", "description": "The status of the import operation.\n* `queued` - the import has been queued and is waiting to be processed\n* `inProgress` - the import is being processed\n* `failed` - the import has failed due to internal errors\n* `done` - the import has finished successfully\n* `cancelled` - the import has been interrupted", "enum": [ "queued", "inProgress", "failed", "done", "cancelled" ] } }, "required": [ "id", "status" ] }, "translation-memory-import-history-response": { "title": "Translation Memory Import History Response", "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the import operation." }, "status": { "type": "string", "description": "The status of the import operation.\n* `queued` - the import has been queued\n* `inPorgress` - the import is being processed\n* `failed` - the import has failed\n* `done` - the import has finished successfully\n* `cancelled` - the import has been cancelled", "enum": [ "queued", "inProgress", "failed", "done", "cancelled" ] }, "displayName": { "type": "string", "description": "The assigned name of the import operation." }, "settings": { "$ref": "#/components/schemas/translation-memory-import-settings" }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-01-12T12:00:00Z", "description": "The creation date of the import operation.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2022-01-12T12:00:00Z", "description": "The last update time of the import operation.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss" }, "ownerId": { "type": "string", "description": "Owner of the import operation, corresponds with the tenant identifier." } }, "required": [ "id", "status" ] }, "translation-memory-import-settings": { "title": "Translation Memory Import Settings", "type": "object", "description": "The properties provided by the client, when the Import Operation was triggered.", "properties": { "onlyImportSegmentsWithConfirmationLevels": { "description": "Only segments with the these confirmation levels were be imported.", "type": "array", "items": { "type": "string", "enum": [ "translated", "approvedTranslation", "approvedSignOff", "draft", "rejectedTranslation", "rejectedSignOff" ] } }, "unknownFieldsOption": { "description": "This option describes how were the translation units handled when there were unknown fields in the request.", "enum": [ "skipTranslationUnit", "ignore", "addToTranslationMemory", "failTranslationUnitImport" ], "type": "string" }, "targetSegmentsDifferOption": { "description": "This option describes how were the translation units handled when there were differences in target segments.", "enum": [ "addNew", "overwrite", "leaveUnchanged", "keepMostRecent" ], "type": "string" }, "importAsPlainText": { "description": "(Deprecated) The default value is set for this field, as this property is set internally.", "type": "boolean", "deprecated": true }, "exportInvalidTranslationUnits": { "description": "This option describes if the invalid translation units were exported during the original translation memory import operation.", "type": "boolean" }, "triggerRecomputeStatistics": { "description": "(Deprecated) The default value is set for this field, as this property is set internally.", "type": "boolean", "deprecated": true }, "fileName": { "description": "The name of the file attached to the import request.", "type": "string" }, "sourceLanguageCode": { "description": "The source language code of the import request.", "type": "string" }, "targetLanguageCode": { "description": "The target language code of the import request.", "type": "string" }, "traceId": { "description": "(Deprecated) The field will be completly remove in the future. For compatibily, until it will be removed a default value it is set: 0000-0000-0000-0000.", "type": "string", "deprecated": true } }, "required": [ "onlyImportSegmentsWithConfirmationLevels", "unknownFieldsOption", "targetSegmentsDifferOption", "importAsPlainText", "exportInvalidTranslationUnits", "triggerRecomputeStatistics", "fileName", "sourceLanguageCode", "targetLanguageCode", "traceId" ] }, "translation-memory-export-response": { "title": "Translation Memory Export Response", "type": "object", "properties": { "id": { "type": "string", "description": "The translation memory export identifier." }, "status": { "type": "string", "description": "(Deprecated) The status of the import operation.\n* `queued` - the import has been queued and is waiting to be processed\n* `inProgress` - the import is being processed\n* `failed` - the import has failed due to internal errors\n* `done` - the import has finished successfully\n* `cancelled` - the import has been interrupted", "enum": [ "queued", "inProgress", "failed", "done", "cancelled" ], "deprecated": true } }, "required": [ "id", "status" ] }, "translation-memory-poll-export-response": { "title": "Translation Memory Export Response", "type": "object", "properties": { "id": { "type": "string", "description": "The translation memory export identifier." }, "status": { "type": "string", "description": "The translation memory export status.\n* `queued` - the export has been queued to be processed\n* `inProgress` - the export is being processed\n* `failed` - the export has failed due to internal errors\n* `done` - the export has finished successfully\n* `cancelled` - the export has been interrupted", "enum": [ "queued", "inProgress", "failed", "done", "cancelled" ] } }, "required": [ "id", "status" ] }, "translation-memory-export-language-direction": { "title": "Translation Memory Export Language Direction", "type": "object", "description": "", "properties": { "sourceLanguage": { "$ref": "#/components/schemas/source-language-request" }, "targetLanguage": { "$ref": "#/components/schemas/target-language-request" } }, "required": [ "sourceLanguage", "targetLanguage" ] }, "translation-memory-export-request": { "title": "Translation Memory Export Request", "description": "", "type": "object", "properties": { "languageDirection": { "$ref": "#/components/schemas/translation-memory-export-language-direction" } }, "required": [ "languageDirection" ] }, "translation-memory-settings-filters-response": { "type": "object", "title": "Translation Memory Filters", "properties": { "hardFilter": { "$ref": "#/components/schemas/translation-memory-settings-hard-filter-response", "description": "
default
Hard filter configuration for Translation Memory matching.
", "x-default-field": true } } }, "translation-memory-settings-hard-filter-response": { "title": "Translation Memory Hard Filter", "type": "object", "description": "Hard filter configuration for Translation Memory matching.", "required": [ "expression" ], "properties": { "expression": { "type": "string", "example": "(NOT \"TU confirmation level\" = \"Not Translated\" OR \"Last modified on\" > 2024-02-29T10:00:00.000Z\") AND \"Source segment length\" >= 10", "description": "The filter expression is a set of atomic expressions connected by logical operators. An atomic expression describes the relationship of a field to a value." }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/translation-memory-settings-filter-field-response" } } } }, "translation-memory-settings-filter-field-response": { "title": "Translation Memory Filter Field", "type": "object", "description": "Translation Memory Filter Field definition", "required": [ "fieldId", "fieldTemplateId", "fieldTemplateName", "name", "type" ], "properties": { "fieldId": { "type": "string", "description": "The field identifier. For system fields, use system field names. For custom fields, use the custom field identifier." }, "fieldTemplateId": { "type": "string", "description": "`system` or identifier of the custom field template" }, "fieldTemplateName": { "type": "string", "description": "The name of the field template." }, "name": { "type": "string", "description": "The field name. For system fields, identical to fieldId. For custom fields, use the custom field name." }, "type": { "type": "string", "description": "Type of the field.", "enum": [ "singleString", "multipleString", "singlePicklist", "multiplePicklist", "dateTime", "integer" ] }, "allowedValues": { "type": "array", "x-default-field": true, "description": "
default
Available values for picklist fields. Only present for singlePicklist and multiplePicklist field types.
", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "The unique identifier of the allowed value." }, "name": { "type": "string", "description": "The display name of the allowed value." } } } } } }, "translation-memory-settings-update-field-response": { "title": "Translation Memory Update Field", "type": "object", "description": "Translation Memory Field definition with values for field updates", "allOf": [ { "$ref": "#/components/schemas/translation-memory-settings-filter-field-response" }, { "type": "object", "properties": { "values": { "type": "array", "x-default-field": true, "description": "
default
The actual values assigned to this field.
", "items": { "type": "string" } } } } ] }, "translation-service-type": { "title": "Service Type", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The Service Type identifier." }, "name": { "type": "string", "description": "
default
The Service Type name.
" } } }, "update-translation-memory": { "title": "Update Translation Memory", "type": "object", "properties": { "settings": { "$ref": "#/components/schemas/update-translation-memory-settings", "description": "The configuration settings for Update Translation Memory\r\n.", "x-default-field": true } }, "required": [ "settings" ] }, "update-translation-memory-settings": { "title": "Update Translation Memory Settings", "type": "object", "properties": { "segmentsConfirmationLevels": { "type": "array", "items": { "type": "string", "enum": [ "approvedTranslation", "approvedSignOff", "draft", "notTranslated", "translated", "rejectedTranslation", "rejectedSignOff" ] }, "description": "Default values are: \n\r [`translated`, `approvedTranslation`, `approvedSignOff`]." }, "targetSegmentsDifferOption": { "type": "string", "enum": [ "addNew", "overwrite", "keepMostRecent", "leaveUnchanged", "merge" ], "description": "Options:\r\n- `merge`: replace (update) only the TU (from which a match was retrieved for the edited TU) with the latest available translation AND keep the other duplicates as they are. Use this option to have multiple translations for the same source together with Multiple Translation Penalty = 0.\r\n- `addNew`: add translations as new TUs to the TM. Specify the status of the TUs (which will be added) under Segment status. This means that the existing TUs in the TM are not overwritten.\r\n- `overwriteExisting`: delete all TUs (which have the same source, all TU duplicates) and keep only the last added TU (the latest available translation). Use this option to prevent inconsistent translations.\r\n- `leaveUnchanged`: keep the existing TUs and do not add any new ones.\r\n- `keepMostRecent`: replace (update) only the most recent TU (from which a match was retrieved for the edited TU) with the latest available translation AND delete all other duplicates.\r\n", "default": "merge" } }, "required": [ "segmentsConfirmationLevels", "targetSegmentsDifferOption" ] }, "user": { "title": "User", "type": "object", "description": "User in the account.", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "User account identifier." }, "description": { "type": "string", "description": "Description of this account user. For Service account users only." }, "email": { "type": "string", "description": "
default
The user's email address. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
", "x-default-field": true }, "name": { "type": "string", "description": "
default
The user's name. Retrieved only for Service users (not RWS ID users) that the authenticated entity is authorized to read.
" }, "firstName": { "type": "string", "description": "
default
The user's first name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
", "x-default-field": true }, "lastName": { "type": "string", "description": "
default
The user's last name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
", "x-default-field": true }, "anonymized": { "type": "boolean", "description": "
default
This shows if the authenticated entity has access to read the details of the user or not. If true, then the 'anonymizedUserName' should be retrieved.
", "nullable": true, "x-default-field": true }, "anonymizedUserName": { "type": "string", "description": "
default
Retrieved if the authenticated entity does not have access to read the User.
", "x-default-field": true }, "account": { "$ref": "#/components/schemas/account", "description": "The account the user is part of." }, "location": { "$ref": "#/components/schemas/folder-v2" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/group" } }, "userType": { "$ref": "#/components/schemas/user-type" }, "status": { "$ref": "#/components/schemas/user-status" }, "invitationLink": { "type": "string", "description": "The user's invitation link. Retrieved only for RWS ID (formerly SDL ID) users—not service users. It is available only if the user has not yet accepted the invitation (status is `inactive`)." }, "membership": { "$ref": "#/components/schemas/account-membership-type" }, "metadata": { "title": "Metadata", "description": "Additional metadata values in a key–value pair format", "additionalProperties": true, "example": { "colour": "green", "flag-enabled": true, "max value": 3 } } } }, "user-create-request": { "title": "User Create Request", "type": "object", "description": "If you need to create a Service User, send only the `serviceUserDetails` object and omit the `userDetails`object, vice-versa for a normal user. ", "properties": { "groups": { "type": "array", "minItems": 1, "description": "The identifiers for the user groups. At least one valid group must be provided.", "items": { "type": "object", "$ref": "#/components/schemas/object-id" } }, "location": { "type": "string", "description": "The identifier of the parent folder for the account user. If it isn't mentioned, it will be created in the Root folder." }, "serviceUserDetails": { "$ref": "#/components/schemas/service-user-details" }, "userDetails": { "$ref": "#/components/schemas/user-details" } }, "required": [ "groups" ] }, "service-user-details": { "title": "Service User Details", "type": "object", "description": "The account details. Provide these to create a Service User.", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "The Service User name.", "maxLength": 100 }, "description": { "type": "string", "description": "The Service User description.", "maxLength": 200 } } }, "user-details": { "title": "User Details", "type": "object", "description": "The account details. Provide these to invite a user.", "required": [ "membership", "email", "firstName", "lastName" ], "properties": { "membership": { "$ref": "#/components/schemas/account-membership-type" }, "email": { "type": "string", "format": "email", "description": "The user email." }, "firstName": { "type": "string", "description": "The First Name of the account user.", "maxLength": 50 }, "lastName": { "type": "string", "description": "The Last Name of the account user.", "maxLength": 50 }, "invitationMessage": { "type": "string", "description": "A personalized message that will be included in the invitation.", "maxLength": 1000 }, "sendInvitationEmail": { "type": "boolean", "default": true, "description": "If enabled, the user will receive an email at the specified address containing the invitation details." }, "inviteInCustomerPortal": { "type": "boolean", "default": false, "description": "Enable this if the invited user is meant to be a Customer Reviewer or Customer Requester. When enabled, the user will always be redirected to the Customer Portal." } } }, "user-update-request": { "title": "User Update Request", "type": "object", "properties": { "name": { "type": "string", "description": "The account user name. For Service users only.", "maxLength": 100 }, "description": { "type": "string", "description": "Description of this account user. For Service account users only.", "maxLength": 200 }, "firstName": { "type": "string", "description": "The First Name of this account user. For RWSID account users only.", "maxLength": 50 }, "lastName": { "type": "string", "description": "The Last Name of this account user. For RWSID account users only.", "maxLength": 50 }, "groups": { "type": "array", "minItems": 1, "description": "The identifiers for the user groups. \r\n\r\nWhen updating a user, observe the rules of [JSON Merge Patch Semantics](https://tools.ietf.org/html/rfc7386) to prevent accidentally removing a user from groups. If provided it must contain at least one valid group id.", "items": { "type": "object", "$ref": "#/components/schemas/object-id" } }, "metadata": { "title": "Metadata", "description": "Additional metadata values in a key–value pair format", "additionalProperties": true, "example": { "colour": "green", "flag-enabled": true, "max value": 3 } } } }, "user-type": { "title": "User Type", "type": "string", "enum": [ "user", "serviceUser" ], "description": "The type of the account user." }, "user-status": { "title": "User Status", "type": "string", "enum": [ "inactive", "active", "deleted", "provisioned" ], "description": "Status of this account user." }, "vendor-order": { "title": "Vendor Order", "type": "object", "properties": { "id": { "type": "string" }, "quote": { "$ref": "#/components/schemas/quote" } }, "required": [ "id" ], "description": "A vendor order resource." }, "vendor-order-template": { "title": "Vendor Order Template", "description": "The vendor order template.", "deprecated": true, "x-deprecated-reason": "Use vendor-order-template-response for full vendor order template representation.", "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "vendor-order-template-response": { "title": "Vendor Order Template Response", "type": "object", "description": "A vendor order template resource.", "properties": { "id": { "type": "string", "description": "The unique identifier of the vendor order template." }, "name": { "type": "string", "description": "The name of the vendor order template." }, "description": { "type": "string", "description": "A description of the vendor order template." }, "allowQuoteEditing": { "type": "boolean", "description": "Whether the vendor is allowed to edit the quote." }, "serviceTypes": { "type": "array", "description": "The service types associated with this vendor order template.", "items": { "$ref": "#/components/schemas/translation-service-type" } }, "pricingModel": { "$ref": "#/components/schemas/pricing-model", "description": "The pricing model associated with this vendor order template." }, "quoteConfiguration": { "$ref": "#/components/schemas/vendor-order-template-quote-configuration", "description": "Controls when and how the vendor quote is generated." }, "customFields": { "type": "array", "description": "Custom field values associated with the vendor order template.", "items": { "$ref": "#/components/schemas/custom-field" } }, "languagePairs": { "type": "array", "description": "The language pairs supported by this vendor order template.", "items": { "$ref": "#/components/schemas/language-pair" } }, "assignments": { "type": "array", "description": "Assignee and manager assignments per language pair. Contains exactly one entry for each language pair in `languagePairs`.", "items": { "$ref": "#/components/schemas/vot-configuration-response" } } }, "required": ["id"] }, "list-vendor-order-templates-response": { "title": "List Vendor Order Templates Response", "type": "object", "properties": { "items": { "type": "array", "description": "The list of vendor order templates.", "items": { "$ref": "#/components/schemas/vendor-order-template-response" } }, "itemCount": { "type": "integer", "description": "The number of items returned in this response." } }, "required": ["items", "itemCount"], "description": "A response for the List Vendor Order Templates endpoint." }, "vendor-order-template-update-request": { "title": "Vendor Order Template Update Request", "type": "object", "description": "Request body for updating an existing vendor order template.", "properties": { "name": { "type": "string", "description": "The name of the vendor order template.", "minLength": 1, "maxLength": 50 }, "description": { "type": "string", "description": "A description of the vendor order template.", "maxLength": 1024 }, "serviceTypes": { "type": "array", "description": "The service type identifiers to associate with this vendor order template. Use the [List Service Types](#/operations/ListTranslationServiceTypes) endpoint to retrieve available values.", "items": { "type": "string" } }, "pricingModelId": { "type": "string", "description": "The identifier of the pricing model to associate with this vendor order template. Use the [List Pricing Models](#/operations/ListPricingModels) endpoint with `location` set to the vendor's folder identifier. Set `locationStrategy=location` to see only pricing models saved directly in the vendor folder" }, "quoteConfiguration": { "$ref": "#/components/schemas/vendor-order-template-quote-configuration", "description": "Controls when and how the vendor quote is generated." }, "customFields": { "type": "array", "description": "Custom field values to associate with the vendor order template. Use the [List Custom Field Definitions](#/operations/ListCustomFields) endpoint with `location` set to the vendor's folder identifier and `resourceType=vendorOrderTemplate` to retrieve applicable definitions.", "items": { "$ref": "#/components/schemas/custom-field-request" } }, "languagePairs": { "type": "array", "description": "The language pairs supported by this vendor order template.", "items": { "$ref": "#/components/schemas/language-pair" } }, "assignments": { "type": "array", "description": "Assignee and manager assignments per language pair. Must contain exactly one entry for each language pair listed in `languagePairs`.", "items": { "$ref": "#/components/schemas/vot-configuration" } } } }, "vendor-order-template-create-request": { "title": "Vendor Order Template Create Request", "type": "object", "description": "Request body for creating a new vendor order template.", "properties": { "name": { "type": "string", "description": "The name of the vendor order template.", "minLength": 1, "maxLength": 50 }, "description": { "type": "string", "description": "A description of the vendor order template.", "maxLength": 1024 }, "allowQuoteEditing": { "type": "boolean", "default": false, "description": "Whether the vendor is allowed to edit the vendor quote at any time. When `false` (default), vendor project managers can only edit the quote during the Vendor Quote Review task." }, "serviceTypes": { "type": "array", "description": "The service type identifiers to associate with this vendor order template. Use the [List Service Types](#/operations/ListTranslationServiceTypes) endpoint to retrieve available values.", "items": { "type": "string" } }, "pricingModelId": { "type": "string", "description": "The identifier of the pricing model to associate with this vendor order template. Use the [List Pricing Models](#/operations/ListPricingModels) endpoint with `location` set to the vendor's folder identifier. Set `locationStrategy=location` to see only pricing models saved directly in the vendor folder." }, "quoteConfiguration": { "$ref": "#/components/schemas/vendor-order-template-quote-configuration", "description": "Controls when and how the vendor quote is generated." }, "customFields": { "type": "array", "description": "Custom field values to associate with the vendor order template. Use the [List Custom Field Definitions](#/operations/ListCustomFields) endpoint with `location` set to the vendor's folder identifier and `resourceType=vendorOrderTemplate` to retrieve applicable definitions.", "items": { "$ref": "#/components/schemas/custom-field-request" } }, "languagePairs": { "type": "array", "description": "The language pairs supported by this vendor order template.", "items": { "$ref": "#/components/schemas/language-pair" } }, "assignments": { "type": "array", "description": "Assignee and manager assignments per language pair. Must contain exactly one entry for each language pair listed in `languagePairs`.", "items": { "$ref": "#/components/schemas/vot-configuration" } } }, "required": ["name", "languagePairs", "assignments", "pricingModelId", "quoteConfiguration", "serviceTypes"] }, "vot-quote-behaviour": { "title": "Vendor Order Template Quote Behaviour", "type": "string", "description": "The strategy that determines when the vendor quote is generated. For details on how each strategy behaves, see [Vendor order template strategies and their behavior](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/vendor-order-template-strategies-and-their-behavior-1170239).\n\n- `waitForAllFiles`: Wait until all files assigned to the vendor have reached their task, up to `holdingDelay` minutes (default: 1440 = 24 hours). If all files have not arrived within the waiting period, the quote is generated for the files that did arrive; remaining files are added to the same quote when they arrive.\n- `perFileQuote`: Generate a separate quote for each file individually as it reaches the vendor task.\n- `finalQuoteAfterBatchCompleted`: Generate a single quote immediately after the Project Planning task is completed. This is the default strategy.\n- `quoteBeforeCustomerQuoteGeneration`: Generate the vendor quote before the customer quote is generated.", "enum": [ "waitForAllFiles", "perFileQuote", "finalQuoteAfterBatchCompleted", "quoteBeforeCustomerQuoteGeneration" ] }, "vendor-order-template-quote-configuration": { "title": "Vendor Order Template Quote Configuration", "type": "object", "description": "Controls when and how the vendor quote is generated.", "properties": { "behaviour": { "$ref": "#/components/schemas/vot-quote-behaviour", "description": "The strategy that determines when the vendor quote is generated." }, "holdingDelay": { "type": "integer", "minimum": 1, "description": "The maximum time in minutes the system waits for all files to reach the vendor task before generating the quote. Only applicable when `behaviour` is `waitForAllFiles`. Defaults to 1440 (24 hours)." } }, "required": ["behaviour"] }, "vot-person-request": { "title": "Vendor Order Template Person", "description": "A user or group assigned as a manager or assignee on a vendor order template. When `type` is `user`, `id` is the identifier of a user present in the vendor's `members` list. When `type` is `group`, `id` is the identifier of a group present in the vendor's `groups` list.", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "description": "The kind of assignment.", "enum": [ "user", "group" ] }, "id": { "type": "string", "description": "The identifier of the user or group being assigned, according to `type`." } } }, "vot-person-response": { "title": "Vendor Order Template Person", "description": "A user or group assigned as a manager or assignee on a vendor order template. When `type` is `user`, the `user` object is populated. When `type` is `group`, the `group` object is populated.", "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "The kind of assignment.", "enum": [ "user", "group" ] }, "user": { "description": "The user it is assigned to. Present when `type` is `user`.", "$ref": "#/components/schemas/user" }, "group": { "description": "The group it is assigned to. Present when `type` is `group`.", "$ref": "#/components/schemas/group" } } }, "vot-configuration": { "title": "Vendor Order Template Configuration", "type": "object", "description": "Assignee and manager assignment for a specific language pair. Every language pair listed in `languagePairs` must have exactly one corresponding entry in `assignments`.", "properties": { "languagePair": { "$ref": "#/components/schemas/language-pair", "description": "The language pair this assignment applies to." }, "managers": { "type": "array", "description": "The vendor project managers responsible for the Vendor Quote Review task for this language pair. All entries must be members of the vendor's Vendor Project Manager group.", "minItems": 1, "items": { "$ref": "#/components/schemas/vot-person-request" } }, "assignees": { "type": "array", "description": "The vendor users who will perform the actual service tasks (e.g. Translation, Linguistic Review, DTP) for this language pair. All entries must be members of the vendor's Vendor Project Manager group.", "minItems": 1, "items": { "$ref": "#/components/schemas/vot-person-request" } } }, "required": ["languagePair", "managers", "assignees"] }, "vot-configuration-response": { "title": "Vendor Order Template Configuration", "type": "object", "description": "Assignee and manager assignment for a specific language pair. Every language pair listed in `languagePairs` must have exactly one corresponding entry in `assignments`.", "properties": { "languagePair": { "$ref": "#/components/schemas/language-pair", "description": "The language pair this assignment applies to." }, "managers": { "type": "array", "description": "The vendor project managers responsible for the Vendor Quote Review task for this language pair. All entries must be members of the vendor's Vendor Project Manager group.", "minItems": 1, "items": { "$ref": "#/components/schemas/vot-person-response" } }, "assignees": { "type": "array", "description": "The vendor users who will perform the actual service tasks (e.g. Translation, Linguistic Review, DTP) for this language pair. All entries must be members of the vendor's Vendor Project Manager group.", "minItems": 1, "items": { "$ref": "#/components/schemas/vot-person-response" } } }, "required": ["languagePair", "managers", "assignees"] }, "key-contact": { "title": "Key Contact", "type": "object", "description": "The key contact of a vendor — the primary point of contact within the LSP organization.", "properties": { "firstName": { "type": "string", "description": "The first name of the key contact.", "maxLength": 50 }, "lastName": { "type": "string", "description": "The last name of the key contact.", "maxLength": 50 }, "email": { "type": "string", "format": "email", "description": "The email address of the key contact.", "maxLength": 50 } }, "required": ["firstName", "lastName", "email"] }, "vendor": { "title": "Vendor", "type": "object", "description": "Represents an external LSP (Language Service Provider) organization that can be assigned translation tasks through vendor order templates.", "properties": { "id": { "type": "string", "description": "The unique identifier of the vendor. Generated by the system." }, "name": { "type": "string", "description": "
default
The name of the vendor.
", "x-default-field": true }, "description": { "type": "string", "description": "A description of the vendor.", "x-default-field": true }, "keyContact": { "$ref": "#/components/schemas/user", "description": "The user that is the primary point of contact for this vendor." }, "vendorFolder": { "$ref": "#/components/schemas/folder-v2", "description": "The folder provisioned for this vendor during creation." }, "groups": { "type": "array", "description": "The groups located in this vendor's folder. Includes the auto-provisioned `VendorProjectManager` group as well as any custom groups created in the vendor folder. The `VendorProjectManager` group identifier can be used when inviting users to the vendor via the [Create User](#/operations/CreateUser) endpoint.", "items": { "$ref": "#/components/schemas/group" } }, "selfManaged": { "type": "boolean", "description": "Indicates whether the vendor is self-managed. When true, the vendor can manage its own users." }, "quoteTemplate": { "$ref": "#/components/schemas/project-quote-template", "description": "The quote template associated with this vendor." }, "members": { "type": "array", "description": "The users that are members of this vendor, belonging to the vendor's `VendorProjectManager` group. To add users to the vendor, invite them via the [Create User](#/operations/CreateUser) endpoint specifying the `VendorProjectManager` group. To remove users, use the [Update Group](#/operations/UpdateGroup) or [Update User](#/operations/UpdateUser) endpoints.", "items": { "$ref": "#/components/schemas/user" } }, "customFields": { "type": "array", "description": "Custom field values associated with the vendor.", "items": { "$ref": "#/components/schemas/custom-field" } } }, "required": ["id"] }, "vendor-create-request": { "title": "Vendor Create Request", "type": "object", "description": "Request body for creating a new vendor. Creating a vendor automatically provisions a dedicated folder and a `VendorProjectManager` group.", "properties": { "name": { "type": "string", "description": "The name of the vendor.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", "minLength": 1, "maxLength": 50 }, "description": { "type": "string", "description": "A description of the vendor.", "maxLength": 1024 }, "keyContact": { "$ref": "#/components/schemas/key-contact", "description": "The primary point of contact within the vendor organization. Required when creating a vendor." }, "selfManaged": { "type": "boolean", "description": "Indicates whether the vendor can manage its own users and settings independently. When true (default), users with access to the vendor folder can manage the vendor's group membership. When false, only account-level administrators can manage the vendor. Can be updated after creation via the Update Vendor endpoint.", "default": true }, "quoteTemplateId": { "type": "string", "description": "The identifier of the quote template to associate with the vendor. Use the [List Quote Templates](#/operations/ListQuoteTemplates) endpoint to retrieve available values.
The quote template must be in the same folder as the vendor or above." }, "customFields": { "type": "array", "description": "Custom field values to associate with the vendor. Use the [List Custom Field Definitions](#/operations/ListCustomFields) endpoint with `location` set to the vendor's folder identifier and `resourceType=vendor` to retrieve applicable definitions.", "items": { "$ref": "#/components/schemas/custom-field-request" } } }, "required": ["name", "keyContact"] }, "vendor-update-request": { "title": "Vendor Update Request", "type": "object", "description": "Request body for updating an existing vendor. Only fields included in the request body are updated. Member management is not part of this endpoint — use the [Create User](#/operations/CreateUser), [Update User](#/operations/UpdateUser), or [Update Group](#/operations/UpdateGroup) endpoints to add or remove users from the vendor's `VendorProjectManager` group.", "properties": { "name": { "type": "string", "description": "The name of the vendor. \\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", "minLength": 1, "maxLength": 50 }, "description": { "type": "string", "description": "A description of the vendor.", "maxLength": 1024 }, "keyContactId": { "type": "string", "description": "The identifier of the user to set as the primary point of contact for this vendor." }, "selfManaged": { "type": "boolean", "description": "Indicates whether the vendor is self-managed." }, "quoteTemplateId": { "type": "string", "description": "The identifier of the quote template to associate with the vendor. Use the [List Quote Templates](#/operations/ListQuoteTemplates) endpoint to retrieve available values.
The quote template must be in the same folder as the vendor or above." }, "customFields": { "type": "array", "description": "Custom field values to associate with the vendor. Use the [List Custom Field Definitions](#/operations/ListCustomFields) endpoint with `location` set to the vendor's folder identifier and `resourceType=vendor` to retrieve applicable definitions.", "items": { "$ref": "#/components/schemas/custom-field-request" } } } }, "volume-unit-type": { "title": "Volume Unit Type", "type": "string", "enum": [ "words", "characters", "custom" ] }, "workflow": { "title": "Workflow", "type": "object", "description": "The steps a project goes through. (Not available for List Projects endpoint)", "properties": { "id": { "type": "string", "description": "The workflow identifier." }, "name": { "type": "string", "description": "
default
The workflow name.
", "x-default-field": true }, "description": { "type": "string", "description": "The workflow description." }, "location": { "$ref": "#/components/schemas/folder" }, "workflowTemplate": { "$ref": "#/components/schemas/workflow-template" }, "taskConfigurations": { "type": "array", "items": { "$ref": "#/components/schemas/workflow-task-configuration" } }, "languageDirections": { "type": "array", "items": { "$ref": "#/components/schemas/language-direction-no-statistics" } } }, "required": [ "id" ] }, "workflow-task-assignee": { "title": "Workflow Task Assignee", "type": "object", "description": "Task assignee. Based on the \"type\", further details can be retrieved.
For ex. for \"type\"=\"user\", \"user\" property is available.
For \"projectCreator\" and \"projectManager\" no other property is available.", "properties": { "type": { "type": "string", "enum": [ "user", "group", "vendorOrderTemplate", "projectCreator", "projectManager" ] }, "user": { "$ref": "#/components/schemas/user", "description": "
default
User in the account
", "x-default-field": true }, "group": { "$ref": "#/components/schemas/group", "description": "
default
Group of users.
", "x-default-field": true }, "vendorOrderTemplate": { "$ref": "#/components/schemas/vendor-order-template", "description": "
default
A vendor oder template.
", "x-default-field": true } }, "required": [ "type" ] }, "workflow-task-assignee-request": { "title": "Workflow Task Assignee Request", "type": "object", "properties": { "type": { "type": "string", "enum": [ "user", "group", "vendorOrderTemplate", "projectCreator", "projectManager" ] }, "user": { "$ref": "#/components/schemas/object-id-request" }, "group": { "$ref": "#/components/schemas/object-id-request" }, "vendorOrderTemplate": { "$ref": "#/components/schemas/object-id-request" } }, "required": [ "type" ] }, "workflow-task-configuration": { "title": "Workflow Task Configuration", "type": "object", "description": "Properties of a workflow task.", "properties": { "scope": { "$ref": "#/components/schemas/task-configuration-scope" }, "assignees": { "$ref": "#/components/schemas/workflow-task-assignee" }, "isSkipped": { "type": "boolean", "nullable": true, "description": "
default
", "x-default-field": true }, "taskTemplate": { "$ref": "#/components/schemas/workflow-task-template" }, "configurationValues": { "type": "array", "description": "The task type configuration values set on this workflow task. Each item corresponds to a configuration key defined in `taskTemplate.taskType.configurationDefinitions`.", "items": { "$ref": "#/components/schemas/workflow-task-type-config-value" } } }, "required": [ "scope", "taskTemplate" ] }, "workflow-phase": { "title": "Workflow Phase", "type": "object", "description": "A set of workflow steps which work together towards a localization outcome.", "properties": { "id": { "type": "string", "description": "The phase identfier." }, "name": { "type": "string", "description": "
default
The phase name.
", "x-default-field": true } }, "required": [ "id" ] }, "workflow-task-configuration-request": { "title": "Workflow Task Configuration Request", "type": "object", "description": "A task configuration request.", "properties": { "taskTemplate": { "$ref": "#/components/schemas/object-id" }, "isSkipped": { "type": "boolean" }, "assignees": { "type": "array", "description": "Specifies the list of assignees for the task template. \n
When the 'isSkipped' field is set to 'true', an empty list of assignees should be specified.\r\n
Total assignee count is limited. See more at [Assigning users and groups to workflow tasks](https://docs.rws.com/791595/743481/trados-enterprise---accelerate/assigning-users-and-groups-to-workflow-tasks) point 5e.", "items": { "$ref": "#/components/schemas/workflow-task-assignee-request" } }, "scope": { "$ref": "#/components/schemas/task-configuration-scope-request" }, "configurationValues": { "type": "array", "items": { "$ref": "#/components/schemas/workflow-task-type-config-value" } } }, "required": [ "taskTemplate", "isSkipped", "assignees", "scope" ] }, "workflow-task-type-config-value": { "title": "Workflow Task Type Config Value", "type": "object", "description": "A key-value pair representing a task type configuration setting.\n\nValid configuration keys (`id`), data types, options (for string types), and constraints (e.g., min/max for integer types) are defined in the sibling field `taskTemplate.taskType.configurationDefinitions` within the same task configuration.", "required": [ "id", "value" ], "properties": { "id": { "type": "string", "description": "The configuration key identifier (e.g. `FORCE_CLOSE_MAX_AGE`, `EDITOR_MODE`, `CONCURRENT_EDITING_ENABLED`)." }, "value": { "description": "The configuration value.", "type": "object" } }, "example": { "id": "CONCURRENT_EDITING_ENABLED", "value": false } }, "workflow-task-template": { "title": "Workflow Task Template", "type": "object", "properties": { "id": { "type": "string", "description": "The workflow task template identifier." }, "name": { "type": "string", "description": "
default
The workflow task template name.
", "x-default-field": true }, "apiInternalId": { "type": "string", "description": "
default
Unique identifier of workflow task templates\r\n
" }, "description": { "type": "string" }, "canSkip": { "type": "boolean", "nullable": true }, "requiresAssignment": { "type": "boolean", "nullable": true }, "taskType": { "$ref": "#/components/schemas/task-type" }, "phase": { "$ref": "#/components/schemas/workflow-phase" } }, "required": [ "id" ] }, "workflow-template": { "title": "Workflow Template", "type": "object", "properties": { "id": { "type": "string", "description": "The workflow template identifier." }, "name": { "type": "string", "description": "
default
The workflow template name.
", "x-default-field": true }, "description": { "type": "string", "description": "The workflow template description." }, "taskTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/workflow-task-template" } }, "phases": { "type": "array", "items": { "$ref": "#/components/schemas/workflow-phase" } }, "transitions": { "type": "array", "items": { "$ref": "#/components/schemas/workflow-template-transition" } }, "configurationValues": { "type": "array", "description": "The task type configuration values set on this task. Each item corresponds to a configuration key defined in `taskTemplates.taskType.configurationDefinitions`.", "items": { "$ref": "#/components/schemas/workflow-task-type-config-value" } } }, "required": [ "id" ] }, "workflow-template-transition": { "title": "Workflow Template Transition", "type": "object", "properties": { "from": { "$ref": "#/components/schemas/workflow-template-transition-node", "description": "
default
", "x-default-field": true }, "to": { "$ref": "#/components/schemas/workflow-template-transition-node", "description": "
default
", "x-default-field": true }, "condition": { "$ref": "#/components/schemas/workflow-template-transition-condition" } } }, "workflow-template-transition-condition": { "title": "Workflow Template Transition Condition", "type": "object", "properties": { "type": { "type": "string", "enum": [ "outcome", "expression" ], "nullable": true, "description": "
default
", "x-default-field": true }, "value": { "type": "string", "description": "
default
", "x-default-field": true } } }, "workflow-template-transition-node": { "title": "Workflow Template Transition Node", "type": "object", "properties": { "type": { "type": "string", "enum": [ "taskTemplate", "start", "end" ], "description": "
default
", "x-default-field": true }, "taskTemplate": { "$ref": "#/components/schemas/workflow-task-template", "description": "
default
", "x-default-field": true } } }, "workflow-update-request": { "title": "Workflow Update Request", "type": "object", "description": "A model to update a workflow.", "properties": { "name": { "type": "string", "description": "The workflow name." }, "description": { "type": "string", "description": "The workflow description." }, "taskConfigurations": { "type": "array", "description": "The task configurations.", "items": { "$ref": "#/components/schemas/workflow-task-configuration-request" } } } }, "well-known-jwks-response": { "title": "Well Known Keys Response", "type": "object", "properties": { "keys": { "$ref": "#/components/schemas/list-jwks", "description": "The list of public keys." } } }, "translation-update-definition": { "title": "Translation Update Definition", "type": "object", "required": [ "translationEngineId" ], "properties": { "translationEngineId": { "type": "string", "description": "The translation engine id. The translation engine must have a `TM` resource." } } }, "translation-update-field": { "title": "Translation Update Field", "type": "object", "required": [ "name", "values" ], "properties": { "name": { "type": "string", "description": "Field name" }, "values": { "type": "array", "description": "Field values", "items": { "type": "string" } } }, "description": "" }, "translation-search-settings": { "title": "Translation Search Settings", "type": "object", "properties": { "translationMemory": { "$ref": "#/components/schemas/translation-search-settings-tm" } } }, "concordance-search-settings": { "title": "Concordance Search Settings", "type": "object", "properties": { "translationMemory": { "$ref": "#/components/schemas/concordance-search-settings-tm" } } }, "translation-search-settings-tm": { "title": "Translation Memory Search Settings", "type": "object", "properties": { "minimumMatchValue": { "type": "integer", "description": "This is the degree of match that must exist between a source document segment and a translation memory segment in order for the segment translation to be offered as a match. The default is 70%, but you can set a value between 30% and 100%.\r\n\r\nThe selected value is inclusive, meaning that matches with your exact selected value are also included in translation results.", "minimum": 30, "maximum": 100, "default": 70 }, "penalties": { "$ref": "#/components/schemas/translation-search-TM-penalties" } } }, "concordance-search-settings-tm": { "title": "Translation Memory Concordance Search Settings", "type": "object", "properties": { "minimumMatchValue": { "type": "integer", "description": "This is the degree of match that must exist between a source document segment and a translation memory segment in order for the segment translation to be offered as a match. The default is 70%, but you can set a value between 30% and 100%.\r\n\r\nThe selected value is inclusive, meaning that matches with your exact selected value are also included in translation results.", "minimum": 30, "maximum": 100, "default": 70 }, "penalties": { "$ref": "#/components/schemas/concordance-search-TM-penalties" } } }, "translation-search-standard-penalties": { "title": "Translation Memory Standard Penalties", "type": "object", "properties": { "missingFormatting": { "type": "integer", "minimum": 0, "maximum": 20, "default": 1 }, "differentFormatting": { "type": "integer", "default": 1, "minimum": 0, "maximum": 20 }, "multipleTranslations": { "type": "integer", "default": 1, "minimum": 0, "maximum": 20 }, "autoLocalization": { "type": "integer", "default": 0, "minimum": 0, "maximum": 20 }, "textReplacement": { "type": "integer", "default": 0, "minimum": 0, "maximum": 20 }, "alignment": { "type": "integer", "default": 1, "minimum": 0, "maximum": 20 }, "characterWidthDifference": { "type": "integer", "default": 1, "minimum": 0, "maximum": 20 } }, "description": "" }, "translation-search-unit-status-penalties": { "title": "Translation Unit Status Penalties", "type": "object", "description": "The penalties to apply depending on the status of the translation unit.", "properties": { "translated": { "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "translationRejected": { "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "translationApproved": { "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "signOffRejected": { "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "signOff": { "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "notTranslated": { "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "draft": { "type": "integer", "minimum": 0, "maximum": 20, "default": 0 } } }, "translation-concordance-search-standard-penalties": { "title": "Translation Memory Concordance Standard Penalties", "type": "object", "properties": { "alignment": { "type": "integer", "default": 1, "minimum": 0, "maximum": 20 }, "characterWidthDifference": { "type": "integer", "default": 1, "minimum": 0, "maximum": 20 } }, "description": "" }, "translation-concordance-search-unit-status-penalties": { "title": "Translation Unit Status Concordance Penalties", "type": "object", "description": "The penalties to apply depending on the status of the translation unit.", "properties": { "translated": { "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "translationRejected": { "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "translationApproved": { "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "signOffRejected": { "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "signOff": { "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "notTranslated": { "type": "integer", "minimum": 0, "maximum": 20, "default": 0 }, "draft": { "type": "integer", "minimum": 0, "maximum": 20, "default": 0 } } }, "translation-search-TM-penalties": { "title": "Translation TM Penalties", "type": "object", "properties": { "standardPenalties": { "$ref": "#/components/schemas/translation-search-standard-penalties" }, "translationUnitStatusPenalties": { "$ref": "#/components/schemas/translation-search-unit-status-penalties" } } }, "concordance-search-TM-penalties": { "title": "Concordance Search TM Penalties", "type": "object", "properties": { "standardPenalties": { "$ref": "#/components/schemas/translation-concordance-search-standard-penalties" }, "translationUnitStatusPenalties": { "$ref": "#/components/schemas/translation-concordance-search-unit-status-penalties" } } }, "language-direction-general-request": { "title": "Language Direction General Request", "type": "object", "description": "The language directions model used for creating or updating a resource.", "properties": { "sourceLanguage": { "$ref": "#/components/schemas/source-language-request" }, "targetLanguage": { "$ref": "#/components/schemas/target-language-request" } } }, "translation-lookup-input-request": { "title": "Translation Lookup Input Request", "type": "object", "description": "The translation input.", "required": [ "content", "contentType" ], "properties": { "content": { "type": [ "string" ], "description": "A plain text phrase or a BCM fragment with a single segment serialized as JSON string." }, "contentType": { "type": "string", "enum": [ "text", "bcmFragment" ], "description": "The content type." } } }, "translation-concordance-input-request": { "title": "Translation Concordance Input Request", "type": "object", "required": [ "content" ], "properties": { "content": { "type": "string", "description": "Text to search for." } } }, "translation-tu-update-input-request": { "title": "Translation TU Input Request", "type": "object", "required": [ "content" ], "properties": { "content": { "type": "string", "description": "The Translation Unit update content as a BCM fragment serialized in JSON string." } } }, "zip-file-export-request": { "title": "Export Project Files Request", "type": "object", "properties": { "referenceFiles": { "$ref": "#/components/schemas/zip-file-export-reference-files-request" }, "targetFiles": { "$ref": "#/components/schemas/zip-file-export-target-files-request" } } }, "zip-file-export-reference-files-request": { "title": "Export Project Reference Files Request", "type": "object", "description": "Reference files associated with the project.", "properties": { "include": { "type": "boolean", "description": "Add reference files to the export package.", "default": true } } }, "zip-file-export-target-files-request": { "title": "Export Project Target Files Request", "type": "object", "description": "Target files associated with the project.", "properties": { "includeVersions": { "type": "string", "enum": [ "currentVersion", "none", "nativeVersion" ], "description": "Include target files with these versions into the export.", "default": "currentVersion" }, "targetLanguages": { "type": "array", "description": "Include target files for the specified languages (e.g., 'en-US', 'de-DE'). Only one target language is supported when `downloadFlat` is set to `true`.", "items": { "type": "string" } }, "downloadFlat": { "type": "boolean", "description": "If this flag is set to `true`, folder structure will reflect exactly the file paths. If the flag is set to `false`, a ZIP folder will be generated with a structure similar to the one provided by Trados.", "default": false } } }, "zip-file-export-response": { "title": "Project Files export poll response", "type": "object", "required": [ "exportId", "state" ], "properties": { "exportId": { "type": "string", "description": "The identifier of the export operation" }, "state": { "type": "string", "description": "The status of the export", "default": "created", "enum": [ "created", "processing", "done", "error" ] } } }, "application": { "title": "Application", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The application identifier." }, "name": { "type": "string", "description": "
default
The application name.
", "x-default-field": true }, "description": { "type": "string", "description": "The application description." }, "enableApiAccess": { "type": "boolean", "description": "Is oAuth 2.0 API access enabled." }, "serviceUser": { "$ref": "#/components/schemas/user", "description": "The Service User associated with this application." }, "apiAccess": { "type": "object", "description": "API Access details.", "required": [ "clientId" ], "properties": { "clientId": { "type": "string", "description": "The client identifier." }, "clientSecret": { "type": "string", "description": "The client secret." } } } } } }, "parameters": { "export-format": { "name": "format", "in": "query", "schema": { "type": "string", "default": "native", "enum": [ "native", "sdlxliff" ] }, "description": "The file format." }, "quote-report-format": { "name": "format", "in": "query", "schema": { "type": "string", "default": "pdf", "enum": [ "pdf", "excel" ] }, "description": "The file format of the quote report." }, "X-LC-Tenant": { "name": "X-LC-Tenant", "in": "header", "description": "The identifier of the account where the request is executed.", "schema": { "type": "string" }, "required": true }, "Authorization": { "name": "Authorization", "in": "header", "description": "The bearer access token provided by Auth0.", "schema": { "type": "string" }, "required": true }, "top": { "name": "top", "in": "query", "description": "The number of items to include inside the page.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "default": 100 } }, "skip": { "name": "skip", "in": "query", "description": "The number of items that are skipped to reach the desired page.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, "location": { "name": "location", "in": "query", "description": "The identifiers of the resource folders. You can control the behavior by using the 'locationStrategy'. ", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, "location-strategy": { "name": "locationStrategy", "in": "query", "description": "Options:
- `location`: all the resources located strictly in the folders from the 'location' parameter (default);
- `lineage`: all the resources located in the folders specified in the 'location' parameter, as well as the subfolders;
- `bloodline`: all the resources located in the folders specified in the 'location' parameter, as well as the ancestor folders;
- `genealogy`: the resources located in the folders specified in the 'location' parameter together with subfolders and ancestors.", "schema": { "type": "string", "enum": [ "location", "lineage", "bloodline", "genealogy" ] } }, "sort": { "name": "sort", "in": "query", "description": "A comma separated list of fields used to sort the resources in the response. Each field can have a unary negative to imply descending sort order.", "schema": { "type": "string" } }, "fields": { "name": "fields", "in": "query", "description": "A comma separated list of fields to include in the response.\n Every value in the list should either consist of a top-level property name (excluding the items envelope for endpoints returning lists) or refer to a property of a top-level property of type object, in the following form: \"toplevelpropertyname.subpropertyname\".\n When this query parameter is omitted, default resource representations are returned (excluding fields marked as optional). The same applies to nested objects when just specifying the top-level property name, without explicitly listing sub-property names. When specifying the fields query parameter, only the specified fields are returned.\n The id property is always returned.", "schema": { "type": "string" } }, "email": { "name": "email", "in": "query", "description": "The exact match of the email, used to filter the response list.", "schema": { "type": "string" } }, "resourceType": { "name": "resourceType", "in": "query", "required": false, "description": "Filters the custom field definitions by the resource type they apply to.", "schema": { "type": "string", "enum": [ "project", "customer", "vendor", "vendorOrderTemplate" ] } }, "customerId": { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The customer identifier." }, "projectId": { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The project identifier." }, "taskId": { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task identifier." }, "sourceFileId": { "name": "sourceFileId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The source file identifier." }, "targetFileId": { "name": "targetFileId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The target file identifier." }, "exportId": { "name": "exportId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The export identifier." }, "projectTemplateId": { "name": "projectTemplateId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The project template identifier." }, "fileVersionId": { "name": "fileVersionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The file version identifier." }, "taskTypeId": { "name": "taskTypeId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The task type identifier." }, "workflowId": { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The workflow identifier." }, "fileProcessingConfigurationId": { "name": "fileProcessingConfigurationId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The file processing configuration identifier." }, "translationEngineId": { "name": "translationEngineId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The translation engine identifier." }, "pricingModelId": { "name": "pricingModelId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The pricing model identifier." }, "folderId": { "name": "folderId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The folder identifier." }, "groupId": { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The group identifier." }, "importId": { "name": "importId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The import identifier." }, "fileId": { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The file identifier." }, "customFieldDefinitionId": { "name": "customFieldDefinitionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The custom field definition identifier." }, "profileId": { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The profile identifier." }, "language-id": { "name": "languageId", "in": "query", "description": "The language used for localization.", "schema": { "type": "string", "default": "en" } }, "userId": { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The user identifier." }, "name": { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filter by name." }, "termbaseTemplateId": { "name": "termbaseTemplateId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The termbase template identifier." }, "termbaseId": { "name": "termbaseId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The termbase identifier." }, "translationMemoryId": { "name": "translationMemoryId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The translation memory identifier." }, "entryId": { "name": "entryId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The termbase entry identifier." }, "humanReadableIds": { "name": "humanReadableIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "description": "Can provide a list of humanReadableId from entries to filter by." }, "applicationId": { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The application identifier." } }, "headers": { "X-LC-TraceId": { "required": true, "schema": { "type": "string", "example": "df680285-adcd-4bda-8f79-0bba4a857287" }, "description": "A unique identifier for the request. It should be saved in the logs as it can be used to troubleshoot potential issues. When raising a request for support, it should be provided to help with the investigation." } } } }