{ "openapi": "3.0.1", "info": { "title": "wxrks API", "version": "3" }, "servers": [ { "url": "https://{host}", "description": "Your wxrks host", "variables": { "host": { "description": "The host you sign in to wxrks with.", "default": "app.wxrks.com" } } } ], "security": [ { "ApiKeyAuth": [] } ], "paths": { "/api/v1/atlas-tm": { "get": { "tags": [ "Translation Memory" ], "summary": "List Translation Memory (TM)", "operationId": "listTranslationMemoryTm", "parameters": [ { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "uuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sourceLocale", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sourceLocales", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "targetLocales", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "client.id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "client.name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "creator.id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "creator.name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "organization", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "clientUUIDs", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "organizationUUIDs", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "ignoredIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "creationDate", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "startCreateDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endCreateDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "domain", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "subDomain", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "note", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "customFields", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } }, { "name": "customFieldsJson", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "idsOnly", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "restrictOwnAccount", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeCustomFields", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageTMDto" } } } } }, "x-permissions": [ "TM_list" ] } }, "/api/v1/atlas-tm/job/{jobId}": { "get": { "tags": [ "Translation Memory" ], "summary": "Get TM Job", "description": "Reports a TM import or export job. `status` is `SCHEDULED`, `STARTING` or `STARTED` while it runs, then `COMPLETED` or `FAILED` (also `INTERRUPTED`, `STOPPED` or `ABANDONED` when the job was cut short). A completed export's `fileName` is a signed link to the file, valid for one hour.", "operationId": "getTmJob", "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TMJobDto" } } } } }, "x-permissions": [ "TM_get_by_id" ] } }, "/api/v1/atlas-tm/{tmUuid}/bulk-importer": { "post": { "tags": [ "Translation Memory" ], "summary": "Import TM File", "operationId": "importTmFile", "parameters": [ { "name": "tmUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "languages", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TMJobDto" } } } } }, "x-permissions": [ "TM_import_segments" ] } }, "/api/v1/atlas-tm/{tmUuid}/export": { "post": { "tags": [ "Translation Memory" ], "summary": "Export TM", "description": "Exports the TM. `format` is required: `tmx` or `xlsx`. With projectId plus workUnitIds or projectStepLevel, exports as TMX only the entries whose current version was saved by those work units of the project (TM updates); the TM must be linked to the project, tuIds and date filters do not apply, and the caller also needs the PROJECT_export_import_file permission. Such an export is `SCHEDULED` first: a few seconds after the request it waits until the translations still on their way to the TM have been written, then runs; after two minutes it ends `FAILED` with failureReason `TM_WRITES_PENDING`, and can be requested again. Leave projectId, workUnitIds and projectStepLevel out to export the whole TM.", "operationId": "exportTm", "parameters": [ { "name": "tmUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TmExportRequest" }, "examples": { "wholeTm": { "summary": "The whole TM, two locales", "description": "wholeTm", "value": { "format": "tmx", "languages": [ "en_us", "de_de" ] } }, "workUnitPath": { "summary": "The entries saved by a project's workflow step", "description": "workUnitPath", "value": { "format": "tmx", "projectId": "e42cd601-bec2-4bb3-b64d-59d07d239b54", "projectStepLevel": 1 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TMJobDto" } } } } }, "x-also-requires": [ "PROJECT_export_import_file" ], "x-permissions": [ "TM_export" ] } }, "/api/v1/atlas/parser/file-params": { "get": { "tags": [ "Projects / Resources and File Params", "Projects / Project Routing / Base Project Setup" ], "summary": "Get File Params", "operationId": "getFileParams", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParserParameters" } } } } }, "x-permissions": [ "PROJECT_RESOURCE_create" ] } }, "/api/v1/translation-memory/{tmUuid}/segment/fuzzy-search": { "get": { "tags": [ "Translation Memory" ], "summary": "Fuzzy Search Segments", "operationId": "fuzzySearchSegments", "parameters": [ { "name": "tmUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceText", "in": "query", "description": "Text to search for.", "required": true, "schema": { "type": "string" }, "example": "Hello world" }, { "name": "targetLocale", "in": "query", "description": "Target locale of the hits.", "required": true, "schema": { "type": "string" }, "example": "fr_fr" }, { "name": "threshold", "in": "query", "description": "Minimum similarity. Default: 0.49.", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "maxHits", "in": "query", "description": "Maximum number of hits. Default: 5.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "sourceContext.type", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sourceContext.previousText", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sourceContext.nextText", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sourceContext.contextKey", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "overviewOnly", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleTmHitDto" } } } } } }, "x-permissions": [ "TM_get_by_id" ] } }, "/api/v1/translation-memory/{tmUuid}/translation-unit": { "post": { "tags": [ "Translation Memory" ], "summary": "Upsert Translation in TU", "description": "The TM must be linked to the caller's organization or one of the caller's org units.", "operationId": "upsertTranslationInTu", "parameters": [ { "name": "tmUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "override", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleTUUpsertData" }, "examples": { "withContextKey": { "description": "withContextKey", "value": { "sourceLocale": "en_us", "sourceText": "Click Save to keep your changes.", "targetLocale": "de_de", "targetText": "Klicken Sie auf Speichern, um Ihre Änderungen zu behalten.", "sourceContext": { "type": "CONTEXT_KEY", "contextKey": "settings.save.hint" } } } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleTUDto" } } } } }, "x-permissions": [ "TM_create_translation_unit" ] } }, "/api/v1/translation-memory/{tmUuid}/translation-unit/fuzzy-search": { "get": { "tags": [ "Translation Memory" ], "summary": "Fuzzy Search Translation Units", "operationId": "fuzzySearchTranslationUnits", "parameters": [ { "name": "tmUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceText", "in": "query", "description": "Text to search for.", "required": true, "schema": { "type": "string" }, "example": "Hello world" }, { "name": "targetLocales", "in": "query", "description": "Target locales of the translations to return. The singular targetLocale is not read by this operation.", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": "de_de" }, { "name": "threshold", "in": "query", "description": "Minimum similarity. Default: 0.49.", "required": false, "schema": { "type": "number", "format": "float" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TranslationUnitMatch" } } } } } }, "x-permissions": [ "TM_get_by_id" ] } }, "/api/v1/translation-memory/{tmUuid}/translation-unit/search": { "get": { "tags": [ "Translation Memory" ], "summary": "Search Translation Units", "operationId": "searchTranslationUnits", "parameters": [ { "name": "tmUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceText", "in": "query", "description": "Text to search for.", "required": true, "schema": { "type": "string" }, "example": "Hello world" }, { "name": "targetLocale", "in": "query", "description": "Target locale of the translations to return.", "required": true, "schema": { "type": "string" }, "example": "fr_fr" }, { "name": "matchType", "in": "query", "description": "How sourceText is matched. Default: Contains.", "required": false, "schema": { "type": "string", "enum": [ "Contains", "StartsWith", "EndsWith", "ExactMatch", "Expression" ] } }, { "name": "isSourceLocale", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "description": "Page number, from 0. Default: 0.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Page size, 1 to 250. Default: 50.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponseTranslationUnitMatch" } } } } }, "x-permissions": [ "TM_get_by_id" ] } }, "/api/v1/translation-memory/{tmUuid}/translation-unit/{tuId}": { "put": { "tags": [ "Translation Memory" ], "summary": "Update Translation in TU", "operationId": "updateTranslationInTu", "parameters": [ { "name": "tmUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tuId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleTUUpdateData" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleTUDto" } } } } }, "x-permissions": [ "TM_update_translation_unit" ] }, "delete": { "tags": [ "Translation Memory" ], "summary": "Delete Translation Unit (TU)", "operationId": "deleteTranslationUnitTu", "parameters": [ { "name": "tmUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tuId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" } }, "x-permissions": [ "TM_delete_translation_unit" ] } }, "/api/v1/translation-memory/{tmUuid}/{tuId}/segment": { "delete": { "tags": [ "Translation Memory" ], "summary": "Delete Translation in TU", "description": "Deletes the translation of one locale from the TU. The TM's source locale can't be deleted: delete the whole TU instead. A TU of another TM, or one with no translation in that locale, answers 404.", "operationId": "deleteTranslationInTu", "parameters": [ { "name": "tmUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tuId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "locale", "in": "query", "description": "Locale of the translation to delete.", "required": true, "schema": { "type": "string" }, "example": "de_de" } ], "responses": { "204": { "description": "No Content" } }, "x-permissions": [ "TM_delete_translation_unit" ] } }, "/api/v2/organization": { "get": { "tags": [ "Organization" ], "summary": "List Organizations", "operationId": "listOrganizations", "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exactMatch", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "excludeOrganizationIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "restrictOwnAccount", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "accountUUID", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "customFields", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } }, { "name": "customFieldsJson", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page to return, starting at 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "description": "Items per page.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageOrganizationDto" } } } } }, "x-permissions": [ "ORGANIZATION_list" ] }, "post": { "tags": [ "Organization" ], "summary": "Create Organization", "operationId": "createOrganization", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDto" } } } } }, "x-permissions": [ "ORGANIZATION_create" ] } }, "/api/v2/organization/{organizationUUID}": { "get": { "tags": [ "Organization" ], "summary": "Get Organization", "operationId": "getOrganization", "parameters": [ { "name": "organizationUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDto" } } } } }, "x-permissions": [ "ORGANIZATION_get_by_id" ] } }, "/api/v2/permission-group": { "get": { "tags": [ "Permission / Permission Group" ], "summary": "List Permission Groups", "operationId": "listPermissionGroups", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionGroup" } } } } } }, "x-permissions": [ "PERMISSION_GROUP_create" ] }, "post": { "tags": [ "Permission / Permission Group" ], "summary": "Create Permission Group", "operationId": "createPermissionGroup", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionGroupDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionGroupDto" } } } } }, "x-permissions": [ "PERMISSION_GROUP_create" ] } }, "/api/v2/permission-group/{uuid}": { "get": { "tags": [ "Permission / Permission Group" ], "summary": "Get Permission Group", "operationId": "getPermissionGroup", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionGroup" } } } } }, "x-permissions": [ "PERMISSION_GROUP_create" ] }, "post": { "tags": [ "Permission / Permission Group" ], "summary": "Update Permission Group", "operationId": "updatePermissionGroup", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionGroupDto" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-permissions": [ "PERMISSION_GROUP_create" ] } }, "/api/v2/permission-group/{uuid}/user/{userUuid}": { "post": { "tags": [ "Permission / Permission Group" ], "summary": "Add User to Permission Group", "operationId": "addUserToPermissionGroup", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-permissions": [ "PERMISSION_GROUP_create" ] }, "delete": { "tags": [ "Permission / Permission Group" ], "summary": "Remove User from Permission Group", "operationId": "removeUserFromPermissionGroup", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-permissions": [ "PERMISSION_GROUP_create" ] } }, "/api/v2/permission/grantee/{granteeUuid}/permission/{permissionUuid}": { "post": { "tags": [ "Permission" ], "summary": "Grant Permission for Grantee", "description": "The grantee is a user, an organization, an org unit or a permission group of your account; any other grantee answers `403`. You can only grant a permission you hold yourself, otherwise `403`. Granting a permission the grantee already has changes nothing; granting one whose inheritance was turned off for the grantee turns it back on.", "operationId": "grantPermissionForGrantee", "parameters": [ { "name": "granteeUuid", "in": "path", "description": "A user, organization, org unit or permission group of your account.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "1c9e4b7a-5d2f-4e8a-b3c6-7f0a2d5e9b14" }, { "name": "permissionUuid", "in": "path", "description": "The permission, from listPermissions.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "7c4e9b2d-6a1f-4d83-b5e0-3a8c1f7d2e56" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "x-roles": [ "SYSADMIN", "ADMIN", "ACCOUNT_ADMIN" ] }, "delete": { "tags": [ "Permission" ], "summary": "Revoke Permission for Grantee", "description": "The grantee is a user or a permission group of your account. A grantee outside your account answers `403`, an organization or org unit `422`. You can only revoke a permission you hold yourself, otherwise `403`. When the grantee is a user who inherits the permission from one of their roles, revoking it turns the inheritance off for that user. An account admin can turn off only these inherited permissions, and gets `422` for any other: `USER_access_tms`, `USER_disable_augmented_translation_actions`, `ORG_UNIT_add_contact`, `ORG_UNIT_remove_contact`, `ORG_UNIT_add_tm`, `ORG_UNIT_remove_tm`, `ORG_UNIT_edit_tm`, `ORG_UNIT_add_glossary`, `ORG_UNIT_remove_glossary`, `ORG_UNIT_edit_glossary`, `PROJECT_copy_source_to_target`, `EDITOR_clear_translations`, `EDITOR_turn_off_inherited_qa_checks`, `EDITOR_confirm_all`, `EDITOR_edit_own_comments`, `EDITOR_hide_comments` and `EDITOR_resolve_comments`.", "operationId": "revokePermissionForGrantee", "parameters": [ { "name": "granteeUuid", "in": "path", "description": "A user, organization, org unit or permission group of your account.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "1c9e4b7a-5d2f-4e8a-b3c6-7f0a2d5e9b14" }, { "name": "permissionUuid", "in": "path", "description": "The permission, from listPermissions.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "7c4e9b2d-6a1f-4d83-b5e0-3a8c1f7d2e56" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "x-roles": [ "SYSADMIN", "ADMIN", "ACCOUNT_ADMIN" ] } }, "/api/v2/permission/{granteeUuid}": { "get": { "tags": [ "Permission" ], "summary": "List Permissions", "operationId": "listPermissions", "parameters": [ { "name": "granteeUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionGrantDto" } } } } } }, "x-roles": [ "SYSADMIN", "ADMIN", "ACCOUNT_ADMIN" ] } }, "/api/v3/auth": { "post": { "tags": [ "Authentication and Reference / Auth" ], "summary": "Auth API Token", "description": "Exchanges the API user's `accessKey` and `secret` for a token. On success the token comes back in the `X-AUTH-TOKEN` response header; send it in a header of the same name on every other call.\n", "operationId": "authApiToken", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiLoginDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [] } }, "/api/v3/client": { "get": { "tags": [ "Org Units" ], "summary": "List Org Units", "operationId": "listOrgUnits", "parameters": [ { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exactMatch", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "withoutOrganization", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "queryType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "NOTIFICATION", "AUTOMATION", "LLM", "DEFAULT" ] } }, { "name": "targetUserUUID", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "organizationUUID", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "organizationUuids", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "uuids", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "restrictOwnAccount", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "autopilotEnabled", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "excludeOrgUnitIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "excludeOrgUnitUuids", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "organizationIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "customFields", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } }, { "name": "customFieldsJson", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page to return, starting at 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "description": "Items per page.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "includeCustomFields", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageFatClientDto" } } } } }, "x-permissions": [ "ORG_UNIT_list" ] }, "post": { "tags": [ "Org Units" ], "summary": "Create Org Unit", "operationId": "createOrgUnit", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCreateDtoV3" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimpleClientDto" } } } } }, "x-permissions": [ "ORG_UNIT_create" ] } }, "/api/v3/client/translation-memory/{tmUuid}": { "post": { "tags": [ "Translation Memory" ], "summary": "Associate Translation Memory with Org Units", "description": "The caller also needs the ORG_UNIT_update permission on each org unit in orgUnitUuids. Org units that don't exist are ignored.", "operationId": "associateTranslationMemoryWithOrgUnits", "parameters": [ { "name": "tmUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "orgUnitUuids", "in": "query", "description": "Org units to associate, comma-separated.", "required": true, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "example": "b146d2ca-aa95-429f-8860-da62701de326" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TmOrgUnitAssociationRequest" }, "examples": { "readWrite": { "description": "readWrite", "value": { "read": true, "write": true, "isDefault": false, "penalty": 5 } } } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-also-requires": [ "ORG_UNIT_update" ], "x-permissions": [ "ORG_UNIT_add_tm" ] } }, "/api/v3/client/{clientUuid}": { "get": { "tags": [ "Org Units" ], "summary": "Get Org Unit", "operationId": "getOrgUnit", "parameters": [ { "name": "clientUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FatClientDto" } } } } }, "x-permissions": [ "ORG_UNIT_get_by_id" ] } }, "/api/v3/connector/eloqua/config": { "put": { "tags": [ "Integrations / Eloqua" ], "summary": "Update Configuration", "operationId": "eloquaUpdateConfiguration", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EloquaConfig" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EloquaConfig" } } } } }, "x-permissions": [ "CONNECTORS_create_config" ] }, "post": { "tags": [ "Integrations / Eloqua" ], "summary": "Create Configuration", "operationId": "eloquaCreateConfiguration", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EloquaConfig" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EloquaConfig" } } } } }, "x-permissions": [ "CONNECTORS_create_config" ] } }, "/api/v3/connector/eloqua/config/{configUUID}": { "get": { "tags": [ "Integrations / Eloqua" ], "summary": "Get Configuration", "operationId": "eloquaGetConfiguration", "parameters": [ { "name": "configUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EloquaConfig" } } } } }, "x-permissions": [ "CONNECTORS_create_config" ] } }, "/api/v3/connector/eloqua/sync": { "post": { "tags": [ "Integrations / Eloqua" ], "summary": "Create Project", "operationId": "eloquaCreateProject", "parameters": [ { "name": "requestId", "in": "query", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncRequestDto" } } } } }, "x-permissions": [ "PROJECT_create" ] } }, "/api/v3/connector/eloqua/translation/{projectUUID}": { "post": { "tags": [ "Integrations / Eloqua" ], "summary": "Deliver Translations", "operationId": "eloquaDeliverTranslations", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "requestId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDeliveryFilters" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncRequestDto" } } } } }, "x-permissions": [ "PROJECT_create" ] } }, "/api/v3/connector/github/config": { "put": { "tags": [ "Integrations / GitHub" ], "summary": "Update Configuration", "operationId": "githubUpdateConfiguration", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GithubConfig" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "x-permissions": [ "CONNECTORS_create_config" ] }, "post": { "tags": [ "Integrations / GitHub" ], "summary": "Create Configuration", "operationId": "githubCreateConfiguration", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GithubConfig" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GithubConfig" } } } } }, "x-permissions": [ "CONNECTORS_create_config" ] } }, "/api/v3/connector/github/config/{configUUID}": { "get": { "tags": [ "Integrations / GitHub" ], "summary": "Get Configuration", "operationId": "githubGetConfiguration", "parameters": [ { "name": "configUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GithubConfig" } } } } }, "x-permissions": [ "CONNECTORS_create_config" ] } }, "/api/v3/connector/github/config/{configUUID}/repo": { "get": { "tags": [ "Integrations / GitHub" ], "summary": "Get Repository Configurations", "operationId": "getRepositoryConfigurations", "parameters": [ { "name": "configUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RepositoryConfig" } } } } } }, "x-permissions": [ "CONNECTORS_create_config" ] }, "post": { "tags": [ "Integrations / GitHub" ], "summary": "Upsert Repository Configurations", "description": "Two repository configurations of one GitHub configuration can't share the same repository (`name` and `owner`), `configPath` and `baseBranch`, even with different `projectTag`s: deleteRepositoryConfiguration finds a repository configuration by them. A configuration that repeats another's is rejected, and none of the list is saved.", "operationId": "upsertRepositoryConfigurations", "parameters": [ { "name": "configUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RepositoryConfig" } }, "examples": { "newRepository": { "description": "newRepository", "value": [ { "name": "docs-site", "owner": "example-org", "baseBranch": "main", "configPath": "wxrks.yml", "projectTag": "docs-site", "fileSuffix": "-l10n" } ] } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "x-permissions": [ "CONNECTORS_create_config" ] } }, "/api/v3/connector/github/config/{configUUID}/repo/{name}/owner/{owner}/config-path/{configPath}/base-branch/{baseBranch}": { "delete": { "tags": [ "Integrations / GitHub" ], "summary": "Delete Repository Configuration", "operationId": "deleteRepositoryConfiguration", "parameters": [ { "name": "configUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "owner", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "configPath", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "baseBranch", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "x-permissions": [ "CONNECTORS_create_config" ] } }, "/api/v3/connector/github/sync": { "post": { "tags": [ "Integrations / GitHub" ], "summary": "Create Project", "operationId": "githubCreateProject", "parameters": [ { "name": "requestId", "in": "query", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncRequestDto" } } } } }, "x-permissions": [ "PROJECT_create" ] } }, "/api/v3/connector/github/translation/{projectUUID}": { "post": { "tags": [ "Integrations / GitHub" ], "summary": "Deliver Translations", "operationId": "githubDeliverTranslations", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "requestId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "writeToS3", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "writeToDisk", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "skipGitHub", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "skipDatabaseUpdate", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "createSeparateOutputFolder", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "skipBuildTranslatedFile", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDeliveryFilters" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncRequestDto" } } } } }, "x-permissions": [ "PROJECT_create" ] } }, "/api/v3/connector/wordpress/config": { "put": { "tags": [ "Integrations / WordPress" ], "summary": "Update Configuration", "operationId": "wordpressUpdateConfiguration", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WordPressConfig" }, "examples": { "update": { "description": "update", "value": { "uuid": "5e0b3c8a-7f2d-4a61-9b4e-1d6c8a2f0e97", "name": "Company blog", "orgUnitUuid": "6b1f0c2e-8d4a-4f3b-9c5e-2a7d9e1b4c60", "baseUrl": "https://blog.example.com", "wpUser": "wxrks-integration", "wpPassword": "wp-application-password", "defaultWorkflows": [ "TRANSLATION", "REVIEW" ], "strategy": "DEFAULT" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WordPressConfig" } } } } }, "x-permissions": [ "CONNECTORS_create_config" ] }, "post": { "tags": [ "Integrations / WordPress" ], "summary": "Create Configuration", "operationId": "wordpressCreateConfiguration", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WordPressConfig" }, "examples": { "create": { "description": "create", "value": { "name": "Company blog", "orgUnitUuid": "6b1f0c2e-8d4a-4f3b-9c5e-2a7d9e1b4c60", "baseUrl": "https://blog.example.com", "wpUser": "wxrks-integration", "wpPassword": "wp-application-password", "defaultWorkflows": [ "TRANSLATION" ], "strategy": "DEFAULT" } } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WordPressConfig" } } } } }, "x-permissions": [ "CONNECTORS_create_config" ] } }, "/api/v3/connector/wordpress/config/{configUUID}": { "get": { "tags": [ "Integrations / WordPress" ], "summary": "Get Configuration", "operationId": "wordpressGetConfiguration", "parameters": [ { "name": "configUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WordPressConfig" } } } } }, "x-permissions": [ "CONNECTORS_create_config" ] } }, "/api/v3/connector/wordpress/sync": { "post": { "tags": [ "Integrations / WordPress" ], "summary": "Create Project", "operationId": "wordpressCreateProject", "parameters": [ { "name": "requestId", "in": "query", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncRequestDto" } } } } }, "x-permissions": [ "PROJECT_create" ] } }, "/api/v3/connector/wordpress/translation/{projectUUID}": { "post": { "tags": [ "Integrations / WordPress" ], "summary": "Deliver Translations", "operationId": "wordpressDeliverTranslations", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "requestId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDeliveryFilters" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncRequestDto" } } } } }, "x-permissions": [ "PROJECT_create" ] } }, "/api/v3/custom-field": { "post": { "tags": [ "Custom Fields" ], "summary": "Create Custom Fields", "operationId": "createCustomFields", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldDto" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-roles": [ "SYSADMIN", "ADMIN", "ACCOUNT_ADMIN" ] } }, "/api/v3/custom-field/entity/{entityType}/{entityUUID}": { "put": { "tags": [ "Custom Fields" ], "summary": "Update Custom Fields", "operationId": "updateCustomFields", "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entityUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } } } } } } }, "/api/v3/custom-field/list": { "get": { "tags": [ "Custom Fields" ], "summary": "List Custom Fields", "operationId": "listCustomFields", "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "types", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "entities", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "value", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "entityOrganizations", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "entityOrgUnits", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "entityGlossaries", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "entityMemories", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "entityOrgUnitMembers", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "entityUserRoles", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "entityExcludedUsers", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "recordOrgUnits", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "viewOrgUnits", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "viewRoles", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "viewExcludedUsers", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fillOrgUnits", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fillRoles", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "fillExcludedUsers", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page to return, starting at 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "description": "Items per page.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageCustomFieldDto" } } } } }, "x-permissions": [ "USER_view_custom_fields", "USER_edit_custom_fields" ] } }, "/api/v3/glossary": { "get": { "tags": [ "Glossary / Glossary Management" ], "summary": "List Glossary", "operationId": "listGlossary", "parameters": [ { "name": "glossaryUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "organizationUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "orgUnitUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "ignoreIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "idsOnly", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "restrictOwnAccount", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "customFields", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } }, { "name": "customFieldsJson", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page to return, starting at 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "description": "Items per page.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "includeCustomFields", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageGlossaryDto" } } } } }, "x-permissions": [ "GLOSSARY_list" ] }, "put": { "tags": [ "Glossary / Glossary Management" ], "summary": "Update Glossary", "description": "Replaces the glossary with the body. An omitted domain or subDomain is cleared, and customAttributes is replaced by the list sent (an omitted list removes them all). An omitted or blank name and an omitted note keep their stored values.", "operationId": "updateGlossary", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryUpdateRequest" }, "examples": { "renameAndAddLanguage": { "description": "renameAndAddLanguage", "value": { "uuid": "bfb645fd-ad81-4f77-8744-0c13782b6243", "name": "Product terminology", "note": "Approved terms for the product UI.", "languages": [ "en_us", "de_de", "fr_fr" ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryDto" } } } } }, "x-permissions": [ "GLOSSARY_update" ] }, "post": { "tags": [ "Glossary / Glossary Management" ], "summary": "Create Glossary", "operationId": "createGlossary", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryCreateRequest" }, "examples": { "minimal": { "description": "minimal", "value": { "name": "Product terminology", "note": "Approved terms for the product UI.", "languages": [ "en_us", "de_de" ], "organization": { "uuid": "97b55a5e-9133-464c-937e-a99c8156c23e" }, "orgUnits": [ { "uuid": "b146d2ca-aa95-429f-8860-da62701de326" } ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryDto" } } } } }, "x-permissions": [ "GLOSSARY_create" ] } }, "/api/v3/glossary/concept-entries/{conceptId}": { "get": { "tags": [ "Glossary / Concept Entries" ], "summary": "Get a Concept Entry", "operationId": "getAConceptEntry", "parameters": [ { "name": "conceptId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConceptEntryDtoV3" } } } } }, "x-permissions": [ "GLOSSARY_get_by_id" ] } }, "/api/v3/glossary/export/{glossaryUuid}/{fileType}": { "get": { "tags": [ "Glossary / Import and Export" ], "summary": "Init Export Glossary", "operationId": "initExportGlossary", "parameters": [ { "name": "glossaryUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fileType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "languages", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "exportFields", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "customAttributes", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadTranslatedFiles" } } } } }, "x-permissions": [ "GLOSSARY_export" ] } }, "/api/v3/glossary/export/{glossaryUuid}/{fileType}/{requestUUID}/status": { "get": { "tags": [ "Glossary / Import and Export" ], "summary": "Export Glossary Status", "operationId": "exportGlossaryStatus", "parameters": [ { "name": "glossaryUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fileType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "requestUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadTranslatedFiles" } } } } }, "x-permissions": [ "GLOSSARY_export" ] } }, "/api/v3/glossary/term": { "post": { "tags": [ "Glossary / Terms" ], "summary": "Create a New Term", "description": "`glossaryUuid`, `text`, `language` and `status` are required, and `status` must be `Approved` on create. The fields the glossary marks as required for terms must be filled too.", "operationId": "createANewTerm", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermCreateRequest" }, "examples": { "minimal": { "description": "minimal", "value": { "glossaryUuid": "bfb645fd-ad81-4f77-8744-0c13782b6243", "text": "release note", "language": "en_us", "status": "Approved", "note": "Reviewed by the documentation team." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermEntryDto" } } } } }, "x-permissions": [ "GLOSSARY_create_term" ] } }, "/api/v3/glossary/term/check-duplicated": { "post": { "tags": [ "Glossary / Terms" ], "summary": "Check for Duplicated Terms", "operationId": "checkForDuplicatedTerms", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckDuplicatedTermsRequest" }, "examples": { "pair": { "description": "pair", "value": { "glossaryIds": [ 1042 ], "sourceLanguage": "en_us", "sourceTerm": "release note", "targetLanguage": "de_de", "targetTerm": "Versionshinweis" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } }, "x-permissions": [ "EDITOR_add_terms" ] } }, "/api/v3/glossary/term/recognition": { "get": { "tags": [ "Glossary / Terms" ], "summary": "Search Terms (Term Recognition)", "operationId": "searchTermsTermRecognition", "parameters": [ { "name": "text", "in": "query", "description": "Text to search for terms.", "required": true, "schema": { "type": "string" }, "example": "Click Save to keep your changes." }, { "name": "sourceLanguage", "in": "query", "description": "Language of the text.", "required": true, "schema": { "type": "string" }, "example": "en_us" }, { "name": "glossaryUuids", "in": "query", "description": "Glossaries to search.", "required": true, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "example": "bfb645fd-ad81-4f77-8744-0c13782b6243" }, { "name": "targetLanguage", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TermEntryOnSegment" } } } } } }, "x-permissions": [ "EDITOR_glossary_terms_search" ] } }, "/api/v3/glossary/term/search/params": { "get": { "tags": [ "Glossary / Terms" ], "summary": "Search Terms by Parameters", "operationId": "searchTermsByParameters", "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "queryLocale", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "targetLocale", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filename", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "statusList", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "glossaryIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "tmId", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "rtl", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "createdByUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "modifiedByUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "createdAtStart", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "createdAtEnd", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "modifiedAtStart", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "modifiedAtEnd", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "projectId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "workUnitId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "workflowUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "matchType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Contains", "StartsWith", "EndsWith", "ExactMatch", "Expression" ] } }, { "name": "ignoreCase", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortDirection", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "isSourceLocale", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageTermEntryOnSegment" } } } } }, "x-permissions": [ "EDITOR_glossary_terms_search" ] } }, "/api/v3/glossary/term/search/segment": { "get": { "tags": [ "Glossary / Terms" ], "summary": "Search Terms Based on a Segment", "description": "Finds the terms that occur in the segment. `glossaryIds` chooses the glossaries to search; without it, the search covers every glossary the caller can reach. A vendor reaches a project's glossaries through `workUnitId`, a work unit where it has a task. When no glossary is reachable, the answer is `[]`.", "operationId": "searchTermsBasedOnASegment", "parameters": [ { "name": "segment", "in": "query", "description": "Segment text to search for terms.", "required": true, "schema": { "type": "string" }, "example": "Click Save to keep your changes." }, { "name": "sourceLanguage", "in": "query", "description": "Language of the segment.", "required": true, "schema": { "type": "string" }, "example": "en_us" }, { "name": "targetLanguage", "in": "query", "description": "Language of the translations to return. Without it, each term found comes with `sourceTerm` only and no `targetTerm`.", "required": false, "schema": { "type": "string" }, "example": "de_de" }, { "name": "forbidden", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "workUnitId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "statusList", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "glossaryIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "matchType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Contains", "StartsWith", "EndsWith", "ExactMatch", "Expression" ] } }, { "name": "orderByGlossaryPriority", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TermEntryOnSegment" } } } } } }, "x-permissions": [ "EDITOR_glossary_terms_search" ] } }, "/api/v3/glossary/term/{termUuid}": { "get": { "tags": [ "Glossary / Terms" ], "summary": "Get Term", "operationId": "getTerm", "parameters": [ { "name": "termUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermEntryDto" } } } } }, "x-permissions": [ "EDITOR_glossary_terms_search" ] }, "put": { "tags": [ "Glossary / Terms" ], "summary": "Update a Term", "operationId": "updateATerm", "parameters": [ { "name": "termUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermUpdateRequest" }, "examples": { "statusAndNote": { "description": "statusAndNote", "value": { "text": "Versionshinweis", "status": "Under_Review", "note": "Reviewed by the documentation team." } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermEntryDto" } } } } }, "x-permissions": [ "GLOSSARY_update_term" ] }, "delete": { "tags": [ "Glossary / Terms" ], "summary": "Delete a Term", "operationId": "deleteATerm", "parameters": [ { "name": "termUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-permissions": [ "GLOSSARY_delete_term" ] } }, "/api/v3/glossary/term/{termUuid}/translations": { "get": { "tags": [ "Glossary / Terms" ], "summary": "Get Translations for a Term", "operationId": "getTranslationsForATerm", "parameters": [ { "name": "termUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TermDTO" } } } } } }, "x-permissions": [ "EDITOR_glossary_terms_search" ] } }, "/api/v3/glossary/{glossaryUuid}": { "get": { "tags": [ "Glossary / Glossary Management" ], "summary": "Get Glossary", "operationId": "getGlossary", "parameters": [ { "name": "glossaryUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryDto" } } } } }, "x-permissions": [ "GLOSSARY_get_by_id" ] }, "delete": { "tags": [ "Glossary / Glossary Management" ], "summary": "Delete Glossary", "operationId": "deleteGlossary", "parameters": [ { "name": "glossaryUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-permissions": [ "GLOSSARY_delete" ] } }, "/api/v3/glossary/{glossaryUuid}/clear": { "post": { "tags": [ "Glossary / Glossary Management" ], "summary": "Clear Glossary", "operationId": "clearGlossary", "parameters": [ { "name": "glossaryUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-permissions": [ "GLOSSARY_delete_term" ] } }, "/api/v3/glossary/{glossaryUuid}/concept-entries": { "get": { "tags": [ "Glossary / Concept Entries" ], "summary": "List Concept Entries", "operationId": "listConceptEntries", "parameters": [ { "name": "conceptUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "glossaryUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "language", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "text", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "matchMode", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "CONTAINS", "EXACT", "STARTS_WITH" ] } }, { "name": "languages", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "strictLanguageMatch", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "createdBy", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "createdAtStart", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "createdAtEnd", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "lastModifiedAtStart", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "lastModifiedAtEnd", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "Under_Review", "Approved", "Published", "Preferred", "Deprecated" ] } } }, { "name": "customAttributeName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "customAttributeType", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "customAttributeValue", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page to return, starting at 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "description": "Items per page.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageConceptEntryDtoV3" } } } } }, "x-permissions": [ "GLOSSARY_get_by_id" ] } }, "/api/v3/glossary/{glossaryUuid}/import": { "post": { "tags": [ "Glossary / Import and Export" ], "summary": "Import TBX", "description": "Imports a TBX or XLSX file into the glossary. The file name's extension (`.tbx` or `.xlsx`) decides the format.", "operationId": "importTbx", "parameters": [ { "name": "glossaryUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "description": "The file to import: `.tbx` or `.xlsx`. The extension of its name decides the format.", "format": "binary", "example": "glossary.tbx" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryJobDto" } } } } }, "x-permissions": [ "GLOSSARY_update" ] } }, "/api/v3/glossary/{glossaryUuid}/jobs": { "get": { "tags": [ "Glossary / Import and Export" ], "summary": "List Imports", "operationId": "listImports", "parameters": [ { "name": "glossaryUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "glossaryId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "jobType", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page to return, starting at 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "description": "Items per page.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GlossaryJobDto" } } } } } }, "x-permissions": [ "GLOSSARY_get_by_id" ] } }, "/api/v3/glossary/{glossaryUuid}/last-import-job": { "get": { "tags": [ "Glossary / Import and Export" ], "summary": "Last Import", "operationId": "lastImport", "parameters": [ { "name": "glossaryUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryJobDto" } } } } }, "x-permissions": [ "GLOSSARY_get_by_id" ] } }, "/api/v3/glossary/{glossaryUuid}/org-unit-settings": { "post": { "tags": [ "Glossary / Glossary Management" ], "summary": "Associate Glossary with Org Units", "operationId": "associateGlossaryWithOrgUnits", "parameters": [ { "name": "glossaryUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlossaryOrgUnitSettingsParams" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GlossaryOrgUnitSettingsDto" } } } } } }, "x-permissions": [ "ORG_UNIT_add_glossary" ] } }, "/api/v3/language": { "get": { "tags": [ "Authentication and Reference / Locale" ], "summary": "List Languages", "operationId": "listLanguages", "parameters": [ { "name": "orgUnitUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } } } } } } } }, "/api/v3/multi-project": { "get": { "tags": [ "Projects / Project Routing / Configuration" ], "summary": "List Project Routing Configs", "operationId": "listProjectRoutingConfigs", "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sourceLanguage", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "orgUnit", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "targetLanguages", "in": "query", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page to return, starting at 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "description": "Items per page.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageMultiProjectConfigDto" } } } } }, "x-permissions": [ "PROJECT_create" ] } }, "/api/v3/multi-project/config/upsert": { "post": { "tags": [ "Projects / Project Routing / Configuration" ], "summary": "Project Routing Config", "operationId": "projectRoutingConfig", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiProjectConfigDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } }, "x-permissions": [ "PROJECT_create" ] } }, "/api/v3/multi-project/{baseProjectUuid}/status": { "get": { "tags": [ "Projects / Project Routing / Execution" ], "summary": "Project Routing Status", "operationId": "projectRoutingStatus", "parameters": [ { "name": "baseProjectUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CacheProgress" } } } } }, "x-permissions": [ "PROJECT_create" ] } }, "/api/v3/multi-project/{configUuid}": { "get": { "tags": [ "Projects / Project Routing / Configuration" ], "summary": "Search Project Routing Config", "operationId": "searchProjectRoutingConfig", "parameters": [ { "name": "configUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiProjectConfigDto" } } } } }, "x-permissions": [ "PROJECT_create" ] } }, "/api/v3/multi-project/{configUuid}/preview": { "post": { "tags": [ "Projects / Project Routing / Execution" ], "summary": "Project Routing Preview", "operationId": "projectRoutingPreview", "parameters": [ { "name": "configUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "baseProjectUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiProjectConfigDto" } } } } }, "x-permissions": [ "PROJECT_create" ] } }, "/api/v3/multi-project/{configUuid}/project-create": { "post": { "tags": [ "Projects / Project Routing / Execution" ], "summary": "Create Project Routing", "operationId": "createProjectRouting", "parameters": [ { "name": "configUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiProjectCreationParams" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-permissions": [ "PROJECT_create" ] } }, "/api/v3/net-rate-settings/list-account": { "get": { "tags": [ "Net Rate" ], "summary": "List Account Net Rate Settings", "operationId": "listAccountNetRateSettings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NetRateSettingsDto" } } } } } }, "x-roles": [ "SYSADMIN", "ADMIN", "ACCOUNT_ADMIN" ] } }, "/api/v3/net-rate-settings/list-org-unit-account/{orgUnitUuid}": { "get": { "tags": [ "Net Rate" ], "summary": "List Org Unit Net Rate Settings", "operationId": "listOrgUnitNetRateSettings", "parameters": [ { "name": "orgUnitUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NetRateSettingsDto" } } } } } }, "x-roles": [ "SYSADMIN", "ADMIN", "ACCOUNT_ADMIN" ] } }, "/api/v3/net-rate-settings/{uuid}": { "get": { "tags": [ "Net Rate" ], "summary": "Get Net Rate Settings", "operationId": "getNetRateSettings", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetRateSettingsDto" } } } } }, "x-roles": [ "SYSADMIN", "ADMIN", "ACCOUNT_ADMIN" ] } }, "/api/v3/payable": { "get": { "tags": [ "Accounting / Payables" ], "summary": "List Payables", "operationId": "listPayables", "parameters": [ { "name": "vendorName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "creationDate.start", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "creationDate.end", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dueDate.start", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dueDate.end", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "statuses", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "PENDING", "PENDING_APPROVAL", "READY", "PROCESSING", "AWAITING_RECONCILIATION", "PAID", "CLOSED", "CANCELLED", "ERROR" ] } } }, { "name": "vendor", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "missingAccountingInfo", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "paymentMethods", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "PAYONEER", "PAYPAL", "BANK", "QUICKBOOKS" ] } } }, { "name": "serviceProviderAccountUuids", "in": "query", "description": "Payables approved and paid by these service provider accounts", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "withoutServiceProvider", "in": "query", "description": "Payables approved and paid by the account itself; combined with serviceProviderAccountUuids, either one matches", "required": false, "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page to return, starting at 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "description": "Items per page.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagePayableDto" } } } } }, "x-permissions": [ "PAYABLES_get_payables" ] } }, "/api/v3/payable/create": { "post": { "tags": [ "Accounting / Payables" ], "summary": "Create Payable for an Account", "operationId": "createPayableForAnAccount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayableRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-permissions": [ "PAYABLES_create" ] } }, "/api/v3/payable/import/status/{requestUuid}": { "get": { "tags": [ "Accounting / Payables" ], "summary": "Get Payables Import Status", "operationId": "getPayablesImportStatus", "parameters": [ { "name": "requestUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayableImportResultDto" } } } } }, "x-permissions": [ "PAYABLES_import" ] } }, "/api/v3/payable/import/{accountUuid}": { "post": { "tags": [ "Accounting / Payables" ], "summary": "Import Payables from Spreadsheet", "operationId": "importPayablesFromSpreadsheet", "parameters": [ { "name": "accountUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "timezone", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "serviceProviderAccountUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } } }, "x-permissions": [ "PAYABLES_import" ] } }, "/api/v3/payable/import/{accountUuid}/json": { "post": { "tags": [ "Accounting / Payables" ], "summary": "Import Payables from JSON", "operationId": "importPayablesFromJson", "parameters": [ { "name": "accountUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayableBatchRequestDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayableBatchResultDto" } } } } }, "x-permissions": [ "PAYABLES_import" ] } }, "/api/v3/payable/summary": { "get": { "tags": [ "Accounting / Payables" ], "summary": "Payable Summary", "operationId": "payableSummary", "parameters": [ { "name": "vendorName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "creationDate.start", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "creationDate.end", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dueDate.start", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dueDate.end", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "statuses", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "PENDING", "PENDING_APPROVAL", "READY", "PROCESSING", "AWAITING_RECONCILIATION", "PAID", "CLOSED", "CANCELLED", "ERROR" ] } } }, { "name": "vendor", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "missingAccountingInfo", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "paymentMethods", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "PAYONEER", "PAYPAL", "BANK", "QUICKBOOKS" ] } } }, { "name": "serviceProviderAccountUuids", "in": "query", "description": "Payables approved and paid by these service provider accounts", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "withoutServiceProvider", "in": "query", "description": "Payables approved and paid by the account itself; combined with serviceProviderAccountUuids, either one matches", "required": false, "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page to return, starting at 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "description": "Items per page.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayablesSummaryDto" } } } } }, "x-permissions": [ "PAYABLES_get_summary" ] } }, "/api/v3/payable/{payableId}/invoice-file": { "delete": { "tags": [ "Accounting / Payables" ], "summary": "Delete Payable Attachment", "operationId": "deletePayableAttachment", "parameters": [ { "name": "payableId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayableDto" } } } } }, "x-permissions": [ "PAYABLES_get_payables" ] } }, "/api/v3/payable/{payableUuid}": { "get": { "tags": [ "Accounting / Payables" ], "summary": "Get Payable", "operationId": "getPayable", "parameters": [ { "name": "payableUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayableDto" } } } } }, "x-permissions": [ "PAYABLES_get_payables" ] } }, "/api/v3/payable/{payableUuid}/approve": { "put": { "tags": [ "Accounting / Payables" ], "summary": "Approve Payable", "operationId": "approvePayable", "parameters": [ { "name": "payableUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayableDto" } } } } }, "x-permissions": [ "PAYABLES_approve" ] } }, "/api/v3/payable/{payableUuid}/cancel-payable": { "put": { "tags": [ "Accounting / Payables" ], "summary": "Cancel Payable", "operationId": "cancelPayable", "parameters": [ { "name": "payableUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayableDto" } } } } }, "x-permissions": [ "PAYABLES_cancel" ] } }, "/api/v3/portal/translate": { "post": { "tags": [ "Portal" ], "summary": "Translate (Context Sensitive)", "description": "Translates the content synchronously. `originalContent` (the text to translate), `sourceLocale` and `targetLocale` (for example `en_us`, `fr_fr`) are required; `orgUnitUuid` (the org unit whose translation settings apply) is optional.", "operationId": "translateContextSensitive", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalTranslateRequest" }, "examples": { "translate": { "description": "translate", "value": { "originalContent": "Our support team reviews the release notes before Friday.", "sourceLocale": "en_us", "targetLocale": "pt_br", "orgUnitUuid": "6b1f0c2e-8d4a-4f3b-9c5e-2a7d9e1b4c60" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } } } } }, "/api/v3/portal/translations": { "post": { "tags": [ "Portal" ], "summary": "Translate (Context Sensitive) - Async", "description": "Starts a translation and answers 202 with the request; poll getTranslationResult (the Location header) for the result. `originalContent` (the text to translate), `sourceLocale` and `targetLocale` (for example `en_us`, `fr_fr`) are required; `orgUnitUuid` (the org unit whose translation settings apply) is optional.", "operationId": "translateContextSensitiveAsync", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalTranslateRequest" }, "examples": { "translate": { "description": "translate", "value": { "originalContent": "Our support team reviews the release notes before Friday.", "sourceLocale": "en_us", "targetLocale": "pt_br", "orgUnitUuid": "6b1f0c2e-8d4a-4f3b-9c5e-2a7d9e1b4c60" } } } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalTranslationRequestDto" } } } } } } }, "/api/v3/portal/translations/{requestUuid}": { "get": { "tags": [ "Portal" ], "summary": "Get Translation Result", "operationId": "getTranslationResult", "parameters": [ { "name": "requestUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalTranslationRequestDto" } } } } } } }, "/api/v3/price-list": { "get": { "tags": [ "Price List" ], "summary": "List Price Lists", "operationId": "listPriceLists", "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "accountDefault", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "currencies", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sources", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "targets", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "chargeBy", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "WORD", "HOUR" ] } } }, { "name": "accountUUID", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "excludeOrganizationUUID", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "orgUnitUUID", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "organizationUUID", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "organizationIds", "in": "query", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "orgUnitIds", "in": "query", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "isSysAdmin", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page to return, starting at 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "description": "Items per page.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagePriceListDto" } } } } }, "x-permissions": [ "PRICE_LIST_list" ] } }, "/api/v3/project": { "get": { "tags": [ "Projects / Project Management" ], "summary": "List Projects", "operationId": "listProjects", "parameters": [ { "name": "uuids", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "reference", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "purchaseOrder", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "createDate", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "dueDate", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "startCreateDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endCreateDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDueDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDueDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "isContinuous", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "targetUserUUID", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "unassigned", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "contactPersonUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectManagerUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectManagerUuids", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "projectGroupId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceLocales", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "targetLocales", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "organizationUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "orgUnitUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "orgUnitUuids", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "sourceQuery", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "targetQuery", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fileName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "invoiceUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "prompt", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "orgUnitName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "orgName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "projectManagerName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "contactName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page to return, starting at 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "description": "Items per page.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageProjectDto" } } } } }, "x-permissions": [ "PROJECT_list" ] }, "post": { "tags": [ "Projects / Project Management" ], "summary": "Create Project", "description": "Creates a project from the body. With `id-only`, the body is ignored and an empty project is created instead (the base project of *Project Routing*), optionally for `clientUuid`, `sourceLocale` and `contentMode`.\n", "operationId": "createProject", "parameters": [ { "name": "id-only", "in": "query", "description": "Create an empty project and ignore the body.", "schema": { "type": "boolean" } }, { "name": "inferDefaultSettings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectDto" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDto" } } } } }, "x-permissions": [ "PROJECT_create" ] } }, "/api/v3/project/ci": { "post": { "tags": [ "Projects / Continuous Project" ], "summary": "Create Continuous Project", "operationId": "createContinuousProject", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContinuousProject" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDto" } } } } }, "x-permissions": [ "PROJECT_create" ] } }, "/api/v3/project/ci/{orgUnitUUID}/{productTag}": { "get": { "tags": [ "Projects / Continuous Project" ], "summary": "Get Continuous Project", "operationId": "getContinuousProject", "parameters": [ { "name": "orgUnitUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "productTag", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectStatus", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDto" } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] }, "post": { "tags": [ "Projects / Continuous Project" ], "summary": "Upload Continuous Project File", "operationId": "uploadContinuousProjectFile", "parameters": [ { "name": "orgUnitUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "productTag", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ContinuousFileUploadDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDto" } } } } }, "x-permissions": [ "PROJECT_create" ] } }, "/api/v3/project/ci/{orgUnitUUID}/{productTag}/download": { "get": { "tags": [ "Projects / Continuous Project" ], "summary": "Download Continuous Project Translations", "operationId": "downloadContinuousProjectTranslations", "parameters": [ { "name": "orgUnitUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "productTag", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resources", "in": "query", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "locales", "in": "query", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "filenames", "in": "query", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "projectStatus", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "DELETED", "CANCELLED", "DRAFT", "PENDING", "APPROVED", "DELIVERED", "INVOICED", "PARTIALLY_INVOICED", "NOT_INVOICED", "CONTINUOUS" ] } }, { "name": "updateDataTransformation", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "retrieveLatestDeliveredWorkflow", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "dataTransformationParamsMap", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } } }, "deprecated": true, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUUID}": { "get": { "tags": [ "Projects / Project Management" ], "summary": "Get Project", "operationId": "getProject", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "responseType", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDto" } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUUID}/async/calculate/costs": { "post": { "tags": [ "Projects / Project Costs" ], "summary": "Create Cost", "operationId": "createCost", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "requestId", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncRequestDto" } } } } }, "x-permissions": [ "PROJECT_COST_calculate" ] } }, "/api/v3/project/{projectUUID}/cost/manual-cost": { "get": { "tags": [ "Projects / Project Costs" ], "summary": "List Manual Costs", "operationId": "listManualCosts", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CostDto" } } } } } }, "x-permissions": [ "PROJECT_COST_calculate" ] }, "post": { "tags": [ "Projects / Project Costs" ], "summary": "Add Costs Manually", "operationId": "addCostsManually", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostDto" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostDto" } } } } }, "x-permissions": [ "PROJECT_COST_calculate" ] } }, "/api/v3/project/{projectUUID}/cost/priceTypes": { "get": { "tags": [ "Projects / Project Costs" ], "summary": "Costs Price Types", "operationId": "costsPriceTypes", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "byLanguage", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PriceTypeDto" } } } } } }, "x-permissions": [ "PROJECT_COST_calculate" ] } }, "/api/v3/project/{projectUUID}/cost/{costUUID}": { "delete": { "tags": [ "Projects / Project Costs" ], "summary": "Delete Costs", "operationId": "deleteCosts", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "costUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-permissions": [ "PROJECT_COST_calculate" ] } }, "/api/v3/project/{projectUUID}/costs-summary": { "get": { "tags": [ "Projects / Project Costs" ], "summary": "Costs Summary", "operationId": "costsSummary", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostsDto" } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUUID}/costs/lang-pair": { "get": { "tags": [ "Projects / Project Costs" ], "summary": "Costs to Language Pair", "operationId": "costsToLanguagePair", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sourceLang", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "targetLang", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MatchCostDto" } } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUUID}/download": { "get": { "tags": [ "Projects / Downloads" ], "summary": "Download Project Translations", "operationId": "downloadProjectTranslations", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "resources", "in": "query", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "locales", "in": "query", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "filenames", "in": "query", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "name": "projectStatus", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "DELETED", "CANCELLED", "DRAFT", "PENDING", "APPROVED", "DELIVERED", "INVOICED", "PARTIALLY_INVOICED", "NOT_INVOICED", "CONTINUOUS" ] } }, { "name": "updateDataTransformation", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "retrieveLatestDeliveredWorkflow", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "dataTransformationParamsMap", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } } }, "deprecated": true, "x-permissions": [ "PROJECT_get_by_id" ] }, "post": { "tags": [ "Projects / Downloads" ], "summary": "Download Project Translations Async", "operationId": "downloadProjectTranslationsAsync", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadFiltersDto" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadTranslatedFiles" } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUUID}/download/{requestUUID}/status": { "get": { "tags": [ "Projects / Downloads" ], "summary": "Download Project Translations Async Status", "operationId": "downloadProjectTranslationsAsyncStatus", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "requestUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadTranslatedFiles" } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUUID}/glossaries": { "post": { "tags": [ "Projects / Linguistic Assets" ], "summary": "Bind Glossaries to Project", "description": "Each glossary must be assigned to the project's org unit; otherwise the call answers 422.", "operationId": "bindGlossariesToProject", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "4d7b2e9c-1a6f-4c38-9e5d-0b8a3f6c2d71" }, { "name": "glossaries", "in": "query", "description": "Glossaries to bind. Each must be assigned to the project's org unit.", "required": true, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "example": "2f8d1a6c-9e4b-4b27-8c3a-6d0e5f1b9a48" } ], "responses": { "200": { "description": "OK" } }, "x-permissions": [ "PROJECT_add_glossary_settings" ] } }, "/api/v3/project/{projectUUID}/info": { "post": { "tags": [ "Projects / Project Management" ], "summary": "Update Project Info", "operationId": "updateProjectInfo", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectInfoDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDto" } } } } }, "x-permissions": [ "PROJECT_update" ] } }, "/api/v3/project/{projectUUID}/ingestion/status": { "get": { "tags": [ "Projects / Project Management" ], "summary": "Get Project Ingestion Status", "operationId": "getProjectIngestionStatus", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "enum": [ "COMPLETED", "COMPLETED_WARN", "IN_PROGRESS" ] } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUUID}/logfile": { "get": { "tags": [ "Logfiles" ], "summary": "List Logfiles", "operationId": "listLogfiles", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "orderType", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponseGenesisAnalysisDto" } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] }, "post": { "tags": [ "Logfiles" ], "summary": "Create Logfile", "description": "Creates a logfile (analysis) for the work units in the body. With `pre-analysis`, the body is ignored and a pre-analysis logfile is created for the whole project instead.\n", "operationId": "createLogfile", "parameters": [ { "name": "pre-analysis", "in": "query", "description": "Create a pre-analysis logfile for the whole project and ignore the body. Its presence selects this, whatever its value.", "schema": { "type": "boolean" } }, { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLogfileRequest" }, "examples": { "workUnits": { "description": "workUnits", "value": { "name": "Pre-analysis, first batch", "type": "PRE_ANALYSE", "workUnitIds": [ "9a2c5f8e-3d1b-4e7a-a6c4-2f9b0d5e8c33", "1e7b4d0a-6c2f-4a83-9b5e-8d3a0c6f2b19" ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenesisAnalysisDto" } } } } }, "x-permissions": [ "PROJECT_create" ] } }, "/api/v3/project/{projectUUID}/logfile/{logfileUUID}": { "get": { "tags": [ "Logfiles" ], "summary": "Project Logfile Details", "operationId": "projectLogfileDetails", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "logfileUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenesisAnalysisDto" } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] }, "patch": { "tags": [ "Logfiles" ], "summary": "Rename Logfile", "description": "Renames the logfile. It keeps the previous name, who renamed it and when.", "operationId": "renameLogfile", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "logfileUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameLogfileDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenesisAnalysisDto" } } } } }, "x-permissions": [ "PROJECT_update" ] } }, "/api/v3/project/{projectUUID}/logfile/{logfileUUID}/breakdown-by-locale": { "get": { "tags": [ "Logfiles" ], "summary": "Project Logfile Breakdown By Locale", "operationId": "projectLogfileBreakdownByLocale", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "logfileUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "targetLocale", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "targetWorkflow", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenesisAnalysisDto" } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUUID}/logfile/{logfileUUID}/download-async": { "get": { "tags": [ "Logfiles" ], "summary": "Export Logfile", "operationId": "exportLogfile", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "logfileUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "default": "csv" } }, { "name": "rebuild", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "splitByTargetLocale", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "fileNamePattern", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogfileDownloadFile" } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUUID}/logfile/{logfileUUID}/download/{requestUUID}/status": { "get": { "tags": [ "Logfiles" ], "summary": "Status Export Logfile", "operationId": "statusExportLogfile", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "logfileUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "requestUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogfileDownloadFile" } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUUID}/logfile/{logfileUUID}/summary": { "get": { "tags": [ "Logfiles" ], "summary": "Logfile Summary", "operationId": "logfileSummary", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "logfileUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GenesisAnalysisSummaryDto" } } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUUID}/message": { "get": { "tags": [ "Projects / Notes" ], "summary": "List Simple Notes", "operationId": "listSimpleNotes", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageProjectMessageDto" } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] }, "post": { "tags": [ "Projects / Notes" ], "summary": "Create Simple Note", "operationId": "createSimpleNote", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMessageCreateDto" } } }, "required": true }, "responses": { "201": { "description": "Created" } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUUID}/profitability": { "get": { "tags": [ "Projects / Project Costs" ], "summary": "Profitability", "operationId": "profitability", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfitabilityMargin" } } } } }, "x-permissions": [ "PROJECT_COST_profitability_margin" ] } }, "/api/v3/project/{projectUUID}/recalculate/costs": { "post": { "tags": [ "Projects / Project Costs" ], "summary": "Costs Recalculate", "description": "Only for projects in Draft status; any other status answers 422.", "operationId": "costsRecalculate", "parameters": [ { "name": "projectUUID", "in": "path", "description": "A project in Draft status.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "4d7b2e9c-1a6f-4c38-9e5d-0b8a3f6c2d71" }, { "name": "requestId", "in": "query", "description": "Leave it out to start a recalculation; send the id it answered to read its status.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncRequestDto" } } } } }, "x-permissions": [ "PROJECT_COST_calculate" ] } }, "/api/v3/project/{projectUUID}/reference-file": { "post": { "tags": [ "Projects / Reference Files" ], "summary": "Upload Reference File", "operationId": "uploadReferenceFile", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK" } }, "x-permissions": [ "PROJECT_upload_reference_file" ] } }, "/api/v3/project/{projectUUID}/resource": { "post": { "tags": [ "Projects / Resources and File Params", "Projects / Project Routing / Base Project Setup" ], "summary": "Create Project Resource", "operationId": "createProjectResource", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectResourceDto" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectResourceDto" } } } } }, "x-permissions": [ "PROJECT_RESOURCE_create" ] } }, "/api/v3/project/{projectUUID}/resource/simple": { "get": { "tags": [ "Projects / Resources and File Params" ], "summary": "Get Project Resources", "operationId": "getProjectResources", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectResourceDto" } } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUUID}/resource/{projectResourceUUID}": { "delete": { "tags": [ "Projects / Resources and File Params" ], "summary": "Delete Project Resource", "operationId": "deleteProjectResource", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectResourceUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "processingTaskId", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-permissions": [ "PROJECT_RESOURCE_delete" ] } }, "/api/v3/project/{projectUUID}/resource/{projectResourceUUID}/content": { "put": { "tags": [ "Projects / Resources and File Params", "Projects / Project Routing / Base Project Setup" ], "summary": "Upload Project Resource Content", "description": "A `.zip` is stored as one file, not extracted: call *Extract ZIP Resource* afterwards to add the files inside it.", "operationId": "uploadProjectResourceContent", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectResourceUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK" } }, "x-permissions": [ "PROJECT_RESOURCE_create" ] } }, "/api/v3/project/{projectUUID}/resource/{projectResourceUUID}/file-params": { "post": { "tags": [ "Projects / Resources and File Params" ], "summary": "Change Project Resource Params", "operationId": "changeProjectResourceParams", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectResourceUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileParams" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectResourceDto" } } } } }, "x-permissions": [ "PROJECT_RESOURCE_create" ] } }, "/api/v3/project/{projectUUID}/resource/{projectResourceUUID}/zip": { "post": { "tags": [ "Projects / Resources and File Params" ], "summary": "Extract ZIP Resource", "description": "Unpacks a `.zip` resource whose contents were uploaded with *Upload Project Resource Content*, which stores a ZIP as one file and does not extract it. Each file inside becomes a resource of the project, with its folders kept in `path`; create the work units for those resources, not for the `.zip`.\n\nThe extraction runs in the background: the call returns a task id to follow with *Get ZIP Extraction Status*.\n", "operationId": "extractZipResource", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectResourceUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "The task id of the extraction.", "content": { "text/plain": { "schema": { "type": "string", "example": "0f6d2a8e-5b1c-4e7a-9d3f-2c8b6a1e4f90" } } } } }, "x-permissions": [ "PROJECT_RESOURCE_create" ] } }, "/api/v3/project/{projectUUID}/resource/{projectResourceUUID}/zip/status/{taskId}": { "get": { "tags": [ "Projects / Resources and File Params" ], "summary": "Get ZIP Extraction Status", "description": "The progress of an extraction started with *Extract ZIP Resource*. `status` is `IN_PROGRESS` until it ends `COMPLETED`, `ERROR` or `CANCELLED`. Once `COMPLETED`, `processedProjectResources` lists the resources created from the ZIP; an entry with `isProcessedSuccessfully: false` was not added to the project.\n\nThe status is kept for 10 minutes after its last change. An unknown or expired task id answers `200` with `status: ERROR` and a `message`.\n", "operationId": "getZipExtractionStatus", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectResourceUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The status of the extraction.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipProcessingStatusDto" } } } } }, "x-permissions": [ "PROJECT_RESOURCE_create" ] }, "delete": { "tags": [ "Projects / Resources and File Params" ], "summary": "Cancel ZIP Extraction", "description": "Stops an extraction that is `IN_PROGRESS`: no further file of the ZIP is added. Files already extracted stay in the project. A task that has already ended is left as it is.", "operationId": "cancelZipExtraction", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectResourceUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "x-permissions": [ "PROJECT_RESOURCE_create" ] } }, "/api/v3/project/{projectUUID}/status": { "post": { "tags": [ "Projects / Project Management" ], "summary": "Change Project Status", "operationId": "changeProjectStatus", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "can-calculate-costs", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectStatusChangeDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDto" } } } } }, "x-permissions": [ "PROJECT_change_status" ] } }, "/api/v3/project/{projectUUID}/total-costs": { "get": { "tags": [ "Projects / Project Costs" ], "summary": "Total Costs", "operationId": "totalCosts", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TotalCostDto" } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUUID}/translated-file/download": { "get": { "tags": [ "Projects / Downloads" ], "summary": "Download Project Translations (Non-Zip)", "description": "Send either `workUnitUUID`, or `resourceUUID` together with `targetLanguage`, never both. Any other combination answers 422.", "operationId": "downloadProjectTranslationsNonZip", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "4d7b2e9c-1a6f-4c38-9e5d-0b8a3f6c2d71" }, { "name": "workUnitUUID", "in": "query", "description": "Work unit whose translated file to download. Don't combine with resourceUUID or targetLanguage.", "required": false, "schema": { "type": "string", "format": "uuid" }, "example": "9a2c5f8e-3d1b-4e7a-a6c4-2f9b0d5e8c33" }, { "name": "resourceUUID", "in": "query", "description": "Source file (resource) whose translation to download; requires targetLanguage.", "required": false, "schema": { "type": "string", "format": "uuid" }, "example": "c7a1e4b9-2f6d-4083-9b5a-1e8d3c6f0a24" }, { "name": "targetLanguage", "in": "query", "description": "Target language of the translation; requires resourceUUID.", "required": false, "schema": { "type": "string" }, "example": "fr_fr" }, { "name": "retrieveLatestDeliveredWorkflow", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTranslatedFileUrlDto" } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUUID}/translation-kit-job/loc-kit": { "post": { "tags": [ "Projects / Translation Kit Jobs / Export Kits" ], "summary": "Request Export Project", "description": "Starts an export kit: a ZIP with the bilingual files of the chosen work units. Choose them with `workflowLevel` (every work unit at that workflow step) or `workUnitUuids` (all at the same step); a vendor always gets their own assigned work units. The project comes from the path.\n\nBy default (`locKitTypeJob: ALL`) the kit holds XLIFF, XLSX, TMX and TBX files. For the bilingual XLIFF files only, send `locKitTypeJob: XLIFF`.\n\nReturns a job: poll *Check Translation Kit Job Status* until `status` is `COMPLETED`, then download the ZIP.\n", "operationId": "requestExportProject", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranslationKitParams" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranslationKitJobDto" } } } } }, "x-permissions": [ "PROJECT_export_import_file" ] } }, "/api/v3/project/{projectUUID}/translation-kit-job/resource": { "post": { "tags": [ "Projects / Translation Kit Jobs / Import Kits" ], "summary": "Create Import Kit Resource", "description": "First step of an import: registers the file you are about to upload. `name` must end in a supported file extension; only `name`, `path` and `notes` are read. Use the returned `uuid` in *Get Import Kit Upload URL* and in the import request.\n", "operationId": "createImportKitResource", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectResourceDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectResourceDto" } } } } }, "x-permissions": [ "PROJECT_export_import_file" ] } }, "/api/v3/project/{projectUUID}/translation-kit-job/resource/{projectResourceUUID}": { "post": { "tags": [ "Projects / Translation Kit Jobs / Import Kits" ], "summary": "Get Import Kit Upload URL", "description": "Returns a pre-signed URL to upload the resource's file to. Send the raw file with an HTTP `PUT` to `url` within 60 minutes (until `urlExpiresAt`), with the headers in `headers`, which are part of the signature:\n\n- `x-amz-server-side-encryption: aws:kms`\n- `x-amz-server-side-encryption-aws-kms-key-id`: the `kmsKey` of this response\n\n```\ncurl -X PUT \"$URL\" \\\n -H \"x-amz-server-side-encryption: aws:kms\" \\\n -H \"x-amz-server-side-encryption-aws-kms-key-id: $KMS_KEY\" \\\n --data-binary @file.xlf\n```\n\nThen start the import (*Import Kit to Work Unit* or *Bulk Import Kit*). `expiryDate` is not when the URL expires. To skip this step, upload and import in one call with *Import File to Work Unit*.\n", "operationId": "getImportKitUploadUrl", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectResourceUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/S3PresignedUrlResponse" } } } } }, "x-permissions": [ "PROJECT_export_import_file" ] } }, "/api/v3/project/{projectUUID}/translation-kit-job/resource/{projectResourceUUID}/bulk-import": { "post": { "tags": [ "Projects / Translation Kit Jobs / Import Kits" ], "summary": "Bulk Import Kit", "description": "Imports a ZIP of bilingual files (for example an edited export kit) into the project's work units in one job. Upload the ZIP first (*Create Import Kit Resource*, then *Get Import Kit Upload URL*). `workUnitUuids` limits the import to those work units.\n\nReturns a job to poll with *Check Translation Kit Job Status*. The job reports the run as a whole; *Check Work Unit Import Status* shows each work unit's own result. The flags and their effects are the same as in *Import Kit to Work Unit*. With `applyStatusFromFile`, locks change in the work units on which you have *Lock Segments*: those listed in `workUnitUuids`, or any of the project without a list.\n", "operationId": "bulkImportKit", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectResourceUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkImportKitRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranslationKitJobDto" } } } } }, "x-permissions": [ "PROJECT_export_import_file" ] } }, "/api/v3/project/{projectUUID}/translation-kit-job/source-files": { "post": { "tags": [ "Projects / Translation Kit Jobs / Source Files" ], "summary": "Bulk Source Files", "description": "Starts a job that builds a ZIP with the original source files of the work units in `workUnitUuids`, or of the whole project when the list is empty (a vendor always gets the files of their own assigned work units). Returns a job: poll *Check Translation Kit Job Status* until `status` is `COMPLETED`, then download the ZIP.\n", "operationId": "bulkSourceFiles", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranslationKitParams" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranslationKitJobDto" } } } } }, "x-permissions": [ "PROJECT_download_files" ] } }, "/api/v3/project/{projectUUID}/translation-kit-job/translated-files": { "post": { "tags": [ "Projects / Translation Kit Jobs / Translated Files" ], "summary": "Request Project Translated Files", "operationId": "requestProjectTranslatedFiles", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranslationKitParams" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranslationKitJobDto" } } } } }, "x-permissions": [ "PROJECT_download_files" ] } }, "/api/v3/project/{projectUUID}/translation-kit-job/work-unit/{workUnitUUID}/bilingual": { "get": { "tags": [ "Projects / Translation Kit Jobs / Export Kits" ], "summary": "Download Work Unit Bilingual File", "description": "Returns one work unit's bilingual XLIFF in the response, without a job: the same file an export kit holds for that work unit, ready to be edited and imported back.\n\nWork units with more than 20,000 segments are refused with `413`: export them with *Request Export Project* (`locKitTypeJob: XLIFF`) and download the kit when the job completes.\n", "operationId": "downloadWorkUnitBilingualFile", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workUnitUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "format", "in": "query", "description": "Format of the file. Only `XLIFF` is supported.", "required": false, "schema": { "type": "string", "default": "XLIFF", "enum": [ "XLIFF" ] } } ], "responses": { "200": { "description": "The XLIFF file, as an attachment.", "content": { "application/x-xliff+xml": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "`format` is not supported: only `XLIFF` is.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamingResponseBody" } } } }, "413": { "description": "The work unit has more than 20,000 segments: use an export kit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamingResponseBody" } } } }, "422": { "description": "The work unit has no segments.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamingResponseBody" } } } } }, "x-permissions": [ "PROJECT_export_import_file" ] } }, "/api/v3/project/{projectUUID}/translation-kit-job/work-unit/{workUnitUUID}/import": { "post": { "tags": [ "Projects / Translation Kit Jobs / Import Kits" ], "summary": "Import File to Work Unit", "description": "Uploads a bilingual XLIFF or XLSX (`importType`) and imports it into one work unit, in one call. Send a `multipart/form-data` request with the file in `file`; the other parameters can be form fields or query parameters. An XLSX import needs an `.xlsx` file.\n\nRuns asynchronously and returns the import: poll it with *Get Work Unit Import*. One import runs at a time in a work unit: while one runs, another is rejected with `409`.\n\nBoth flags default to `false`:\n\n| `confirmOnlyChangeSegments` | `confirmAllNotEmpty` | Segments written | Confirmation |\n|---|---|---|---|\n| `false` | `false` | every segment with a non-empty target | segments whose text changed become **unconfirmed** |\n| `true` | `false` | only segments whose text changed | changed segments are **confirmed** and get a segment review |\n| `false` | `true` | every segment with a non-empty target | **all** of them are confirmed |\n| `true` | `true` | only segments whose text changed | as with `confirmOnlyChangeSegments` alone; a segment written only because its alternative translations or back translation changed is confirmed too |\n\nWhatever the flags:\n- Locked segments, segments already decided in the next workflow step and file segments without a `bwx:ts-id` are skipped, without an error. An empty target leaves the translation as it is, unless the file also carries a back translation for that segment: then the translation is cleared.\n- Changed segments lose their translation memory match details.\n- Confirmed segments are carried to the next workflow step.\n- The confirmed segments this import wrote are added to the project's translation memories, the same way confirmations in the editor are (when the project has translation memories and your permission group can update them). Send `updateTm: false` to skip this.\n- The work unit's progress (confirmed segments out of total segments) is recalculated.\n\nWith `applyStatusFromFile: true` (XLIFF only), the file also sets each segment's status from its unit's `bwx:locked` and `bwx:confirmed` (`yes` or `no`, written on every unit of an exported kit) and adds its notes as comments:\n- A unit with `bwx:confirmed` confirms or unconfirms its segment, changed or not, instead of the flags above. A unit without it follows the flags.\n- A unit with `bwx:locked` locks or unlocks its segment, when you have the *Lock Segments* permission on the work unit; without it, locks stay as they are and locked segments are skipped. Locking confirms the segment, as in the editor. To also change the text of a segment you unlock, remove the unit's `translate=\"no\"`.\n- Each `` is added as a comment of the segment, written by you; a note of someone else (`from`) keeps the author at the start of the text. A note whose text the segment's comments already have is skipped, so importing the same file twice adds nothing.\n\nThe import's `error` says why it ended in `ERROR`, and its counts say how many segments it wrote or changed the status of, confirmed, and skipped because they were locked or had no `bwx:ts-id`.\n", "operationId": "importFileToWorkUnit", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workUnitUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "importType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "XLIFF", "XLSX" ] } }, { "name": "confirmOnlyChangeSegments", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "confirmAllNotEmpty", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "applyStatusFromFile", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "updateTm", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkUnitImportDto" } } } } }, "x-permissions": [ "PROJECT_export_import_file" ] } }, "/api/v3/project/{projectUUID}/translation-kit-job/work-unit/{workUnitUUID}/import/status": { "post": { "tags": [ "Projects / Translation Kit Jobs / Import Kits" ], "summary": "Check Work Unit Import Status", "description": "Reports the latest import of the given format (`importType`) into the work unit: `importingStatus` is `STARTED` while it runs, then `IMPORTED` or `ERROR`. There is no import id: a second import into the same work unit replaces what this reports.\n", "operationId": "checkWorkUnitImportStatus", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workUnitUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkUnitImportStatusDto" } } } } }, "x-permissions": [ "PROJECT_export_import_file" ] } }, "/api/v3/project/{projectUUID}/translation-kit-job/work-unit/{workUnitUUID}/import/{importId}": { "get": { "tags": [ "Projects / Translation Kit Jobs / Import Kits" ], "summary": "Get Work Unit Import", "description": "Reports one import into the work unit, by the `id` its import request returned: `status` is `STARTED` while it runs, then `IMPORTED` or `ERROR` with the reason in `error`. Once it ended, the counts say how many segments it wrote, confirmed and skipped.\n", "operationId": "getWorkUnitImport", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workUnitUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "importId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkUnitImportDto" } } } } }, "x-permissions": [ "PROJECT_export_import_file" ] } }, "/api/v3/project/{projectUUID}/translation-kit-job/work-unit/{workUnitUUID}/resource/{projectResourceUUID}/import": { "post": { "tags": [ "Projects / Translation Kit Jobs / Import Kits" ], "summary": "Import Kit to Work Unit", "description": "Imports a bilingual XLIFF or XLSX (`importType`) into one work unit, from a file uploaded with *Create Import Kit Resource* and *Get Import Kit Upload URL*. To upload and import in one call, use *Import File to Work Unit*.\n\nRuns asynchronously and returns the import: poll it with *Get Work Unit Import*. One import runs at a time in a work unit: while one runs, another is rejected with `409`.\n\nBoth flags default to `false`:\n\n| `confirmOnlyChangeSegments` | `confirmAllNotEmpty` | Segments written | Confirmation |\n|---|---|---|---|\n| `false` | `false` | every segment with a non-empty target | segments whose text changed become **unconfirmed** |\n| `true` | `false` | only segments whose text changed | changed segments are **confirmed** and get a segment review |\n| `false` | `true` | every segment with a non-empty target | **all** of them are confirmed |\n| `true` | `true` | only segments whose text changed | as with `confirmOnlyChangeSegments` alone; a segment written only because its alternative translations or back translation changed is confirmed too |\n\nWhatever the flags:\n- Locked segments, segments already decided in the next workflow step and file segments without a `bwx:ts-id` are skipped, without an error. An empty target leaves the translation as it is, unless the file also carries a back translation for that segment: then the translation is cleared.\n- Changed segments lose their translation memory match details.\n- Confirmed segments are carried to the next workflow step.\n- The confirmed segments this import wrote are added to the project's translation memories, the same way confirmations in the editor are (when the project has translation memories and your permission group can update them). Send `updateTm: false` to skip this.\n- The work unit's progress (confirmed segments out of total segments) is recalculated.\n\nWith `applyStatusFromFile: true` (XLIFF only), the file also sets each segment's status from its unit's `bwx:locked` and `bwx:confirmed` (`yes` or `no`, written on every unit of an exported kit) and adds its notes as comments:\n- A unit with `bwx:confirmed` confirms or unconfirms its segment, changed or not, instead of the flags above. A unit without it follows the flags.\n- A unit with `bwx:locked` locks or unlocks its segment, when you have the *Lock Segments* permission on the work unit; without it, locks stay as they are and locked segments are skipped. Locking confirms the segment, as in the editor. To also change the text of a segment you unlock, remove the unit's `translate=\"no\"`.\n- Each `` is added as a comment of the segment, written by you; a note of someone else (`from`) keeps the author at the start of the text. A note whose text the segment's comments already have is skipped, so importing the same file twice adds nothing.\n\nThe import's `error` says why it ended in `ERROR`, and its counts say how many segments it wrote or changed the status of, confirmed, and skipped because they were locked or had no `bwx:ts-id`.\n", "operationId": "importKitToWorkUnit", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workUnitUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectResourceUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportKitRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkUnitImportDto" } } } } }, "x-permissions": [ "PROJECT_export_import_file" ] } }, "/api/v3/project/{projectUUID}/translation-kit-job/{translationKitJobUUID}": { "get": { "tags": [ "Projects / Translation Kit Jobs / Export Kits", "Projects / Translation Kit Jobs / Import Kits", "Projects / Translation Kit Jobs / Source Files", "Projects / Translation Kit Jobs / Translated Files" ], "summary": "Check Translation Kit Job Status", "description": "Reports a job started by an export, translated files, source files or bulk import request. `status` is `STARTING` while the job runs, then `COMPLETED` or `FAILED`. When a job that builds a file has completed, download it from `downloadFileUrl`, or from `sharedLink` when the job was started with `sharedLinkExpiresInDays`.\n", "operationId": "checkTranslationKitJobStatus", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "translationKitJobUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranslationKitJobDto" } } } } }, "x-permissions": [ "PROJECT_download_files", "PROJECT_export_import_file" ] } }, "/api/v3/project/{projectUUID}/translation-kit-job/{translationKitJobUUID}/download-links": { "get": { "tags": [ "Projects / Translation Kit Jobs / Translated Files" ], "summary": "List Translation Kit Job Download Links", "operationId": "listTranslationKitJobDownloadLinks", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "translationKitJobUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "description": "Zero-based page index (0..N)", "required": false, "schema": { "minimum": 0, "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "The size of the page to be returned", "required": false, "schema": { "minimum": 1, "type": "integer", "default": 20 } }, { "name": "sort", "in": "query", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageTranslationKitJobDownloadLinkDto" } } } } }, "x-permissions": [ "PROJECT_download_files" ] } }, "/api/v3/project/{projectUUID}/translation-memory": { "get": { "tags": [ "Projects / Linguistic Assets" ], "summary": "Get Project Translation Memories", "operationId": "getProjectTranslationMemories", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TMSettingsDTO" } } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] }, "post": { "tags": [ "Projects / Linguistic Assets" ], "summary": "Bind TM to Project", "operationId": "bindTmToProject", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TMSettingsDTO" } } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "x-permissions": [ "PROJECT_update" ] } }, "/api/v3/project/{projectUUID}/work-unit": { "get": { "tags": [ "Projects / Work Units" ], "summary": "List Project Work Units", "description": "Lists the project's work units, 50 per page unless `size` says otherwise.\n\nEach work unit in the list carries only `uuid`, `filename`, `projectResource`, `sourceLanguage`, `targetLanguage`, `workflow`, `workflowUuid`, `workStatus`, `orgUnitId`, `isSplit` and `readOnly`. Fields without a value are left out. *Get Project Work Unit* returns one work unit with its progress, task, word counts and cost.\n", "operationId": "listProjectWorkUnits", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "uuids", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "targetLanguages", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "taskStatus", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filenames", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "workflows", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filepaths", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "projectResourceUuids", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "genesisCreationStatus", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "CREATING", "FAILED", "CREATED" ] } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "NEW", "CREATED", "IN_PROGRESS", "COMPLETED", "APPROVED", "REJECTED", "DELIVERED", "CANCELLED", "FAILED" ] } }, { "name": "fileName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sourceLanguage", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "targetLanguage", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "createdAtFrom", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "createdAtTo", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "dueDateFrom", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "dueDateTo", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "deliveryDateFrom", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "deliveryDateTo", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "assigneeQuery", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sourceQuery", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "targetQuery", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "entryStatuses", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "workPackageStatuses", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "PENDING", "IMPORTED", "DELIVERED", "FAILED" ] } } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page to return, starting at 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "description": "Items per page.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageWorkUnitDto" } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] }, "post": { "tags": [ "Projects / Work Units" ], "summary": "Create Work Units", "description": "Without `bulk=true` this path searches the project's work units instead; use *List Project Work Units* for that.", "operationId": "createWorkUnits", "parameters": [ { "name": "bulk", "in": "query", "description": "Must be `true`.", "required": true, "schema": { "type": "boolean", "enum": [ "true" ] } }, { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkCreateWorkUnit" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkUnitDto" } } } } } }, "x-permissions": [ "PROJECT_update" ] } }, "/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}": { "get": { "tags": [ "Projects / Work Units" ], "summary": "Get Project Work Unit", "description": "Returns one work unit of the project, with its progress (`confirmedSegments` out of `totalSegments`), `workStatus`, its task's `taskStatus`, `assignee`, `dueDate` and `deliveryDate`, its word counts and its cost. Fields without a value are left out.\n", "operationId": "getProjectWorkUnit", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workUnitUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkUnitDto" } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}/comments": { "get": { "tags": [ "Projects / Segments and Quality" ], "summary": "List Work Unit Comments", "description": "The comments on the work unit's segments, oldest first, as the editor's comments panel shows them. Comments belong to a segment's position in the file (`fileIndex`), so every workflow step of the file shares them; `segmentId` is this work unit's segment at that position. A reply has the `parentId` of the comment it answers. Other users' private comments are not included.\n", "operationId": "listWorkUnitComments", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workUnitUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageSegmentCommentDto" } } } } }, "x-permissions": [ "EDITOR_open_editor" ] } }, "/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}/segments/lock": { "post": { "tags": [ "Projects / Segments and Quality" ], "summary": "Lock or Unlock Segments", "description": "Locks (`locked: true`) or unlocks (`locked: false`) segments of the work unit, as the editor's lock button does: locking a segment also confirms it, unlocking it also unconfirms it. Up to 1,000 segments per call; every one must belong to the work unit.\n\nThe call changes every segment in it or none. A segment that cannot take the change (it has no target, is over its hard character limit, or is already confirmed or locked in the next workflow step) fails the call with `422`, which names the reasons. A segment already in the requested state is left as it is. The segments' repetitions are not changed.\n\nNeeds the *Lock Segments* permission on the work unit, and a work unit that can be written (for example, not cancelled, and with its previous workflow step closed). Imports skip locked segments.\n", "operationId": "setWorkUnitSegmentsLock", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workUnitUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SegmentsLockRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "x-permissions": [ "EDITOR_lock_segments" ] } }, "/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}/segments/{segmentId}/comments": { "post": { "tags": [ "Projects / Segments and Quality" ], "summary": "Create Segment Comment", "description": "Adds a comment to a segment of the work unit, as the editor's comments panel does; with `parentId`, it answers a comment of the same segment. Users mentioned in the text as `[@First Last:]` are notified. Returns the comment.\n", "operationId": "createSegmentComment", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workUnitUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "segmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SegmentCommentCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SegmentCommentDto" } } } } }, "x-permissions": [ "EDITOR_open_editor" ] } }, "/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}/tm-updates": { "post": { "tags": [ "Projects / Work Units" ], "summary": "Export Work Unit TM Updates", "description": "Starts one TMX export for each translation memory of the project that some workflow step writes to, and for any other one this work unit wrote to, and returns them. Each TMX holds the entries whose current translation was saved by this work unit: an entry a later work unit overwrote belongs to that work unit's export instead, so exports never need to run in order. A TMX is empty when the work unit wrote nothing to that translation memory; the job then reports `0` translation units. An empty list means the project has no translation memory to export.\n\nTranslations reach the translation memory asynchronously, whether confirmed in the editor, imported or confirmed in bulk. Each export is `SCHEDULED` first: a few seconds after this request it marks what is still on its way to the translation memory, waits until all of it has been written, then runs. If that takes more than two minutes, the job ends `FAILED` with `failureReason` `TM_WRITES_PENDING`: call this endpoint again a little later.\n\nPoll each job with Get Work Unit TM Update. A job can be read only by the user who started it. To sync on every delivery, call this endpoint when a `WORK_UNIT_STATUS_CHANGE` webhook reports `new_status` `DELIVERED`, with its `project_uuid` and `id`.\n", "operationId": "exportWorkUnitTmUpdates", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workUnitUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkUnitTmUpdate" } } } } } }, "x-permissions": [ "PROJECT_export_import_file" ] } }, "/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}/tm-updates/{jobId}": { "get": { "tags": [ "Projects / Work Units" ], "summary": "Get Work Unit TM Update", "description": "Reports a job started by Export Work Unit TM Updates for this work unit. `status` is `SCHEDULED`, `STARTING` or `STARTED` while it runs, then `COMPLETED` or `FAILED`. Once `COMPLETED`, `translationUnits` says how many entries the TMX holds and `downloadUrl` is a signed link to it, valid for one hour after the job completed; to get a new one, export again. A job can be polled for 24 hours.\n", "operationId": "getWorkUnitTmUpdate", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workUnitUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "jobId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkUnitTmUpdateJob" } } } } }, "x-permissions": [ "PROJECT_export_import_file" ] } }, "/api/v3/project/{projectUUID}/work-unit/{workUnitUUID}/translation": { "get": { "tags": [ "Projects / Work Units" ], "summary": "Download Original File", "operationId": "downloadOriginalFile", "parameters": [ { "name": "projectUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workUnitUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "isXliff", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkUnitDownloadFile" } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUuid}/payment-type": { "get": { "tags": [ "Projects / Project Management" ], "summary": "Get Project Payment Type", "operationId": "getProjectPaymentType", "parameters": [ { "name": "projectUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } } }, "x-permissions": [ "EDITOR_open_editor" ] } }, "/api/v3/project/{projectUuid}/process-summary": { "get": { "tags": [ "Projects / Project Management" ], "summary": "Get Project Process Summary", "operationId": "getProjectProcessSummary", "parameters": [ { "name": "projectUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GenesisProjectProcessSummaryDto" } } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUuid}/quality-summary": { "get": { "tags": [ "Projects / Segments and Quality" ], "summary": "Get Project Quality Summary", "operationId": "getProjectQualitySummary", "parameters": [ { "name": "projectUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workUnitUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "stepLevel", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectQualitySummaryDto" } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUuid}/reference-files/download": { "get": { "tags": [ "Projects / Reference Files" ], "summary": "Download All Reference Files", "operationId": "downloadAllReferenceFiles", "parameters": [ { "name": "projectUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } } }, "x-permissions": [ "PROJECT_download_reference_file" ] } }, "/api/v3/project/{projectUuid}/segments": { "get": { "tags": [ "Projects / Segments and Quality" ], "summary": "List Project Segments", "operationId": "listProjectSegments", "parameters": [ { "name": "projectUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "workUnitUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "stepLevel", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "includeFindings", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagedResponseProjectSegmentDto" } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/project/{projectUuid}/work-unit/bulk": { "delete": { "tags": [ "Projects / Work Units" ], "summary": "Bulk Delete Work Units", "description": "Removes work units from a project. The project must be `DRAFT` or `CONTINUOUS`, and your permission group also needs cost calculation on the project's org unit.\n", "operationId": "bulkDeleteWorkUnits", "parameters": [ { "name": "projectUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "resetCost", "in": "query", "description": "Has no effect. Deprecated: it will be removed in the next API version.", "required": false, "deprecated": true, "schema": { "type": "boolean" } }, { "name": "workUnits", "in": "query", "description": "The work units to remove.", "required": true, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "OK" } }, "x-permissions": [ "PROJECT_delete_work_unit" ] } }, "/api/v3/receivables": { "get": { "tags": [ "Accounting / Receivables" ], "summary": "List Receivables", "operationId": "listReceivables", "parameters": [ { "name": "orgUnitUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "orgUnitName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "projectName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "creationDate.start", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "creationDate.end", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dueDate.start", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dueDate.end", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "statuses", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "INVOICED", "INVOICED_NFE", "INVOICED_NFE_ERROR", "PARTIALLY_INVOICED", "PARTIALLY_PAID", "PAID", "VOID", "CANCELLED" ] } } }, { "name": "purchaseOrder", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page to return, starting at 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "description": "Items per page.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageReceivableDto" } } } } }, "x-permissions": [ "RECEIVABLES_get_invoices" ] }, "post": { "tags": [ "Accounting / Receivables" ], "summary": "Create Receivable", "description": "Bills projects of one org unit to one of its contacts: `contactUser` is a user of that org unit or of its organization, and any other user answers 422. The org unit, the contact and every project must be yours, and the projects that org unit's; projects are referenced by `id`. Totals, taxes and installments are computed by wxrks.", "operationId": "createReceivable", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReceivableRequest" }, "examples": { "singleInstallment": { "description": "singleInstallment", "value": { "organizationalUnit": { "uuid": "6b1f0c2e-8d4a-4f3b-9c5e-2a7d9e1b4c60" }, "contactUser": { "uuid": "3b6e9d2a-4c8f-4e15-a7b3-9f2d6c0a5e81" }, "projects": [ { "id": 12345 } ], "currency": "USD", "dueDate": 1767225600000, "purchaseOrder": "PO-1001" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivableDto" } } } } }, "x-permissions": [ "RECEIVABLES_create" ] } }, "/api/v3/receivables/cancel-receivable": { "post": { "tags": [ "Accounting / Receivables" ], "summary": "Cancel Receivable", "operationId": "cancelReceivable", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivablePaidDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "x-permissions": [ "RECEIVABLES_update" ] } }, "/api/v3/shared-link/{token}": { "get": { "tags": [ "Projects / Translation Kit Jobs / Translated Files" ], "summary": "Resolve Shared Link", "description": "Redirects to a temporary download URL of the shared file. No authentication: the link itself is the credential.", "operationId": "resolveSharedLink", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "302": { "description": "Redirect to the file.", "headers": { "Location": { "description": "Temporary download URL of the file.", "style": "simple", "schema": { "type": "string", "format": "uri" } } } }, "404": { "description": "The link does not point to a downloadable file." }, "422": { "description": "The shared link has expired." } }, "security": [] } }, "/api/v3/task": { "get": { "tags": [ "Tasks" ], "summary": "List Tasks", "operationId": "listTasks", "parameters": [ { "name": "uuids", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "file", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startCreateDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endCreateDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDueDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDueDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDeliveryDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDeliveryDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "payableAmountFrom", "in": "query", "required": false, "schema": { "type": "number" } }, { "name": "payableAmountTo", "in": "query", "required": false, "schema": { "type": "number" } }, { "name": "assigneeQuery", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "workflows", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sourceLanguage", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "targetLanguage", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sourceLanguages", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "targetLanguages", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "workflow", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "statuses", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "CANCELLED", "PENDING", "PENDING_ACCEPTANCE", "PENDING_CONFIRMATION", "SCHEDULED", "EXPIRED", "ASSIGNED", "DELIVERED", "INVOICED", "PAID", "NOT_INVOICED", "SKIPPED" ] } } }, { "name": "taskUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "workUnitUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "orgUnitUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "orgUnitUuids", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "organizationUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "workUnitUuids", "in": "query", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "projectUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectUuids", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "assigneeUUID", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "pmId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "pmUuids", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "overdue", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "unassigned", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "taskStatusGroup", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "CANCELLED", "PENDING", "PENDING_ACCEPTANCE", "PENDING_CONFIRMATION", "SCHEDULED", "EXPIRED", "ASSIGNED", "DELIVERED", "INVOICED", "PAID", "NOT_INVOICED", "SKIPPED" ] } }, { "name": "taskGroupStatus", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page to return, starting at 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "description": "Items per page.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "includeCustomFields", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageTaskDto" } } } } }, "x-permissions": [ "TASK_list" ] } }, "/api/v3/task/assignment": { "post": { "tags": [ "Tasks" ], "summary": "Bulk Assign Tasks to User", "operationId": "bulkAssignTasksToUser", "parameters": [ { "name": "bulk", "in": "query", "required": true, "schema": { "type": "boolean", "enum": [ "true" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkAssignTask" }, "examples": { "assign": { "description": "assign", "value": { "userUuid": "1c9e4b7a-5d2f-4e8a-b3c6-7f0a2d5e9b14", "taskUuids": [ "8e3a6d1f-2b7c-4a95-8d0e-5c4b1a7f3e29", "2d5f8a1c-7e3b-4c96-a0d4-6b9e2f5c8a17" ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaskDto" } } } } } }, "deprecated": true, "x-permissions": [ "TASK_assign" ] } }, "/api/v3/task/work-unit/{workUnitUUID}": { "get": { "tags": [ "Tasks" ], "summary": "List Tasks by Work Unit", "operationId": "listTasksByWorkUnit", "parameters": [ { "name": "workUnitUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaskDto" } } } } } }, "x-permissions": [ "TASK_list" ] } }, "/api/v3/task/{projectUuid}/statuses": { "get": { "tags": [ "Tasks" ], "summary": "List Project Task Statuses", "operationId": "listProjectTaskStatuses", "parameters": [ { "name": "projectUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "enum": [ "CANCELLED", "PENDING", "PENDING_ACCEPTANCE", "PENDING_CONFIRMATION", "SCHEDULED", "EXPIRED", "ASSIGNED", "DELIVERED", "INVOICED", "PAID", "NOT_INVOICED", "SKIPPED" ] } } } } } }, "x-permissions": [ "PROJECT_get_by_id" ] } }, "/api/v3/task/{taskUUID}": { "get": { "tags": [ "Tasks" ], "summary": "Get Task", "operationId": "getTask", "parameters": [ { "name": "taskUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskDto" } } } } }, "x-permissions": [ "TASK_get_by_id" ] } }, "/api/v3/task/{taskUUID}/logfile": { "get": { "tags": [ "Logfiles" ], "summary": "Task Logfile", "operationId": "taskLogfile", "parameters": [ { "name": "taskUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/GenesisAnalysisDto" } } } } } }, "x-permissions": [ "TASK_get_by_id" ] } }, "/api/v3/task/{taskUUID}/logfile/{logfileUUID}/breakdown-by-workflow": { "get": { "tags": [ "Logfiles" ], "summary": "Task Logfile Breakdown", "operationId": "taskLogfileBreakdown", "parameters": [ { "name": "taskUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "logfileUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "logFileType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "PRE_ANALYSE", "POST_ANALYSE" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenesisAnalysisDto" } } } } }, "x-permissions": [ "TASK_get_by_id" ] } }, "/api/v3/task/{taskUuid}": { "put": { "tags": [ "Tasks" ], "summary": "Create or Update Instructions", "description": "Updates the task in the path. Only the fields sent change; a body `uuid` other than the path's answers 400.", "operationId": "createOrUpdateInstructions", "parameters": [ { "name": "taskUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "8e3a6d1f-2b7c-4a95-8d0e-5c4b1a7f3e29" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTaskRequest" }, "examples": { "instructions": { "description": "instructions", "value": { "instructions": "

Keep product names in English. Use the glossary for UI strings.

" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskDto" } } } } }, "x-permissions": [ "TASK_update" ] } }, "/api/v3/task/{taskUuid}/assignment": { "delete": { "tags": [ "Tasks" ], "summary": "Revoke Task Assignment", "operationId": "revokeTaskAssignment", "parameters": [ { "name": "taskUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskDto" } } } } }, "x-permissions": [ "TASK_assign" ] } }, "/api/v3/task/{taskUuid}/assignment/{userUuid}": { "post": { "tags": [ "Tasks" ], "summary": "Assign Task to User", "operationId": "assignTaskToUser", "parameters": [ { "name": "taskUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskDto" } } } } }, "x-permissions": [ "TASK_assign" ] } }, "/api/v3/task/{taskUuid}/payment-update": { "post": { "tags": [ "Tasks" ], "summary": "Task Payment", "operationId": "taskPayment", "parameters": [ { "name": "taskUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentItemDto" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskPaymentUpdateResponseDto" } } } } }, "x-permissions": [ "TASK_list" ] } }, "/api/v3/task/{taskUuid}/status-update": { "post": { "tags": [ "Tasks" ], "summary": "Task Status", "operationId": "taskStatus", "parameters": [ { "name": "taskUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskStatusUpdateDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskStatusUpdateResponseDto" } } } } }, "x-permissions": [ "TASK_update" ] } }, "/api/v3/translation-memory": { "post": { "tags": [ "Translation Memory" ], "summary": "Create Translation Memory", "operationId": "createTranslationMemory", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TMCreateParams" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TMDto" } } } } }, "x-permissions": [ "TM_create" ] } }, "/api/v3/user": { "get": { "tags": [ "Users" ], "summary": "List Users", "operationId": "listUsers", "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "wordRateInit", "in": "query", "required": false, "schema": { "type": "number", "format": "double" } }, { "name": "wordRateEnd", "in": "query", "required": false, "schema": { "type": "number", "format": "double" } }, { "name": "hourlyRateInit", "in": "query", "required": false, "schema": { "type": "number", "format": "double" } }, { "name": "hourlyRateEnd", "in": "query", "required": false, "schema": { "type": "number", "format": "double" } }, { "name": "nameOrEmail", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "exactMatch", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "roles", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sourceLanguage", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "targetLanguages", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "lastAccessOlderThanDays", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "neverAccessed", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "loggedUserIsAccountAdmin", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "taskSysAdminView", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "strictAccountScope", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "accountRoles", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "accountUUID", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "isAutopilotEligibleTasksByAccountEnabled", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "organizationUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "orgUnitUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "permissionGroupUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "isolatedTags", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "tagFilterDisabled", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "useTagDictionary", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "qualityFilterDisabled", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "qualityGraceEnabled", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "taskMinimumScore", "in": "query", "required": false, "schema": { "type": "number" } }, { "name": "customFields", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } }, { "name": "customFieldsJson", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "workflow", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "workflowUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page to return, starting at 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "description": "Items per page.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageUserDto" } } } } }, "x-permissions": [ "USER_list" ] }, "post": { "tags": [ "Users" ], "summary": "Create User", "description": "Creates a user in your account, in the `organizations` (at least one) and `orgUnits` sent. Sending the `uuid` of an existing user updates that user instead; organizations, org units and language pairs are then left as they are.", "operationId": "createUser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" }, "examples": { "create": { "description": "create", "value": { "name": "Jane Doe", "email": "jane.doe@example.com", "notes": "Reviewer for the marketing org unit.", "roles": [ "USER" ], "notifyUser": false, "organizations": [ { "uuid": "0e5a8c3f-6b9d-4f72-8a1e-4c7b2d9f6a05" } ], "orgUnits": [ { "uuid": "6b1f0c2e-8d4a-4f3b-9c5e-2a7d9e1b4c60" } ] } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } } } }, "x-permissions": [ "USER_save" ] } }, "/api/v3/user/{userUUID}/role/{role}": { "post": { "tags": [ "Users" ], "summary": "Add Role for User", "operationId": "addRoleForUser", "parameters": [ { "name": "userUUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "role", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "USER", "ADMIN", "SYSADMIN", "ACCOUNT_ADMIN", "CLIENT", "CLIENT_ADMIN", "CLIENT_AGENCY", "CLIENT_REQUESTER", "CLIENT_PROJECT_MANAGER", "PROJECT_MANAGER", "ACCOUNTING", "REVIEWER", "INTERNAL", "PAYMENTS", "QUALITY_ISO", "QUALITY_AUDITOR", "VENDOR_ADMIN", "SALES", "WIKI_MODERATOR", "WIKI_READONLY", "WIKI_USER", "WIKI_ACTIONS", "WIKI_ADMIN", "REF_ADMIN", "REF_USER", "REF_READONLY", "VENDOR", "TERM_TRANSLATOR", "TERM_REVIEWER", "TERM_ADMIN", "TERM_CONTENT_CREATOR", "TERM_LANGUAGE_MANAGER", "TERM_UPDATE_REQUESTER", "TERM_READ_ONLY", "TERMINOLOGY_STANDALONE_USER", "TERMINOLOGY_STANDALONE_OWNER" ] } } ], "responses": { "200": { "description": "OK" } }, "x-permissions": [ "USER_update_roles" ] } }, "/api/v3/user/{userUuid}/rate": { "get": { "tags": [ "Users / Rates" ], "summary": "List User Rates", "operationId": "listUserRates", "parameters": [ { "name": "userUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "orgUnitUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "scope", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ALL", "DEFAULT", "ORG_UNIT" ] } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page to return, starting at 0.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "description": "Items per page.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserRateDetailsDto" } } } } } }, "x-permissions": [ "USER_get_by_id" ] }, "post": { "tags": [ "Users / Rates" ], "summary": "Create User Rate", "operationId": "createUserRate", "parameters": [ { "name": "userUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRateDetailsDto" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRateDetailsDto" } } } } }, "x-permissions": [ "USER_update_billing" ] } }, "/api/v3/user/{userUuid}/rate/{userRateUuid}": { "put": { "tags": [ "Users / Rates" ], "summary": "Update User Rate", "operationId": "updateUserRate", "parameters": [ { "name": "userUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userRateUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRateDetailsDto" }, "examples": { "currencyAndMinimumFee": { "description": "currencyAndMinimumFee", "value": { "currency": "GBP", "minimumFee": 0.5 } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRateDetailsDto" } } } } }, "x-permissions": [ "USER_update_billing" ] }, "delete": { "tags": [ "Users / Rates" ], "summary": "Delete User Rate", "operationId": "deleteUserRate", "parameters": [ { "name": "userUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userRateUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } }, "x-permissions": [ "USER_update_billing" ] } }, "/api/v3/user/{userUuid}/rate/{userRateUuid}/default": { "put": { "tags": [ "Users / Rates" ], "summary": "Set Default User Rate", "operationId": "setDefaultUserRate", "parameters": [ { "name": "userUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userRateUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "x-permissions": [ "USER_update_billing" ] } }, "/api/v3/user/{userUuid}/rate/{userRateUuid}/detail/{rateDetailUuid}": { "delete": { "tags": [ "Users / Rates" ], "summary": "Delete User Rate Detail", "operationId": "deleteUserRateDetail", "parameters": [ { "name": "userUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userRateUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "rateDetailUuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" } }, "x-permissions": [ "USER_update_billing" ] } }, "/api/v3/user/{uuid}": { "get": { "tags": [ "Users" ], "summary": "Get User", "operationId": "getUser", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } } } }, "x-permissions": [ "USER_get_by_id" ] } }, "/api/v3/webhook": { "post": { "tags": [ "Webhooks" ], "summary": "Create Webhook", "description": "Creates a webhook that sends one event type to `url`, as a `POST` with a JSON body.\n\n- Right after it is created, wxrks sends a `WEBHOOK_VALIDATION` request to the URL. The webhook becomes active when the URL answers it with a `2xx` status within 3 seconds; until then it receives no events.\n- With a `secret`, every request is signed. `X-BWX-Timestamp` is the Unix time in seconds it was signed at, and `X-BWX-Signature` is `v1=` followed by the lowercase hex HMAC-SHA256 of `{X-BWX-Timestamp}.{raw body}`, keyed with the secret (UTF-8). Accept a request only when the signature matches, compared in constant time, and the timestamp is less than 5 minutes old. Retries are signed again with a new timestamp.\n- Receivers written before signatures can still read the secret itself in `X-BWX-Webhook-Secret`; check the signature instead.\n\nThe Webhooks guide lists the payload of each event type and has a verification example.\n", "operationId": "createWebhook", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookResponseDto" } } } } }, "x-roles": [ "SYSADMIN", "ADMIN", "ACCOUNT_ADMIN" ] } }, "/api/v3/workflow": { "get": { "tags": [ "Workflows" ], "summary": "List Workflows", "operationId": "listWorkflows", "parameters": [ { "name": "accountUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "clientUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "projectUuid", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "includeInactive", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowDto" } } } } } } } } }, "components": { "schemas": { "AIInstructions": { "type": "object", "properties": { "audience": { "maxLength": 1000, "minLength": 0, "type": "string" }, "creativity": { "type": "string" }, "domain": { "maxLength": 200, "minLength": 0, "type": "string" }, "formality": { "maxLength": 100, "minLength": 0, "type": "string" }, "guideline": { "maxLength": 5000, "minLength": 0, "type": "string" }, "tone": { "maxLength": 100, "minLength": 0, "type": "string" }, "userPrompt": { "maxLength": 5000, "minLength": 0, "type": "string" } }, "description": "Domain, audience, tone and other guidance for the translation." }, "AccountDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "aiReviewEnabled": { "type": "boolean" }, "allowInviteUsers": { "type": "boolean" }, "certificates": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Certificate" } }, "costsLogfileType": { "type": "string", "enum": [ "PRE_ANALYSE", "POST_ANALYSE" ] }, "createDate": { "type": "integer", "format": "int64" }, "customProjectCancellationOptionsEnabled": { "type": "boolean" }, "customReviewCategorizationEnabled": { "type": "boolean" }, "customSubdomain": { "type": "string" }, "disabledQualityFilter": { "type": "boolean" }, "disabledRateFilter": { "type": "boolean" }, "disabledTagFilter": { "type": "boolean" }, "emailDomain": { "type": "string" }, "logoUrl": { "type": "string" }, "name": { "type": "string" }, "notifyZendeskEnabled": { "type": "boolean" }, "payoneerApiUrl": { "type": "string" }, "payoneerAuthUrl": { "type": "string" }, "payoneerClientId": { "type": "string" }, "payoneerClientSecret": { "type": "string" }, "payoneerProgramId": { "type": "string" }, "projectAutomationEnabled": { "type": "boolean" }, "sendLearntToKanban": { "type": "boolean" }, "settings": { "$ref": "#/components/schemas/Settings" }, "ssoClientId": { "type": "string" }, "ssoClientSecret": { "type": "string" }, "ssoDomains": { "type": "object", "additionalProperties": { "type": "string" } }, "ssoUrl": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE", "TRIAL" ] }, "stripeId": { "type": "string" }, "subdomain": { "type": "string" }, "subscriptionId": { "type": "string" }, "type": { "type": "string", "enum": [ "CLI", "PERSONAL", "BUSINESS", "ENTERPRISE", "OTHER" ] }, "useCustomReviewCategoriesOnly": { "type": "boolean" }, "uuid": { "type": "string", "format": "uuid" } } }, "AnalysisConfigDto": { "type": "object", "properties": { "analyzeByLanguage": { "type": "boolean" }, "analyzeByProvider": { "type": "boolean" }, "calculateMachineTranslationReuse": { "type": "boolean" }, "calculateNonTranslatableReuse": { "type": "boolean" }, "calculateTranslationMemoryReuse": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "ignoreConfirmedSegments": { "type": "boolean" }, "ignoreLockedSegments": { "type": "boolean" }, "ignoreNumbers": { "type": "boolean" }, "includeNetRate": { "type": "boolean" } } }, "AnalysisItemByFileDto": { "type": "object", "properties": { "analysisTotals": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisTotalsDto" } }, "fileName": { "type": "string" }, "sourceLocale": { "type": "string" }, "targetLocale": { "type": "string" }, "uuidFromWorkUnitId": { "type": "string", "format": "uuid" }, "workUnitId": { "type": "string" } } }, "AnalysisItemByLangPairDto": { "type": "object", "properties": { "analysisTotals": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisTotalsDto" } }, "sourceLocale": { "type": "string" }, "targetLocale": { "type": "string" } } }, "AnalysisTotalsDto": { "type": "object", "properties": { "analysisItemType": { "type": "string", "enum": [ "ALL", "TM_MATCH", "CS_MATCH", "REPETITION", "MT_MATCH", "NON_TRANSLATABLE", "CONFIDENCE_CONFIRMED" ] }, "isMissingMatch": { "type": "boolean" }, "match": { "type": "number", "format": "double" }, "matchEnd": { "type": "number", "format": "double" }, "matchLabel": { "type": "string" }, "matchOrZeroIfNull": { "type": "number", "format": "double" }, "netChars": { "type": "number", "format": "double" }, "netRateFactor": { "type": "number", "format": "double" }, "netSegments": { "type": "number", "format": "double" }, "netWords": { "type": "number", "format": "double" }, "totalChars": { "type": "number", "format": "double" }, "totalSegments": { "type": "number", "format": "double" }, "totalWords": { "type": "number", "format": "double" } } }, "ApiLoginDto": { "type": "object", "properties": { "accessKey": { "type": "string" }, "secret": { "type": "string" } } }, "AsyncRequestDto": { "type": "object", "properties": { "data": { "type": "object" }, "error": { "type": "object" }, "id": { "type": "string" }, "status": { "type": "string", "enum": [ "NEW", "RUNNING", "ERROR", "WARN", "DONE" ] } } }, "BulkAssignTask": { "type": "object", "properties": { "taskUuids": { "type": "array", "description": "The tasks to assign.", "items": { "type": "string", "description": "The tasks to assign.", "format": "uuid" } }, "tasksUuids": { "type": "array", "description": "Same as `taskUuids`. The misspelled name stays until the next API version.", "deprecated": true, "items": { "type": "string", "description": "Same as `taskUuids`. The misspelled name stays until the next API version.", "format": "uuid", "deprecated": true } }, "userUuid": { "type": "string", "format": "uuid" } } }, "BulkCreateWorkUnit": { "type": "object", "properties": { "accountUuid": { "type": "string", "format": "uuid", "readOnly": true }, "documentUuid": { "type": "string", "format": "uuid" }, "entityWorkflows": { "type": "array", "items": { "$ref": "#/components/schemas/Workflow" } }, "messageUuid": { "type": "string", "format": "uuid" }, "projectResourceUuid": { "type": "string", "format": "uuid" }, "targetLocales": { "type": "array", "items": { "type": "string" } }, "workUnitAutomation": { "type": "boolean" }, "workflowSequences": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } }, "workflows": { "type": "array", "items": { "type": "string" } } } }, "BulkImportKitRequest": { "required": [ "importType" ], "type": "object", "properties": { "applyStatusFromFile": { "type": "boolean", "description": "XLIFF only: apply each unit's `bwx:locked`, `bwx:confirmed` and notes to its segment (lock and unlock, confirm and unconfirm, notes added as comments). A unit without `bwx:confirmed` follows the confirmation flags. Locks change only with the Lock Segments permission on the work unit.", "default": false }, "confirmAllNotEmpty": { "type": "boolean", "description": "Confirm every segment with a non-empty target, changed or not.", "default": false }, "confirmOnlyChangeSegments": { "type": "boolean", "description": "Write only the segments whose text changed, and confirm them.", "default": false }, "importType": { "type": "string", "description": "Format of the imported file.", "enum": [ "XLIFF", "XLSX" ] }, "updateTm": { "type": "boolean", "description": "Add the confirmed segments this import writes to the project's translation memories.", "default": true }, "workUnitUuids": { "type": "array", "description": "Import only the files of these work units. Leave empty to import every file in the kit. A vendor always imports into their own assigned work units, whatever this list says.", "items": { "type": "string", "description": "Import only the files of these work units. Leave empty to import every file in the kit. A vendor always imports into their own assigned work units, whatever this list says.", "format": "uuid" } } } }, "BwxFontMappings": { "type": "object", "properties": { "sourceFonts": { "type": "array", "items": { "type": "string" } }, "sourceLocale": { "type": "string" }, "targetFont": { "type": "string" }, "targetLocale": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" } } }, "CacheProgress": { "type": "object", "properties": { "current": { "type": "integer", "format": "int32" }, "fixedSegments": { "type": "integer", "format": "int32" }, "key": { "type": "string" }, "remainingSegments": { "type": "integer", "format": "int32" }, "skippedSegments": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "unfixedSegments": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "url": { "type": "string" } } }, "Certificate": { "type": "object", "properties": { "arn": { "type": "string" }, "certificate": { "type": "string" }, "chain": { "type": "string" }, "domain": { "type": "string" }, "key": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "object" } } } }, "CheckDuplicatedTermsRequest": { "required": [ "glossaryIds", "sourceLanguage", "sourceTerm", "targetLanguage", "targetTerm" ], "type": "object", "properties": { "glossaryIds": { "type": "array", "description": "Ids (`bwGlossaryId`) of the glossaries to check. Each must be readable by the caller.", "example": [ 1042 ], "items": { "type": "integer", "format": "int64", "example": 1042 } }, "sourceLanguage": { "type": "string", "example": "en_us" }, "sourceTerm": { "type": "string", "example": "release note" }, "targetLanguage": { "type": "string", "example": "de_de" }, "targetTerm": { "type": "string", "example": "Versionshinweis" }, "taskUuids": { "uniqueItems": true, "type": "array", "description": "Tasks that give a vendor access to their projects' glossaries.", "example": [ "c64d892f-7ecf-4b75-976b-395d16002499" ], "items": { "type": "string", "format": "uuid", "example": "c64d892f-7ecf-4b75-976b-395d16002499" } } } }, "ClientAddressDto": { "type": "object", "properties": { "additionalInfo": { "type": "string" }, "city": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" }, "zip": { "type": "string" } } }, "ClientCreateDtoV3": { "type": "object", "properties": { "addLoggedUserToClient": { "type": "boolean" }, "contactPersonUuid": { "type": "string", "format": "uuid" }, "country": { "type": "string" }, "currency": { "type": "string" }, "name": { "type": "string" }, "organizationUuid": { "type": "string", "format": "uuid" }, "timezone": { "type": "string" } } }, "ClientDto": { "type": "object", "properties": { "externalId": { "type": "string" }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "ClientIdNameDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "sourceLanguage": { "type": "string" }, "targetLanguage": { "type": "array", "items": { "type": "string" } }, "uuid": { "type": "string", "format": "uuid" } }, "description": "The org unit of `orgUnitUuid`, filled in by wxrks on reads.", "readOnly": true }, "ClientTaxInfoDto": { "type": "object", "properties": { "issueNfe": { "type": "boolean" }, "municipalRegistration": { "type": "string" }, "requirePurchaseOrder": { "type": "boolean" }, "retainIr": { "type": "boolean" }, "retainIss": { "type": "boolean" }, "simplesNacional": { "type": "boolean" } } }, "ClientTmSettingsDto": { "type": "object", "properties": { "atlasTmId": { "type": "integer", "format": "int64" }, "client": { "$ref": "#/components/schemas/OrganizationalUnitDto" }, "createdBy": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/UserRef" } ] }, "creationDate": { "type": "integer", "format": "int64" }, "defaultThreshold": { "type": "number", "format": "double" }, "fixPreTranslateMismatchTags": { "type": "boolean" }, "fixSuggestionMismatchTags": { "type": "boolean" }, "fixTags": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "name": { "type": "string" }, "penalty": { "type": "number", "format": "double" }, "read": { "type": "boolean" }, "settings": { "$ref": "#/components/schemas/Settings" }, "sourceLocale": { "type": "string" }, "targetLocales": { "type": "array", "items": { "type": "string" } }, "tmUuid": { "type": "string", "format": "uuid" }, "uuid": { "type": "string", "format": "uuid" }, "write": { "type": "boolean" } } }, "CodeUomSpan": { "type": "object", "properties": { "end": { "type": "integer", "format": "int32" }, "start": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "value": { "type": "string" } } }, "ConceptDTO": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "writable": { "type": "boolean" } } }, "ConceptEntryDtoV3": { "type": "object", "properties": { "createdDate": { "type": "integer", "format": "int64" }, "definition": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "note": { "type": "string" }, "terms": { "type": "array", "items": { "$ref": "#/components/schemas/TermEntryDto" } }, "uuid": { "type": "string", "format": "uuid" } } }, "ConfigOrgUnitsDto": { "type": "object", "properties": { "country": { "type": "string" }, "defaultContactPerson": { "$ref": "#/components/schemas/UserRef" }, "fileParams": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceFileParamsDto" } }, "glossaryList": { "type": "array", "items": { "$ref": "#/components/schemas/GlossaryDto" } }, "id": { "type": "integer", "format": "int64" }, "instructions": { "type": "string" }, "name": { "type": "string" }, "organizationUuid": { "type": "string", "format": "uuid" }, "priceList": { "$ref": "#/components/schemas/PriceListDto" }, "resourceUuids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "targetLanguages": { "type": "array", "items": { "type": "string" } }, "tmList": { "type": "array", "items": { "$ref": "#/components/schemas/ClientTmSettingsDto" } }, "tmSettings": { "type": "array", "items": { "$ref": "#/components/schemas/MultiConfigTmSettingsDto" } }, "uuid": { "type": "string", "format": "uuid" }, "workflows": { "type": "array", "items": { "type": "string" } } } }, "ContinuousFileUploadDto": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "locales": { "type": "array", "items": { "type": "string" } }, "path": { "type": "string" }, "reference": { "type": "string" }, "source": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "workflows": { "type": "array", "items": { "type": "string" } } } }, "ContinuousProject": { "type": "object", "properties": { "ciTag": { "type": "string" }, "contactUUID": { "type": "string", "format": "uuid" }, "contentMode": { "type": "string", "enum": [ "FILES", "KEY_VALUE" ] }, "instructions": { "type": "string" }, "notes": { "type": "string" }, "orgUnitUUID": { "type": "string", "format": "uuid" }, "reference": { "type": "string" }, "source": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "totalExpectedWorkUnits": { "type": "integer", "format": "int32" } } }, "CostDto": { "type": "object", "properties": { "costPerUnit": { "type": "number" }, "costType": { "type": "string", "enum": [ "TRANSLATIONS", "FILE_ENGINEERING", "QA", "NONE" ] }, "costsLogfileId": { "type": "string", "format": "uuid" }, "creationTimestamp": { "type": "integer", "format": "int64" }, "description": { "type": "string" }, "displayOrder": { "type": "integer", "format": "int32" }, "filename": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "matchEnd": { "type": "integer", "format": "int32" }, "matchStart": { "type": "integer", "format": "int32" }, "noPriceList": { "type": "boolean" }, "rateType": { "type": "string", "enum": [ "PERCENTAGE", "NOMINAL" ] }, "reason": { "type": "string" }, "sourceLanguage": { "type": "string" }, "targetLanguage": { "type": "string" }, "total": { "type": "number", "format": "double" }, "unitType": { "type": "string", "enum": [ "WORD", "PAGE", "MINUTE", "HOUR", "DAY", "FEE", "DISCOUNT" ] }, "units": { "type": "number" }, "uuid": { "type": "string", "format": "uuid" } } }, "CostInfoDto": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "calculatedCost": { "type": "number", "format": "double" }, "costType": { "type": "string" }, "costUnitType": { "type": "string" }, "costValue": { "type": "number", "format": "double" }, "description": { "type": "string" }, "minimumFee": { "type": "number" }, "noPriceList": { "type": "boolean" }, "reason": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" } } }, "CostsDto": { "type": "object", "properties": { "langPairCosts": { "type": "array", "items": { "$ref": "#/components/schemas/LangPairCostDto" } }, "totalCost": { "type": "number" } } }, "CreateLogfileRequest": { "required": [ "type" ], "type": "object", "properties": { "allWorkUnitsAtLevel": { "type": "integer", "description": "Analyse every work unit at this workflow level.", "format": "int32" }, "calculateMachineTranslationReuse": { "type": "boolean" }, "calculateNonTranslatableReuse": { "type": "boolean" }, "calculateTranslationMemoryReuse": { "type": "boolean" }, "classifyConfidenceApproved": { "type": "boolean" }, "confidenceOverRepetition": { "type": "boolean", "description": "Defaults to the project's setting." }, "countWordsFrom": { "type": "string", "description": "Defaults to `SOURCE`.", "enum": [ "SOURCE", "TARGET" ] }, "ignoreConfirmedSegments": { "type": "boolean" }, "ignoreLockedSegments": { "type": "boolean" }, "ignoreNumbers": { "type": "boolean" }, "maxSegmentTimestamp": { "type": "integer", "description": "Only segments changed up to this time (epoch milliseconds) count.", "format": "int64" }, "name": { "type": "string", "description": "Name of the logfile.", "example": "Pre-analysis, first batch" }, "ntOverRepetition": { "type": "boolean", "description": "Defaults to the project's setting." }, "taskIds": { "type": "array", "description": "Tasks to analyse.", "items": { "type": "string", "description": "Tasks to analyse.", "format": "uuid" } }, "taskUuids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "tmOverRepetition": { "type": "boolean", "description": "Defaults to the project's setting." }, "type": { "type": "string", "example": "PRE_ANALYSE", "enum": [ "PRE_ANALYSE", "POST_ANALYSE", "COMPARE" ] }, "workUnitIds": { "type": "array", "description": "Work units to analyse. Without work units, tasks or `allWorkUnitsAtLevel`, every work unit of the project.", "items": { "type": "string", "description": "Work units to analyse. Without work units, tasks or `allWorkUnitsAtLevel`, every work unit of the project.", "format": "uuid" } }, "workflow": { "type": "string" } } }, "CreateProjectDto": { "type": "object", "properties": { "assigneeUUID": { "type": "string", "format": "uuid" }, "contactUUID": { "type": "string", "format": "uuid" }, "contentMode": { "type": "string", "enum": [ "FILES", "KEY_VALUE" ] }, "creatorUUID": { "type": "string", "format": "uuid" }, "currency": { "type": "string" }, "isContinuous": { "type": "boolean" }, "notes": { "type": "string" }, "orgUnitUUID": { "type": "string", "format": "uuid" }, "reference": { "type": "string" }, "sourceLocale": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "timezone": { "type": "string" } } }, "CreateProjectResourceDto": { "type": "object", "properties": { "name": { "type": "string" }, "notes": { "type": "string" }, "path": { "type": "string" }, "previewUrl": { "type": "string" }, "tags": { "type": "string" }, "targetLocales": { "type": "array", "items": { "type": "string" } } } }, "CreateReceivableRequest": { "required": [ "contactUser", "currency", "dueDate", "organizationalUnit" ], "type": "object", "properties": { "contactUser": { "$ref": "#/components/schemas/ReceivableUuidRef" }, "currency": { "type": "string", "example": "USD" }, "customReceivableByUser": { "type": "boolean" }, "dueDate": { "type": "integer", "description": "Due date of the first installment, epoch milliseconds.", "format": "int64", "example": 1767225600000 }, "equally": { "type": "boolean", "description": "Split the amount equally between installments. Defaults to true." }, "firstInstallmentValue": { "type": "number", "description": "Amount of the first installment when the split is not equal.", "format": "double" }, "intervalBetweenDues": { "type": "integer", "description": "Days between installment due dates. Defaults to 30.", "format": "int32" }, "invoiceFirstOnly": { "type": "boolean", "description": "Invoice the first installment only. Defaults to false." }, "manualInvoice": { "type": "boolean" }, "multipleInstallments": { "type": "boolean", "description": "Defaults to false." }, "numInstallments": { "type": "integer", "description": "With `multipleInstallments`. Defaults to 1.", "format": "int32" }, "organizationalUnit": { "$ref": "#/components/schemas/ReceivableUuidRef" }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/ReceivableProjectRef" } }, "purchaseOrder": { "type": "string", "example": "PO-1001" }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/ReceivableTaxRef" } } } }, "CreateUserRequest": { "required": [ "email", "name", "organizations" ], "type": "object", "properties": { "address": { "type": "string" }, "address2": { "type": "string" }, "avatar": { "type": "string" }, "cellPhone": { "type": "string" }, "city": { "type": "string" }, "companyName": { "type": "string" }, "country": { "type": "string" }, "currency": { "type": "string" }, "dailyRate": { "type": "number" }, "defaultWorkflowRates": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "email": { "type": "string", "example": "jane.doe@example.com" }, "entryPoint": { "type": "string", "enum": [ "WORKS_HOME", "PORTAL_HOME" ] }, "externalId": { "type": "string" }, "hourlyRate": { "type": "number" }, "invoicingDayOfMonth": { "type": "string", "enum": [ "DAY_15", "DAY_30" ] }, "invoicingPeriodicity": { "type": "integer", "format": "int32" }, "minimumFee": { "type": "number" }, "name": { "type": "string", "example": "Jane Doe" }, "notes": { "type": "string", "example": "Reviewer for the marketing org unit." }, "notifyUser": { "type": "boolean", "description": "Email the new user their access. Defaults to true.", "example": false }, "orgUnits": { "type": "array", "items": { "$ref": "#/components/schemas/UserAssociationRef" } }, "organizations": { "type": "array", "items": { "$ref": "#/components/schemas/UserAssociationRef" } }, "pagesRate": { "type": "number" }, "paymentMethod": { "type": "string", "enum": [ "PAYONEER", "PAYPAL", "BANK", "QUICKBOOKS" ] }, "payoneerId": { "type": "string" }, "paypalAccount": { "type": "string" }, "phone": { "type": "string" }, "postalCode": { "type": "string" }, "roles": { "uniqueItems": true, "type": "array", "description": "Roles to grant. You can only grant roles you are allowed to manage; `USER` is always granted.", "example": [ "USER" ], "items": { "type": "string", "description": "Roles to grant. You can only grant roles you are allowed to manage; `USER` is always granted.", "example": "[\"USER\"]", "enum": [ "USER", "ADMIN", "SYSADMIN", "ACCOUNT_ADMIN", "CLIENT", "CLIENT_ADMIN", "CLIENT_AGENCY", "CLIENT_REQUESTER", "CLIENT_PROJECT_MANAGER", "PROJECT_MANAGER", "ACCOUNTING", "REVIEWER", "INTERNAL", "PAYMENTS", "QUALITY_ISO", "QUALITY_AUDITOR", "VENDOR_ADMIN", "SALES", "WIKI_MODERATOR", "WIKI_READONLY", "WIKI_USER", "WIKI_ACTIONS", "WIKI_ADMIN", "REF_ADMIN", "REF_USER", "REF_READONLY", "VENDOR", "TERM_TRANSLATOR", "TERM_REVIEWER", "TERM_ADMIN", "TERM_CONTENT_CREATOR", "TERM_LANGUAGE_MANAGER", "TERM_UPDATE_REQUESTER", "TERM_READ_ONLY", "TERMINOLOGY_STANDALONE_USER", "TERMINOLOGY_STANDALONE_OWNER" ] } }, "skypeId": { "type": "string" }, "slackHandle": { "type": "string" }, "state": { "type": "string" }, "status": { "type": "string", "description": "The user's status. Read ignoring case. New users default to Active.", "enum": [ "Active", "Inactive", "Disabled" ] }, "supportedLanguagePairs": { "type": "array", "items": { "$ref": "#/components/schemas/UserLanguagePairRef" } }, "tags": { "type": "array", "items": { "type": "string" } }, "targetAccountUuid": { "type": "string", "description": "wxrks staff only: the account to create the user in. Ignored for anyone else.", "format": "uuid" }, "taxId": { "type": "string" }, "taxpayerId": { "type": "string" }, "timezone": { "type": "string" }, "uuid": { "type": "string", "description": "Leave it out to create a user. The uuid of an existing user updates that user.", "format": "uuid" }, "wordRate": { "type": "number" } } }, "CreatedPayable": { "type": "object", "properties": { "currency": { "type": "string" }, "dueDate": { "type": "integer", "format": "int64" }, "index": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "payableAmount": { "type": "number", "format": "double" }, "uuid": { "type": "string", "format": "uuid" } } }, "CurrencyRateDto": { "type": "object", "properties": { "rate": { "type": "number", "format": "double" }, "sourceCurrency": { "type": "string" }, "targetCurrency": { "type": "string" }, "unsupportedByDefault": { "type": "boolean" } } }, "CurrencySummaryDto": { "type": "object", "properties": { "convertedValue": { "type": "number" }, "originalValue": { "type": "number" }, "percentage": { "type": "number" } } }, "CustomFieldDto": { "type": "object", "properties": { "entities": { "type": "array", "items": { "type": "string", "enum": [ "DEFAULT", "PROJECT", "TASK", "USER", "ORGANIZATION", "ORG_UNIT", "GLOSSARY", "PAYABLE", "INVOICE", "TRANSLATION_MEMORY" ] } }, "entity": { "type": "string" }, "entityCode": { "type": "string", "enum": [ "DEFAULT", "PROJECT", "TASK", "USER", "ORGANIZATION", "ORG_UNIT", "GLOSSARY", "PAYABLE", "INVOICE", "TRANSLATION_MEMORY" ] }, "multivalueDefault": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "sameNameEntities": { "type": "array", "items": { "type": "string" } }, "scope": { "$ref": "#/components/schemas/CustomFieldScope" }, "scopeNames": { "type": "object", "additionalProperties": { "type": "string" } }, "type": { "type": "string", "enum": [ "BOOL", "TEXT", "NUMERIC", "MULTIVALUE", "FREE_TEXT" ] }, "uuid": { "type": "string", "format": "uuid" }, "value": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } }, "CustomFieldScope": { "type": "object", "properties": { "entityExcludedUsers": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "entityGlossaries": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "entityMemories": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "entityOrgUnitMembers": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "entityOrgUnits": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "entityOrganizations": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "entityUserRoles": { "type": "array", "items": { "type": "string", "enum": [ "USER", "ADMIN", "SYSADMIN", "ACCOUNT_ADMIN", "CLIENT", "CLIENT_ADMIN", "CLIENT_AGENCY", "CLIENT_REQUESTER", "CLIENT_PROJECT_MANAGER", "PROJECT_MANAGER", "ACCOUNTING", "REVIEWER", "INTERNAL", "PAYMENTS", "QUALITY_ISO", "QUALITY_AUDITOR", "VENDOR_ADMIN", "SALES", "WIKI_MODERATOR", "WIKI_READONLY", "WIKI_USER", "WIKI_ACTIONS", "WIKI_ADMIN", "REF_ADMIN", "REF_USER", "REF_READONLY", "VENDOR", "TERM_TRANSLATOR", "TERM_REVIEWER", "TERM_ADMIN", "TERM_CONTENT_CREATOR", "TERM_LANGUAGE_MANAGER", "TERM_UPDATE_REQUESTER", "TERM_READ_ONLY", "TERMINOLOGY_STANDALONE_USER", "TERMINOLOGY_STANDALONE_OWNER" ] } }, "fillExcludedUsers": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "fillOrgUnits": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "fillRoles": { "type": "array", "items": { "type": "string", "enum": [ "USER", "ADMIN", "SYSADMIN", "ACCOUNT_ADMIN", "CLIENT", "CLIENT_ADMIN", "CLIENT_AGENCY", "CLIENT_REQUESTER", "CLIENT_PROJECT_MANAGER", "PROJECT_MANAGER", "ACCOUNTING", "REVIEWER", "INTERNAL", "PAYMENTS", "QUALITY_ISO", "QUALITY_AUDITOR", "VENDOR_ADMIN", "SALES", "WIKI_MODERATOR", "WIKI_READONLY", "WIKI_USER", "WIKI_ACTIONS", "WIKI_ADMIN", "REF_ADMIN", "REF_USER", "REF_READONLY", "VENDOR", "TERM_TRANSLATOR", "TERM_REVIEWER", "TERM_ADMIN", "TERM_CONTENT_CREATOR", "TERM_LANGUAGE_MANAGER", "TERM_UPDATE_REQUESTER", "TERM_READ_ONLY", "TERMINOLOGY_STANDALONE_USER", "TERMINOLOGY_STANDALONE_OWNER" ] } }, "recordOrgUnits": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "recordTypes": { "type": "array", "items": { "type": "string", "enum": [ "DEFAULT", "PROJECT", "TASK", "USER", "ORGANIZATION", "ORG_UNIT", "GLOSSARY", "PAYABLE", "INVOICE", "TRANSLATION_MEMORY" ] } }, "viewExcludedUsers": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "viewOrgUnits": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "viewRoles": { "type": "array", "items": { "type": "string", "enum": [ "USER", "ADMIN", "SYSADMIN", "ACCOUNT_ADMIN", "CLIENT", "CLIENT_ADMIN", "CLIENT_AGENCY", "CLIENT_REQUESTER", "CLIENT_PROJECT_MANAGER", "PROJECT_MANAGER", "ACCOUNTING", "REVIEWER", "INTERNAL", "PAYMENTS", "QUALITY_ISO", "QUALITY_AUDITOR", "VENDOR_ADMIN", "SALES", "WIKI_MODERATOR", "WIKI_READONLY", "WIKI_USER", "WIKI_ACTIONS", "WIKI_ADMIN", "REF_ADMIN", "REF_USER", "REF_READONLY", "VENDOR", "TERM_TRANSLATOR", "TERM_REVIEWER", "TERM_ADMIN", "TERM_CONTENT_CREATOR", "TERM_LANGUAGE_MANAGER", "TERM_UPDATE_REQUESTER", "TERM_READ_ONLY", "TERMINOLOGY_STANDALONE_USER", "TERMINOLOGY_STANDALONE_OWNER" ] } } } }, "DownloadFiltersDto": { "type": "object", "properties": { "dataTransformationParamsMap": { "type": "string" }, "filenames": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "locales": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "projectStatus": { "type": "string", "enum": [ "DELETED", "CANCELLED", "DRAFT", "PENDING", "APPROVED", "DELIVERED", "INVOICED", "PARTIALLY_INVOICED", "NOT_INVOICED", "CONTINUOUS" ] }, "resources": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } }, "retrieveLatestDeliveredWorkflow": { "type": "boolean" }, "updateDataTransformation": { "type": "boolean" } } }, "DownloadTranslatedFiles": { "type": "object", "properties": { "downloadUrl": { "type": "string" }, "error": { "type": "string" }, "requestUuid": { "type": "string", "format": "uuid" }, "status": { "type": "string" } } }, "EloquaConfig": { "type": "object", "properties": { "accountUuid": { "type": "string", "description": "The account of the org unit, set by wxrks.", "format": "uuid", "readOnly": true }, "active": { "type": "boolean" }, "companyName": { "type": "string" }, "defaultWorkflows": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "orgUnit": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/ClientIdNameDto" } ] }, "orgUnitUuid": { "type": "string", "format": "uuid" }, "password": { "type": "string" }, "username": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" } } }, "EntityTaxDto": { "type": "object", "properties": { "calculationType": { "type": "string", "enum": [ "INCREASE", "DECREASE" ] }, "enabled": { "type": "boolean" }, "entityType": { "type": "string", "enum": [ "USER", "ORG_UNIT" ] }, "entityUuid": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "taxUuid": { "type": "string", "format": "uuid" }, "type": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "value": { "type": "number" } } }, "FatClientDto": { "type": "object", "properties": { "accountCode": { "type": "string" }, "accountUuid": { "type": "string", "format": "uuid", "readOnly": true }, "address": { "$ref": "#/components/schemas/ClientAddressDto" }, "aiReviewEnabled": { "type": "boolean" }, "autoBilling": { "type": "boolean" }, "autopilotEnabled": { "type": "boolean" }, "billingEmail": { "type": "string" }, "categorizationDisabled": { "type": "boolean" }, "clientLanguages": { "type": "string" }, "confidenceMatchOverRepetitionEnabled": { "type": "boolean" }, "consolidateProjects": { "type": "boolean" }, "contactNotes": { "type": "string" }, "contactPerson": { "$ref": "#/components/schemas/UserRef" }, "contactPersonEmailNotifications": { "type": "boolean" }, "continuousPlatformTag": { "type": "string" }, "continuousProjectConfig": { "type": "string" }, "continuousSealed": { "type": "boolean" }, "contract": { "type": "boolean" }, "contractEndDate": { "type": "integer", "format": "int64" }, "contractStartDate": { "type": "integer", "format": "int64" }, "costsLogfileType": { "type": "string", "enum": [ "PRE_ANALYSE", "POST_ANALYSE" ] }, "country": { "type": "string" }, "currency": { "type": "string" }, "customFields": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "customReceivableByUser": { "type": "boolean" }, "daysUntilPaymentDue": { "type": "integer", "format": "int64" }, "defaultProjectManager": { "$ref": "#/components/schemas/UserRef" }, "defaultSourceLanguage": { "type": "string" }, "disableMachineTranslate": { "type": "boolean" }, "disabledQualityFilter": { "type": "boolean" }, "disabledRateFilter": { "type": "boolean" }, "disabledTagFilter": { "type": "boolean" }, "emails": { "type": "array", "items": { "type": "string" } }, "externalId": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "ignoreTranslationMemories": { "type": "boolean" }, "instructions": { "type": "string" }, "invoiceGroupingKey": { "type": "string" }, "invoiceInfo": { "type": "string" }, "invoicingType": { "type": "string" }, "isClientTerminology": { "type": "boolean" }, "isolatedTags": { "type": "boolean" }, "localeRegion": { "type": "object", "additionalProperties": { "type": "string" } }, "logo": { "type": "string" }, "memo": { "type": "string" }, "mobile": { "type": "string" }, "mtSettings": { "$ref": "#/components/schemas/MtSettingsDto" }, "name": { "type": "string" }, "netRateSettings": { "$ref": "#/components/schemas/NetRateSettingsDto" }, "notes": { "type": "string" }, "notifyProjectComments": { "type": "boolean" }, "notifyZendeskEnabled": { "type": "boolean" }, "ntMatchOverRepetitionEnabled": { "type": "boolean" }, "organization": { "$ref": "#/components/schemas/OrganizationDto" }, "overrideDefaultRegex": { "type": "boolean" }, "paymentMethod": { "type": "string", "enum": [ "CHECK", "PAYPAL", "CREDITCARD", "DEPOSIT", "WIRE", "ACH", "BANKING_TICKET" ] }, "phone": { "type": "string" }, "projectAutomationEnabled": { "type": "boolean" }, "projectCountWordsFrom": { "type": "string", "enum": [ "SOURCE", "TARGET" ] }, "projectManagerEmailNotifications": { "type": "boolean" }, "quickBooksId": { "type": "string" }, "quickBooksProductServiceId": { "type": "string" }, "quoteNotes": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteNotes" } }, "regex": { "type": "string" }, "sendAvailableTasksEmail": { "type": "boolean" }, "sendInvoiceToRequester": { "type": "boolean" }, "sendLearntToKanban": { "type": "boolean" }, "sendQuoteAuto": { "type": "boolean" }, "sendReceivableEmailNotification": { "type": "boolean" }, "settings": { "$ref": "#/components/schemas/Settings" }, "showPaymentPolicy": { "type": "boolean" }, "showRequester": { "type": "boolean" }, "splitLargeJobs": { "type": "boolean" }, "status": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "taskCountWordsFrom": { "type": "string", "enum": [ "SOURCE", "TARGET" ] }, "taskPaymentType": { "type": "string", "enum": [ "WORD", "HOUR" ] }, "taxInfo": { "$ref": "#/components/schemas/ClientTaxInfoDto" }, "taxpayerId": { "type": "string" }, "timezone": { "type": "string" }, "tmMatchOverRepetitionEnabled": { "type": "boolean" }, "trackingCategory": { "type": "string" }, "trackingCategoryType": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "vendorEmailNotifications": { "type": "boolean" }, "webhookEnabled": { "type": "boolean" }, "website": { "type": "string" }, "xeroId": { "type": "string" }, "zendeskUrl": { "type": "string" }, "zendeskUser": { "type": "string" } } }, "FileParams": { "type": "object", "properties": { "applyAll": { "type": "boolean" }, "applySourceSegmentation": { "type": "boolean" }, "defaultFilter": { "type": "string" }, "defaultFilterScope": { "type": "string", "enum": [ "ORG_UNIT", "ACCOUNT" ] }, "defaultFilterSettings": { "type": "boolean" }, "extensionFile": { "type": "string" }, "extractTerms": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "object" } }, "parserFilter": { "type": "string" }, "projectResourceId": { "type": "string", "format": "uuid" }, "segmentationFileUrl": { "type": "string" }, "segmentationParams": { "type": "object", "additionalProperties": { "type": "object" } }, "tagRegex": { "type": "string" }, "termsParams": { "type": "object", "additionalProperties": { "type": "object" } } } }, "FileType": { "type": "object", "properties": { "applySourceSegmentation": { "type": "boolean" }, "filters": { "$ref": "#/components/schemas/Filter" }, "label": { "type": "string" }, "parameters": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Parameter" } }, "terms": { "$ref": "#/components/schemas/TermsParams" } } }, "Filter": { "type": "object", "properties": { "defaultFilter": { "type": "string" }, "types": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Type" } } } }, "GenesisAnalysisDto": { "type": "object", "properties": { "allWorkUnitsAtLevel": { "type": "integer", "format": "int32" }, "analysisWorkflow": { "type": "string" }, "attempt": { "type": "integer", "format": "int32" }, "config": { "$ref": "#/components/schemas/AnalysisConfigDto" }, "countWordsFrom": { "type": "string", "enum": [ "SOURCE", "TARGET" ] }, "creationDate": { "type": "integer", "format": "int64" }, "failureReason": { "type": "string" }, "fileContent": { "type": "array", "items": { "type": "string", "format": "byte" } }, "finishedDate": { "type": "integer", "format": "int64" }, "id": { "type": "string", "format": "uuid" }, "isCostLogFile": { "type": "boolean" }, "isTaskPaymentLogFile": { "type": "boolean" }, "itemsByFile": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisItemByFileDto" } }, "itemsByLangPair": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisItemByLangPairDto" } }, "name": { "type": "string" }, "previousName": { "type": "string", "description": "The name the logfile had before its last rename. Empty when it was never renamed." }, "progress": { "$ref": "#/components/schemas/GenesisAnalysisProgressDto" }, "projectId": { "type": "string", "format": "uuid" }, "renamedAt": { "type": "integer", "description": "When the last rename happened, in epoch milliseconds.", "format": "int64" }, "renamedBy": { "type": "string", "description": "Who made the last rename." }, "startedDate": { "type": "integer", "format": "int64" }, "status": { "type": "string" }, "targetLocales": { "type": "array", "description": "The target locales of the analysis.", "items": { "type": "string", "description": "The target locales of the analysis." } }, "targetsLocales": { "type": "array", "description": "Same as `targetLocales`. The misspelled name stays until the next API version.", "deprecated": true, "items": { "type": "string", "description": "Same as `targetLocales`. The misspelled name stays until the next API version.", "deprecated": true } }, "type": { "type": "string", "enum": [ "PRE_ANALYSE", "POST_ANALYSE", "COMPARE" ] }, "workUnitsAtProjectStepLevel": { "type": "integer", "format": "int32" }, "workflow": { "type": "string" } } }, "GenesisAnalysisProgressDto": { "type": "object", "properties": { "currentStep": { "type": "string" }, "percentage": { "type": "integer", "format": "int32" }, "processedSegments": { "type": "integer", "format": "int32" }, "totalSegments": { "type": "integer", "format": "int32" } } }, "GenesisAnalysisSummaryDto": { "type": "object", "properties": { "language": { "type": "string" }, "totalChars": { "type": "integer", "format": "int64" }, "totalSegments": { "type": "integer", "format": "int64" }, "totalWords": { "type": "integer", "format": "int64" } } }, "GenesisProjectProcessSummaryDto": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "status": { "type": "string" } } }, "GithubConfig": { "type": "object", "properties": { "accountUuid": { "type": "string", "description": "The account of the org unit, set by wxrks.", "format": "uuid", "readOnly": true }, "defaultWorkflows": { "type": "array", "items": { "type": "string" } }, "githubToken": { "type": "string" }, "githubUrl": { "type": "string" }, "githubUser": { "type": "string" }, "name": { "type": "string" }, "orgUnit": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/ClientIdNameDto" } ] }, "orgUnitUuid": { "type": "string", "format": "uuid" }, "uuid": { "type": "string", "format": "uuid" } } }, "GlossaryCreateRequest": { "required": [ "languages", "name", "organization" ], "type": "object", "properties": { "customAttributes": { "type": "array", "description": "Each item has `name`, `type` (`SINGLE_VALUE`, `SINGLE_SELECT` or `MULTI_SELECT`), `value` and, for the select types, `options`.", "example": [ { "name": "Product", "type": "SINGLE_VALUE", "value": "Mobile app" } ], "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "domain": { "type": "string", "description": "Domain name; created in the organization when it doesn't exist.", "example": "Software" }, "languages": { "type": "array", "description": "At least two languages.", "example": [ "en_us", "de_de" ], "items": { "type": "string", "example": "en_us" } }, "name": { "type": "string", "example": "Product terminology" }, "note": { "type": "string", "example": "Approved terms for the product UI." }, "orgUnits": { "type": "array", "description": "Org units the caller must have access to.", "items": { "$ref": "#/components/schemas/GlossaryOrgUnitRef" } }, "organization": { "$ref": "#/components/schemas/GlossaryOrganizationRef" }, "subDomain": { "type": "string", "description": "Subdomain name; created in the organization when it doesn't exist.", "example": "User interface" } } }, "GlossaryDto": { "type": "object", "properties": { "allLanguages": { "type": "array", "items": { "type": "string" } }, "bwGlossaryId": { "type": "integer", "format": "int64" }, "createdBy": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/UserDto" } ] }, "creationDate": { "type": "integer", "format": "int64" }, "customAttributes": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "customFields": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "domain": { "type": "string" }, "enabledTerminologyFlow": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "languages": { "type": "array", "items": { "type": "string" } }, "lastImportJob": { "$ref": "#/components/schemas/GlossaryJobDto" }, "name": { "type": "string" }, "note": { "type": "string" }, "orgUnits": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationalUnitDto" } }, "organization": { "$ref": "#/components/schemas/OrganizationDto" }, "requiredTermFields": { "$ref": "#/components/schemas/RequiredTermFields" }, "subDomain": { "type": "string" }, "totalConcepts": { "type": "integer", "format": "int32" }, "uuid": { "type": "string", "format": "uuid" } } }, "GlossaryJobDto": { "type": "object", "properties": { "creationDate": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "failureReason": { "type": "string" }, "fileName": { "type": "string" }, "glossaryId": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int64" }, "jobExecutionId": { "type": "integer", "format": "int64" }, "jobName": { "type": "string" }, "jobType": { "type": "string" }, "processingTime": { "type": "string" }, "skippedTermsCount": { "type": "integer", "format": "int32" }, "startTime": { "type": "integer", "format": "int64" }, "status": { "type": "string" }, "termsCount": { "type": "integer", "format": "int64" } } }, "GlossaryOrgUnitRef": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "example": "b146d2ca-aa95-429f-8860-da62701de326" } } }, "GlossaryOrgUnitSettingsDto": { "type": "object", "properties": { "adaptiveTermInflectionEnabled": { "type": "boolean" }, "glossaryUuid": { "type": "string", "format": "uuid" }, "isDefault": { "type": "boolean" }, "learntTermsDefault": { "type": "boolean" }, "orgUnitName": { "type": "string" }, "orgUnitUuid": { "type": "string", "format": "uuid" }, "uuid": { "type": "string", "format": "uuid" } } }, "GlossaryOrgUnitSettingsParams": { "type": "object", "properties": { "orgUnitUuids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "settings": { "$ref": "#/components/schemas/OrgUnitSettings" } } }, "GlossaryOrganizationRef": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "example": "97b55a5e-9133-464c-937e-a99c8156c23e" } }, "description": "The organization that owns the glossary." }, "GlossaryThinDTO": { "type": "object", "properties": { "allLangs": { "type": "array", "items": { "type": "string" } }, "client": { "$ref": "#/components/schemas/SimpleClientDto" }, "createdBy": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/UserDto" } ] }, "dateCreated": { "type": "integer", "format": "int64" }, "domain": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "isDefault": { "type": "boolean" }, "langs": { "type": "array", "items": { "type": "string" } }, "languagesInfo": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } }, "name": { "type": "string" }, "note": { "type": "string" }, "subDomain": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" } } }, "GlossaryUpdateRequest": { "required": [ "uuid" ], "type": "object", "properties": { "customAttributes": { "type": "array", "description": "Replaces the stored list; omitted removes them all. Each item has `name`, `type` (`SINGLE_VALUE`, `SINGLE_SELECT` or `MULTI_SELECT`), `value` and, for the select types, `options`.", "example": [ { "name": "Product", "type": "SINGLE_VALUE", "value": "Mobile app" } ], "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "domain": { "type": "string", "description": "Domain name. Omitted clears it.", "example": "Software" }, "languages": { "type": "array", "description": "The full list of languages; omitted keeps the stored ones.", "example": [ "en_us", "de_de", "fr_fr" ], "items": { "type": "string", "example": "en_us" } }, "name": { "type": "string", "description": "Omitted or blank keeps the stored name.", "example": "Product terminology" }, "note": { "type": "string", "description": "Omitted keeps the stored note.", "example": "Approved terms for the product UI." }, "subDomain": { "type": "string", "description": "Subdomain name. Omitted clears it.", "example": "User interface" }, "uuid": { "type": "string", "description": "The glossary to update.", "format": "uuid", "example": "bfb645fd-ad81-4f77-8744-0c13782b6243" } } }, "ITotalCost": { "type": "object", "properties": { "grossCost": { "type": "number", "format": "double" }, "netCost": { "type": "number", "format": "double" }, "projectId": { "type": "integer", "format": "int64" }, "totalSavings": { "type": "number", "format": "double" } } }, "IdNameDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "ImportKitRequest": { "required": [ "importType" ], "type": "object", "properties": { "applyStatusFromFile": { "type": "boolean", "description": "XLIFF only: apply each unit's `bwx:locked`, `bwx:confirmed` and notes to its segment (lock and unlock, confirm and unconfirm, notes added as comments). A unit without `bwx:confirmed` follows the confirmation flags. Locks change only with the Lock Segments permission on the work unit.", "default": false }, "confirmAllNotEmpty": { "type": "boolean", "description": "Confirm every segment with a non-empty target, changed or not.", "default": false }, "confirmOnlyChangeSegments": { "type": "boolean", "description": "Write only the segments whose text changed, and confirm them.", "default": false }, "importType": { "type": "string", "description": "Format of the imported file.", "enum": [ "XLIFF", "XLSX" ] }, "updateTm": { "type": "boolean", "description": "Add the confirmed segments this import writes to the project's translation memories.", "default": true } } }, "ImportStatusRequest": { "required": [ "importType" ], "type": "object", "properties": { "importType": { "type": "string", "description": "Format of the import to report on.", "enum": [ "XLIFF", "XLSX" ] } } }, "InstallmentDto": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "creationDate": { "type": "integer", "format": "int64" }, "currency": { "type": "string" }, "discount": { "type": "number", "format": "double" }, "dueDate": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int64" }, "installmentPayments": { "type": "array", "items": { "$ref": "#/components/schemas/InstallmentPaymentDto" } }, "installmentSeq": { "type": "integer", "format": "int64" }, "interest": { "type": "number", "format": "double" }, "lastUpdateTimestamp": { "type": "integer", "format": "int64" }, "paidAmount": { "type": "number", "format": "double" }, "paidBy": { "type": "integer", "format": "int64" }, "status": { "type": "string", "enum": [ "INVOICED", "INVOICED_NFE", "INVOICED_NFE_ERROR", "PARTIALLY_INVOICED", "PARTIALLY_PAID", "PAID", "VOID", "CANCELLED" ] }, "updatedBy": { "type": "integer", "format": "int64", "readOnly": true } } }, "InstallmentPaymentDto": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "currency": { "type": "string" }, "discount": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int64" }, "interest": { "type": "number", "format": "double" }, "paidBy": { "type": "integer", "format": "int64" }, "paymentDate": { "type": "integer", "format": "int64" } } }, "Issue": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" } } }, "IssueTotal": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "type": { "type": "string" } } }, "LangPairCostDto": { "type": "object", "properties": { "chargeBy": { "type": "string", "enum": [ "WORD", "HOUR" ] }, "minimumFee": { "type": "number" }, "sourceLang": { "type": "string" }, "targetLang": { "type": "string" }, "totalCost": { "type": "number" }, "words": { "type": "number", "format": "double" }, "wordsPerHour": { "type": "integer", "format": "int32" } } }, "Language": { "required": [ "code", "name" ], "type": "object", "properties": { "code": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "LanguagePair": { "required": [ "source", "target" ], "type": "object", "properties": { "pair": { "type": "string" }, "source": { "type": "string" }, "target": { "type": "string" }, "userRatesByPair": { "type": "array", "deprecated": true, "items": { "type": "object", "additionalProperties": { "type": "object", "deprecated": true }, "deprecated": true } } } }, "LogfileDownloadFile": { "type": "object", "properties": { "downloadUrl": { "type": "string" }, "progress": { "type": "number", "format": "double" }, "requestUuid": { "type": "string", "format": "uuid" }, "skippedTargetLocales": { "type": "array", "items": { "$ref": "#/components/schemas/SkippedTargetLocale" } }, "status": { "type": "string" } } }, "MatchCostDto": { "type": "object", "properties": { "costPerItem": { "type": "number", "format": "double" }, "displayOrder": { "type": "integer", "format": "int32" }, "isManualCost": { "type": "boolean" }, "matchType": { "type": "string" }, "totalCost": { "type": "number", "format": "double" }, "uuid": { "type": "string", "format": "uuid" }, "words": { "type": "number", "format": "double" } } }, "MatchRangeDto": { "type": "object", "properties": { "end": { "type": "number", "format": "double" }, "matchStartOrZero": { "type": "number", "format": "double" }, "start": { "type": "number", "format": "double" }, "type": { "type": "string", "enum": [ "TM", "MATCH101", "REPETITION", "CONFIDENCE_CONFIRMED" ] }, "uuid": { "type": "string", "format": "uuid" } } }, "MtSettingsDto": { "type": "object", "properties": { "accountUuid": { "type": "string", "readOnly": true }, "active": { "type": "boolean" }, "credentials": { "type": "string" }, "isCredentialValid": { "type": "boolean" }, "name": { "type": "string" }, "provider": { "type": "string" }, "reason": { "type": "string" }, "reasonCode": { "type": "string" }, "sourceLanguage": { "type": "string" }, "targetLanguage": { "type": "string" }, "text": { "type": "string" }, "translated": { "type": "string" }, "type": { "type": "string", "enum": [ "DEFAULT", "ACCOUNT" ] }, "updateAt": { "type": "integer", "description": "Same as `updatedAt`. The misspelled name stays until the next API version.", "format": "int64", "deprecated": true }, "updatedAt": { "type": "integer", "description": "When the settings were last saved (Unix time in milliseconds).", "format": "int64", "readOnly": true }, "uuid": { "type": "string" } } }, "MultiConfigTmSettingsDto": { "type": "object", "properties": { "atlasTmId": { "type": "integer", "format": "int64" }, "fixTags": { "type": "boolean" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "penalty": { "type": "number", "format": "double" }, "read": { "type": "boolean" }, "threshold": { "type": "number", "format": "double" }, "write": { "type": "boolean" } } }, "MultiProjectConfigDto": { "type": "object", "properties": { "configOrgUnits": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigOrgUnitsDto" } }, "name": { "type": "string" }, "orgUnits": { "type": "array", "items": { "type": "string" } }, "restrictLangPerOrgUnit": { "type": "boolean" }, "sourceLanguage": { "type": "string" }, "targetLanguages": { "type": "array", "items": { "type": "string" } }, "uuid": { "type": "string", "format": "uuid" } } }, "MultiProjectCreationParams": { "type": "object", "properties": { "baseProjectUuid": { "type": "string", "format": "uuid" }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigOrgUnitsDto" } }, "reference": { "type": "string" }, "sourceLanguage": { "type": "string" } } }, "NetRateSettingsDto": { "type": "object", "properties": { "account": { "$ref": "#/components/schemas/AccountDto" }, "default": { "type": "boolean" }, "defaultGlobal": { "type": "boolean" }, "id": { "type": "integer", "format": "int64" }, "isFromPriceList": { "type": "boolean" }, "matchRanges": { "type": "array", "items": { "$ref": "#/components/schemas/MatchRangeDto" } }, "name": { "type": "string" }, "netRateWorkflows": { "type": "array", "items": { "$ref": "#/components/schemas/NetRateWorkflowDto" } }, "uuid": { "type": "string", "format": "uuid" } } }, "NetRateWorkflowDto": { "type": "object", "properties": { "netRateSettingsUUID": { "type": "string", "format": "uuid" }, "netRateWorkflowItems": { "type": "array", "items": { "$ref": "#/components/schemas/NetRateWorkflowItemDto" } }, "uuid": { "type": "string", "format": "uuid" }, "workflow": { "type": "string" } } }, "NetRateWorkflowItemDto": { "type": "object", "properties": { "mtFactor": { "type": "number", "format": "double" }, "netRateWorkflowUUID": { "type": "string", "format": "uuid" }, "ntFactor": { "type": "number", "format": "double" }, "range": { "$ref": "#/components/schemas/MatchRangeDto" }, "rangeStartOrZero": { "type": "number", "format": "double" }, "tmFactor": { "type": "number", "format": "double" }, "uuid": { "type": "string", "format": "uuid" } } }, "Option": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" } } }, "OrgUnitCreate": { "type": "object", "properties": { "addLoggedUserToClient": { "type": "boolean" }, "contactPersonUuid": { "type": "string", "format": "uuid" }, "country": { "type": "string" }, "currency": { "type": "string" }, "name": { "type": "string" }, "organizationUuid": { "type": "string", "format": "uuid" }, "timezone": { "type": "string" } } }, "OrgUnitSettings": { "type": "object", "properties": { "adaptiveTermInflectionEnabled": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "learntTermsDefault": { "type": "boolean" } } }, "OrganizationDto": { "type": "object", "properties": { "accountUuid": { "type": "string", "format": "uuid", "readOnly": true }, "country": { "type": "string" }, "customFields": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "id": { "type": "integer", "format": "int64" }, "logo": { "type": "string" }, "mtSettings": { "$ref": "#/components/schemas/MtSettingsDto" }, "name": { "type": "string" }, "orgUnitDrafts": { "type": "array", "items": { "$ref": "#/components/schemas/OrgUnitCreate" } }, "uuid": { "type": "string", "format": "uuid" } } }, "OrganizationalUnitDto": { "type": "object", "properties": { "costsLogfileType": { "type": "string", "enum": [ "PRE_ANALYSE", "POST_ANALYSE" ] }, "country": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "localeRegion": { "type": "object", "additionalProperties": { "type": "string" } }, "name": { "type": "string" }, "organization": { "$ref": "#/components/schemas/OrganizationDto" }, "projectCountWordsFrom": { "type": "string", "enum": [ "SOURCE", "TARGET" ] }, "sourceLanguage": { "type": "string" }, "targetLanguages": { "type": "array", "items": { "type": "string" } }, "uuid": { "type": "string", "format": "uuid" } } }, "OverwriteSettings": { "type": "object", "properties": { "rateType": { "type": "string", "enum": [ "PERCENT", "FIXED_RATE" ] } } }, "PageConceptEntryDtoV3": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/ConceptEntryDtoV3" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "type": "integer", "format": "int32" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PageCustomFieldDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldDto" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "type": "integer", "format": "int32" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PageFatClientDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/FatClientDto" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "type": "integer", "format": "int32" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PageGlossaryDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/GlossaryDto" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "type": "integer", "format": "int32" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PageMultiProjectConfigDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/MultiProjectConfigDto" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "type": "integer", "format": "int32" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PageOrganizationDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationDto" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "type": "integer", "format": "int32" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PagePayableDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/PayableDto" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "type": "integer", "format": "int32" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PagePriceListDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/PriceListDto" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "type": "integer", "format": "int32" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PageProjectDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "type": "integer", "format": "int32" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PageProjectMessageDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectMessageDto" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "type": "integer", "format": "int32" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PageReceivableDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/ReceivableDto" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "type": "integer", "format": "int32" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PageSegmentCommentDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentCommentDto" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "type": "integer", "format": "int32" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PageTMDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/TMDto" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "type": "integer", "format": "int32" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PageTaskDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/TaskDto" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "type": "integer", "format": "int32" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PageTermEntryOnSegment": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/TermEntryOnSegment" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "type": "integer", "format": "int32" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PageTranslationKitJobDownloadLinkDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/TranslationKitJobDownloadLinkDto" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "type": "integer", "format": "int32" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PageUserDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/UserDto" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "type": "integer", "format": "int32" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PageWorkUnitDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/WorkUnitDto" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "type": "integer", "format": "int32" }, "numberOfElements": { "type": "integer", "format": "int32" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "type": "integer", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PageableObject": { "type": "object", "properties": { "offset": { "type": "integer", "format": "int64" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "paged": { "type": "boolean" }, "sort": { "$ref": "#/components/schemas/SortObject" }, "unpaged": { "type": "boolean" } } }, "PagedResponseGenesisAnalysisDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/GenesisAnalysisDto" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "offset": { "type": "integer", "format": "int64" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PagedResponseProjectSegmentDto": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectSegmentDto" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "offset": { "type": "integer", "format": "int64" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "PagedResponseTranslationUnitMatch": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/TranslationUnitMatch" } }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "offset": { "type": "integer", "format": "int64" }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalElements": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" } } }, "Parameter": { "type": "object", "properties": { "dependsOn": { "type": "string" }, "description": { "type": "string" }, "modeParam": { "type": "string" }, "multiple": { "type": "boolean" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/Option" } }, "taggable": { "type": "boolean" }, "title": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } } }, "ParserParameters": { "type": "object", "properties": { "extensionsMap": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "files": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FileType" } }, "terms": { "$ref": "#/components/schemas/TermsParams" } } }, "PayableBatchItemDto": { "type": "object", "properties": { "currency": { "type": "string" }, "dueDate": { "type": "string" }, "invoicedAmount": { "type": "number", "format": "double" }, "notes": { "type": "string" }, "vendorEmail": { "type": "string" } } }, "PayableBatchRequestDto": { "type": "object", "properties": { "payables": { "type": "array", "items": { "$ref": "#/components/schemas/PayableBatchItemDto" } }, "serviceProviderAccountUuid": { "type": "string", "format": "uuid" }, "timezone": { "type": "string" } } }, "PayableBatchResultDto": { "type": "object", "properties": { "created": { "type": "array", "items": { "$ref": "#/components/schemas/CreatedPayable" } }, "errorCount": { "type": "integer", "format": "int32" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "successCount": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int32" } } }, "PayableDto": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "amountBeforeTaxes": { "type": "number", "format": "double" }, "creationDate": { "type": "integer", "format": "int64" }, "currency": { "type": "string" }, "customFields": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "dueDate": { "type": "integer", "format": "int64" }, "errorMessage": { "type": "string" }, "exchangeRateByCurrency": { "type": "object", "additionalProperties": { "type": "number", "format": "double" } }, "id": { "type": "integer", "format": "int64" }, "lastUpdate": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "notes": { "type": "string" }, "oldTasksInvoiced": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "origin": { "type": "string" }, "overallProfitability": { "type": "number" }, "paidBy": { "type": "integer", "format": "int64" }, "payableFiles": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "paymentDate": { "type": "integer", "format": "int64" }, "payoutMethod": { "type": "string" }, "serviceProviderAccountName": { "type": "string" }, "serviceProviderAccountUuid": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/TaskDto" } }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/PayableTaxDto" } }, "taxesAmount": { "type": "number", "format": "double" }, "totalAllocations": { "type": "integer", "format": "int32" }, "totalTasks": { "type": "integer", "format": "int32" }, "updatedBy": { "type": "integer", "format": "int64", "readOnly": true }, "uuid": { "type": "string", "format": "uuid" }, "vendor": { "$ref": "#/components/schemas/UserDto" }, "vendorMonthlyAverage": { "type": "number", "format": "double" }, "xeroId": { "type": "string" } } }, "PayableImportResultDto": { "type": "object", "properties": { "errorCount": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "status": { "type": "string" }, "successCount": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int32" } } }, "PayableRequest": { "type": "object", "properties": { "accountUuid": { "type": "string", "format": "uuid", "readOnly": true }, "currencyRates": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyRateDto" } }, "dueDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "startDate": { "type": "integer", "format": "int64" }, "vendorUuidList": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "PayableTaxDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "tax": { "$ref": "#/components/schemas/TaxDto" }, "total": { "type": "number", "format": "double" } } }, "PayablesSummaryDto": { "type": "object", "properties": { "separationByCurrency": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CurrencySummaryDto" } }, "separationByPaymentMethod": { "type": "object", "additionalProperties": { "type": "number" } }, "total": { "type": "number" }, "totalCurrency": { "type": "string" } } }, "PaymentItem": { "type": "object", "properties": { "amount": { "type": "number" }, "confirmationDate": { "type": "integer", "format": "int64" }, "confirmedBy": { "type": "string", "format": "uuid" }, "costType": { "type": "string", "enum": [ "FIXED", "PERCENTAGE" ] }, "createdOnDelivery": { "type": "boolean" }, "creationDate": { "type": "integer", "format": "int64" }, "rate": { "type": "number" }, "rejectDate": { "type": "integer", "format": "int64" }, "rejectReason": { "type": "string" }, "rejectReasonBy": { "type": "string", "format": "uuid" }, "source": { "type": "string", "enum": [ "API", "UI" ] }, "taskId": { "type": "string", "format": "uuid" }, "total": { "type": "number" }, "unit": { "type": "string" }, "workUnitFileName": { "type": "string" }, "workUnitId": { "type": "string", "format": "uuid" } } }, "PaymentItemDto": { "type": "object", "properties": { "amount": { "type": "number" }, "createdOnDelivery": { "type": "boolean" }, "creationDate": { "type": "integer", "format": "int64" }, "rate": { "type": "number" }, "source": { "type": "string", "enum": [ "API", "UI" ] }, "taskId": { "type": "string", "format": "uuid" }, "total": { "type": "number" }, "unit": { "type": "string" } } }, "PermissionGrantDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "code": { "type": "string" }, "description": { "type": "string" }, "grantSources": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionGrantSource" } }, "granteeIdentifier": { "type": "string" }, "granteeUuid": { "type": "string", "format": "uuid" }, "inherited": { "type": "boolean" }, "module": { "type": "string" }, "name": { "type": "string" }, "permissionUuid": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "USER", "GROUP", "CLIENT", "ORGANIZATION", "ACCOUNT", "GRANTEE" ] } } }, "PermissionGrantSource": { "type": "object", "properties": { "grantType": { "type": "string", "enum": [ "USER", "GROUP", "CLIENT", "ORGANIZATION", "ACCOUNT", "GRANTEE" ] }, "granteeIdentifier": { "type": "string" }, "granteeUuid": { "type": "string", "format": "uuid" }, "role": { "type": "string", "enum": [ "USER", "ADMIN", "SYSADMIN", "ACCOUNT_ADMIN", "CLIENT", "CLIENT_ADMIN", "CLIENT_AGENCY", "CLIENT_REQUESTER", "CLIENT_PROJECT_MANAGER", "PROJECT_MANAGER", "ACCOUNTING", "REVIEWER", "INTERNAL", "PAYMENTS", "QUALITY_ISO", "QUALITY_AUDITOR", "VENDOR_ADMIN", "SALES", "WIKI_MODERATOR", "WIKI_READONLY", "WIKI_USER", "WIKI_ACTIONS", "WIKI_ADMIN", "REF_ADMIN", "REF_USER", "REF_READONLY", "VENDOR", "TERM_TRANSLATOR", "TERM_REVIEWER", "TERM_ADMIN", "TERM_CONTENT_CREATOR", "TERM_LANGUAGE_MANAGER", "TERM_UPDATE_REQUESTER", "TERM_READ_ONLY", "TERMINOLOGY_STANDALONE_USER", "TERMINOLOGY_STANDALONE_OWNER" ] }, "sourceType": { "type": "string", "enum": [ "PERMISSION_GRANT", "USER_ROLE" ] } } }, "PermissionGroup": { "type": "object", "properties": { "accountUuid": { "type": "string", "format": "uuid", "readOnly": true }, "code": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" } } }, "PermissionGroupDto": { "type": "object", "properties": { "accountUuid": { "type": "string", "format": "uuid", "readOnly": true }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" } } }, "PortalTranslateRequest": { "required": [ "originalContent", "sourceLocale", "targetLocale" ], "type": "object", "properties": { "contextPrioritization": { "type": "string", "description": "Which context wins when glossaries and translation memories disagree. Defaults to the account's setting." }, "instructions": { "$ref": "#/components/schemas/AIInstructions" }, "orgUnitUuid": { "type": "string", "description": "The org unit whose translation settings (glossaries, translation memories) apply. Defaults to your account's.", "example": "6b1f0c2e-8d4a-4f3b-9c5e-2a7d9e1b4c60" }, "originalContent": { "type": "string", "description": "The text to translate.", "example": "Our support team reviews the release notes before Friday." }, "sourceLocale": { "type": "string", "description": "Locale of `originalContent`.", "example": "en_us" }, "targetLocale": { "type": "string", "description": "Locale to translate into.", "example": "pt_br" } } }, "PortalTranslationRequestDto": { "type": "object", "properties": { "createdAt": { "type": "integer", "format": "int64", "readOnly": true }, "error": { "type": "string" }, "finishedAt": { "type": "integer", "format": "int64" }, "requestUuid": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "STARTED", "FINISHED", "FAILED" ] }, "translation": { "type": "string" } } }, "PriceDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "minimumFee": { "type": "number" }, "source": { "type": "string" }, "target": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "value": { "type": "number" }, "valuePerHour": { "type": "number" } } }, "PriceFactorDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "isDefault": { "type": "boolean" }, "isValidMatch": { "type": "boolean" }, "langPairFactor": { "type": "number" }, "langPairPrice": { "type": "number" }, "languageFactor": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "number" } } }, "overwriteSettings": { "$ref": "#/components/schemas/OverwriteSettings" }, "type": { "$ref": "#/components/schemas/PriceTypeDto" }, "uuid": { "type": "string", "format": "uuid" }, "value": { "type": "number" } } }, "PriceList": { "required": [ "name" ], "type": "object", "properties": { "accountUuid": { "type": "string", "format": "uuid", "readOnly": true }, "chargeBy": { "type": "string", "enum": [ "WORD", "HOUR" ] }, "currency": { "type": "string" }, "defaultMinimumFeeByLanguagePair": { "type": "number" }, "defaultPriceList": { "type": "boolean" }, "defaultPricePerHour": { "type": "number" }, "defaultPricePerItem": { "type": "number" }, "fallbackPriceList": { "type": "boolean" }, "hiddenFuzzies": { "type": "boolean" }, "id": { "type": "integer", "format": "int64" }, "isAccountDefault": { "type": "boolean" }, "maxPriceOrDefault": { "type": "number" }, "memo": { "type": "string" }, "minFeeType": { "type": "string", "enum": [ "PROJECT", "LANGUAGE_PAIR", "FIXED" ] }, "minimumFeeByProject": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "boolean" }, "uuid": { "type": "string", "format": "uuid" }, "wordsPerHour": { "type": "integer", "format": "int64" } } }, "PriceListDto": { "type": "object", "properties": { "accountUUID": { "type": "string", "format": "uuid" }, "chargeBy": { "type": "string", "enum": [ "WORD", "HOUR" ] }, "currency": { "type": "string" }, "defaultMinimumFeeByLanguagePair": { "type": "number" }, "defaultPriceList": { "type": "boolean" }, "defaultPricePerHour": { "type": "number" }, "defaultPricePerItem": { "type": "number" }, "hiddenFuzzies": { "type": "boolean" }, "id": { "type": "integer", "format": "int64" }, "infoFields": { "$ref": "#/components/schemas/PriceList" }, "isAccountDefault": { "type": "boolean" }, "memo": { "type": "string" }, "minFeeType": { "type": "string", "enum": [ "PROJECT", "LANGUAGE_PAIR", "FIXED" ] }, "minimumFeeByProject": { "type": "number" }, "name": { "type": "string" }, "priceFactors": { "type": "array", "items": { "$ref": "#/components/schemas/PriceFactorDto" } }, "prices": { "type": "array", "items": { "$ref": "#/components/schemas/PriceDto" } }, "pricesAndPriceFactors": { "$ref": "#/components/schemas/PriceList" }, "status": { "type": "boolean" }, "uuid": { "type": "string", "format": "uuid" }, "wordsPerHour": { "type": "integer", "format": "int64" } } }, "PriceTypeDto": { "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "matches": { "type": "array", "items": { "$ref": "#/components/schemas/PriceTypeMatchRange" } }, "priceUnit": { "type": "string", "enum": [ "WORD", "PAGE", "MINUTE", "HOUR", "DAY", "FEE" ] }, "rateType": { "type": "string", "enum": [ "PERCENT", "FIXED_RATE" ] }, "type": { "type": "string", "enum": [ "TRANSLATIONS", "FILE_ENGINEERING", "QA", "NONE" ] }, "uuid": { "type": "string", "format": "uuid" } } }, "PriceTypeMatchRange": { "type": "object", "properties": { "matchRangeEnd": { "type": "number", "format": "double" }, "matchRangeStart": { "type": "number", "format": "double" } } }, "ProfitabilityMargin": { "type": "object", "properties": { "pmRatesDetails": { "type": "array", "items": { "$ref": "#/components/schemas/TimesheetPayableDetail" } }, "profitability": { "type": "number" }, "profitabilityWithPmRates": { "type": "number" }, "totalCost": { "type": "number" }, "totalCostTasks": { "type": "number" }, "totalCostWithPmRates": { "type": "number" } } }, "ProjectDeliveryFilters": { "type": "object", "properties": { "configPath": { "type": "string" }, "filenames": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "filepaths": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "languages": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "resourceUuids": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } }, "status": { "type": "string", "enum": [ "NEW", "CREATED", "IN_PROGRESS", "COMPLETED", "APPROVED", "REJECTED", "DELIVERED", "CANCELLED", "FAILED" ] }, "workflow": { "type": "string" } } }, "ProjectDto": { "type": "object", "properties": { "accountUuid": { "type": "string", "format": "uuid", "readOnly": true }, "alternativeTranslationsEnabled": { "type": "boolean" }, "approvalDate": { "type": "integer", "format": "int64" }, "assignee": { "$ref": "#/components/schemas/UserDto" }, "automationEnabled": { "type": "boolean" }, "automationStatus": { "type": "string", "enum": [ "RUNNING", "SKIPPED", "FINISHED", "FAILED" ] }, "automationStatusMessage": { "type": "string" }, "autopilotEnabled": { "type": "boolean" }, "ciTag": { "type": "string" }, "client": { "$ref": "#/components/schemas/OrganizationalUnitDto" }, "confidenceMatchOverRepetitionEnabled": { "type": "boolean" }, "confirmedSegments": { "type": "integer", "format": "int32" }, "contact": { "$ref": "#/components/schemas/UserDto" }, "contentMode": { "type": "string", "enum": [ "FILES", "KEY_VALUE" ] }, "continuousMode": { "type": "string", "enum": [ "SEALED", "LEGACY" ] }, "costCalculationMode": { "type": "string", "enum": [ "AUTOMATIC", "MANUAL" ] }, "costs": { "type": "array", "items": { "$ref": "#/components/schemas/CostDto" } }, "costsCalculatedAt": { "type": "integer", "format": "int64" }, "costsLogfileId": { "type": "string", "format": "uuid" }, "costsLogfileName": { "type": "string" }, "costsRequestedAt": { "type": "integer", "format": "int64" }, "costsStatus": { "type": "string", "enum": [ "CREATING", "UPDATING", "COMPLETED", "COMPLETED_WARN", "LOGFILE_ERROR", "INGESTION_ERROR", "ERROR", "NOT_CALCULATED" ] }, "createDate": { "type": "integer", "format": "int64" }, "creator": { "$ref": "#/components/schemas/UserDto" }, "currency": { "type": "string" }, "customFields": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "deliveryDate": { "type": "integer", "format": "int64" }, "dropFiles": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "dueDate": { "type": "integer", "format": "int64" }, "enableTaskFeedback": { "type": "boolean" }, "expirationDate": { "type": "integer", "format": "int64" }, "genesisId": { "type": "string" }, "hasDataTransformation": { "type": "boolean" }, "hasNewUploadFile": { "type": "boolean" }, "id": { "type": "integer", "format": "int64" }, "instructions": { "type": "string" }, "invoiceDate": { "type": "integer", "format": "int64" }, "invoiceInfo": { "type": "string" }, "isContinuous": { "type": "boolean" }, "lastLogfileIdPostUpdate": { "type": "string", "format": "uuid" }, "logfileForTasksPayment": { "type": "string", "format": "uuid" }, "mediaFiles": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectMediaFileDto" } }, "name": { "type": "string" }, "notes": { "type": "string" }, "ntMatchOverRepetitionEnabled": { "type": "boolean" }, "organizationUuid": { "type": "string" }, "organizationalUnit": { "$ref": "#/components/schemas/OrganizationalUnitDto" }, "origin": { "type": "string", "enum": [ "WORK_PACKAGE" ] }, "pdfPreviewFiles": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectPdfPreviewFileDto" } }, "priceList": { "$ref": "#/components/schemas/PriceListDto" }, "progress": { "type": "number", "format": "double" }, "projectGroupId": { "type": "string", "format": "uuid" }, "reference": { "type": "string" }, "referenceFiles": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "reminderThresholdPercentage": { "type": "integer", "format": "int32" }, "requestedDeliveryDate": { "type": "integer", "format": "int64" }, "requirePurchaseOrderEnabled": { "type": "boolean" }, "resources": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectResourceDto" } }, "reviewFiles": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectReviewFileDto" } }, "sourceLocale": { "type": "string" }, "spellCheckerIgnoreWordsEnabled": { "type": "boolean" }, "status": { "type": "string", "enum": [ "DELETED", "CANCELLED", "DRAFT", "PENDING", "APPROVED", "DELIVERED", "INVOICED", "PARTIALLY_INVOICED", "NOT_INVOICED", "CONTINUOUS" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "targetLocales": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "taskPaymentType": { "type": "string", "enum": [ "WORD", "HOUR" ] }, "taskReminderAutomaticEnabled": { "type": "boolean" }, "timezone": { "type": "string" }, "tmMatchOverRepetitionEnabled": { "type": "boolean" }, "totalCost": { "type": "number" }, "totalCostDto": { "$ref": "#/components/schemas/ITotalCost" }, "totalSegments": { "type": "integer", "format": "int32" }, "totalWorkUnits": { "type": "integer", "format": "int64" }, "uuid": { "type": "string", "format": "uuid" }, "workUnits": { "type": "array", "items": { "$ref": "#/components/schemas/WorkUnitDto" } }, "workflows": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowDto" } } } }, "ProjectInfoDto": { "type": "object", "properties": { "accountUuid": { "type": "string", "format": "uuid", "readOnly": true }, "assigneeUUID": { "type": "string", "format": "uuid" }, "automationEnabled": { "type": "boolean" }, "autopilotEnabled": { "type": "boolean" }, "categoryId": { "type": "integer", "format": "int64" }, "ciTag": { "type": "string" }, "clientUUID": { "type": "string", "format": "uuid" }, "confidenceMatchOverRepetitionEnabled": { "type": "boolean" }, "contactUUID": { "type": "string", "format": "uuid" }, "contentMode": { "type": "string", "enum": [ "FILES", "KEY_VALUE" ] }, "costCalculationMode": { "type": "string", "enum": [ "AUTOMATIC", "MANUAL" ] }, "currency": { "type": "string" }, "dueDate": { "type": "integer", "format": "int64" }, "inferDefaultSettings": { "type": "boolean" }, "instructions": { "type": "string" }, "invoiceInfo": { "type": "string" }, "isContinuous": { "type": "boolean" }, "name": { "type": "string" }, "notes": { "type": "string" }, "ntMatchOverRepetitionEnabled": { "type": "boolean" }, "priceListUUID": { "type": "string", "format": "uuid" }, "reference": { "type": "string" }, "sourceLocale": { "type": "string" }, "spellCheckerIgnoreWordsEnabled": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "taskPaymentType": { "type": "string", "enum": [ "WORD", "HOUR" ] }, "timezone": { "type": "string" }, "tmMatchOverRepetitionEnabled": { "type": "boolean" } } }, "ProjectMediaFileDto": { "type": "object", "properties": { "audioCodec": { "type": "string" }, "createDate": { "type": "integer", "format": "int64" }, "createdByEmail": { "type": "string" }, "createdByUser": { "type": "string" }, "hash": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "locale": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "previewStatus": { "type": "string" }, "previewUrl": { "type": "string" }, "projectUuid": { "type": "string", "format": "uuid" }, "signedUrl": { "type": "string" }, "url": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "videoCodec": { "type": "string" }, "workUnitFilename": { "type": "string" } } }, "ProjectMessageCreateDto": { "type": "object", "properties": { "parent": { "type": "string", "format": "uuid" }, "privateMessage": { "type": "boolean" }, "text": { "type": "string" } } }, "ProjectMessageDto": { "type": "object", "properties": { "author": { "type": "string", "format": "uuid" }, "authorName": { "type": "string" }, "creationTimestamp": { "type": "integer", "format": "int64" }, "parent": { "type": "string", "format": "uuid" }, "privateMessage": { "type": "boolean" }, "text": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" } } }, "ProjectPdfPreviewFileDto": { "type": "object", "properties": { "createDate": { "type": "integer", "format": "int64" }, "createdByEmail": { "type": "string" }, "createdByUser": { "type": "string" }, "hash": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "locale": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "projectUuid": { "type": "string", "format": "uuid" }, "url": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" } } }, "ProjectQualitySummaryDto": { "type": "object", "properties": { "confidenceScore": { "type": "number" }, "issuesByType": { "type": "array", "items": { "$ref": "#/components/schemas/IssueTotal" } }, "scoredSegments": { "type": "integer", "format": "int64" }, "smellsByCategory": { "type": "array", "items": { "$ref": "#/components/schemas/SmellCategory" } }, "totalSegments": { "type": "integer", "format": "int64" } } }, "ProjectRequest": { "type": "object", "properties": { "accountUUID": { "type": "string", "format": "uuid" }, "configUUID": { "type": "string", "format": "uuid" }, "contactUUID": { "type": "string", "format": "uuid" }, "orgUnitUUID": { "type": "string", "format": "uuid" }, "productTag": { "type": "string" }, "reference": { "type": "string" }, "skipHashCheck": { "type": "boolean" }, "sourceLanguage": { "type": "string" }, "tags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "targetLanguages": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "type": { "type": "string" }, "workflows": { "type": "array", "items": { "type": "string" } }, "wpExcludePaths": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "wpIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }, "wpPaths": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } }, "ProjectResourceDto": { "type": "object", "properties": { "creation": { "type": "integer", "format": "int64" }, "defaultFilterSettings": { "type": "boolean" }, "hash": { "type": "string" }, "isProcessedSuccessfully": { "type": "boolean" }, "name": { "type": "string" }, "notes": { "type": "string" }, "params": { "$ref": "#/components/schemas/FileParams" }, "parentName": { "type": "string" }, "parentUuid": { "type": "string", "format": "uuid" }, "path": { "type": "string" }, "preSignedUrl": { "type": "string" }, "processingErrorMessage": { "type": "string" }, "projectUuid": { "type": "string", "format": "uuid" }, "segmentationParams": { "type": "object", "additionalProperties": { "type": "object" } }, "sourceLocale": { "type": "string" }, "targetLocales": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string", "enum": [ "FOLDER", "FILE" ] }, "url": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "workflows": { "type": "array", "items": { "type": "string" } }, "zipProcessingTaskId": { "type": "string" } } }, "ProjectReviewFileDto": { "type": "object", "properties": { "annotations": { "type": "string" }, "createDate": { "type": "integer", "format": "int64" }, "createdByEmail": { "type": "string" }, "createdByUser": { "type": "string" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewEvent" } }, "hash": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "locale": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" } } }, "ProjectSegmentDto": { "type": "object", "properties": { "confidenceScore": { "type": "number" }, "id": { "type": "string", "format": "uuid" }, "index": { "type": "integer", "format": "int32" }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/Issue" } }, "locked": { "type": "boolean" }, "smells": { "type": "array", "items": { "$ref": "#/components/schemas/Smell" } }, "source": { "type": "string" }, "status": { "type": "string", "description": "`TRANSLATED` has a translation that is not confirmed yet.", "enum": [ "NOT_TRANSLATED", "TRANSLATED", "CONFIRMED", "REVIEWED" ] }, "stepLevel": { "type": "integer", "format": "int32" }, "target": { "type": "string" }, "workUnitUuid": { "type": "string", "format": "uuid" } } }, "ProjectStatusChangeDto": { "type": "object", "properties": { "calculateCosts": { "type": "boolean" }, "createSeparateOutputFolder": { "type": "boolean" }, "detailedReasons": { "type": "array", "items": { "type": "string" } }, "enableAutoDueDate": { "type": "boolean" }, "force": { "type": "boolean" }, "newStatus": { "type": "string", "enum": [ "DELETED", "CANCELLED", "DRAFT", "PENDING", "APPROVED", "DELIVERED", "INVOICED", "PARTIALLY_INVOICED", "NOT_INVOICED", "CONTINUOUS" ] }, "previousStatus": { "type": "string", "enum": [ "DELETED", "CANCELLED", "DRAFT", "PENDING", "APPROVED", "DELIVERED", "INVOICED", "PARTIALLY_INVOICED", "NOT_INVOICED", "CONTINUOUS" ] }, "projectUuid": { "type": "string", "format": "uuid" }, "reason": { "type": "string" }, "skipBuildTranslatedFile": { "type": "boolean" }, "skipDatabaseUpdate": { "type": "boolean" }, "skipGitHub": { "type": "boolean" }, "timestamp": { "type": "integer", "format": "int64" }, "user": { "$ref": "#/components/schemas/UserDto" }, "userUuid": { "type": "string", "format": "uuid" }, "uuid": { "type": "string", "format": "uuid" }, "writeToDisk": { "type": "boolean" }, "writeToS3": { "type": "boolean" } } }, "ProjectTranslatedFileUrlDto": { "type": "object", "properties": { "fileName": { "type": "string" }, "translatedFileUrl": { "type": "string" }, "workUnitUuid": { "type": "string", "format": "uuid" } } }, "QuoteNotes": { "type": "object", "properties": { "description": { "type": "string" }, "title": { "type": "string" } } }, "RateDetailsDto": { "type": "object", "properties": { "createdAt": { "type": "integer", "format": "int64", "readOnly": true }, "dailyRate": { "type": "number" }, "hourlyRate": { "type": "number" }, "languagePair": { "type": "string" }, "pagesRate": { "type": "number" }, "rateType": { "type": "string" }, "sourceLanguage": { "type": "string" }, "targetLanguage": { "type": "string" }, "updatedAt": { "type": "integer", "format": "int64", "readOnly": true }, "userRateUuid": { "type": "string", "format": "uuid", "readOnly": true }, "uuid": { "type": "string", "description": "Send the uuid of one of the rate's details to update it; leave it out to add a detail.", "format": "uuid" }, "wordRate": { "type": "number" }, "workflowUuid": { "type": "string", "format": "uuid" } } }, "ReceivableDto": { "type": "object", "properties": { "cancelledDate": { "type": "integer", "format": "int64" }, "contact": { "type": "string" }, "contactUser": { "$ref": "#/components/schemas/UserDto" }, "creationDate": { "type": "integer", "format": "int64" }, "currency": { "type": "string" }, "customFields": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "customReceivableByUser": { "type": "boolean" }, "dueDate": { "type": "integer", "format": "int64" }, "equally": { "type": "boolean" }, "firstInstallmentValue": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int64" }, "installments": { "type": "array", "items": { "$ref": "#/components/schemas/InstallmentDto" } }, "intervalBetweenDues": { "type": "integer", "format": "int32" }, "invoiceFirstOnly": { "type": "boolean" }, "manualInvoice": { "type": "boolean" }, "multipleInstallments": { "type": "boolean" }, "netAmount": { "type": "number", "format": "double" }, "nfId": { "type": "number", "format": "double" }, "numInstallments": { "type": "integer", "format": "int32" }, "oldProjectsInvoiced": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "organizationalUnit": { "$ref": "#/components/schemas/OrganizationalUnitDto" }, "paidAmount": { "type": "number", "format": "double" }, "paymentDate": { "type": "integer", "format": "int64" }, "paymentNotesAccount": { "type": "string", "format": "uuid" }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } }, "purchaseOrder": { "type": "string" }, "reference": { "type": "string" }, "status": { "type": "string", "enum": [ "INVOICED", "INVOICED_NFE", "INVOICED_NFE_ERROR", "PARTIALLY_INVOICED", "PARTIALLY_PAID", "PAID", "VOID", "CANCELLED" ] }, "taxAmount": { "type": "number", "format": "double" }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTaxDto" } }, "total": { "type": "number", "format": "double" }, "uuid": { "type": "string", "format": "uuid" }, "xeroId": { "type": "string" } } }, "ReceivablePaidDto": { "type": "object", "properties": { "invoiceUuids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "paymentDate": { "type": "integer", "format": "int64" } } }, "ReceivableProjectRef": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The project's id.", "format": "int64", "example": 12345 } }, "description": "A project of the org unit to invoice, by id." }, "ReceivableTaxRef": { "type": "object", "properties": { "calculationType": { "type": "string", "enum": [ "INCREASE", "DECREASE" ] }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "FIXED", "PERCENTAGE" ] }, "value": { "type": "number" } }, "description": "A tax applied on the projects' total." }, "ReceivableUuidRef": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" } }, "description": "The org unit to bill, or a contact user of that org unit, by uuid." }, "RenameLogfileDto": { "type": "object", "properties": { "name": { "type": "string", "description": "The new name of the logfile. Surrounding spaces are removed; a blank name is refused." } } }, "RepositoryConfig": { "required": [ "baseBranch", "configPath", "name", "owner", "projectTag" ], "type": "object", "properties": { "baseBranch": { "type": "string" }, "configPath": { "type": "string" }, "configUUID": { "type": "string", "format": "uuid", "readOnly": true }, "fileSuffix": { "type": "string" }, "id": { "type": "integer", "description": "Leave it out to create a repository configuration; send the id of one of this GitHub configuration's repository configurations to update it.", "format": "int64" }, "name": { "type": "string" }, "owner": { "type": "string" }, "projectTag": { "type": "string" }, "uuid": { "type": "string", "format": "uuid", "readOnly": true } } }, "RequiredTermFields": { "type": "object", "properties": { "customAttributes": { "type": "array", "items": { "type": "string" } }, "fields": { "type": "array", "items": { "type": "string", "enum": [ "DEFINITION", "USAGE", "NOTE", "PART_OF_SPEECH", "TERM_TYPE", "GENDER" ] } } } }, "ResourceFileParamsDto": { "type": "object", "properties": { "baseResourceUuid": { "type": "string", "format": "uuid" }, "extension": { "type": "string" }, "fileName": { "type": "string" }, "hasUnitDefault": { "type": "boolean" }, "params": { "$ref": "#/components/schemas/FileParams" }, "segmentationParams": { "type": "object", "additionalProperties": { "type": "object" } } } }, "ReviewEvent": { "type": "object", "properties": { "email": { "type": "string" }, "event": { "type": "string" }, "timestamp": { "type": "integer", "format": "int64" }, "user": { "type": "string" } } }, "S3PresignedUrlResponse": { "type": "object", "properties": { "expiryDate": { "type": "string", "description": "A date five days ahead (`yyyy-MM-dd`), kept for compatibility. Not when the URL expires: see `urlExpiresAt`." }, "headers": { "type": "object", "additionalProperties": { "type": "string", "description": "Headers to send with the upload. They are part of the URL's signature." }, "description": "Headers to send with the upload. They are part of the URL's signature." }, "kmsKey": { "type": "string", "description": "Encryption key id: send it in the `x-amz-server-side-encryption-aws-kms-key-id` header of the upload, with `x-amz-server-side-encryption: aws:kms`." }, "url": { "type": "string", "description": "Pre-signed URL to `PUT` the file to. Valid for 60 minutes, until `urlExpiresAt`." }, "urlExpiresAt": { "type": "string", "description": "When the URL stops accepting uploads (ISO-8601 instant, UTC)." } } }, "SegmentCommentAuthor": { "type": "object", "properties": { "name": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" } }, "description": "Who resolved the comment's thread, or null while it is open." }, "SegmentCommentCreateRequest": { "required": [ "text" ], "type": "object", "properties": { "parentId": { "type": "string", "description": "Id of the comment this one answers, in the same segment's thread.", "format": "uuid" }, "text": { "type": "string", "description": "Text of the comment. Mention a user with `[@First Last:]` to notify them." } } }, "SegmentCommentDto": { "type": "object", "properties": { "author": { "$ref": "#/components/schemas/SegmentCommentAuthor" }, "createdAt": { "type": "integer", "description": "When the comment was written (Unix time in milliseconds).", "format": "int64", "readOnly": true }, "fileIndex": { "type": "integer", "description": "Position of the segment in the file. The same in every workflow step of the file.", "format": "int32" }, "id": { "type": "string", "format": "uuid" }, "parentId": { "type": "string", "description": "The comment this one answers, or null for the first comment of a thread.", "format": "uuid" }, "resolvedAt": { "type": "integer", "description": "When the comment's thread was resolved (Unix time in milliseconds), or null while it is open.", "format": "int64" }, "resolvedBy": { "$ref": "#/components/schemas/SegmentCommentAuthor" }, "segmentId": { "type": "string", "description": "The segment of this work unit the comment is on (the `bwx:ts-id` of the bilingual file).", "format": "uuid" }, "text": { "type": "string" } } }, "SegmentDto": { "type": "object", "properties": { "aligned": { "type": "boolean" }, "codedText": { "type": "string" }, "contextKey": { "type": "string" }, "createdAt": { "type": "integer", "format": "int64", "readOnly": true }, "createdBy": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/UserDto" } ] }, "createdByExternalUser": { "type": "string" }, "displayText": { "type": "string" }, "domain": { "type": "string" }, "extraProps": { "type": "object", "additionalProperties": { "type": "string" } }, "filename": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "isSourceSegment": { "type": "boolean" }, "locale": { "type": "string" }, "modifiedAt": { "type": "integer", "format": "int64" }, "modifiedBy": { "$ref": "#/components/schemas/UserDto" }, "modifiedByExternalUser": { "type": "string" }, "nextText": { "type": "string" }, "previousText": { "type": "string" }, "projectName": { "type": "string" }, "reviewed": { "type": "boolean" }, "rtl": { "type": "boolean" }, "spans": { "type": "array", "items": { "$ref": "#/components/schemas/CodeUomSpan" } }, "subDomain": { "type": "string" }, "text": { "type": "string" }, "tmId": { "type": "integer", "format": "int64" }, "tmJobId": { "type": "integer", "format": "int64" }, "translationUnitId": { "type": "integer", "format": "int64" }, "workUnitId": { "type": "string", "format": "uuid" } } }, "SegmentsLockRequest": { "required": [ "locked", "segmentIds" ], "type": "object", "properties": { "locked": { "type": "boolean", "description": "`true` locks the segments, `false` unlocks them." }, "segmentIds": { "type": "array", "description": "Ids of segments of the work unit (the `bwx:ts-id` of the bilingual file), at most 1,000.", "items": { "type": "string", "description": "Ids of segments of the work unit (the `bwx:ts-id` of the bilingual file), at most 1,000.", "format": "uuid" } } } }, "Settings": { "type": "object", "properties": { "codeUomAbbreviationEnabled": { "type": "boolean" }, "updatePropagatedRepetitions": { "type": "boolean" }, "workflows": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowSetup" } } }, "description": "Optional TM behaviour settings." }, "SimpleClientDto": { "type": "object", "properties": { "autopilotEnabled": { "type": "boolean" }, "contactPersonEmailNotifications": { "type": "boolean" }, "continuousPlatformTag": { "type": "string" }, "daysUntilPaymentDue": { "type": "integer", "format": "int64" }, "defaultAtlasCatTool": { "type": "boolean" }, "id": { "type": "integer", "format": "int64" }, "invoiceInfo": { "type": "string" }, "localeRegion": { "type": "object", "additionalProperties": { "type": "string" } }, "name": { "type": "string" }, "projectAutomationEnabled": { "type": "boolean" }, "projectManagerEmailNotifications": { "type": "boolean" }, "showPaymentPolicy": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserDto" } }, "uuid": { "type": "string", "format": "uuid" }, "vendorEmailNotifications": { "type": "boolean" } } }, "SimpleTUDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "tmUuid": { "type": "string", "format": "uuid" } } }, "SimpleTUUpdateData": { "type": "object", "properties": { "locale": { "type": "string" }, "text": { "type": "string" } } }, "SimpleTUUpsertData": { "required": [ "sourceLocale", "sourceText", "targetLocale", "targetText" ], "type": "object", "properties": { "sourceContext": { "$ref": "#/components/schemas/TMContext" }, "sourceLocale": { "type": "string", "example": "en_us" }, "sourceText": { "type": "string", "example": "Hello world" }, "targetLocale": { "type": "string", "example": "fr_fr" }, "targetText": { "type": "string", "example": "Bonjour le monde" } } }, "SimpleTmHitDto": { "type": "object", "properties": { "contextKey": { "type": "string" }, "createdAt": { "type": "integer", "format": "int64", "readOnly": true }, "createdBy": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/UserDto" } ] }, "match": { "type": "number", "format": "double" }, "modifiedAt": { "type": "integer", "format": "int64" }, "modifiedBy": { "$ref": "#/components/schemas/UserDto" }, "nextSourceText": { "type": "string" }, "previousSourceText": { "type": "string" }, "sourceLocale": { "type": "string" }, "sourceSegmentId": { "type": "integer", "format": "int64" }, "sourceText": { "type": "string" }, "targetLocale": { "type": "string" }, "targetSegmentId": { "type": "integer", "format": "int64" }, "targetText": { "type": "string" }, "tmName": { "type": "string" }, "tmUuid": { "type": "string", "format": "uuid" }, "translationUnitId": { "type": "integer", "format": "int64" } } }, "SkippedTargetLocale": { "type": "object", "properties": { "locale": { "type": "string" }, "reason": { "type": "string" } } }, "Smell": { "type": "object", "properties": { "category": { "type": "string" }, "message": { "type": "string" }, "severity": { "type": "string" }, "term": { "type": "string" } } }, "SmellCategory": { "type": "object", "properties": { "bySeverity": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" } }, "category": { "type": "string" }, "total": { "type": "integer", "format": "int64" } } }, "SortObject": { "type": "object", "properties": { "empty": { "type": "boolean" }, "sorted": { "type": "boolean" }, "unsorted": { "type": "boolean" } } }, "StreamingResponseBody": { "type": "object" }, "TMContext": { "type": "object", "properties": { "contextKey": { "type": "string" }, "nextText": { "type": "string" }, "previousText": { "type": "string" }, "type": { "type": "string" } } }, "TMCreateParams": { "type": "object", "properties": { "organization": { "$ref": "#/components/schemas/OrganizationDto" }, "tmMetadata": { "$ref": "#/components/schemas/TMMetadata" } } }, "TMDto": { "type": "object", "properties": { "client": { "$ref": "#/components/schemas/IdNameDto" }, "creationDate": { "type": "integer", "format": "int64" }, "creator": { "$ref": "#/components/schemas/IdNameDto" }, "customFields": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "domain": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "note": { "type": "string" }, "orgUnits": { "type": "array", "items": { "$ref": "#/components/schemas/IdNameDto" } }, "organization": { "$ref": "#/components/schemas/IdNameDto" }, "sourceLocale": { "type": "string" }, "subDomain": { "type": "string" }, "targetLocales": { "type": "array", "items": { "type": "string" } }, "translationUnitCount": { "type": "integer", "format": "int64" }, "uuid": { "type": "string", "format": "uuid" } } }, "TMJobDto": { "type": "object", "properties": { "creationDate": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "failureReason": { "type": "string" }, "fileName": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "jobExecutionId": { "type": "integer", "format": "int64" }, "jobName": { "type": "string" }, "jobType": { "type": "string" }, "processingTime": { "type": "string" }, "progress": { "$ref": "#/components/schemas/TMJobProgressDto" }, "segmentsCount": { "type": "integer", "format": "int64" }, "startTime": { "type": "integer", "format": "int64" }, "status": { "type": "string" }, "tmId": { "type": "integer", "format": "int64" }, "tmUuid": { "type": "string", "format": "uuid" }, "workUnitScoped": { "type": "boolean" } } }, "TMJobProgressDto": { "type": "object", "properties": { "done": { "type": "integer", "format": "int64" }, "phase": { "type": "string" }, "total": { "type": "integer", "format": "int64" }, "translationUnits": { "type": "integer", "format": "int64" }, "unit": { "type": "string" } } }, "TMMetadata": { "type": "object", "properties": { "client": { "$ref": "#/components/schemas/ClientDto" }, "creator": { "$ref": "#/components/schemas/UserDto" }, "customFields": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "domain": { "type": "string" }, "isLarge": { "type": "boolean" }, "name": { "type": "string" }, "note": { "type": "string" }, "organization": { "$ref": "#/components/schemas/OrganizationDto" }, "sourceLocale": { "type": "string" }, "subDomain": { "type": "string" }, "targetLocales": { "type": "array", "items": { "type": "string" } } } }, "TMSettingsDTO": { "type": "object", "properties": { "atlasTmId": { "type": "integer", "format": "int64" }, "fixTags": { "type": "boolean" }, "id": { "type": "string", "format": "uuid" }, "maxHits": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "penalty": { "type": "number", "format": "double" }, "projectUuid": { "type": "string", "format": "uuid" }, "read": { "type": "boolean" }, "settings": { "$ref": "#/components/schemas/Settings" }, "threshold": { "type": "number", "format": "double" }, "tm": { "$ref": "#/components/schemas/TMDto" }, "tmUuid": { "type": "string", "format": "uuid" }, "write": { "type": "boolean" } } }, "TaskDto": { "type": "object", "properties": { "acceptanceDate": { "type": "integer", "format": "int64" }, "assignDate": { "type": "integer", "format": "int64" }, "assignedBy": { "$ref": "#/components/schemas/UserDto" }, "assignee": { "$ref": "#/components/schemas/UserDto" }, "beginIndex": { "type": "integer", "format": "int64" }, "categories": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "client": { "type": "string" }, "createdBy": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/UserDto" } ] }, "creationDate": { "type": "integer", "format": "int64" }, "currency": { "type": "string" }, "customFields": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "dateStatus": { "type": "string" }, "deliveryDate": { "type": "integer", "format": "int64" }, "dependencies": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } }, "dueDate": { "type": "integer", "format": "int64" }, "endIndex": { "type": "integer", "format": "int64" }, "fileName": { "type": "string" }, "files": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "fromSplit": { "type": "boolean" }, "genesisAssignmentId": { "type": "string", "format": "uuid" }, "genesisWorkId": { "type": "string", "format": "uuid" }, "genesisWorkUnitId": { "type": "string", "format": "uuid" }, "hasMismatchTag": { "type": "boolean", "deprecated": true }, "hasTagMismatch": { "type": "boolean" }, "instructions": { "type": "string" }, "minimumScoreRequired": { "type": "number" }, "name": { "type": "string" }, "payableAmount": { "type": "number" }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentItem" } }, "postAnalysisId": { "type": "string", "format": "uuid" }, "previousTaskDueDate": { "type": "integer", "format": "int64" }, "profitability": { "type": "number" }, "project": { "$ref": "#/components/schemas/ProjectDto" }, "receivableAmount": { "type": "number" }, "referenceFiles": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "scheduledDate": { "type": "integer", "format": "int64" }, "sequence": { "type": "integer", "format": "int32" }, "splitSequence": { "type": "integer", "format": "int32" }, "status": { "type": "string", "enum": [ "CANCELLED", "PENDING", "PENDING_ACCEPTANCE", "PENDING_CONFIRMATION", "SCHEDULED", "EXPIRED", "ASSIGNED", "DELIVERED", "INVOICED", "PAID", "NOT_INVOICED", "SKIPPED" ] }, "taskReminderEnabled": { "type": "boolean" }, "uuid": { "type": "string", "format": "uuid" }, "workPackageDestAccountName": { "type": "string" }, "workPackageUuid": { "type": "string", "format": "uuid" }, "workUnit": { "$ref": "#/components/schemas/WorkUnitDto" } } }, "TaskPaymentUpdateResponseDto": { "type": "object", "properties": { "assignee": { "$ref": "#/components/schemas/UserDto" }, "currency": { "type": "string" }, "payableAmount": { "type": "number" }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentItemDto" } }, "project": { "$ref": "#/components/schemas/ProjectDto" }, "status": { "type": "string", "enum": [ "CANCELLED", "PENDING", "PENDING_ACCEPTANCE", "PENDING_CONFIRMATION", "SCHEDULED", "EXPIRED", "ASSIGNED", "DELIVERED", "INVOICED", "PAID", "NOT_INVOICED", "SKIPPED" ] }, "uuid": { "type": "string", "format": "uuid" }, "workUnit": { "$ref": "#/components/schemas/WorkUnitDto" } } }, "TaskStatusUpdateDto": { "type": "object", "properties": { "effectiveHasTagMismatch": { "type": "boolean" }, "hasMismatchTag": { "type": "boolean", "deprecated": true }, "hasTagMismatch": { "type": "boolean" }, "status": { "type": "string", "enum": [ "CANCELLED", "PENDING", "PENDING_ACCEPTANCE", "PENDING_CONFIRMATION", "SCHEDULED", "EXPIRED", "ASSIGNED", "DELIVERED", "INVOICED", "PAID", "NOT_INVOICED", "SKIPPED" ] } } }, "TaskStatusUpdateResponseDto": { "type": "object", "properties": { "assignee": { "$ref": "#/components/schemas/UserDto" }, "hasTagMismatch": { "type": "boolean" }, "project": { "$ref": "#/components/schemas/ProjectDto" }, "status": { "type": "string", "enum": [ "CANCELLED", "PENDING", "PENDING_ACCEPTANCE", "PENDING_CONFIRMATION", "SCHEDULED", "EXPIRED", "ASSIGNED", "DELIVERED", "INVOICED", "PAID", "NOT_INVOICED", "SKIPPED" ] }, "uuid": { "type": "string", "format": "uuid" }, "workUnit": { "$ref": "#/components/schemas/WorkUnitDto" } } }, "TaxDto": { "type": "object", "properties": { "base": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "TermCreateRequest": { "required": [ "glossaryUuid", "language", "status", "text" ], "type": "object", "properties": { "caseSensitive": { "type": "boolean", "example": false }, "conceptUuid": { "type": "string", "description": "The concept the term belongs to.", "format": "uuid", "example": "e776b275-7910-41e5-acd2-813ff3cd8340" }, "definition": { "type": "string", "description": "Definition of the concept the term belongs to.", "example": "Short text that describes a new version of the product." }, "dnt": { "type": "boolean", "description": "Do not translate.", "example": false }, "exactMatch": { "type": "boolean", "example": false }, "forbidden": { "type": "boolean", "example": false }, "gender": { "type": "string", "example": "Neutral", "enum": [ "Masculine", "Feminine", "Neutral", "Undefined" ] }, "glossaryCustomAttributes": { "type": "array", "description": "Values of the glossary's custom attributes. Each item has `name`, `type` and `value`.", "example": [ { "name": "Product", "type": "SINGLE_VALUE", "value": "Mobile app" } ], "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "glossaryUuid": { "type": "string", "format": "uuid", "example": "bfb645fd-ad81-4f77-8744-0c13782b6243" }, "internal": { "type": "boolean", "example": false }, "language": { "type": "string", "description": "One of the glossary's languages.", "example": "en_us" }, "note": { "type": "string", "example": "Reviewed by the documentation team." }, "part": { "type": "string", "example": "Noun", "enum": [ "Noun", "Pronoun", "Adjective", "Determiner", "Verb", "Adverb", "Preposition", "Conjunction", "Interjection", "Acronym", "Other", "Proper Noun", "Undefined" ] }, "rtl": { "type": "boolean", "description": "Right-to-left text.", "example": false }, "status": { "type": "string", "description": "Must be `Approved` on create.", "example": "Approved", "enum": [ "Under_Review", "Approved", "Published", "Preferred", "Deprecated" ] }, "termType": { "type": "string", "example": "Full", "enum": [ "Full", "Acronym" ] }, "text": { "type": "string", "example": "release note" }, "usage": { "type": "string", "example": "Use in changelogs and update notices." }, "writable": { "type": "boolean", "example": true } } }, "TermDTO": { "type": "object", "properties": { "caseSensitive": { "type": "boolean" }, "commentsAboutReview": { "type": "string" }, "concept": { "$ref": "#/components/schemas/ConceptDTO" }, "createdAt": { "type": "integer", "format": "int64", "readOnly": true }, "definition": { "type": "string" }, "dnt": { "type": "boolean" }, "exactMatch": { "type": "boolean" }, "forbidden": { "type": "boolean" }, "gender": { "type": "string", "enum": [ "Masculine", "Feminine", "Neutral", "Undefined" ] }, "glossary": { "$ref": "#/components/schemas/GlossaryThinDTO" }, "id": { "type": "integer", "format": "int64" }, "internal": { "type": "boolean" }, "isRequestedReview": { "type": "boolean" }, "language": { "type": "string" }, "lastModifiedAt": { "type": "integer", "format": "int64" }, "legal": { "type": "boolean" }, "note": { "type": "string" }, "part": { "type": "string", "enum": [ "Noun", "Pronoun", "Adjective", "Determiner", "Verb", "Adverb", "Preposition", "Conjunction", "Interjection", "Acronym", "Other", "Proper Noun", "Undefined" ] }, "requestReviewAt": { "type": "integer", "format": "int64" }, "requestReviewBy": { "type": "string" }, "rtl": { "type": "boolean" }, "status": { "type": "string", "enum": [ "Under_Review", "Approved", "Published", "Preferred", "Deprecated" ] }, "termArbitrationStatus": { "type": "string", "enum": [ "REQUESTED", "IN_PROGRESS", "CLOSED" ] }, "termType": { "type": "string", "enum": [ "Full", "Acronym" ] }, "termsLinked": { "type": "array", "items": { "$ref": "#/components/schemas/TermLinkedDTO" } }, "text": { "type": "string" }, "usage": { "type": "string" }, "writable": { "type": "boolean" } } }, "TermEntryDto": { "type": "object", "properties": { "caseSensitive": { "type": "boolean" }, "conceptDefinition": { "type": "string" }, "conceptId": { "type": "integer", "format": "int64" }, "conceptUuid": { "type": "string", "format": "uuid" }, "createdAt": { "type": "integer", "format": "int64", "readOnly": true }, "definition": { "type": "string" }, "dnt": { "type": "boolean" }, "exactMatch": { "type": "boolean" }, "forbidden": { "type": "boolean" }, "forbiddenMetadata": { "type": "string" }, "gender": { "type": "string", "example": "Undefined", "enum": [ "Masculine", "Feminine", "Neutral", "Undefined" ] }, "glossaryCustomAttributes": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "glossaryUuid": { "type": "string", "format": "uuid" }, "id": { "type": "integer", "format": "int64" }, "internal": { "type": "boolean" }, "language": { "type": "string" }, "lastModifiedAt": { "type": "integer", "format": "int64" }, "learnt": { "type": "boolean" }, "note": { "type": "string" }, "part": { "type": "string", "example": "Noun", "enum": [ "Noun", "Pronoun", "Adjective", "Determiner", "Verb", "Adverb", "Preposition", "Conjunction", "Interjection", "Acronym", "Other", "Proper Noun", "Undefined" ] }, "rtl": { "type": "boolean" }, "status": { "type": "string", "example": "Approved", "enum": [ "Under_Review", "Approved", "Published", "Preferred", "Deprecated" ] }, "termType": { "type": "string", "example": "Full", "enum": [ "Full", "Acronym" ] }, "text": { "type": "string" }, "usage": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "writable": { "type": "boolean" } } }, "TermEntryOnSegment": { "type": "object", "properties": { "contextProjectId": { "type": "string", "format": "uuid" }, "contextWorkId": { "type": "string", "format": "uuid" }, "sourceTerm": { "$ref": "#/components/schemas/TermTranslationDTO" }, "targetTerm": { "$ref": "#/components/schemas/TermTranslationDTO" } } }, "TermLinkedDTO": { "type": "object", "properties": { "linkId": { "type": "integer", "format": "int64" }, "linkType": { "type": "string", "enum": [ "Synonym", "Antonym", "Homograph" ] }, "term": { "$ref": "#/components/schemas/TermDTO" } } }, "TermTranslationDTO": { "type": "object", "properties": { "caseSensitive": { "type": "boolean" }, "concept": { "type": "integer", "format": "int64" }, "conceptDefinition": { "type": "string" }, "conceptId": { "type": "integer", "format": "int64" }, "conceptUuid": { "type": "string", "format": "uuid" }, "createdAt": { "type": "integer", "format": "int64", "readOnly": true }, "definition": { "type": "string" }, "dnt": { "type": "boolean" }, "exactMatch": { "type": "boolean" }, "forbidden": { "type": "boolean" }, "gender": { "type": "string", "enum": [ "Masculine", "Feminine", "Neutral", "Undefined" ] }, "glossaryCustomAttributes": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "glossaryName": { "type": "string" }, "glossaryUuid": { "type": "string", "format": "uuid" }, "id": { "type": "integer", "format": "int64" }, "internal": { "type": "boolean" }, "language": { "type": "string" }, "lastModifiedAt": { "type": "integer", "format": "int64" }, "learnt": { "type": "boolean" }, "nameCreatedBy": { "type": "string" }, "nameModifiedBy": { "type": "string", "description": "Name of the user who last edited the term. `null` when no change to the term recorded who made it, as on a term never edited since it was created." }, "note": { "type": "string" }, "part": { "type": "string", "enum": [ "Noun", "Pronoun", "Adjective", "Determiner", "Verb", "Adverb", "Preposition", "Conjunction", "Interjection", "Acronym", "Other", "Proper Noun", "Undefined" ] }, "rank": { "type": "integer", "format": "int32" }, "rtl": { "type": "boolean" }, "sortValues": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "Under_Review", "Approved", "Published", "Preferred", "Deprecated" ] }, "termType": { "type": "string", "enum": [ "Full", "Acronym" ] }, "text": { "type": "string" }, "usage": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "writable": { "type": "boolean" } } }, "TermUpdateRequest": { "type": "object", "properties": { "caseSensitive": { "type": "boolean", "example": false }, "conceptUuid": { "type": "string", "description": "The concept the term belongs to.", "format": "uuid", "example": "e776b275-7910-41e5-acd2-813ff3cd8340" }, "definition": { "type": "string", "description": "Definition of the concept the term belongs to.", "example": "Short text that describes a new version of the product." }, "dnt": { "type": "boolean", "description": "Do not translate.", "example": false }, "exactMatch": { "type": "boolean", "example": false }, "forbidden": { "type": "boolean", "example": false }, "gender": { "type": "string", "example": "Neutral", "enum": [ "Masculine", "Feminine", "Neutral", "Undefined" ] }, "glossaryCustomAttributes": { "type": "array", "description": "Values of the glossary's custom attributes. Each item has `name`, `type` and `value`.", "example": [ { "name": "Product", "type": "SINGLE_VALUE", "value": "Mobile app" } ], "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "internal": { "type": "boolean", "example": false }, "note": { "type": "string", "example": "Reviewed by the documentation team." }, "part": { "type": "string", "example": "Noun", "enum": [ "Noun", "Pronoun", "Adjective", "Determiner", "Verb", "Adverb", "Preposition", "Conjunction", "Interjection", "Acronym", "Other", "Proper Noun", "Undefined" ] }, "rtl": { "type": "boolean", "description": "Right-to-left text.", "example": false }, "status": { "type": "string", "example": "Under_Review", "enum": [ "Under_Review", "Approved", "Published", "Preferred", "Deprecated" ] }, "termType": { "type": "string", "example": "Full", "enum": [ "Full", "Acronym" ] }, "text": { "type": "string", "description": "Omitted or blank keeps the stored text.", "example": "release note" }, "usage": { "type": "string", "example": "Use in changelogs and update notices." }, "writable": { "type": "boolean", "example": true } }, "description": "`definition` updates the concept's definition only when `conceptUuid` is sent too." }, "TermsParams": { "type": "object", "properties": { "extractTerms": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Parameter" } } } }, "TimesheetPayableDetail": { "type": "object", "properties": { "currency": { "type": "string" }, "hourlyRate": { "type": "number" }, "payableAmount": { "type": "number" }, "payableAmountInUSD": { "type": "number" }, "resourceName": { "type": "string" }, "resourceUuid": { "type": "string" }, "totalHours": { "type": "number", "format": "double" }, "type": { "type": "string" }, "userName": { "type": "string" }, "userUuid": { "type": "string" } } }, "TmExportRequest": { "required": [ "format" ], "type": "object", "properties": { "createdAfter": { "type": "integer", "description": "Only entries created after this time, in epoch milliseconds. Not with the work-unit path.", "format": "int64", "example": 1735689600000 }, "createdBefore": { "type": "integer", "description": "Only entries created before this time, in epoch milliseconds. Not with the work-unit path.", "format": "int64", "example": 1767225600000 }, "format": { "type": "string", "description": "Case-insensitive. The work-unit path is TMX only.", "example": "tmx", "enum": [ "tmx", "xlsx" ] }, "languages": { "type": "array", "description": "Locales to export. Omitted or empty exports all of them.", "example": [ "en_us", "de_de" ], "items": { "type": "string", "example": "en_us" } }, "projectId": { "type": "string", "description": "Work-unit path: the project whose work units saved the entries. The TM must be linked to it, and the caller also needs the PROJECT_export_import_file permission.", "format": "uuid", "example": "e42cd601-bec2-4bb3-b64d-59d07d239b54" }, "projectStepLevel": { "type": "integer", "description": "Work-unit path: the workflow step whose saved entries are exported. Sending it, even as 0, selects the work-unit path.", "format": "int32", "example": 1 }, "tuIds": { "type": "array", "description": "Export only these translation units. Not with the work-unit path.", "example": [ 1001, 1002 ], "items": { "type": "integer", "format": "int64", "example": 1001 } }, "workUnitIds": { "type": "array", "description": "Work-unit path: the project's work units whose saved entries are exported.", "example": [ "8a064b3d-2903-4f2d-a02f-91122ef8b00d" ], "items": { "type": "string", "format": "uuid", "example": "8a064b3d-2903-4f2d-a02f-91122ef8b00d" } } }, "description": "Leave projectId, workUnitIds and projectStepLevel out to export the whole TM, filtered by languages, tuIds and the creation dates. Send projectId with workUnitIds or projectStepLevel to export, as TMX, only the entries saved by those work units (the work-unit path): tuIds and the dates don't apply there." }, "TmOrgUnitAssociationRequest": { "type": "object", "properties": { "defaultThreshold": { "type": "number", "description": "Minimum match score. Default: 0.75.", "format": "double", "example": 0.75 }, "fixPreTranslateMismatchTags": { "type": "boolean", "example": false }, "fixSuggestionMismatchTags": { "type": "boolean", "example": false }, "fixTags": { "type": "boolean", "example": false }, "isDefault": { "type": "boolean", "description": "The TM is the org units' default TM.", "example": false }, "penalty": { "type": "number", "description": "Penalty applied to the TM's matches. Default: 0.", "format": "double", "example": 5 }, "read": { "type": "boolean", "description": "The org units read from the TM. Default: false.", "example": true }, "settings": { "$ref": "#/components/schemas/Settings" }, "write": { "type": "boolean", "description": "The org units write to the TM. Default: false.", "example": true } } }, "TotalCostDto": { "type": "object", "properties": { "confidenceSavings": { "type": "number" }, "costInfoDtoList": { "type": "array", "items": { "$ref": "#/components/schemas/CostInfoDto" } }, "grossCost": { "type": "number" }, "minimumFeeApplied": { "type": "boolean" }, "netCost": { "type": "number" }, "totalCalculatedCost": { "type": "number", "format": "double" }, "totalSavings": { "type": "number" } } }, "TranslationKitJobDownloadLinkDto": { "type": "object", "properties": { "downloadUrl": { "type": "string" }, "expiresAt": { "type": "integer", "format": "int64" }, "generatedAt": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int64" }, "sharedLinkExpiresInDays": { "type": "integer", "format": "int64" } } }, "TranslationKitJobDto": { "type": "object", "properties": { "completedFiles": { "type": "integer", "format": "int32" }, "creationDate": { "type": "integer", "format": "int64" }, "downloadFileUrl": { "type": "string", "description": "Temporary URL of the file the job built, once it has completed. Left out when the job has a `sharedLink`." }, "downloadFileUrlExpiresAt": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "id": { "type": "string", "format": "uuid" }, "isTransient": { "type": "boolean" }, "projectId": { "type": "string", "format": "uuid", "writeOnly": true }, "sharedLink": { "type": "string", "description": "Link that downloads the file without authentication (see *Resolve Shared Link*), when the job was started with `sharedLinkExpiresInDays`." }, "sharedLinkExpiresInDays": { "type": "integer", "format": "int64" }, "startTime": { "type": "integer", "format": "int64" }, "status": { "type": "string", "description": "`STARTING` while the job runs, then `COMPLETED` or `FAILED`.", "enum": [ "STARTING", "COMPLETED", "FAILED" ] }, "totalFiles": { "type": "integer", "format": "int32" }, "type": { "type": "string", "description": "What the job does. Jobs report `LOC_KIT` (export kit), `TRANSLATED_FILES`, `SOURCE_FILES`, `IMPORT_XLIFF` or `IMPORT_XLSX` (bulk import); `EXPORT_XLIFF` and `EXPORT_XLSX` are not used.", "enum": [ "EXPORT_XLIFF", "IMPORT_XLIFF", "EXPORT_XLSX", "IMPORT_XLSX", "LOC_KIT", "TRANSLATED_FILES", "SOURCE_FILES" ] } } }, "TranslationKitParams": { "type": "object", "properties": { "addSourceAndTargetSuffix": { "type": "boolean" }, "downloadDeliverables": { "type": "boolean" }, "fontMappings": { "type": "array", "items": { "$ref": "#/components/schemas/BwxFontMappings" } }, "hideOriginColumn": { "type": "boolean", "description": "Export kits with `locKitTypeJob: XLSX` only: hide the Origin column of the XLSX. The column stays in the sheet, so the file can still be imported." }, "includeComments": { "type": "boolean", "description": "Export kits with `locKitTypeJob` `XLSX` or `ALL` only: add the `Segment Comments` column, with every public comment of each segment. Defaults to `false`.", "default": false }, "intermediateFile": { "type": "boolean" }, "locKitTypeJob": { "type": "string", "description": "Export kits only: what the kit holds. `ALL` (the default) builds XLIFF, XLSX, TMX and TBX files; `XLIFF` builds only the bilingual XLIFF files.", "default": "ALL", "enum": [ "ALL", "XLIFF", "TMX", "TBX", "XLSX" ] }, "projectId": { "type": "string", "description": "Ignored: the project comes from the path.", "format": "uuid" }, "sharedLinkExpiresInDays": { "type": "integer", "description": "Also create a link that downloads the result without authentication, valid for this many days. The job then returns `sharedLink` instead of `downloadFileUrl`.", "format": "int64", "enum": [ 1, 7, 30 ] }, "updateDataTransformation": { "type": "boolean" }, "workUnitUuids": { "type": "array", "description": "The work units to include, all at the same workflow step. Export kits and translated files need it unless `workflowLevel` is set; source files take the whole project when it is empty. A vendor always gets their own assigned work units.", "items": { "type": "string", "description": "The work units to include, all at the same workflow step. Export kits and translated files need it unless `workflowLevel` is set; source files take the whole project when it is empty. A vendor always gets their own assigned work units.", "format": "uuid" } }, "workflowLevel": { "type": "integer", "description": "Every work unit at this workflow step. Export kits and translated files need it or `workUnitUuids`. Ignored for vendors and for source files.", "format": "int32" }, "workflowUuid": { "type": "string", "description": "Every work unit of this workflow. Takes precedence over `workflowLevel` and `workUnitUuids`, but export kits and translated files still need one of those. Ignored for vendors.", "format": "uuid" } } }, "TranslationUnitMatch": { "type": "object", "properties": { "locale": { "type": "string" }, "match": { "type": "number", "format": "double" }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" } }, "translationUnitId": { "type": "integer", "format": "int64" } } }, "Type": { "type": "object", "properties": { "name": { "type": "string" }, "order": { "type": "integer", "format": "int32" } } }, "UpdateTaskRequest": { "type": "object", "properties": { "currency": { "type": "string", "description": "Left out, it stays as it is." }, "dueDate": { "type": "integer", "description": "Due date, epoch milliseconds. Left out, it stays as it is.", "format": "int64" }, "instructions": { "type": "string", "description": "The task's instructions (HTML). Left out, they stay as they are.", "example": "

Keep product names in English. Use the glossary for UI strings.

" }, "name": { "type": "string", "description": "Left out, it stays as it is." }, "uuid": { "type": "string", "description": "Optional. When sent, it must be the task in the path, otherwise the call answers 400.", "format": "uuid" } } }, "UserAssociationRef": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" } }, "description": "An organization or org unit of your account, by uuid. Read when the user is created." }, "UserDto": { "type": "object", "properties": { "accessKey": { "type": "string" }, "accessKeyTimestamp": { "type": "integer", "format": "int64" }, "accountOwner": { "type": "boolean" }, "accountType": { "type": "string", "enum": [ "CLI", "PERSONAL", "BUSINESS", "ENTERPRISE", "OTHER" ] }, "accountUuid": { "type": "string", "format": "uuid", "readOnly": true }, "address": { "type": "string" }, "address2": { "type": "string" }, "admin": { "type": "boolean" }, "assignedJobs": { "type": "integer", "format": "int64" }, "avatar": { "type": "string" }, "captcha": { "type": "string" }, "cellPhone": { "type": "string" }, "city": { "type": "string" }, "companyName": { "type": "string" }, "completedJobs": { "type": "integer", "format": "int64" }, "country": { "type": "string" }, "currency": { "type": "string" }, "customFields": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "dailyRate": { "type": "number" }, "defaultWorkflowRates": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "deleteAllLanguagePair": { "type": "boolean" }, "email": { "type": "string" }, "emailMagicCode": { "type": "string" }, "entryPoint": { "type": "string", "enum": [ "WORKS_HOME", "PORTAL_HOME" ] }, "externalId": { "type": "string" }, "forwardUrl": { "type": "string" }, "hourlyRate": { "type": "number" }, "id": { "type": "integer", "format": "int64" }, "invoicingDayOfMonth": { "type": "string", "enum": [ "DAY_15", "DAY_30" ] }, "invoicingPeriodicity": { "type": "integer", "format": "int32" }, "lastAccessAt": { "type": "integer", "format": "int64" }, "messageError": { "type": "string" }, "messageWarning": { "type": "string" }, "mfa": { "type": "integer", "format": "int64" }, "mfaEnabled": { "type": "boolean" }, "minimumFee": { "type": "number" }, "name": { "type": "string" }, "nameEmail": { "type": "string" }, "newPassword": { "type": "string" }, "notes": { "type": "string" }, "notifyUser": { "type": "boolean" }, "orgUnits": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationalUnitDto" } }, "organizations": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationDto" } }, "pagesRate": { "type": "number" }, "parentUserUuid": { "type": "string", "format": "uuid" }, "paymentMethod": { "type": "string", "enum": [ "PAYONEER", "PAYPAL", "BANK", "QUICKBOOKS" ] }, "payoneerId": { "type": "string" }, "paypalAccount": { "type": "string" }, "permissionGroups": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionGroupDto" } }, "phone": { "type": "string" }, "postalCode": { "type": "string" }, "productName": { "type": "string" }, "punctuality": { "type": "number", "format": "double" }, "quickBooksVendorId": { "type": "string" }, "roles": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "USER", "ADMIN", "SYSADMIN", "ACCOUNT_ADMIN", "CLIENT", "CLIENT_ADMIN", "CLIENT_AGENCY", "CLIENT_REQUESTER", "CLIENT_PROJECT_MANAGER", "PROJECT_MANAGER", "ACCOUNTING", "REVIEWER", "INTERNAL", "PAYMENTS", "QUALITY_ISO", "QUALITY_AUDITOR", "VENDOR_ADMIN", "SALES", "WIKI_MODERATOR", "WIKI_READONLY", "WIKI_USER", "WIKI_ACTIONS", "WIKI_ADMIN", "REF_ADMIN", "REF_USER", "REF_READONLY", "VENDOR", "TERM_TRANSLATOR", "TERM_REVIEWER", "TERM_ADMIN", "TERM_CONTENT_CREATOR", "TERM_LANGUAGE_MANAGER", "TERM_UPDATE_REQUESTER", "TERM_READ_ONLY", "TERMINOLOGY_STANDALONE_USER", "TERMINOLOGY_STANDALONE_OWNER" ] } }, "skypeId": { "type": "string" }, "slackHandle": { "type": "string" }, "state": { "type": "string" }, "status": { "type": "string", "description": "The user's status. Read ignoring case.", "enum": [ "Active", "Inactive", "Disabled" ] }, "subUser": { "type": "boolean" }, "subscriptions": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/UserSubscriptionDto" } }, "supportedLanguagePairs": { "type": "array", "items": { "$ref": "#/components/schemas/LanguagePair" } }, "tags": { "type": "array", "items": { "type": "string" } }, "targetAccountUuid": { "type": "string", "format": "uuid" }, "tasksCompletedCount": { "type": "integer", "format": "int64" }, "taxId": { "type": "string" }, "taxpayerId": { "type": "string" }, "timezone": { "type": "string" }, "totalJobs": { "type": "integer", "format": "int64" }, "useProjectCurrency": { "type": "boolean" }, "userQualityMetrics": { "$ref": "#/components/schemas/UserQualityMetricsDto" }, "userRates": { "type": "array", "items": { "$ref": "#/components/schemas/UserRateDetailsDto" } }, "uuid": { "type": "string", "format": "uuid" }, "wordRate": { "type": "number" } } }, "UserLanguagePairRef": { "type": "object", "properties": { "source": { "type": "string", "example": "en_us" }, "target": { "type": "string", "example": "de_de" } }, "description": "A language pair of the user. Read when the user is created." }, "UserQualityMetricsDto": { "type": "object", "properties": { "avgQualityIndex": { "type": "number" }, "id": { "type": "integer", "format": "int64" }, "maxQualityIndex": { "type": "number" }, "minQualityIndex": { "type": "number" }, "uuid": { "type": "string", "format": "uuid" }, "vendor": { "$ref": "#/components/schemas/UserDto" } } }, "UserRateDetailsDto": { "type": "object", "properties": { "createdAt": { "type": "integer", "format": "int64", "readOnly": true }, "currency": { "type": "string" }, "isDefault": { "type": "boolean" }, "minimumFee": { "type": "number" }, "orgUnitUuid": { "type": "string", "format": "uuid" }, "rateDetails": { "type": "array", "items": { "$ref": "#/components/schemas/RateDetailsDto" } }, "updatedAt": { "type": "integer", "format": "int64", "readOnly": true }, "userUuid": { "type": "string", "format": "uuid", "readOnly": true }, "uuid": { "type": "string", "format": "uuid", "readOnly": true } } }, "UserRef": { "type": "object", "properties": { "avatar": { "type": "string" }, "currency": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "status": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" } }, "description": "A user referenced by another resource." }, "UserSubscriptionDto": { "type": "object", "properties": { "eventType": { "type": "string" }, "userId": { "type": "integer", "format": "int64" } } }, "WebhookDto": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Ignored. A webhook starts inactive and becomes active once its URL answers the validation request." }, "secret": { "type": "string", "description": "Optional, and recommended: the key wxrks signs every request with, an HMAC-SHA256 sent in `X-BWX-Signature`. It is stored encrypted, never returned, and cannot be changed; to rotate it, create a new webhook." }, "type": { "type": "string", "description": "The one event type this webhook receives. Create one webhook per event type; several can share a URL.", "enum": [ "NEW_PROJECT", "NEW_EMPTY_PROJECT", "PROJECT_STATUS_CHANGE", "PROJECT_UPDATE", "PROJECT_INGESTION_COMPLETED", "PROJECT_TRANSLATION_FINISHED", "TASK_ASSIGNED", "TASK_STATUS_CHANGE", "TASK_UPDATE", "WORK_UNIT_STATUS_CHANGE", "WORK_UNIT_TRANSLATION_FILE_READY", "WORK_UNIT_IMPORT_FINISHED", "TRANSLATION_KIT_JOB_FINISHED", "NEW_ORG_UNIT", "ORG_UNIT_UPDATE", "NEW_ORG", "ORG_UPDATE", "NEW_USER", "USER_UPDATE" ] }, "url": { "type": "string", "description": "Where wxrks sends the events, each as a `POST` with a JSON body. It must use `https://`." } } }, "WebhookResponseDto": { "type": "object", "properties": { "account": { "type": "string", "format": "uuid" }, "active": { "type": "boolean" }, "createdAt": { "type": "integer", "format": "int64", "readOnly": true }, "events": { "type": "array", "items": { "type": "string" } }, "url": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" } } }, "WordPressConfig": { "required": [ "baseUrl", "name", "orgUnitUuid", "wpPassword", "wpUser" ], "type": "object", "properties": { "accountUuid": { "type": "string", "description": "The account of the org unit, set by wxrks.", "format": "uuid", "readOnly": true }, "baseUrl": { "type": "string" }, "cloudflareClientId": { "type": "string" }, "cloudflareClientSecret": { "type": "string" }, "defaultWorkflows": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "orgUnit": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/ClientIdNameDto" } ] }, "orgUnitUuid": { "type": "string", "format": "uuid" }, "params": { "type": "object", "additionalProperties": { "type": "object" } }, "sourceSite": { "type": "string" }, "strategy": { "type": "string", "enum": [ "DEFAULT", "ZENDESK" ] }, "uuid": { "type": "string", "format": "uuid" }, "wpCookiePassword": { "type": "string" }, "wpCookieUser": { "type": "string" }, "wpPassword": { "type": "string" }, "wpUser": { "type": "string" } } }, "WorkUnitDownloadFile": { "type": "object", "properties": { "deliverableFileUrl": { "type": "string" }, "fileName": { "type": "string" }, "operationId": { "type": "string" }, "originalFileUrl": { "type": "string" }, "progressElapsedMs": { "type": "integer", "format": "int64" }, "progressLastHeartbeatAt": { "type": "integer", "format": "int64" }, "progressMessage": { "type": "string" }, "progressStage": { "type": "string" }, "progressStartedAt": { "type": "integer", "format": "int64" }, "sharedLink": { "type": "string" }, "sharedLinkExpiresInDays": { "type": "integer", "format": "int64" }, "translatedFileCreationDate": { "type": "integer", "format": "int64" }, "translatedFileUrl": { "type": "string" }, "translationStatus": { "type": "string" } } }, "WorkUnitDto": { "type": "object", "properties": { "assignee": { "$ref": "#/components/schemas/UserRef" }, "baseUnitCost": { "type": "number", "format": "double" }, "characters": { "type": "integer", "format": "int32" }, "confirmedNonTranslatable": { "type": "integer", "format": "int32" }, "confirmedSegments": { "type": "integer", "format": "int32" }, "connectorStatus": { "type": "string" }, "connectorStatusReason": { "type": "string" }, "contentIsEmpty": { "type": "boolean" }, "cost": { "type": "number" }, "createdOnGenesis": { "type": "boolean" }, "creationTimestamp": { "type": "integer", "format": "int64" }, "deliveryDate": { "type": "integer", "format": "int64" }, "downloadTranslatedFileEnabled": { "type": "boolean" }, "dueDate": { "type": "integer", "format": "int64" }, "filename": { "type": "string" }, "genesisCreationDescription": { "type": "string" }, "genesisCreationStatus": { "type": "string", "description": "Whether the work unit's content is ready in the editor.", "enum": [ "CREATING", "FAILED", "CREATED" ] }, "hasDeliverable": { "type": "boolean" }, "hasMismatchTag": { "type": "boolean" }, "hasXsltPreview": { "type": "boolean" }, "hours": { "type": "integer", "format": "int32" }, "isSplit": { "type": "boolean" }, "lastUpdate": { "type": "integer", "format": "int64" }, "minutes": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "netWords": { "type": "integer", "format": "int64" }, "orgUnitId": { "type": "string", "format": "uuid" }, "pages": { "type": "integer", "format": "int32" }, "partiallyDelivered": { "type": "boolean" }, "projectResource": { "$ref": "#/components/schemas/ProjectResourceDto" }, "projectUUID": { "type": "string", "format": "uuid" }, "readOnly": { "type": "boolean" }, "relatedObjectId": { "type": "string" }, "savings": { "type": "number", "format": "double" }, "segments": { "type": "integer", "format": "int32" }, "sequence": { "type": "integer", "format": "int32" }, "slices": { "type": "array", "items": { "$ref": "#/components/schemas/WorkUnitSlice" } }, "sourceLanguage": { "type": "string" }, "targetLanguage": { "type": "string" }, "taskStatus": { "type": "string", "enum": [ "CANCELLED", "PENDING", "PENDING_ACCEPTANCE", "PENDING_CONFIRMATION", "SCHEDULED", "EXPIRED", "ASSIGNED", "DELIVERED", "INVOICED", "PAID", "NOT_INVOICED", "SKIPPED" ] }, "totalNonTranslatable": { "type": "integer", "format": "int32" }, "totalSegments": { "type": "integer", "format": "int32" }, "uuid": { "type": "string", "format": "uuid" }, "words": { "type": "integer", "format": "int64" }, "workId": { "type": "string", "format": "uuid" }, "workPackageStatus": { "type": "string", "description": "For a work unit delivered through a work package: shown only once it is delivered or failed.", "enum": [ "DELIVERED", "FAILED" ] }, "workPackageStatusReason": { "type": "string" }, "workStatus": { "type": "string", "enum": [ "NEW", "CREATED", "IN_PROGRESS", "COMPLETED", "APPROVED", "REJECTED", "DELIVERED", "CANCELLED", "FAILED" ] }, "workflow": { "type": "string" }, "workflowSequence": { "type": "integer", "format": "int32" }, "workflowUuid": { "type": "string", "format": "uuid" } } }, "WorkUnitImportDto": { "type": "object", "properties": { "creationDate": { "type": "integer", "description": "When the import was requested (Unix time in milliseconds).", "format": "int64" }, "endingDate": { "type": "integer", "description": "When the import ended (Unix time in milliseconds). Null while it runs.", "format": "int64" }, "error": { "type": "string", "description": "Why the import ended in `ERROR`: `WORK_UNIT_READ_ONLY` (the work unit is cancelled, expired, or its previous step is still open), `WRONG_WORK_UNIT` (the file was exported from another work unit), `FILE_UNREADABLE`, `NO_SEGMENTS` (the file has no segments), `TARGET_LANGUAGE_MISMATCH` (the file's target language is not the work unit's), `NO_SEGMENT_IDS` (no segment has a `bwx:ts-id`), `NOTHING_UPDATED` (no longer reported: a file that writes no segment, for example an unchanged one, now ends `IMPORTED` with `segmentsUpdated` 0), or `FAILED` (an unexpected error). Null otherwise.", "enum": [ "WORK_UNIT_READ_ONLY", "WRONG_WORK_UNIT", "FILE_UNREADABLE", "NO_SEGMENTS", "TARGET_LANGUAGE_MISMATCH", "NO_SEGMENT_IDS", "NOTHING_UPDATED", "FAILED" ] }, "id": { "type": "string", "description": "Id of the import: poll it with *Get Work Unit Import*.", "format": "uuid" }, "importType": { "type": "string", "description": "Format of the imported file.", "enum": [ "XLIFF", "XLSX" ] }, "segmentsConfirmed": { "type": "integer", "description": "Of the segments written, how many are confirmed. Null while the import runs.", "format": "int32" }, "segmentsInFile": { "type": "integer", "description": "Segments in the file, locked ones included. Null while the import runs.", "format": "int32" }, "segmentsLocked": { "type": "integer", "description": "File segments skipped because they are locked: marked locked in the file (`translate=\"no\"`, `bwx:locked=\"yes\"`) or locked in the work unit since the file was exported. Null while the import runs.", "format": "int32" }, "segmentsUpdated": { "type": "integer", "description": "Segments written to the work unit. Null while the import runs.", "format": "int32" }, "segmentsWithoutId": { "type": "integer", "description": "File segments without a `bwx:ts-id`, which were skipped. Null while the import runs.", "format": "int32" }, "status": { "type": "string", "description": "`STARTED` while the import runs, then `IMPORTED` or `ERROR`.", "enum": [ "STARTED", "IMPORTED", "ERROR" ] }, "workUnitId": { "type": "string", "format": "uuid" } } }, "WorkUnitImportStatusDto": { "type": "object", "properties": { "importingCreationDate": { "type": "integer", "description": "Not filled: always `null`.", "format": "int64", "nullable": true }, "importingEndingDate": { "type": "integer", "description": "When `importingStatus` last changed (Unix time in milliseconds), including when the import started.", "format": "int64" }, "importingStatus": { "type": "string", "description": "State of the latest import of this format into the work unit.", "enum": [ "NOT_STARTED", "STARTED", "IMPORTED", "ERROR" ] }, "workUnitUuid": { "type": "string", "format": "uuid" } } }, "WorkUnitSlice": { "type": "object", "properties": { "assignedUuid": { "type": "string", "format": "uuid" }, "batchId": { "type": "string", "format": "uuid" }, "confirmedSegments": { "type": "integer", "format": "int64" }, "deliverable": { "type": "boolean" }, "fromIndex": { "type": "integer", "format": "int32" }, "hasTagMismatch": { "type": "boolean" }, "previousWorkflowAssignedUuid": { "type": "string", "format": "uuid" }, "readOnly": { "type": "boolean" }, "taskUuid": { "type": "string", "format": "uuid" }, "toIndex": { "type": "integer", "format": "int32" }, "uuid": { "type": "string", "format": "uuid" } } }, "WorkUnitTmUpdate": { "type": "object", "properties": { "jobId": { "type": "integer", "description": "The export job. Poll it with Get Work Unit TM Update.", "format": "int64", "example": 48213 }, "status": { "type": "string", "description": "The job's status when it was created: `SCHEDULED` while it waits for pending translation memory writes.", "example": "SCHEDULED" }, "tmName": { "type": "string", "description": "The translation memory's name.", "example": "Product UI" }, "tmUuid": { "type": "string", "description": "The translation memory.", "format": "uuid", "example": "3f1c2a8e-5b7d-4e2a-9c61-0d4b8e7f2a10" } }, "description": "The export of one translation memory for the work unit." }, "WorkUnitTmUpdateJob": { "type": "object", "properties": { "downloadUrl": { "type": "string", "description": "Only when `status` is `COMPLETED`: a signed link to the TMX file, valid for one hour after the job completed.", "example": "https://bucket.s3.amazonaws.com/tm-export/48213.tmx?X-Amz-Expires=3600" }, "failureReason": { "type": "string", "description": "Only when `status` is `FAILED`: why the export failed." }, "jobId": { "type": "integer", "format": "int64", "example": 48213 }, "status": { "type": "string", "description": "`STARTING`, `STARTED` or `SCHEDULED` while the job runs, then `COMPLETED` or `FAILED`.", "example": "COMPLETED" }, "tmUuid": { "type": "string", "description": "The translation memory.", "format": "uuid", "example": "3f1c2a8e-5b7d-4e2a-9c61-0d4b8e7f2a10" }, "translationUnits": { "type": "integer", "description": "Only when `status` is `COMPLETED`: how many translation units the TMX holds. `0` means the work unit wrote nothing to this TM.", "format": "int64", "example": 312 } }, "description": "A TM update export job of a work unit." }, "Workflow": { "type": "object", "properties": { "accountUuid": { "type": "string", "format": "uuid", "readOnly": true }, "active": { "type": "boolean" }, "code": { "type": "string" }, "createdAt": { "type": "integer", "format": "int64", "readOnly": true }, "description": { "type": "string" }, "editorEnabled": { "type": "boolean" }, "id": { "type": "integer", "format": "int64" }, "projectSequence": { "type": "integer", "format": "int32" }, "sequence": { "type": "integer", "format": "int32" }, "settings": { "$ref": "#/components/schemas/Settings" }, "title": { "type": "string" }, "unitType": { "type": "string" }, "units": { "type": "integer", "format": "int64" }, "updatedAt": { "type": "integer", "format": "int64", "readOnly": true }, "uuid": { "type": "string", "format": "uuid" }, "value": { "type": "number", "format": "double" } } }, "WorkflowDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "code": { "type": "string" }, "description": { "type": "string" }, "editorEnabled": { "type": "boolean" }, "projectSequence": { "type": "integer", "format": "int32" }, "sequence": { "type": "integer", "format": "int32" }, "settings": { "$ref": "#/components/schemas/Settings" }, "title": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" } } }, "WorkflowSetup": { "type": "object", "properties": { "read": { "type": "boolean" }, "workflowUuid": { "type": "string", "format": "uuid" }, "write": { "type": "boolean" } } }, "ZipProcessingStatusDto": { "type": "object", "properties": { "bytesProcessed": { "type": "integer", "format": "int64" }, "failedEntries": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "processedEntries": { "type": "integer", "format": "int32" }, "processedProjectResources": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectResourceDto" } }, "status": { "type": "string" }, "taskId": { "type": "string" }, "totalEntries": { "type": "integer", "format": "int32" } } } }, "securitySchemes": { "ApiKeyAuth": { "description": "The token returned by `POST /api/v3/auth`.", "in": "header", "name": "X-AUTH-TOKEN", "type": "apiKey" } } } }