{ "openapi": "3.1.0", "info": { "title": "Trados Data Bridge API", "version": "1.0", "description": "The Trados Data Bridge API.", "contact": {} }, "servers": [ { "url": "https://api.eu.cloud.trados.com/data-api/v1", "description": "EU Region Server" }, { "url": "https://api.ca.cloud.trados.com/data-api/v1", "description": "CA Region Server" } ], "tags": [ { "name": "File Translation Status Data Set", "description": "File Translation Status Data Set" }, { "name": "Language Revenue Details Data Set", "description": "Language Revenue Details Data Set" }, { "name": "Language Revenues Data Set", "description": "Language Revenues Data Set" }, { "name": "Task Status Data Set", "description": "Task Status Data Set" }, { "name": "Translation Leverage Data Set", "description": "Translation Leverage Data Set" }, { "name": "Translation Quality Evaluation Data Set", "description": "Translation Quality Evaluation Data Set" }, { "name": "Vendor Costs Data Set", "description": "Vendor Costs Data Set" } ], "paths": { "/fts/file-translation-statuses": { "get": { "summary": "List File Translation Metrics", "tags": [ "File Translation Status Data Set" ], "operationId": "ListFileTranslationMetrics", "description": "Endpoint to fetch file translation status metrics, including item count and details.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/expand" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/fact-fts" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } }, "parameters": [] }, "/fts/projects": { "get": { "summary": "List FTS Project Dimension", "tags": [ "File Translation Status Data Set" ], "operationId": "ListFTSProjectDimension", "description": "Retrieves the project dimension present in the file translation status dataset.", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "number", "default": 0 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-project" } } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ] } }, "/fts/customers": { "get": { "summary": "List FTS Customer Dimension", "operationId": "ListFTSCustomerDimension", "tags": [ "File Translation Status Data Set" ], "description": "Retrieves the customer dimension present in the file translation status dataset.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-customer" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/fts/language-pairs": { "get": { "summary": "List FTS Language Pair Dimension", "tags": [ "File Translation Status Data Set" ], "operationId": "ListFTSLanguagePairDimension", "description": "Retrieves the language pair dimension present in the file translation status dataset.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-language-pair" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/fts/source-files": { "get": { "summary": "List FTS Source File Dimension", "tags": [ "File Translation Status Data Set" ], "operationId": "ListFTSSourceFileDimension", "description": "Retrieves the source file dimension present in the file translation status dataset.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-source-file" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/fts/project-creation-dates": { "get": { "summary": "List FTS Project Creation Date Dimension", "tags": [ "File Translation Status Data Set" ], "operationId": "ListFTSProjectCreationDateDimension", "description": "Retrieves the project creation date dimension present in the file translation status dataset.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-date" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/fts/translation-dates": { "get": { "summary": "List FTS Translation Date Dimension", "tags": [ "File Translation Status Data Set" ], "operationId": "ListFTSTranslationDateDimension", "description": "Retrieves the translation date dimension present in the file translation status dataset.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-date" } } } } } }, "description": "" }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/fts/translators": { "get": { "summary": "List FTS Translator Dimension", "tags": [ "File Translation Status Data Set" ], "operationId": "ListFTSTranslatorDimension", "description": "Retrieves the translator dimension present in the file translation status dataset.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-translator" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/fts/review-dates": { "get": { "summary": "List FTS Review Date Dimension", "tags": [ "File Translation Status Data Set" ], "operationId": "ListFTSReviewDateDimension", "description": "Retrieves the review date dimension present in the file translation status dataset.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-date" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/fts/reviewers": { "get": { "summary": "List FTS Reviewer Dimension", "tags": [ "File Translation Status Data Set" ], "operationId": "ListFTSReviewerDimension", "description": "Retrieves the linguistic reviewer dimension present in the file translation status dataset.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-reviewer" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/fts/customer-review-dates": { "get": { "summary": "List FTS Customer Review Date Dimension", "tags": [ "File Translation Status Data Set" ], "operationId": "ListFTSCustomerReviewDateDimension", "description": "Retrieves the customer review date dimension present in the file translation status dataset.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-date" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/fts/customer-reviewers": { "get": { "summary": "List FTS Customer Reviewer Dimension", "tags": [ "File Translation Status Data Set" ], "operationId": "ListFTSCustomerReviewerDimension", "description": "Retrieves the customer reviewer dimension present in the file translation status dataset.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-customer-reviewer" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/fts/finalization-dates": { "get": { "summary": "List FTS Finalization Date Dimension", "tags": [ "File Translation Status Data Set" ], "operationId": "ListFTSFinalizationDateDimension", "description": "Retrieves the finalization date dimension present in the file translation status dataset.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-date" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/task-status/task-statuses": { "get": { "summary": "List Task Status Metrics", "operationId": "ListTaskStatusMetrics", "description": "Endpoint to fetch task status metrics.\r\n\r\n", "tags": [ "Task Status Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/expand" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/fact-task-status" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/task-status/customers": { "get": { "summary": "List Task Status Customer Dimension", "operationId": "ListTaskStatusCustomerDimension", "description": "Retrieves the customer dimension present in the Task Status dataset.\r\n\r\n", "tags": [ "Task Status Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-customer" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/task-status/language-pairs": { "get": { "summary": "List Task Status Language Pair Dimension", "operationId": "ListTaskStatusLanguagePairDimension", "description": "Retrieves the language pair dimension present in the Task Status dataset.\r\n\r\n", "tags": [ "Task Status Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-language-pair" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/task-status/projects": { "get": { "summary": "List Task Status Project Dimension", "operationId": "ListTaskStatusProjectDimension", "description": "Retrieves the project dimension present in task status dataset.\r\n\r\n", "tags": [ "Task Status Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "$ref": "#/components/schemas/dim-project" } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/task-status/source-files": { "get": { "summary": "List Task Status Source File Dimension", "operationId": "ListTaskStatusSourceFileDimension", "description": "Retrieves the source file dimension present in the Task Status dataset.\r\n\r\n", "tags": [ "Task Status Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-source-file" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/task-status/task-owners": { "get": { "summary": "List Task Status Task Owner Dimension", "operationId": "ListTaskStatusTaskOwnerDimension", "description": "Retrieves the task owner dimension present in the Task Status dataset.\r\n", "tags": [ "Task Status Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-owner" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/task-status/task-types": { "get": { "summary": "List Task Status Task Type Dimension", "operationId": "ListTaskStatusTaskTypeDimension", "description": "Retrieves the task types dimension present in the Task Status dataset.\r\n", "tags": [ "Task Status Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-task-types" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/task-status/task-states": { "get": { "summary": "List Task Status Task State Dimension", "operationId": "ListTaskStatusTaskStateDimension", "description": "Retrieves the task states dimension present in the Task Status dataset.\r\n", "tags": [ "Task Status Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-task-states" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/vendor-costs/vendor-costs": { "get": { "summary": "List Vendor Costs Metrics", "operationId": "ListVendorCostsMetrics", "description": "Endpoint to fetch vendor costs metrics, including item count and details", "tags": [ "Vendor Costs Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/expand" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/fact-vendor-costs" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/vendor-costs/projects": { "get": { "summary": "List Vendor Costs Project Dimension", "operationId": "ListVendorCostsProjectDimension", "description": "Retrieves the project dimensions present in the vendor costs dataset.\r\n\r\n", "tags": [ "Vendor Costs Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "$ref": "#/components/schemas/dim-project" } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/vendor-costs/customers": { "get": { "summary": "List Vendor Costs Customer Dimension", "operationId": "ListVendorCostsCustomerDimension", "description": "Retrieves the customer dimensions present in the vendor costs dataset.\r\n\r\n", "tags": [ "Vendor Costs Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-customer" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/vendor-costs/language-pairs": { "get": { "summary": "List Vendor Costs Language Pair Dimension", "operationId": "ListVendorCostsLanguagePairDimension", "description": "Retrieves the language pair dimension present in the vendor costs dataset.\r\n\r\n", "tags": [ "Vendor Costs Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-language-pair" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/vendor-costs/currencies": { "get": { "summary": "List Vendor Costs Currency Dimension", "operationId": "ListVendorCostsCurrencyDimension", "description": "Retrieves the currency dimension present in the vendor costs dataset.\r\n\r\n", "tags": [ "Vendor Costs Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/X-LC-Tenant" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-currency" } } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/vendor-costs/vendor-order-templates": { "get": { "summary": "List Vendor Costs Order Template Dimension", "operationId": "ListVendorCostsOrderTemplateDimension", "description": "Retrieves the vendor order template dimension present in the vendor costs dataset.\r\n", "tags": [ "Vendor Costs Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-vendor-order-template" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/vendor-costs/service-types": { "get": { "summary": "List Vendor Costs Service Type Dimension", "operationId": "ListVendorCostsServiceTypeDimension", "description": "Retrieves the service types dimension present in the vendor costs dataset.\r\n", "tags": [ "Vendor Costs Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-service-types" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/tqe/translation-quality-evaluations": { "get": { "summary": "List Translation Quality Evaluation Metrics", "operationId": "ListTranslationQualityEvaluationMetrics", "tags": [ "Translation Quality Evaluation Data Set" ], "description": "Endpoint to fetch translation quality evaluation (TQE) metrics.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/expand" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/fact-tqe" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/tqe/projects": { "get": { "summary": "List TQE Project Dimension", "tags": [ "Translation Quality Evaluation Data Set" ], "operationId": "ListTQEProjectDimension", "description": "Retrieves the project dimension present in the Translation Quality Evaluation(TQE) dataset.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-project" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/tqe/customers": { "get": { "summary": "List TQE Customer Dimension", "operationId": "ListTQECustomerDimension", "tags": [ "Translation Quality Evaluation Data Set" ], "description": "Retrieves the customer dimension present in the Translation Quality Evaluation(TQE) dataset.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-customer" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/tqe/language-pairs": { "get": { "summary": "List TQE Language Pair Dimension", "tags": [ "Translation Quality Evaluation Data Set" ], "operationId": "ListTQELanguagePairDimension", "description": "Retrieves the language pair dimension present in the Translation Quality Evaluation(TQE) dataset.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-language-pair" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/tqe/source-files": { "get": { "summary": "List TQE Source File Dimension", "tags": [ "Translation Quality Evaluation Data Set" ], "operationId": "ListTQESourceFileDimension", "description": "Retrieves the source file dimension present in the Translation Quality Evaluation(TQE) dataset.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-source-file" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/tqe/linguists": { "get": { "summary": "List TQE Linguist Dimension", "operationId": "ListTQELinguistDimension", "description": "Retrieves the Linguist dimension present in the Translation Quality Evaluation(TQE) dataset.", "tags": [ "Translation Quality Evaluation Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-linguist" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/tqe/final-translation-origins": { "get": { "summary": "List TQE Final Translation Origin Dimension", "operationId": "ListTQEFinalTranslationOriginDimension", "description": "Retrieves the Final Translation origin dimension present in the Translation Quality Evaluation(TQE) dataset.", "tags": [ "Translation Quality Evaluation Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "description": "Final Translation Origin dimension\r\n\r\n", "items": { "$ref": "#/components/schemas/dim-translation-origin" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/tqe/original-translation-origins": { "get": { "summary": "List TQE Original Translation Origin Dimension", "operationId": "ListTQEOriginalTranslationOriginDimension", "description": "Retrieves the Original Translation origin dimension present in the Translation Quality Evaluation(TQE) dataset.", "tags": [ "Translation Quality Evaluation Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "description": "Original Translation Origin dimension\r\n\r\n", "items": { "$ref": "#/components/schemas/dim-translation-origin" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/tqe/translation-quality-evaluation-categories": { "get": { "summary": "List TQE Evaluation Category Dimension", "operationId": "ListTQEEvaluationCategoryDimension", "description": "Retrieves the Translation Quality Evaluation Category dimension present in the Translation Quality Evaluation(TQE) dataset.", "tags": [ "Translation Quality Evaluation Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-tqe-category" } } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } } } }, "/tqe/task-types": { "get": { "summary": "List TQE Task Type Dimension", "operationId": "ListTQETaskTypeDimension", "description": "Retrieves the Task Types dimension present in the Translation Quality Evaluation(TQE) dataset.", "tags": [ "Translation Quality Evaluation Data Set" ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-task-types" } } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/language-revenue-details/language-revenue-details": { "get": { "summary": "List Language Revenue Details Metrics", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/fact-language-revenue-details" } } } }, "examples": { "Example 1": { "value": { "itemCount": "string", "items": [ { "quoteDateId": 20240203, "customerId": 132445, "projectId": 123467, "languagePairId": 678954, "revenueTypeId": 23940, "currencyId": 59, "projectCreationDateId": 20240202, "numberOfUnits": 100, "revenue": 0.7 } ] } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListLanguageRevenueDetailsMetrics", "description": "Retrieves the revenue details metrics present in the language revenue details dataset.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/expand" } ], "tags": [ "Language Revenue Details Data Set" ] } }, "/language-revenue-details/projects": { "get": { "summary": "List Language Revenue Details Project Dimension", "tags": [ "Language Revenue Details Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-project" } } } }, "examples": { "Example 1": { "value": { "itemCount": 1, "items": [ { "internalId": 11, "projectId": "uuid", "projectShortId": 11, "projectName": "Test", "projectDescription": "", "projectLocationId": "3f7e792b23d5494f8ce8fb73f796dbc7", "projectGroupId": "groupid", "projectGroupShortId": 1, "projectGroupName": "Test group", "projectStatus": "in_progress", "projectTemplateId": "templateuuid", "projectTemplateName": "Template test", "originSystem": "LCUI", "sourceLanguage": "en-EN", "targetLanguages": "fr-FR", "createdAt": "2023-11-21T09:59:54Z", "quoteCreatedAt": "9999-12-31T00:00:00Z", "quoteApprovedAt": "2499-12-31T00:00:00Z", "completedAt": "2499-12-31T00:00:00Z", "dueAt": "2023-11-28T11:00:36Z", "deliveredAt": "9999-12-31T00:00:00Z", "projectSegmentCount": 6, "projectWordCount": 21, "projectCharacterCount": 70, "projectFileCount": 1, "projectRevenue": 0, "projectSavings": 0, "projectCurrencyCode": "EUR", "deliveryTimeDiff": 0, "onTimeStatus": "VERY_EARLY", "projectCreatorName": "Test", "projectCreatorId": "31231231231", "deleted": false, "customFields": "cf1=abc" } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListLanguageRevenueDetailsProjectDimension", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "description": "Retrieves the projects present in the language revenue details dataset." } }, "/language-revenue-details/customers": { "get": { "summary": "List Language Revenue Details Customer Dimension", "tags": [ "Language Revenue Details Data Set" ], "responses": { "200": { "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-customer" } } } }, "examples": { "Example 1": { "value": { "itemCount": 1, "items": [ { "internalId": 123, "customerId": "abc123abc123abc123", "customerLocationId": "locationid", "customerName": "Customer name", "createdBy": "N/A", "createdAt": "2023-04-11T10:30:50Z", "keyContactId": "contactId", "keyContactEmail": "contact email", "ragStatusName": "Green", "customFields": "custom field=abc", "deleted": false } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListLanguageRevenueDetailsCustomerDimension", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "description": "Retrieves the customers present in the language revenue details dataset." }, "parameters": [] }, "/language-revenue-details/language-pairs": { "get": { "summary": "List Language Revenue Details Language Pair Dimension", "tags": [ "Language Revenue Details Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-language-pair" } } } }, "examples": { "Example 1": { "value": { "itemCount": 1, "items": [ { "internalId": 1, "sourceLanguageCode": "en-GI", "sourceEnglishName": "English (Gibraltar)", "sourceParentLanguageCode": "en", "targetLanguageCode": "tk", "targetEnglishName": "Turkmen", "targetParentLanguageCode": "N/A" } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListLanguageRevenueDetailsLanguagePairDimension", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "description": "Retrieves the language pairs present in the language revenue details dataset." } }, "/language-revenue-details/revenue-types": { "get": { "summary": "List Language Revenue Details Revenue Type Dimension", "tags": [ "Language Revenue Details Data Set" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-revenue-type" } } } }, "examples": { "Example 1": { "value": { "itemCount": 0, "items": [ { "internalId": 2, "name": "0.25 hours for minimum charge", "category": "language", "type": "Hourly", "unit": "Hour" } ] } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListLanguageRevenueDetailsRevenueTypeDimension", "description": "Retrieves the revenue types present in the language revenue details dataset.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ] }, "parameters": [] }, "/language-revenue-details/quote-dates": { "get": { "summary": "List Language Revenue Details Quote Date Dimension", "tags": [ "Language Revenue Details Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-date" } } } }, "examples": { "Example 1": { "value": { "itemCount": 1, "items": [ { "internalId": 20000101, "year": 2000, "month": 1, "day": 1, "dayOfWeek": 7, "dayOfWeekName": "Saturday", "monthName": "January", "dayOfYear": 1, "quarter": 1, "yearNumber": "2000", "monthNumber": "1", "fullDate": "2000-01-01" } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListLanguageRevenueDetailsQuoteDateDimension", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "description": "Retrieves the quote dates present in the language revenue details dataset." } }, "/language-revenue-details/project-creation-dates": { "get": { "summary": "List Language Revenue Details Project Creation Date Dimension", "tags": [ "Language Revenue Details Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-date" } } } }, "examples": { "Example 1": { "value": { "itemCount": 1, "items": [ { "internalId": 20000101, "year": 2000, "month": 1, "day": 1, "dayOfWeek": 7, "dayOfWeekName": "Saturday", "monthName": "January", "dayOfYear": 1, "quarter": 1, "yearNumber": "2000", "monthNumber": "1", "fullDate": "2000-01-01" } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListLanguageRevenueDetailsProjectCreationDateDimension", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "description": "Retrieves the project creation dates present in the language revenue details dataset." } }, "/language-revenue-details/currencies": { "get": { "summary": "List Language Revenue Details Currency Dimension", "tags": [ "Language Revenue Details Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-currency" } } } }, "examples": { "Example 1": { "value": { "itemCount": 1, "items": [ { "internalId": 698582, "name": "Euro", "code": "EUR", "symbol": "€" } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListLanguageRevenueDetailsCurrencyDimension", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "description": "Retrieves the currencies present in the language revenue details dataset." } }, "/language-revenues/customers": { "get": { "summary": "List Language Revenues Customer Dimension", "tags": [ "Language Revenues Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-customer" } } } }, "examples": { "Example 1": { "value": { "itemCount": 1, "items": [ { "internalId": 123, "customerId": "abc123abc123abc123", "customerLocationId": "locationid", "customerName": "Customer name", "createdBy": "N/A", "createdAt": "2023-04-11T10:30:50Z", "keyContactId": "contactId", "keyContactEmail": "contact email", "ragStatusName": "Green", "customFields": "custom field=abc", "deleted": false } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListLanguageRevenuesCustomerDimension", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "description": "Retrieves the customers present in the language revenues dataset." } }, "/language-revenues/projects": { "get": { "summary": "List Language Revenues Projects Dimension", "tags": [ "Language Revenues Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-project" } } } }, "examples": { "Example 1": { "value": { "itemCount": 1, "items": [ { "internalId": 11, "projectId": "uuid", "projectShortId": 11, "projectName": "Test", "projectDescription": "", "projectLocationId": "3f7e792b23d5494f8ce8fb73f796dbc7", "projectGroupId": "groupid", "projectGroupShortId": 1, "projectGroupName": "Test group", "projectStatus": "in_progress", "projectTemplateId": "templateuuid", "projectTemplateName": "Template test", "originSystem": "LCUI", "sourceLanguage": "en-EN", "targetLanguages": "fr-FR", "createdAt": "2023-11-21T09:59:54Z", "quoteCreatedAt": "9999-12-31T00:00:00Z", "quoteApprovedAt": "2499-12-31T00:00:00Z", "completedAt": "2499-12-31T00:00:00Z", "dueAt": "2023-11-28T11:00:36Z", "deliveredAt": "9999-12-31T00:00:00Z", "projectSegmentCount": 6, "projectWordCount": 21, "projectCharacterCount": 70, "projectFileCount": 1, "projectRevenue": 0, "projectSavings": 0, "projectCurrencyCode": "EUR", "deliveryTimeDiff": 0, "onTimeStatus": "VERY_EARLY", "projectCreatorName": "Test", "projectCreatorId": "31231231231", "deleted": false, "customFields": "cf=abc" } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListLanguageRevenuesProjectsDimension", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "description": "Retrieves the projects present in the language revenues dataset." } }, "/language-revenues/language-pairs": { "get": { "summary": "List Language Revenues Language Pair Dimension", "tags": [ "Language Revenues Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-language-pair" } } } }, "examples": { "Example 1": { "value": { "itemCount": 1, "items": [ { "internalId": 123, "sourceLanguageCode": "en-US", "sourceEnglishName": "English (United States)", "sourceParentLanguageCode": "en", "targetLanguageCode": "ro-RO", "targetEnglishName": "Româna(România)", "targetParentLanguageCode": "ro" } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListLanguageRevenuesLanguagePairDimension", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "description": "Retrieves the language pairs present in the language revenues dataset." } }, "/language-revenues/approve-dates": { "get": { "summary": "List Language Revenues Approve Date Dimension", "tags": [ "Language Revenues Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-date" } } } }, "examples": { "Example 1": { "value": { "itemCount": 1, "items": [ { "internalId": 20240203, "year": 2024, "month": 2, "day": 3, "dayOfWeek": 7, "dayOfWeekName": "Saturday", "monthName": "February", "dayOfYear": 34, "quarter": 1, "yearNumber": "2024", "monthNumber": "02", "fullDate": "2024-02-04" } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListLanguageRevenuesApproveDateDimension", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "description": "Retrieves the approve dates present in the language revenues dataset." } }, "/language-revenues/quote-dates": { "get": { "summary": "List Language Revenues Quote Date Dimension", "tags": [ "Language Revenues Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-date" } } } }, "examples": { "Example 1": { "value": { "itemCount": 1, "items": [ { "internalId": 20240203, "year": 2024, "month": 2, "day": 3, "dayOfWeek": 7, "dayOfWeekName": "Saturday", "monthName": "February", "dayOfYear": 34, "quarter": 1, "yearNumber": "2024", "monthNumber": "02", "fullDate": "2024-02-04" } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListLanguageRevenuesQuoteDateDimension", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "description": "Retrieves the quote dates present in the language revenues dataset." } }, "/language-revenues/language-revenues": { "get": { "summary": "List Language Revenues Metrics", "tags": [ "Language Revenues Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/fact-language-revenues" } } } }, "examples": { "Example 1": { "value": { "itemCount": 0, "items": [ { "customerId": 123, "projectId": 23432, "languagePairId": 34890, "approveDateId": 20240129, "currencyId": 453290, "quoteApproverId": 810908, "quoteDateId": 20240128, "translationPrice": 120.3, "languagePrice": 30.21, "projectAdditionalPrice": 0.39, "totalRevenue": 150.9, "savings": 12.44, "wordCount": 230, "files": 1 } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListLanguageRevenuesMetrics", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/expand" } ], "description": "Retrieves the revenue metrics present in the language revenues dataset." } }, "/language-revenues/currencies": { "get": { "summary": "List Language Revenues Currency Dimension", "tags": [ "Language Revenues Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-currency" } } } }, "examples": { "Example 1": { "value": { "itemCount": 1, "items": [ { "internalId": 21389, "name": "US Dollar", "code": "USD", "symbol": "$" } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListLanguageRevenuesCurrencyDimension", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "description": "Retrieves the currencies present in the language revenues dataset." } }, "/language-revenues/quote-approver": { "get": { "summary": "List Language Revenue Quote Approver", "tags": [ "Language Revenues Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-quote-approver" } } } }, "examples": { "Example 1": { "value": { "itemCount": 0, "items": [ { "internalId": 1234567, "accountUserId": "423e18f01573f2d6", "accountId": "d65315e82ec604b7", "accountName": "Test Account", "firstName": "First", "lastName": "Last", "userEmail": "user@example.com", "accountUserLocationId": "57d39d0b88319631", "membership": "MEMBER", "status": "ACTIVE", "authorId": "5cba149cb5f78fe6", "creationDate": "2023-01-01T00:00:00Z", "lastModificationDate": "2024-01-01T00:00:00Z", "deletionDate": "9999-12-31T00:00:00Z", "vendorId": "N/A", "vendorName": "N/A", "deleted": false } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListLanguageRevenueQuoteApprover", "description": "Retrieves the quote approvers present in the language revenues dataset.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ] } }, "/translation-leverages/translation-leverages": { "get": { "summary": "List Translation Leverages Metrics", "tags": [ "Translation Leverage Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/fact-translation-leverage" } } } }, "examples": { "Example 1": { "value": { "itemCount": 0, "items": [ { "translationDateId": 20240101, "translationTime": 1435, "accountId": 123, "projectId": 122, "customerId": 1234, "languagePairId": 810908, "sourceFileId": 20240128, "bandId": 120, "characterCount": 30, "wordCount": 39, "segmentCount": 150, "bandCharacters": 12, "bandWords": 14, "bandSegments": 1, "canceled": false } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListTranslationLeveragesMetrics", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/expand" } ], "description": "Retrieves the translation leverages metrics present in the translation leverages dataset." } }, "/translation-leverages/translation-dates": { "get": { "summary": "List Translation Leverages Translation Dates", "tags": [ "Translation Leverage Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-date" } } } }, "examples": { "Example 1": { "value": { "itemCount": 1, "items": [ { "internalId": 20240203, "year": 2024, "month": 2, "day": 3, "dayOfWeek": 7, "dayOfWeekName": "Saturday", "monthName": "February", "dayOfYear": 34, "quarter": 1, "yearNumber": "2024", "monthNumber": "02", "fullDate": "2024-02-04" } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListTranslationLeveragesTranslationDates", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "description": "Retrieves the translation dates present in the translation leverages dataset." } }, "/translation-leverages/projects": { "get": { "summary": "List Translations Leverages Projects", "tags": [ "Translation Leverage Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-project" } } } }, "examples": { "Example 1": { "value": { "itemCount": 1, "items": [ { "internalId": 11, "projectId": "uuid", "projectShortId": 11, "projectName": "Test", "projectDescription": "", "projectLocationId": "3f7e792b23d5494f8ce8fb73f796dbc7", "projectGroupId": "groupid", "projectGroupShortId": 1, "projectGroupName": "Test group", "projectStatus": "in_progress", "projectTemplateId": "templateuuid", "projectTemplateName": "Template test", "originSystem": "LCUI", "sourceLanguage": "en-EN", "targetLanguages": "fr-FR", "createdAt": "2023-11-21T09:59:54Z", "quoteCreatedAt": "9999-12-31T00:00:00Z", "quoteApprovedAt": "2499-12-31T00:00:00Z", "completedAt": "2499-12-31T00:00:00Z", "dueAt": "2023-11-28T11:00:36Z", "deliveredAt": "9999-12-31T00:00:00Z", "projectSegmentCount": 6, "projectWordCount": 21, "projectCharacterCount": 70, "projectFileCount": 1, "projectRevenue": 0, "projectSavings": 0, "projectCurrencyCode": "EUR", "deliveryTimeDiff": 0, "onTimeStatus": "VERY_EARLY", "projectCreatorName": "Test", "projectCreatorId": "31231231231", "deleted": false, "customFields": "cf=abc" } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListTranslationsLeveragesProjects", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "description": "Retrieves the project dimension present in the translation leverages dataset." } }, "/translation-leverages/customers": { "get": { "summary": "List Translations Leverages Customers", "tags": [ "Translation Leverage Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-customer" } } } }, "examples": { "Example 1": { "value": { "itemCount": 1, "items": [ { "internalId": 123, "customerId": "abc123abc123abc123", "customerLocationId": "locationid", "customerName": "Customer name", "createdBy": "N/A", "createdAt": "2023-04-11T10:30:50Z", "keyContactId": "contactId", "keyContactEmail": "contact email", "ragStatusName": "Green", "customFields": "custom field=abc", "deleted": false } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListTranslationsLeveragesCustomers", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "description": "Retrieves the customers dimension present in the translation leverages dataset." } }, "/translation-leverages/language-pairs": { "get": { "summary": "List Translations Leverages Language Pairs", "tags": [ "Translation Leverage Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-language-pair" } } } }, "examples": { "Example 1": { "value": { "itemCount": 1, "items": [ { "internalId": 123, "sourceLanguageCode": "en-US", "sourceEnglishName": "English (United States)", "sourceParentLanguageCode": "en", "targetLanguageCode": "ro-RO", "targetEnglishName": "Româna(România)", "targetParentLanguageCode": "ro" } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListTranslationsLeveragesLanguagePairs", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "description": "Retrieves the language pair dimension present in the translation leverages dataset." } }, "/translation-leverages/source-files": { "get": { "summary": "List Translations Leverages Source Files", "tags": [ "Translation Leverage Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-source-file" } } } }, "examples": { "Example 1": { "value": { "itemCount": 1, "items": [ { "internalId": 1, "sourceFileId": "abcd0001", "projectId": "proj001", "projectName": "Project Alpha", "fileName": "AlphaFile.txt", "sourceFileLocationId": "location123", "fileTypeSettingsId": "settings123", "fileRole": "translatable", "batch": 1, "sourceFileSegmentCount": 10, "sourceFileWordCount": 150, "sourceFileCharacterCount": 600, "creationAt": "2024-01-01T00:00:00Z" } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListTranslationsLeveragesSourceFiles", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" } ], "description": "Retrieves the source file dimension present in the translation leverages dataset." } }, "/translation-leverages/leverage-bands": { "get": { "summary": "List Translations Leverages Leverage Bands", "tags": [ "Translation Leverage Data Set" ], "responses": { "200": { "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/dim-leverage-band" } } } }, "examples": { "Example 1": { "value": { "itemCount": 1, "items": [ { "internalId": 1, "bandName": "In-Context Match" } ] } } } } } }, "400": { "$ref": "#/components/responses/error-model-400" }, "401": { "$ref": "#/components/responses/error-model-401" }, "403": { "$ref": "#/components/responses/error-model-403" } }, "operationId": "ListTranslationsLeveragesLeverageBands", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/count" }, { "$ref": "#/components/parameters/expand" } ], "description": "Retrieves the leverage bands dimension present in the translation leverages dataset." } } }, "components": { "schemas": { "dim-project": { "type": "object", "x-examples": { "Example 1": { "internalId": 11, "projectId": "uuid", "projectShortId": 11, "projectName": "Test", "projectDescription": "", "projectLocationId": "3f7e792b23d5494f8ce8fb73f796dbc7", "projectGroupId": "groupid", "projectGroupShortId": 1, "projectGroupName": "Test group", "projectStatus": "in_progress", "projectTemplateId": "templateuuid", "projectTemplateName": "Template test", "originSystem": "LCUI", "sourceLanguage": "en-EN", "targetLanguages": "fr-FR", "createdAt": "2023-11-21T09:59:54Z", "quoteCreatedAt": "9999-12-31T00:00:00Z", "quoteApprovedAt": "2499-12-31T00:00:00Z", "completedAt": "2499-12-31T00:00:00Z", "dueAt": "2023-11-28T11:00:36Z", "deliveredAt": "9999-12-31T00:00:00Z", "projectSegmentCount": 6, "projectWordCount": 21, "projectCharacterCount": 70, "projectFileCount": 1, "projectRevenue": 0, "projectSavings": 0, "projectCurrencyCode": "EUR", "deliveryTimeDiff": 0, "onTimeStatus": "VERY_EARLY", "projectCreatorName": "Test", "projectCreatorId": "31231231231", "deleted": false, "customFields": "cf=abc" } }, "description": "Project dimension", "title": "Project Dimension", "properties": { "internalId": { "type": "integer", "description": "A unique internal identifier for the project." }, "projectId": { "type": "string", "description": "A unique identifier for the project, as it is in Trados Cloud Platform." }, "projectShortId": { "type": "integer", "description": "A shortened, numeric identifier for the project, assigned by Trados Cloud Platform." }, "projectName": { "type": "string", "description": "The name of the project." }, "projectDescription": { "type": "string", "description": "A detailed description of the project." }, "projectLocationId": { "type": "string", "description": "The identifier for the location where the project is based or managed." }, "projectGroupId": { "type": "string", "description": "The identifier for the project group." }, "projectGroupShortId": { "type": "integer", "description": "A shortened, numeric identifier for the project group, assigned by Trados Cloud Platform." }, "projectGroupName": { "type": "string", "description": "The name of the group responsible for the project." }, "projectStatus": { "type": "string", "description": "The current status of the project. Can have the following values: 'created','in_progress','completed','archived'.", "enum": [ "N/A", "created", "in_progress", "completed" ] }, "projectTemplateId": { "type": "string", "description": "The identifier for the template used to create the project." }, "projectTemplateName": { "type": "string", "description": "The name of the template used to create the project." }, "originSystem": { "type": "string", "description": "The originating system or application where the project was created." }, "sourceLanguage": { "type": "string", "description": "The source language of the project content." }, "targetLanguages": { "type": "string", "description": "The target languages for the project content, typically a comma-separated list." }, "createdAt": { "type": "string", "description": "The date and time when the project was created. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "quoteCreatedAt": { "type": "string", "description": "The date and time when the project quote was created. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "quoteApprovedAt": { "type": "string", "description": "The date and time when the project quote was approved. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "completedAt": { "type": "string", "description": "The date and time when the project was completed. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "dueAt": { "type": "string", "description": "The due date and time for the project. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "deliveredAt": { "type": "string", "description": "The date and time when the project was delivered. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "projectSegmentCount": { "type": "integer", "description": "The total number of segments in the project." }, "projectWordCount": { "type": "integer", "description": "The total number of words in the project." }, "projectCharacterCount": { "type": "integer", "description": "The total number of characters in the project." }, "projectFileCount": { "type": "integer", "description": "The total number of files in the project." }, "projectRevenue": { "type": "number", "description": "The total revenue generated by the project.", "format": "float" }, "projectSavings": { "type": "number", "description": "The total savings associated with the project.", "format": "float" }, "projectCurrencyCode": { "type": "string", "description": "The currency code (e.g., USD, EUR) for the project financials." }, "deliveryTimeDiff": { "type": "integer", "description": "The difference in time between the due date and the actual delivery date, measured in seconds." }, "onTimeStatus": { "type": "string", "description": "A status indicating the punctuality of the project's delivery.", "enum": [ "N/A", "VERY_EARLY", "EARLY", "ON_TIME", "LATE", "VERY_LATE" ] }, "projectCreatorName": { "type": "string", "description": "The name of the user who created the project." }, "projectCreatorId": { "type": "string", "description": "The identifier for the user who created the project." }, "deleted": { "type": "boolean", "description": "A boolean flag indicating whether the project has been deleted." }, "customFields": { "type": "string", "description": "A string containing custom fields and values specific to the project. Format: 'customField1 = value1 | customField2 = value2'." } } }, "fact-fts": { "type": "object", "examples": [ { "projectId": 0, "customerId": 0, "languagePairId": 0, "sourceFileId": 0, "projectCreationDateId": 0, "translationDateId": 0, "translatorId": 0, "reviewDateId": 0, "reviewerId": 0, "customerReviewDateId": 0, "customerReviewerId": 0, "finalizationDateId": 0, "sourceWords": 0, "lockedWords": 0, "repetitionWords": 0, "crossFileRepetitionWords": 0, "perfectMatchWords": 0, "inContextMatchWords": 0, "exactMatchWords": 0, "fuzzyMatchWords": 0, "newMatchWords": 0, "machineTranslationWords": 0, "translationDuration": 0, "humanTranslatedSegments": 0, "humanTranslatedWords": 0, "humanTranslatedCharacters": 0, "reviewDuration": 0, "reviewedSegments": 0, "reviewedWords": 0, "reviewedCharacters": 0, "pipelineDuration": 0, "isCanceled": true } ], "description": "File translation status fact", "title": "FTS Metrics", "properties": { "projectId": { "type": "integer", "description": "A unique identifier for the project associated with the file translation status." }, "customerId": { "type": "integer", "description": "A unique identifier for the customer associated with the file translation status." }, "languagePairId": { "type": "integer", "description": "A unique identifier for the language pair used in the translation." }, "sourceFileId": { "type": "integer", "description": "A unique identifier for the source file associated with the translation." }, "projectCreationDateId": { "type": "integer", "description": "A unique identifier for the date when the project was created." }, "translationDateId": { "type": "integer", "description": "A unique identifier for the date when the translation was performed." }, "translatorId": { "type": "integer", "description": "A unique identifier for the translator who performed the translation." }, "reviewDateId": { "type": "integer", "description": "A unique identifier for the date when the review was performed." }, "reviewerId": { "type": "integer", "description": "A unique identifier for the reviewer who performed the review." }, "customerReviewDateId": { "type": "integer", "description": "A unique identifier for the date when the customer review was performed." }, "customerReviewerId": { "type": "integer", "description": "A unique identifier for the customer reviewer who performed the review." }, "finalizationDateId": { "type": "integer", "description": "A unique identifier for the date when the translation was finalized." }, "sourceWords": { "type": "integer", "description": "The total number of source words in the file." }, "lockedWords": { "type": "integer", "description": "The total number of locked words in the file." }, "repetitionWords": { "type": "integer", "description": "The total number of repetition words in the file." }, "crossFileRepetitionWords": { "type": "integer", "description": "The total number of cross-file repetition words in the file." }, "perfectMatchWords": { "type": "integer", "description": "The total number of perfect match words in the file." }, "inContextMatchWords": { "type": "integer", "description": "The total number of in-context match words in the file." }, "exactMatchWords": { "type": "integer", "description": "The total number of exact match words in the file." }, "fuzzyMatchWords": { "type": "integer", "description": "The total number of fuzzy match words in the file." }, "newMatchWords": { "type": "integer", "description": "The total number of new match words in the file." }, "machineTranslationWords": { "type": "integer", "description": "The total number of words translated by machine translation in the file." }, "translationDuration": { "type": "integer", "description": "The total duration of the translation process, in minutes." }, "humanTranslatedSegments": { "type": "integer", "description": "The total number of segments translated by human translators in the file." }, "humanTranslatedWords": { "type": "integer", "description": "The total number of words translated by human translators in the file." }, "humanTranslatedCharacters": { "type": "integer", "description": "The total number of characters translated by human translators in the file." }, "reviewDuration": { "type": "integer", "description": "The total duration of the review process, in minutes." }, "reviewedSegments": { "type": "integer", "description": "The total number of segments reviewed in the file." }, "reviewedWords": { "type": "integer", "description": "The total number of words reviewed in the file." }, "reviewedCharacters": { "type": "integer", "description": "The total number of characters reviewed in the file." }, "pipelineDuration": { "type": "integer", "description": "The total duration of the entire translation pipeline, in minutes." }, "canceled": { "type": "boolean", "description": "A boolean indicating whether the translation project was canceled." }, "project": { "$ref": "#/components/schemas/dim-project", "description": "(Optional) Expand the project dimension associated with the project id using the $expand parameter." }, "customer": { "$ref": "#/components/schemas/dim-customer", "description": "(Optional) Expand the customer dimension associated with the customer id using the $expand parameter." }, "languagePair": { "$ref": "#/components/schemas/dim-language-pair", "description": "(Optional) Expand the language pair dimension associated with the language pair id using the $expand parameter." }, "sourceFile": { "$ref": "#/components/schemas/dim-source-file", "description": "(Optional) Expand the source file dimension associated with the source file id using the $expand parameter." }, "projectCreationDate": { "$ref": "#/components/schemas/dim-date", "description": "(Optional) Expand the project creation date dimension associated with the project creation date id using the $expand parameter." }, "translationDate": { "$ref": "#/components/schemas/dim-date", "description": "(Optional) Expand the translation date dimension associated with the project translation date id using the $expand parameter." }, "translator": { "$ref": "#/components/schemas/dim-translator", "description": "(Optional) Expand the translator dimension associated with the translator id using the $expand parameter." }, "reviewDate": { "$ref": "#/components/schemas/dim-date", "description": "(Optional) Expand the review date dimension associated with the review date id using the $expand parameter." }, "reviewer": { "$ref": "#/components/schemas/dim-reviewer", "description": "(Optional) Expand the reviewer dimension associated with the reviewer id using the $expand parameter." }, "customerReviewDate": { "$ref": "#/components/schemas/dim-date", "description": "(Optional) Expand the customer review date dimension associated with the customer review date id using the $expand parameter." }, "customerReviewer": { "$ref": "#/components/schemas/dim-customer-reviewer", "description": "(Optional) Expand the customer reviewer dimension associated with the customer reviewer id using the $expand parameter." }, "finalizationDate": { "$ref": "#/components/schemas/dim-date", "description": "(Optional) Expand the finalization date dimension associated with the finalization date id using the $expand parameter." } } }, "error-details": { "title": "Error details", "type": "object", "description": "Error details", "properties": { "code": { "type": "string" }, "message": { "type": "string", "description": "Error description" } } }, "dim-customer": { "type": "object", "properties": { "internalId": { "type": "integer", "description": "A unique internal identifier for the customer." }, "customerId": { "type": "string", "description": "A unique identifier for the customer, as it is in Trados Cloud Platform." }, "customerLocationId": { "type": "string", "description": "The identifier for the location where the customer is based or managed." }, "customerName": { "type": "string", "description": "The name of the customer." }, "createdBy": { "type": "string", "description": "The identifier of the user who created the customer." }, "createdAt": { "type": "string", "description": "The date and time when the customer record was created. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format." }, "keyContactId": { "type": "string", "description": "The identifier for the key contact person for the customer." }, "keyContactEmail": { "type": "string", "description": "The email address of the key contact person for the customer." }, "ragStatusName": { "type": "string", "description": "The RAG (Red, Amber, Green) status name indicating the current health or risk status of the customer." }, "customFields": { "type": "string", "description": "A string containing custom fields and values specific to the customer. Format: 'customField1 = value1 | customField2 = value2'. " }, "deleted": { "type": "boolean", "description": "A boolean flag indicating whether the customer record has been deleted." } }, "x-examples": { "Example 1": { "internalId": 123, "customerId": "abc123abc123abc123", "customerLocationId": "locationid", "customerName": "Customer name", "createdBy": "N/A", "createdAt": "2023-04-11T10:30:50Z", "keyContactId": "contactId", "keyContactEmail": "contact email", "ragStatusName": "Green", "customFields": "custom field=abc | customF2=123", "deleted": false } }, "description": "Customer dimension", "title": "Customer Dimension" }, "dim-language-pair": { "type": "object", "properties": { "internalId": { "type": "integer", "description": "A unique internal identifier for the language pair." }, "sourceLanguageCode": { "type": "string", "description": "The ISO code representing the source language." }, "sourceEnglishName": { "type": "string", "description": "The English name of the source language." }, "sourceParentLanguageCode": { "type": "string", "description": "The ISO code of the parent language for the source language, if applicable." }, "targetLanguageCode": { "type": "string", "description": "The ISO code representing the target language." }, "targetEnglishName": { "type": "string", "description": "The English name of the target language." }, "targetParentLanguageCode": { "type": "string", "description": "The code of the parent language for the target language, if applicable." } }, "x-examples": { "Example 1": { "internalId": 1, "sourceLanguageCode": "en-GI", "sourceEnglishName": "English (Gibraltar)", "sourceParentLanguageCode": "en", "targetLanguageCode": "tk", "targetEnglishName": "Turkmen", "targetParentLanguageCode": "N/A" } }, "description": "Language Pair dimension", "title": "Language Pair Dimension" }, "dim-source-file": { "type": "object", "x-examples": { "Example 1": { "internalId": 1, "sourceFileId": "abcd0001", "projectId": "proj001", "projectName": "Project Alpha", "fileName": "AlphaFile.txt", "sourceFileLocationId": "location123", "fileTypeSettingsId": "settings123", "fileRole": "translatable", "batch": 1, "sourceFileSegmentCount": 10, "sourceFileWordCount": 150, "sourceFileCharacterCount": 600, "creationAt": "2024-01-01T00:00:00Z" } }, "title": "Source File Dimension", "properties": { "internalId": { "type": "integer", "description": "A unique internal identifier for the source file." }, "sourceFileId": { "type": "string", "description": "A unique identifier for the source file, as it is in Trados Cloud Platform." }, "projectId": { "type": "string", "description": "The identifier for the project associated with the source file, as it is in Trados Cloud Platform." }, "projectName": { "type": "string", "description": "The name of the project associated with the source file." }, "fileName": { "type": "string", "description": "The name of the source file." }, "sourceFileLocationId": { "type": "string", "description": "The identifier for the location where the source file is stored." }, "fileTypeSettingsId": { "type": "string", "description": "The identifier for the file type settings used for processing the source file." }, "fileRole": { "type": "string", "description": "The role or category of the source file (e.g., source, reference)." }, "batch": { "type": "integer", "description": "The batch number." }, "sourceFileSegmentCount": { "type": "integer", "description": "The total number of segments in the source file." }, "sourceFileWordCount": { "type": "integer", "description": "The total number of words in the source file." }, "sourceFileCharacterCount": { "type": "integer", "description": "The total number of characters in the source file." }, "createdAt": { "type": "string", "description": "The date and time when the source file was created. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" } } }, "dim-date": { "type": "object", "x-examples": { "Example 1": { "internalId": 20000101, "year": 2000, "month": 1, "day": 1, "dayOfWeek": 7, "dayOfWeekName": "Saturday", "monthName": "January", "dayOfYear": 1, "quarter": 1, "yearNumber": "2000", "monthNumber": "1", "fullDate": "2000-01-01" } }, "description": "Date dimension", "title": "Date Dimension", "properties": { "internalId": { "type": "integer", "description": "A unique internal identifier for the date." }, "year": { "type": "integer", "description": "The year of the date." }, "month": { "type": "integer", "description": "The month of the date (1 for January, 2 for February, etc.)." }, "day": { "type": "integer", "description": "The day of the month (1 to 31)." }, "dayOfWeek": { "type": "integer", "description": "The day of the week as a number (1 for Monday, 2 for Tuesday, ..., 7 for Sunday)." }, "dayOfWeekName": { "type": "string", "description": "The name of the day of the week (e.g., Monday, Tuesday, ..., Sunday)." }, "monthName": { "type": "string", "description": "The name of the month (e.g., January, February, ..., December)." }, "dayOfYear": { "type": "integer", "description": "The day of the year (1 to 366)." }, "quarter": { "type": "integer", "description": "The quarter of the year (1 to 4)." }, "yearNumber": { "type": "string", "description": "The year as a string." }, "monthNumber": { "type": "string", "description": "The month as a string (e.g., '1' for January)." }, "fullDate": { "type": "string", "description": "The full date in 'YYYY-MM-DD' format.", "format": "date" } } }, "dim-translator": { "type": "object", "x-examples": { "Example 1": { "internalId": 1234567, "accountUserId": "1234abcd5678efgh9012ijkl", "accountId": "2345bcde6789fgha0123ijkl", "accountName": "Test Account", "firstName": "First", "lastName": "Last", "userEmail": "user@example.com", "accountUserLocationId": "N/A", "membership": "ROLE", "status": "STATUS", "authorId": "1234abcd5678efgh9012ijkl", "creationDate": "2023-01-01T00:00:00Z", "lastModificationDate": "2023-01-01T00:00:00Z", "deletionDate": "9999-12-31T00:00:00Z", "vendorId": "3456cdef7890ghij1234klmn", "vendorName": "Vendor Name", "deleted": false } }, "description": "Translator dimension", "title": "Translator Dimension", "properties": { "internalId": { "type": "integer", "description": "A unique internal identifier for the translator." }, "accountUserId": { "type": "string", "description": "A unique identifier for the account user associated with the translator." }, "firstName": { "type": "string", "description": "The first name of the translator." }, "lastName": { "type": "string", "description": "The last name of the translator." }, "userEmail": { "type": "string", "description": "The email address of the translator." }, "accountUserLocationId": { "type": "string", "description": "The identifier for the location associated with the user's account." }, "membership": { "type": "string", "description": "Displays the type of membership the user has with the account: member, collaborator(guest)." }, "createdAt": { "type": "string", "description": "The date and time when the translator's account was created. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "lastModifiedAt": { "type": "string", "description": "The date and time when the translator's account was last modified. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "deletedAt": { "type": "string", "description": "The date and time when the translator's account was deleted, if applicable. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "vendorId": { "type": "string", "description": "The identifier for the vendor associated with the translator." }, "vendorName": { "type": "string", "description": "The name of the vendor associated with the translator." }, "deleted": { "type": "boolean", "description": "A boolean indicating whether the translator's account has been deleted." } } }, "dim-reviewer": { "type": "object", "x-examples": { "Example 1": { "internalId": 1234567, "accountUserId": "1234abcd5678efgh9012ijkl", "accountId": "2345bcde6789fgha0123ijkl", "accountName": "Test Account", "firstName": "First", "lastName": "Last", "userEmail": "user@example.com", "accountUserLocationId": "N/A", "membership": "ROLE", "status": "STATUS", "authorId": "N/A", "creationDate": "2023-01-01T00:00:00Z", "lastModificationDate": "2024-01-01T00:00:00Z", "deletionDate": "9999-12-31T00:00:00Z", "vendorId": "N/A", "vendorName": "N/A", "deleted": false } }, "description": "Reviewer dimension", "title": "Reviewer Dimension", "properties": { "internalId": { "type": "integer", "description": "A unique internal identifier for the reviewer." }, "accountUserId": { "type": "string", "description": "A unique identifier for the account user associated with the reviewer." }, "firstName": { "type": "string", "description": "The first name of the reviewer." }, "lastName": { "type": "string", "description": "The last name of the reviewer." }, "userEmail": { "type": "string", "description": "The email address of the reviewer." }, "accountUserLocationId": { "type": "string", "description": "The identifier for the location associated with the user's account." }, "membership": { "type": "string", "description": "Displays the type of membership the user has with the account: member, collaborator(guest)." }, "createdAt": { "type": "string", "description": "The date and time when the reviewer's account was created. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "lastModifiedAt": { "type": "string", "description": "The date and time when the reviewer's account was last modified. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "deletedAt": { "type": "string", "description": "The date and time when the reviewer's account was deleted, if applicable. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "vendorId": { "type": "string", "description": "The identifier for the vendor associated with the reviewer." }, "vendorName": { "type": "string", "description": "The name of the vendor associated with the reviewer." }, "deleted": { "type": "boolean", "description": "A boolean indicating whether the reviewer's account has been deleted." } } }, "dim-customer-reviewer": { "type": "object", "x-examples": { "Example 1": { "internalId": 1234567, "accountUserId": "1234abcd5678efgh9012ijkl", "accountId": "2345bcde6789fgha0123ijkl", "accountName": "Test Account", "firstName": "First", "lastName": "Last", "userEmail": "user@example.com", "accountUserLocationId": "N/A", "membership": "ROLE", "status": "STATUS", "authorId": "N/A", "creationDate": "2023-01-01T00:00:00Z", "lastModificationDate": "2024-01-01T00:00:00Z", "deletionDate": "9999-12-31T00:00:00Z", "deleted": false } }, "description": "Customer reviewer dimension", "title": "Customer Reviewer Dimension", "properties": { "internalId": { "type": "integer", "description": "A unique internal identifier for the customer reviewer." }, "accountUserId": { "type": "string", "description": "A unique identifier for the account user associated with the customer reviewer." }, "firstName": { "type": "string", "description": "The first name of the customer reviewer." }, "lastName": { "type": "string", "description": "The last name of the customer reviewer." }, "userEmail": { "type": "string", "description": "The email address of the customer reviewer." }, "accountUserLocationId": { "type": "string", "description": "The identifier for the location associated with the user's account." }, "membership": { "type": "string", "description": "Displays the type of membership the user has with the account: member, collaborator(guest)." }, "createdAt": { "type": "string", "description": "The date and time when the customer reviewer's account was created. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "lastModifiedAt": { "type": "string", "description": "The date and time when the customer reviewer's account was last modified. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "deletedAt": { "type": "string", "description": "The date and time when the customer reviewer's account was deleted, if applicable. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "deleted": { "type": "boolean", "description": "A boolean indicating whether the customer reviewer's account has been deleted." } } }, "fact-vendor-costs": { "type": "object", "x-examples": { "Example 1": { "accountId": 1234567890, "projectId": 9876543210, "customerId": 1234567890, "languagePairId": 111111, "vendorOrderTemplateId": 222222, "quoteCreatedAt": "2024-01-01T00:00:00Z", "serviceTypeId": 333, "quoteReviewedAt": "2024-01-01T00:00:00Z", "quoteApprovedAt": "2024-01-01T00:00:00Z", "quoteUpdatedAt": "2024-01-01T00:00:00Z", "fileCount": 1, "targetWordCount": 1000, "currencyId": 444444, "translationCost": 100.1, "languageCost": 50.22, "additionalCost": 10.333 } }, "description": "Vendor costs fact. Represents the cost details provided by a vendor for a translation project.", "properties": { "accountId": { "type": "integer", "description": "The unique identifier for the account associated with the vendor cost." }, "projectId": { "type": "integer", "description": "The unique identifier for the project for which the vendor cost is being recorded." }, "customerId": { "type": "integer", "description": "The unique identifier for the customer associated with the vendor cost." }, "languagePairId": { "type": "integer", "description": "The unique identifier for the language pair (source and target languages) involved in the project." }, "vendorOrderTemplateId": { "type": "integer", "description": "The unique identifier for the vendor order template used for the cost estimation." }, "quoteCreatedAt": { "type": "string", "format": "date-time", "description": "The timestamp when the cost quote was created." }, "serviceTypeId": { "type": "integer", "description": "The unique identifier for the type of service being provided." }, "quoteReviewedAt": { "type": "string", "format": "date-time", "description": "The timestamp when the cost quote was reviewed." }, "quoteApprovedAt": { "type": "string", "format": "date-time", "description": "The timestamp when the cost quote was approved." }, "quoteUpdatedAt": { "type": "string", "format": "date-time", "description": "The timestamp when the cost quote was last updated." }, "fileCount": { "type": "integer", "description": "The number of files involved in the project." }, "targetWordCount": { "type": "integer", "description": "The total number of words in the target language for the project." }, "currencyId": { "type": "integer", "description": "The unique identifier for the currency in which the costs are recorded." }, "translationCost": { "type": "number", "format": "float", "description": "The cost of the translation service." }, "languageCost": { "type": "number", "format": "float", "description": "The cost related to language services for a specific target language." }, "additionalCost": { "type": "number", "format": "float", "description": "Any additional costs related to the project." }, "project": { "$ref": "#/components/schemas/dim-project", "description": "(Optional) Expand the project dimension associated with the project id using the $expand parameter." }, "customer": { "$ref": "#/components/schemas/dim-customer", "description": "(Optional) Expand the customer dimension associated with the customer id using the $expand parameter." }, "languagePair": { "$ref": "#/components/schemas/dim-language-pair", "description": "(Optional) Expand the language pair dimension associated with the language pair id using the $expand parameter." }, "vendorOrderTemplate": { "$ref": "#/components/schemas/dim-vendor-order-template", "description": "(Optional) Expand the vendor order template dimension associated with the vendorOrderTemplateId using the $expand parameter." }, "serviceType": { "$ref": "#/components/schemas/dim-service-types", "description": "(Optional) Expand the service types dimension associated with the serviceTypeId using the $expand parameter." }, "currency": { "$ref": "#/components/schemas/dim-currency", "description": "(Optional) Expand the currency dimension associated with the currencyId using the $expand parameter." } }, "title": "Vendor Costs Metrics" }, "dim-currency": { "type": "object", "properties": { "internalId": { "type": "integer", "description": "A unique identifier assigned to each currency entry. This is typically an internal database ID used to reference the currency within the system." }, "name": { "type": "string", "description": "The official name of the currency. This field stores the full name of the currency as recognized internationally." }, "code": { "type": "string", "description": "The standard three-letter currency code as defined by ISO 4217. This code uniquely identifies the currency." }, "symbol": { "type": "string", "description": "The symbol used to represent the currency in financial documents and transactions. This symbol is commonly used in pricing and financial reports." } }, "x-examples": { "Example 1": { "internalId": 698582, "name": "Euro", "code": "EUR", "symbol": "€" } }, "description": "Currency dimension", "title": "Currency Dimension" }, "dim-vendor-order-template": { "type": "object", "x-examples": { "Example 1": { "internalId": 123456, "originatingId": "1234abcd5678efgh9012ijkl", "orderTemplateName": "Example Order Template", "vendorId": "abcd123456efgh7890ijkl12", "vendorName": "Example Vendor", "locationId": "abcd1234efgh5678ijkl9012mnop3456", "accountId": "abcd5678ijkl9012mnop3456efgh1234", "creationDate": "2024-07-15T10:00:00Z", "deleted": false } }, "description": "Vendor Order Template dimension", "title": "Vendor Order Template Dimension", "properties": { "internalId": { "type": "integer", "description": "Unique identifier for the vendor order template within the system." }, "originatingId": { "type": "string", "description": "Identifier originating from the Trados Cloud Platform." }, "orderTemplateName": { "type": "string", "description": "Name or title of the vendor order template." }, "vendorId": { "type": "string", "description": "Unique identifier for the vendor associated with this order template." }, "vendorName": { "type": "string", "description": "Name of the vendor associated with this order template." }, "locationId": { "type": "string", "description": "Identifier for the location associated with this vendor order template." }, "accountId": { "type": "string", "description": "Identifier for the account associated with this vendor order template." }, "createdAt": { "type": "string", "description": "Date and time when the vendor order template was created. (ISO 8601 format)", "format": "date-time" }, "deleted": { "type": "boolean", "description": "Indicates whether the vendor order template has been deleted (`true`) or is active (`false`)." } } }, "dim-service-types": { "type": "object", "properties": { "internalId": { "type": "integer", "description": "An integer representing the internal identifier of the service type." }, "name": { "type": "string", "description": "A string representing the name or title of the service type." }, "originatingId": { "type": "string", "description": "Identifier originating from the Trados Cloud Platform." }, "allowInternal": { "type": "boolean", "description": "A boolean indicating whether the service type is allowed for internal use." }, "allowCustomer": { "type": "boolean", "description": "A boolean indicating whether the service type is allowed for customer use." }, "allowVendor": { "type": "boolean", "description": "A boolean indicating whether the service type is allowed for vendor use." } }, "x-examples": { "Example 1": { "internalId": 6469, "name": "service-type-name-1", "originatingId": "1_9d196a9d-0911-4c6d-8d2d-a19fc5816992", "allowInternal": true, "allowCustomer": true, "allowVendor": false } }, "description": "Service Type dimension", "title": "Service Type Dimension" }, "dim-owner": { "title": "Task Owner Dimension", "type": "object", "x-examples": { "Example 1": { "internalId": 1234567, "accountUserId": "1234abcd5678efgh9012ijkl", "accountId": "2345bcde6789fgha0123ijkl", "accountName": "Test Account", "firstName": "First", "lastName": "Last", "userEmail": "user@example.com", "accountUserLocationId": "N/A", "membership": "ROLE", "status": "STATUS", "authorId": "N/A", "creationDate": "2023-01-01T00:00:00Z", "lastModificationDate": "2024-01-01T00:00:00Z", "deletionDate": "9999-12-31T00:00:00Z", "vendorId": "N/A", "vendorName": "N/A", "deleted": false } }, "description": "Task Owner dimension", "properties": { "internalId": { "type": "integer", "description": "A unique internal identifier for the task owner." }, "accountUserId": { "type": "string", "description": "A unique identifier for the account user associated with the task owner." }, "firstName": { "type": "string", "description": "The first name of the task owner." }, "lastName": { "type": "string", "description": "The last name of the task owner." }, "userEmail": { "type": "string", "description": "The email address of the task owner." }, "accountUserLocationId": { "type": "string", "description": "The identifier for the location associated with the user's account." }, "membership": { "type": "string", "description": "Displays the type of membership the user has with the account: member, collaborator(guest)." }, "createdAt": { "type": "string", "description": "The date and time when the task owner's account was created. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "lastModifiedAt": { "type": "string", "description": "The date and time when the task owner's account was last modified. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "deletedAt": { "type": "string", "description": "The date and time when the task owner's account was deleted, if applicable. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "vendorId": { "type": "string", "description": "The identifier for the vendor associated with the task owner." }, "vendorName": { "type": "string", "description": "The name of the vendor associated with the task owner." }, "deleted": { "type": "boolean", "description": "A boolean indicating whether the task owner's account has been deleted." } } }, "dim-quote-approver": { "title": "Quote Approver Dimension", "type": "object", "x-examples": { "Example 1": { "internalId": 1234567, "accountUserId": "1234abcd5678efgh9012ijkl", "accountId": "2345bcde6789fgha0123ijkl", "accountName": "Test Account", "firstName": "First", "lastName": "Last", "userEmail": "user@example.com", "accountUserLocationId": "N/A", "membership": "ROLE", "status": "STATUS", "authorId": "N/A", "creationDate": "2023-01-01T00:00:00Z", "lastModificationDate": "2024-01-01T00:00:00Z", "deletionDate": "9999-12-31T00:00:00Z", "vendorId": "N/A", "vendorName": "N/A", "deleted": false } }, "description": "Quote Approver dimension", "examples": [ { "internalId": 1234567, "accountUserId": "423e18f01573f2d6", "accountId": "d65315e82ec604b7", "accountName": "Test Account", "firstName": "First", "lastName": "Last", "userEmail": "user@example.com", "accountUserLocationId": "57d39d0b88319631", "membership": "MEMBER", "status": "ACTIVE", "authorId": "5cba149cb5f78fe6", "creationDate": "2023-01-01T00:00:00Z", "lastModificationDate": "2024-01-01T00:00:00Z", "deletionDate": "9999-12-31T00:00:00Z", "vendorId": "N/A", "vendorName": "N/A", "deleted": false } ], "properties": { "internalId": { "type": "integer", "description": "A unique internal identifier for the quote approver." }, "accountUserId": { "type": "string", "description": "A unique identifier for the account user associated with the quote approver." }, "firstName": { "type": "string", "description": "The first name of the quote approver." }, "lastName": { "type": "string", "description": "The last name of the quote approver." }, "userEmail": { "type": "string", "description": "The email address of the quote approver." }, "accountUserLocationId": { "type": "string", "description": "The identifier for the location associated with the user's account." }, "membership": { "type": "string", "description": "Displays the type of membership the user has with the account: member, collaborator(guest)." }, "createdAt": { "type": "string", "description": "The date and time when the quote approver's account was created. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "lastModifiedAt": { "type": "string", "description": "The date and time when the quote approver's account was last modified. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "deletedAt": { "type": "string", "description": "The date and time when the quote approver's account was deleted, if applicable. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "vendorId": { "type": "string", "description": "The identifier for the vendor associated with the quote approver." }, "vendorName": { "type": "string", "description": "The name of the vendor associated with the quote approver." }, "deleted": { "type": "boolean", "description": "A boolean indicating whether the quote approver's account has been deleted." } } }, "dim-task-types": { "type": "object", "properties": { "internalId": { "type": "integer", "description": "A unique identifier for the task type." }, "taskType": { "type": "string", "description": "A string representing the specific type of the task." }, "name": { "type": "string", "description": "The name of the task type." }, "businessKey": { "type": "string", "description": "A key associated with the business context of the task type." }, "automated": { "type": "boolean", "description": "Indicates whether the task type is automated (true) or manual (false)." }, "accountId": { "type": "string", "description": "The identifier of the account associated with the task type." } }, "x-examples": { "Example 1": { "internalId": 26124, "taskType": "task-type", "name": "Task Type Name", "businessKey": "task-type", "automated": true, "accountId": "abcdefghiklmn12345" } }, "description": "Task Types Dimension", "title": "Task Type Dimension" }, "fact-tqe": { "type": "object", "x-examples": { "Example 1": { "projectId": 1234567890123, "customerId": 2345678901234, "accountId": 3456789012345, "linguistId": 4567890123456, "originalTranslationOriginId": 0, "finalTranslationOriginId": 6, "taskTypeId": 12345, "languagePairId": 23456, "sourceFileId": 34567, "translationEvaluationId": 45678, "evaluationDate": "2024-06-20T06:13:44Z", "taskId": "abc123def456ghi789jkl000", "totalSegments": 10, "editDistance0": 2, "editDistance1": 2, "editDistance2": 0, "editDistance3": 0, "editDistance4": 0, "editDistance5": 0, "editDistance6": 3, "editDistance7": 0, "editDistance8": 2, "editDistance9": 0, "editDistance10": 1 } }, "description": "Translation Quality Evaluation metrics", "title": "Translation Quality Evaluation Metrics", "properties": { "projectId": { "type": "integer", "description": "The unique identifier for the project." }, "customerId": { "type": "integer", "description": "The unique identifier for the customer." }, "accountId": { "type": "integer", "description": "The unique identifier for the account." }, "linguistId": { "type": "integer", "description": "The unique identifier for the linguist." }, "originalTranslationOriginId": { "type": "integer", "description": "The unique identifier for the original translation origin." }, "finalTranslationOriginId": { "type": "integer", "description": "The unique identifier for the final translation origin." }, "taskTypeId": { "type": "integer", "description": "The unique identifier for the task type." }, "languagePairId": { "type": "integer", "description": "The unique identifier for the language pair." }, "sourceFileId": { "type": "integer", "description": "The unique identifier for the source file." }, "translationEvaluationId": { "type": "integer", "description": "The unique identifier for the translation evaluation." }, "evaluatedAt": { "type": "string", "description": "The date and time when the evaluation was conducted in 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "taskId": { "type": "string", "description": "The unique identifier for the task." }, "totalSegments": { "type": "integer", "description": "The total number of segments in the source file." }, "editDistance0": { "type": "integer" }, "editDistance1": { "type": "integer" }, "editDistance2": { "type": "integer" }, "editDistance3": { "type": "integer" }, "editDistance4": { "type": "integer" }, "editDistance5": { "type": "integer" }, "editDistance6": { "type": "integer" }, "editDistance7": { "type": "integer" }, "editDistance8": { "type": "integer" }, "editDistance9": { "type": "integer" }, "editDistance10": { "type": "integer" }, "project": { "$ref": "#/components/schemas/dim-project", "description": "(Optional) Expand the project dimension associated with the projectId using the $expand parameter.\r\n\r\n" }, "customer": { "$ref": "#/components/schemas/dim-customer", "description": "(Optional) Expand the customer dimension associated with the customerId using the $expand parameter.\r\n\r\n" }, "linguist": { "$ref": "#/components/schemas/dim-linguist", "description": "(Optional) Expand the linguist dimension associated with the linguistId using the $expand parameter.\r\n\r\n" }, "originalTranslationOrigin": { "$ref": "#/components/schemas/dim-translation-origin", "description": "(Optional) Expand the original translation origin dimension associated with the originalTranslationOriginId using the $expand parameter.\r\n" }, "finalTranslationOrigin": { "$ref": "#/components/schemas/dim-translation-origin", "description": "(Optional) Expand the final translation origin dimension associated with the finalTranslationOriginId using the $expand parameter.\r\n" }, "taskType": { "$ref": "#/components/schemas/dim-task-types", "description": "(Optional) Expand the task type dimension associated with the taskTypeId using the $expand parameter.\r\n" }, "languagePair": { "$ref": "#/components/schemas/dim-language-pair", "description": "(Optional) Expand the language pair dimension associated with the languagePairId using the $expand parameter.\r\n" }, "sourceFile": { "$ref": "#/components/schemas/dim-source-file", "description": "(Optional) Expand the source file dimension associated with the sourceFileId using the $expand parameter.\r\n" }, "translationQualityEvaluationCategory": { "$ref": "#/components/schemas/dim-tqe-category", "description": "(Optional) Expand the translation quality evaluation category dimension associated with the translationQualityEvaluationCategoryId using the $expand parameter.\r\n" } } }, "dim-linguist": { "title": "Linguist Dimension", "type": "object", "x-examples": { "Example 1": { "internalId": 1234567, "accountUserId": "1234abcd5678efgh9012ijkl", "accountId": "2345bcde6789fgha0123ijkl", "accountName": "Test Account", "firstName": "First", "lastName": "Last", "userEmail": "user@example.com", "accountUserLocationId": "N/A", "membership": "ROLE", "status": "STATUS", "authorId": "N/A", "creationDate": "2023-01-01T00:00:00Z", "lastModificationDate": "2024-01-01T00:00:00Z", "deletionDate": "9999-12-31T00:00:00Z", "vendorId": "N/A", "vendorName": "N/A", "deleted": false } }, "description": "Linguist dimension", "properties": { "internalId": { "type": "integer", "description": "A unique internal identifier for the linguist." }, "accountUserId": { "type": "string", "description": "A unique identifier for the account user associated with the linguist." }, "firstName": { "type": "string", "description": "The first name of the linguist." }, "lastName": { "type": "string", "description": "The last name of the linguist." }, "userEmail": { "type": "string", "description": "The email address of the linguist." }, "accountUserLocationId": { "type": "string", "description": "The identifier for the location associated with the user's account." }, "membership": { "type": "string", "description": "The role or membership category of the linguist within the account." }, "createdAt": { "type": "string", "description": "The date and time when the linguist's account was created. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "lastModifiedAt": { "type": "string", "description": "The date and time when the linguist's account was last modified. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "deletedAt": { "type": "string", "description": "The date and time when the linguist's account was deleted, if applicable. Timestamp with 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "vendorId": { "type": "string", "description": "The identifier for the vendor associated with the linguist." }, "vendorName": { "type": "string", "description": "The name of the vendor associated with the linguist." }, "deleted": { "type": "boolean", "description": "A boolean indicating whether the linguist's account has been deleted." } } }, "fact-task-status": { "type": "object", "x-examples": { "Example 1": { "projectId": 1234567890123, "customerId": 9876543210987, "taskTypeId": 10101, "taskStatusId": 2020202, "startDate": 20230101, "startedAt": "2023-01-01T09:00:00Z", "languageDirectionId": 1, "sourceFileId": 555555, "ownerId": 12345, "completionDate": 20231231, "completedAt": "2023-12-31T18:00:00Z", "dueDate": 20231231, "dueBy": "2023-12-31T23:59:59Z", "actualDuration": 360, "estimatedDuration": 400, "delivery": 1, "otdStatus": 1, "words": 500, "taskId": "abcd1234efgh5678ijkl9012" } }, "description": "Task status metrics", "title": "Task Status Metrics", "properties": { "projectId": { "type": "integer", "description": "Unique identifier for the project." }, "customerId": { "type": "integer", "description": "Unique identifier for the customer." }, "taskTypeId": { "type": "integer", "description": "Identifier for the type of task." }, "taskStatusId": { "type": "integer", "description": "Current status of the task." }, "startDate": { "type": "integer", "description": "Start date of the task in YYYYMMDD format." }, "startedAt": { "type": "string", "description": "Timestamp when the task was started in 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "languageDirectionId": { "type": "integer", "description": "Identifier for the language direction." }, "sourceFileId": { "type": "integer", "description": "Unique identifier for the source file associated with the task." }, "ownerId": { "type": "integer", "description": "Identifier for the owner of the task." }, "completionDate": { "type": "integer", "description": "Date when the task was completed in YYYYMMDD format." }, "completedAt": { "type": "string", "description": "Timestamp when the task was completed in 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "dueDate": { "type": "integer", "description": "Due date for the task in YYYYMMDD format." }, "dueBy": { "type": "string", "description": "Timestamp by which the task is due in 'YYYY-MM-DDTHH:MM:SSZ' format.", "format": "date-time" }, "actualDuration": { "type": "integer", "description": "Actual duration taken to complete the task, in minutes." }, "estimatedDuration": { "type": "integer", "description": "Estimated duration to complete the task, in minutes." }, "delivery": { "type": "integer", "description": "Difference between the actual duration and the estimated duration." }, "otdStatus": { "type": "integer", "description": "On-time delivery status." }, "words": { "type": "integer", "description": "Number of words in the source file processed in this task." }, "taskId": { "type": "string", "description": "Unique identifier for the task, as it is in Trados Cloud Platform." }, "project": { "$ref": "#/components/schemas/dim-project", "description": "(Optional) Expand the project dimension associated with the projectId using the $expand parameter." }, "customer": { "$ref": "#/components/schemas/dim-customer", "description": "(Optional) Expand the customer dimension associated with the customerId using the $expand parameter." }, "taskType": { "$ref": "#/components/schemas/dim-task-types", "description": "(Optional) Expand the task type dimension associated with the taskTypeId using the $expand parameter." }, "taskState": { "$ref": "#/components/schemas/dim-task-states", "description": "(Optional) Expand the task state dimension associated with the taskStatusId using the $expand parameter." }, "languagePair": { "$ref": "#/components/schemas/dim-language-pair", "description": "(Optional) Expand the language pair dimension associated with the languageDirectionId using the $expand parameter." }, "sourceFile": { "$ref": "#/components/schemas/dim-source-file", "description": "(Optional) Expand the source file dimension associated with the sourceFileId using the $expand parameter." }, "taskOwner": { "$ref": "#/components/schemas/dim-owner", "description": "(Optional) Expand the task owner dimension associated with the taskOwnerId using the $expand parameter." } } }, "dim-task-states": { "type": "object", "properties": { "internalId": { "type": "integer", "description": "Unique internal identifier for the task state." }, "taskStatus": { "type": "string", "description": "Internal status code for the task." }, "name": { "type": "string", "description": "Human-readable name of the task status." } }, "x-examples": { "Example 1": { "internalId": 1234567, "taskStatus": "pending", "name": "Pending" } }, "description": "Task States dimension", "title": "Task State Dimension" }, "dim-translation-origin": { "type": "object", "properties": { "internalId": { "type": "integer", "description": "Unique internal identifier for the translation origin." }, "sourceOrigin": { "type": "string", "description": "Internal code indicating the origin of the translation." }, "description": { "type": "string", "description": "Human-readable description of the translation origin." } }, "x-examples": { "Example 1": { "internalId": 0, "sourceOrigin": "unknown", "description": "Unknown" } }, "description": "Translation Origin dimension", "title": "Translation Origin Dimension" }, "dim-tqe-category": { "type": "object", "properties": { "internalId": { "type": "integer", "description": "Unique internal identifier for the TQE (Translation Quality Evaluation) category." }, "evaluationSystem": { "type": "string", "description": "System used for the translation quality evaluation." }, "evaluationEngine": { "type": "string", "description": "Engine used for the evaluation." }, "evaluationMinValue": { "type": "integer", "description": "Minimum value in the evaluation range." }, "evaluationMaxValue": { "type": "integer", "description": "Maximum value in the evaluation range." }, "evaluationCategory": { "type": "string", "description": "Category of the evaluation based on the score range (e.g., green, amber, red)." } }, "x-examples": { "Example 1": { "internalId": 137, "evaluationSystem": "trados-smartreview", "evaluationEngine": "bedrock:anthropic.claude-3-sonnet-20240229-v1:0", "evaluationMinValue": 91, "evaluationMaxValue": 100, "evaluationCategory": "green" } }, "description": "Translation quality evaluation category", "title": "Translation Quality Evaluation Category" }, "fact-language-revenues": { "title": "fact-language-revenues", "type": "object", "description": "The language revenue metrics", "properties": { "customerId": { "type": "integer", "description": "The unique identifier for the customer." }, "projectId": { "type": "integer", "description": "The unique identifier for the project." }, "languagePairId": { "type": "integer", "description": "The unique identifier for the language pair." }, "approveDateId": { "type": "integer", "description": "The unique identifier for the quote approve date." }, "currencyId": { "type": "integer", "description": "The unique identifier for the currency." }, "quoteApproverId": { "type": "integer", "description": "The unique identifier for the quote approver." }, "quoteDateId": { "type": "integer", "description": "The unique identifier for the quote creation date." }, "translationPrice": { "type": "number", "format": "double", "description": "The price of the translation service." }, "languagePrice": { "type": "number", "format": "double", "description": "The additional language price of the translation service." }, "projectAdditionalPrice": { "type": "number", "format": "double", "description": "The project level additional price of the translation service." }, "totalRevenue": { "type": "number", "format": "double", "description": "The total price of the project." }, "savings": { "type": "number", "format": "double", "description": "The savings obtain through the use of the automated translation features." }, "wordCount": { "type": "integer", "description": "The number of words processed during the translation service." }, "files": { "type": "integer", "description": "The number of target files processed during the translation service" }, "customer": { "$ref": "#/components/schemas/dim-customer", "description": "(Optional) Expand the customer dimension associated with the customer id using the $expand parameter and \"customer\" value." }, "project": { "$ref": "#/components/schemas/dim-project", "description": "(Optional) Expand the project dimension associated with the project id using the $expand parameter and \"project\" value." }, "languagePair": { "$ref": "#/components/schemas/dim-language-pair", "description": "(Optional) Expand the language pair dimension associated with the language pair id using the $expand parameter and \"languagePair\" value." }, "approveDate": { "$ref": "#/components/schemas/dim-date", "description": "(Optional) Expand the approve date dimension associated with the approve date id using the $expand parameter and \"approveDate\" value." }, "currency": { "$ref": "#/components/schemas/dim-currency", "description": "(Optional) Expand the currency dimension associated with the currency id using the $expand parameter and \"currency\" value." }, "quoteApprover": { "$ref": "#/components/schemas/dim-quote-approver", "description": "(Optional) Expand the quote approver dimension associated with the quote approver id using the $expand parameter and \"quoteApprover\" value." }, "quoteDate": { "$ref": "#/components/schemas/dim-date", "description": "(Optional) Expand the quote date dimension associated with the quote date id using the $expand parameter and \"quoteDate\" value." } }, "examples": [ { "customerId": 123, "projectId": 23432, "languagePairId": 34890, "approveDateId": 20240129, "currencyId": 453290, "quoteApproverId": 810908, "quoteDateId": 20240128, "translationPrice": 120.3, "languagePrice": 30.21, "projectAdditionalPrice": 0.39, "totalRevenue": 150.9, "savings": 12.44, "wordCount": 230, "files": 1 } ] }, "fact-language-revenue-details": { "title": "fact-language-revenue-details", "type": "object", "description": "Language revenue details metrics", "properties": { "quoteDateId": { "type": "integer", "description": "The unique identifier for the quote creation date." }, "customerId": { "type": "integer", "description": "The unique identifier for the customer." }, "projectId": { "type": "integer", "description": "The unique identifier for the project." }, "languagePairId": { "type": "integer", "description": "The unique identifier for the language pair." }, "revenueTypeId": { "type": "integer", "description": "The unique identifier for the revenue type." }, "currencyId": { "type": "integer", "description": "The unique identifier for the currency." }, "projectCreationDateId": { "type": "integer", "description": "The unique identifier for the project creation date." }, "numberOfUnits": { "type": "number", "format": "double", "description": "The number of units of the revenue type that generated the revenue." }, "revenue": { "type": "number", "format": "double", "description": "The revenue generated by the revenue type." }, "quoteDate": { "$ref": "#/components/schemas/dim-date", "description": "(Optional) Expand the quote date dimension associated with the quote date id using the $expand parameter and \"quoteDate\" value." }, "customer": { "$ref": "#/components/schemas/dim-customer", "description": "(Optional) Expand the customer dimension associated with the customer id using the $expand parameter and \"customer\" value." }, "project": { "$ref": "#/components/schemas/dim-project", "description": "(Optional) Expand the project dimension associated with the project id using the $expand parameter and \"project\" value." }, "languagePair": { "$ref": "#/components/schemas/dim-language-pair", "description": "(Optional) Expand the language pair dimension associated with the language pair id using the $expand parameter and \"languagePair\" value." }, "revenueType": { "$ref": "#/components/schemas/dim-revenue-type", "description": "(Optional) Expand the revenue type dimension associated with the revenue type id using the $expand parameter and \"revenueType\" value." }, "currency": { "$ref": "#/components/schemas/dim-currency", "description": "(Optional) Expand the currency dimension associated with the currency id using the $expand parameter and \"currency\" value." }, "projectCreationDate": { "$ref": "#/components/schemas/dim-date", "description": "(Optional) Expand the project creation date dimension associated with the project creation date id using the $expand parameter and \"projectCreationDate\" value." } }, "examples": [ { "quoteDateId": 20240203, "customerId": 132445, "projectId": 123467, "languagePairId": 678954, "revenueTypeId": 23940, "currencyId": 59, "projectCreationDateId": 20240202, "numberOfUnits": 100, "revenue": 0.7 } ] }, "dim-revenue-type": { "title": "dim-revenue-type", "type": "object", "description": "The revenue type dimension. \nThe dimension stores details about individual cost/revenue types.", "examples": [ { "internalId": 2, "name": "0.25 hours for minimum charge", "category": "language", "type": "Hourly", "unit": "Hour" }, { "internalId": 200, "name": "Project Management fee", "category": "project", "type": "Percentage", "unit": "Percent" }, { "internalId": 12, "name": "50% - 74% Match", "category": "file", "type": "Volume", "unit": "Words" } ], "properties": { "internalId": { "type": "integer", "description": "The internal unique identifier of the revenue type." }, "name": { "type": "string", "description": "The name of the revenue type which is displayed in the Trados Enterprise Quote or Price model." }, "category": { "type": "string", "description": "The Trados Enterprise cost/price category. This field will detail the level where the revenue type will apply. The possible values are: file, language, project." }, "type": { "type": "string", "description": "Represents the way the revenue type will be applied when calculating the overall cost. \n" }, "unit": { "type": "string", "description": "Represents the measurement that will be used when calculating the units of the revenue type. " } } }, "dim-leverage-band": { "title": "dim-leverage-band", "type": "object", "description": "The translation leverage band dimension. \nA translation leverage band refers to a specific category or level of similarity between the content being translated and existing translations or reference material.", "properties": { "internalId": { "type": "number", "description": "The internal unique identifier of the leverage band." }, "bandName": { "type": "string", "description": "The name of the translation leverage band as it is in Trados Enterprise." } }, "examples": [ { "internalId": 1000, "bandName": "In Context Match" } ] }, "fact-translation-leverage": { "title": "fact-translation-leverage", "type": "object", "description": "The translation leverage metrics", "properties": { "translationDateId": { "type": "number", "description": "The unique internal identifier for the translation date." }, "translationTime": { "type": "number" }, "accountId": { "type": "number", "description": "The unique identifier for the account." }, "customerId": { "type": "number", "description": "The unique identifier for the customer." }, "projectId": { "type": "number", "description": "The unique identifier for the project." }, "languagePairId": { "type": "number", "description": "The unique identifier for the language pair." }, "sourceFileId": { "type": "number", "description": "The unique internal identifier for the source file." }, "bandId": { "type": "number", "description": "The unique identifier for the leverage band." }, "characterCount": { "type": "number", "description": "The total number of characters in the source file." }, "wordCount": { "type": "number", "description": "The total number of words in the source file." }, "segmentCount": { "type": "number", "description": "The total number of segments in the source file." }, "bandCharacters": { "type": "number", "description": "The total number of characters within the specified leverage band." }, "bandWords": { "type": "number", "description": "The total number of words within the specified leverage band." }, "bandSegments": { "type": "number", "description": "The total number of segments within the specified leverage band." }, "canceled": { "type": "boolean", "description": "A boolean flag indicating whether the specific workflow was canceled or not." }, "translationDate": { "$ref": "#/components/schemas/dim-date", "description": "(Optional) Expand the date dimension associated with the translation date id using the $expand parameter and \"translationDate\" value." }, "customer": { "$ref": "#/components/schemas/dim-customer", "description": "(Optional) Expand the customer dimension associated with the customer id using the $expand parameter and \"customer\" value." }, "project": { "$ref": "#/components/schemas/dim-project", "description": "(Optional) Expand the project dimension associated with the project id using the $expand parameter and \"project\" value." }, "languagePair": { "$ref": "#/components/schemas/dim-language-pair", "description": "(Optional) Expand the language pair dimension associated with the language pair id using the $expand parameter and \"languagePair\" value." }, "sourceFile": { "$ref": "#/components/schemas/dim-source-file", "description": "(Optional) Expand the source file dimension associated with the source file id using the $expand parameter and \"sourceFile\" value." }, "leverageBand": { "$ref": "#/components/schemas/dim-leverage-band", "description": "(Optional) Expand the leverage band dimension associated with the band id using the $expand parameter and \"leverageBand\" value." } } } }, "parameters": { "Authorization": { "name": "Authorization", "in": "header", "description": "The bearer access token provided by Auth0.", "schema": { "type": "string" }, "required": true }, "filter": { "name": "$filter", "in": "query", "schema": { "type": "string" }, "description": "System query option restricts the set of items returned.\nOperations:\n1. [Built-in Filter Operations](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_BuiltinFilterOperations)\n2. [Built-in Query Functions](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_BuiltinQueryFunctions)\n" }, "top": { "name": "$top", "in": "query", "schema": { "type": "integer", "default": 5000 }, "description": "System query option specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." }, "skip": { "name": "$skip", "in": "query", "schema": { "type": "integer", "default": 0 }, "description": "System query option specifies a non-negative integer n that excludes the first n items of the queried collection from the result. The service returns items starting at position n+1." }, "count": { "name": "$count", "in": "query", "schema": { "type": "boolean", "default": true }, "description": "System query option with a value of true specifies that the total count of items within a collection matching the request be returned along with the result.\n\nAccording to the OData standard the same result is obtain by adding /$count to the service path" }, "expand": { "name": "$expand", "in": "query", "schema": { "type": "string" }, "description": "System query option that specifies a related entity to expand the current response" }, "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 } }, "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." } }, "responses": { "error-model-400": { "description": "Bad Request. The request could not be understood by the server. Check error message and details to further understand the cause.", "content": { "application/json": { "schema": { "type": "object", "required": [ "errorCode", "message" ], "properties": { "errorCode": { "type": "string", "description": "Required, non-null, non-empty, language-independent string. Its value is a service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response." }, "message": { "type": "string", "description": "Required, non-null, non-empty, language-dependent, human-readable string describing the error." }, "details": { "type": "array", "description": "Optional, potentially empty collection of structured instances with code, message, and target following the rules above.", "items": { "$ref": "#/components/schemas/error-details" } } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "error-model-401": { "description": "Unauthorized request. The user could not be identified.", "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "errorCode": "AUTHENTICATION_EXCEPTION", "message": "You are not authorized to perform this action", "details": [] } }, "required": [ "errorCode", "message" ], "properties": { "errorCode": { "type": "string", "description": "Required, non-null, non-empty, language-independent string. Its value is a service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response." }, "message": { "type": "string", "description": "Required, non-null, non-empty, language-dependent, human-readable string describing the error." }, "details": { "type": "array", "description": "Optional, potentially empty collection of structured instances with code, message, and target following the rules above.", "items": { "$ref": "#/components/schemas/error-details" } } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, "error-model-403": { "description": "Forbidden request. The user does not have the necessary permissions for the resource.", "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "errorCode": "AUTHENTICATION_EXCEPTION", "message": "You are not authorized to perform this action", "details": [] } }, "required": [ "errorCode", "message" ], "properties": { "errorCode": { "type": "string", "description": "Required, non-null, non-empty, language-independent string. Its value is a service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response." }, "message": { "type": "string", "description": "Required, non-null, non-empty, language-dependent, human-readable string describing the error." }, "details": { "type": "array", "description": "Optional, potentially empty collection of structured instances with code, message, and target following the rules above.", "items": { "$ref": "#/components/schemas/error-details" } } } } } }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } } } } }