Here’a a smiley face ![]()
",
+ "Here’s a table:
"
+ ],
+ "engineId": "en_ro_nmt"
+}
+```
+
+- The `engineId` is the identifier of the engine used to translate the `contents`.
+
+- The response would look like this:
+
+```json
+{
+ "translations": [
+ " Iată un chip zâmbet ![]()
",
+ " Iată un tabel:
"
+ ]
+}
+```
+
+> ` ..
` might cause problems for some engines. You can parse them out before sending them to the translation service if the order of the segments can be guaranteed. Once the translated segments are available, these need to be added back when sending the response.
+
+#### Endpoint usage
+
+To test the endpoint, first, you will need a workflow that contains the **Machine Translation** automatic task and the **Translation** human task. For example:
+
+
+
+Using that **workflow** and the **translation engine** created in the previous step, you can start a new project like this:
+
+
+
+When the project reaches **Translation**, you can open it in the **Online Editor** and check the target segments. This is where you should find the translations performed by your app in the **Machine Translation** step. You can also search for Lookups to obtain alternative translations. This will invoke again the `lc.mtprovider.translate` endpoint.
+
+
+
+You can find more details on how to use an MT app in the [consumer guide](../consumer/MT-App-consumer-guide.md).
+
+The blueprints contain placeholders from where you can start implementing the endpoint's functionality:
+
+- [.NET blueprint](https://github.com/RWS/language-cloud-extensibility/blob/main/blueprints/dotNetAppBlueprint/Rws.LC.AppBlueprint/Controllers/TranslationController.cs#L35)
+- [Java blueprint](https://github.com/RWS/language-cloud-extensibility/blob/main/blueprints/javaAppBlueprint/src/main/java/com/rws/lt/lc/blueprint/web/TranslateController.java#L22)
+
+Please refer to the endpoint's [documentation](../../api/Extensibility-API.v1-fv.html#/operations/MachineTranslationProviderTranslateBCM) for further details.
diff --git a/articles/Extensibility/docs/development/Multi-Region.md b/articles/Extensibility/docs/development/Multi-Region.md
new file mode 100644
index 0000000..fc3dd7d
--- /dev/null
+++ b/articles/Extensibility/docs/development/Multi-Region.md
@@ -0,0 +1,164 @@
+---
+stoplight-id: 4x29bwcvq2f84
+tags: [Development]
+---
+
+# Multi-Region
+
+To fulfill the requirements of our customers, Trados Enterprise allows multi-region deployments of your app.
+
+To enable multi-region on your app you must provide regional instances of your app and include their `regionalBaseUrls` in your [descriptor](../../api/Extensibility-API.v1-fv.html#/operations/descriptor).
+
+> [!NOTE]
+> Multi-Region is only supported on apps starting with `decriptorVersion: 1.4`
+
+> [!WARNING]
+> Please note that the responsibility for ensuring region-specific URLs lies with the developer. The URLs should accurately reflect the physical location of the instances.
+
+Currently, the supported regions are Europe(`eu`) and Canada(`ca`). Depending on where your app is deployed you can choose either one or both of them. This will tell Trados what endpoints to invoke based on where the consumer tenant is living.
+
+> [!WARNING]
+> All instances, in all regions should provide the exact same descriptor.
+
+## Installing an App with Multi-Region support
+
+When a consumer installs an app, if `regionalBaseUrls` is present and same region as consumer's is available, that region will be used.
+
+If your app does not provide the region where the consumer tenant belongs, the consumer will be notified before installing the app that the global region (`baseUrl`) will be used instead.
+
+
+
+> [!WARNING]
+> Once installed globally, if the app adds support for a new region, the consumers will have to reinstall it to change the region.
+
+The `INSTALLED` lifecycle event now includes the region information for the account where the app is installed so you can save it in the database and use it to identify to which regions calls should be made (for ex. which region/url to use for Public API). That is already implemented in the provided [Java](https://github.com/RWS/language-cloud-extensibility/tree/main/blueprints/javaAppBlueprint) and [.NET](https://github.com/RWS/language-cloud-extensibility/tree/main/blueprints/dotNetAppBlueprint) blueprints.
+
+## Base URL vs Multi-Region Base URLs
+
+The `baseUrl` property from [descriptor](../../api/Extensibility-API.v1-fv.html#/operations/descriptor) remains mandatory even if you add the `regionalBaseUrls` property(which is optional).
+
+> [!WARNING]
+> The `baseUrl` in your app should stay fixed and not change based on region. When an App is registered, `baseUrl` from that initial descriptor is used for setting audience for all future authentication requests, independent of regions (it is possible to change it later, see [Changing Base URL](App-Descriptor.md#changing-base-url).
+
+Your "multi-region descriptor" should look something like this:
+```json
+{
+ // baseUrl - also treated as global path
+ "baseUrl": "foo.com/app/v1"
+ "regionalBaseUrls": {
+ "eu": "eu.foo.com/app/v1",
+ "ca": "ca.foo.com/app/v1"
+ }
+ //..
+}
+```
+
+> [!NOTE]
+> It is also acceptable to have the same URL in `baseUrl` as for one of regions in your `regionalBaseUrls` property.
+
+The `baseUrl` is treated as a global region URL and is still used in the following scenarios even if `regionalBaseUrls` is also defined:
+
+1. Health checks - the `/health` endpoint that is periodically invoked to check the health status of your app
+2. Version checks - the `/descriptor` endpoint that is periodically invoked to check for new versions(by the `version` property).
+ > [!NOTE]
+ > It is the developer's responsibility to keep the version of the regional instances in sync.
+3. `UPDATED` lifecycle event - explained below in the [Special Case](#special-case) section.
+
+The regional URLs from `regionalBaseUrl` are used in the following scenarios:
+
+1. `REGISTERED`/`UNREGISTERED` lifecycle events - each regional URL is invoked and `baseUrl`. If `baseUrl` is same as one of the regional URLs, the events will be sent only once for that URL, to avoid duplicating them.
+2. Tenant-based requests(if install was done with a region and not a `baseUrl` - region was available at the time of install):
+ 1. `INSTALLED`/`UNINSTALLED` lifecycle events
+ 2. GET/Update/Validate configuration
+ 3. Webhooks - if your app supports webhooks they will be sent to your regional URLs
+ 4. Extension endpoints
+
+### Examples
+
+If your app offers only a `baseUrl` with no `regionalBaseUrls`, for ex:
+```json
+...
+"baseUrl": "foo.com/app/v1"
+...
+```
+When someone will try to install it, they will see a popup informing them that the app does not provide data residency in the same region as them and will ask them to confirm if they want to proceed with installation.
+
+Let's see another example where only one region is specified:
+```json
+...
+"baseUrl": "foo.com/app/v1",
+"regionalBaseUrls": {
+ "ca": "ca.foo.com/app/v1"
+}
+...
+```
+If a user in Canada region tries to install the App, the installation will go per usual. If a user in Europe, tries to install it, the confirmation popup will show up because Europe is not specified explicitly.
+
+For the case were all currently supported regions are specified:
+```json
+...
+"baseUrl": "foo.com/app/v1"
+"regionalBaseUrls": {
+ "eu": "eu.foo.com/app/v1",
+ "ca": "ca.foo.com/app/v1"
+}
+...
+```
+When someone installs the app from Canada region or from Europe region, the installation will proceed as usual with no popups. If in the future a new region is introduced, but the app is not updated, users in the new region will be able to install the app but they will be met with the confirmation popup.
+
+`baseUrl` can be any valid url where calls will be processed as per documentation. Any of the following are valid:
+```json
+...
+"baseUrl": "foo.com/app/v1"
+"regionalBaseUrls": {
+ "eu": "eu.foo.com/app/v1",
+ "ca": "ca.foo.com/app/v1"
+}
+...
+```
+```json
+...
+"baseUrl": "eu.foo.com/app/v1"
+"regionalBaseUrls": {
+ "eu": "eu.foo.com/app/v1",
+ "ca": "ca.foo.com/app/v1"
+}
+...
+```
+```json
+...
+"baseUrl": "ca.foo.com/app/v1"
+"regionalBaseUrls": {
+ "eu": "eu.foo.com/app/v1",
+ "ca": "ca.foo.com/app/v1"
+}
+...
+```
+
+## Multi-Region on Fresh Apps
+
+Registering a new app that comes from the start with `regionalBaseUrls` will trigger the [REGISTERED event](./Lifecycle.md#registered-event) notifications for each regional base URL as well as for `baseUrl` if not already present in the `regionalBaseUrls`. The same pair of credentials will be sent to each URL.
+
+## Multi-Region on Existing Apps
+
+If your app has been registered without the `regionalBaseUrls` property it means it was only available globally via the `baseUrl` property.
+
+To add regional support you will have to include `regionalBaseUrls` in your descriptor. When Trados detects the new version it will sent the [REGISTERED event](./Lifecycle.md#registered-event) only to the regional URLs that have been added in that new version.
+
+The same pair of credentials that were initially sent to the `baseUrl` will also be sent to the regional URLs. It is necessary that all your app deployments know to handle the event and store the received credentials securely.
+
+### Special Case
+
+This section is for old add-ons(`decriptorVersion:1.3`) that have to be migrated to apps(`decriptorVersion:1.4`) and also want to support multi-region on the new version.
+
+As described in the [migration guide](./Add-On-To-App-Migration.md) when a descriptor with `decriptorVersion:1.4` is detected, Trados will send the `UPDATED` event with a new pair of credentials. This event will be sent globally(only to the `baseUrl`) as before.
+
+After the `UPDATED` event was successfully received by the app, Trados will also send the `REGISTERED` event for each of the regional base URLs with the same pair of credentials from the previously sent `UPDATED` event.
+
+## Recommendations
+
+To comply with data residency rules, make sure you provide instances for all supported regions, and your instances are physically in the specified region and there communication channel does not cross the region borders.
+
+Don't hard code the regions in your code. Make sure your code is flexible and can handle any new region. That way you will future proof your app as we are adding new regions.
+
+Decide on a primary region and set the `baseUrl` to that region url. That should simplify your deployment and configuration.
diff --git a/articles/Extensibility/docs/development/Preview-App-development-guide.md b/articles/Extensibility/docs/development/Preview-App-development-guide.md
new file mode 100644
index 0000000..49bc2a7
--- /dev/null
+++ b/articles/Extensibility/docs/development/Preview-App-development-guide.md
@@ -0,0 +1,377 @@
+---
+tags: [Development]
+stoplight-id: i7ib8ruwpxdxr
+---
+
+
+# Preview Provider
+
+## Introduction
+
+Preview apps offer the possibility to use external preview providers within the Trados Enterprise platform.
+
+The type of preview generated is known as "Dynamic Preview" as it can dynamically adjust depending on choices the user might make in the browser, for instance, selecting different preview sections or views from the rendered preview. The extension acts as a webserver which implements custom endpoints to serve the content to the browser. This content can be anything which the browser is able to parse and display accordingly.
+
+To build a new preview app we recommend to start by using the provided [app blueprints](https://github.com/RWS/language-cloud-extensibility/tree/main/blueprints).
+
+## Preview App Extension
+
+A preview app needs to define at least one preview extension within its [descriptor](../../api/Extensibility-API.v1-fv.html#/operations/descriptor).
+For example:
+
+```json
+{
+ ...
+ "extensions": [
+ {
+ "extensionPointId": "lc.previewprovider",
+ "id": "string",
+ "name": "string",
+ "description": "string",
+ "extensionPointVersion": "string",
+ "configuration": {
+ "endpoints": {
+ "lc.preview.startpreview": "string",
+ "lc.preview.refreshpreview": "string",
+ "lc.preview.updatesegment": "string",
+ "lc.preview.endpreview": "string"
+ },
+ "supportedFileTypes": "html",
+ "requiredInputFiles": {
+ "bilingualDocument": true,
+ "previewPackageTemplate": true,
+ "nativeFile": true,
+ "nativeAnnotatedFile": true
+ },
+ "outputType": "previewPackage"
+ }
+}
+ ]
+ ...
+}
+```
+
+- `id` - unique extension identifier provided by the app Developer.
+- `name` - provide a friendly and unique name. It might be shown to the end user, and may be useful to help the user distinguish between multiple extensions.
+- `extensionPointVersion` - the version of the extension point that is implemented in the Extension.
+- `extensionPointId` - the extension point identifier corresponding to this extensionType: **lc.previewprovider**.
+- `description` - the preview extension description
+- `configuration` - the extension configuration.
+ - `endpoints` - the required endpoints for the preview extension, should be relative to your `baseUrl`.
+ - `lc.previewprovider.startpreview` - the endpoint used to start the preview generation. For ex: `/start-preview`.
+ - `lc.previewprovider.refreshpreview` - the endpoint used to refresh the existing preview session. For ex: `refresh-preview`.
+ - `lc.previewprovider.updatesegment` - the endpoint used to update a segment based on a BCM document fragment. For ex: `update-segment`.
+ - `lc.previewprovider.endpreview` - the endpoint used to clean up any state associated with a given preview session. For ex: `end-preview`.
+ - `supportedFileTypes` - A list of FileTypeDefinitionIds which this app may be associated with
+ - `requiredInputFiles` - provides details about which types of input files this extension will require for generating a preview.
+ - `bilingualDocument` - request an endpoint for downloading a BCM document.
+ - `previewPackageTemplate` - request an endpoint for downloading a preview Package Template.
+ - `nativeFile` - request an endpoint for downloading a native file.
+ - `nativeAnnotatedFile` - request an endpoint for downloading a native annotated file.
+ - `outputType` - Indicates which type of output is generated by the extension. For v1, this can be "previewPackage" for package-based previews or "previewUrl" for dynamic URL-based previews.
+
+### Preview App Endpoints
+
+#### StartPreview
+The _startPreview_ endpoint initiates a background preview generation session
+and returns after creating the background worker which generates the actual preview. The result is sent via calling the URL set in the `callbackUrl` field. An important field is the `previewSessionId` which indicates the session this preview is associated with.
+
+If the app needs to store any state, it should associate it with this identifier. The very first call for a given session should always be _startPreview_. If other endpoints are called before this, they should return an error.
+
+If the app is generating a previewPackage or standalone HTML result, it should be uploaded via the URL defined in the `previewResultFileUrl` field.
+The resulting resource identifier returned from this call should be set in the `previewResult` field of the callback response.
+
+For dynamic previews (outputType: "previewUrl"), the preview content is served by the app via one or more endpoints the app implements. The content can be any format, as long as the browser hosting the preview can parse and display that content. This includes HTML, PDF, streamed video etc. The resulting URL returned from this call should be set in the `previewResult` field of the callback response.
+
+ Example:
+```html
+POST https://your-app.com/start-preview
+```
+
+- The request is as follows:
+
+```json
+{
+ "previewSessionId": "string",
+ "fileInformation": {
+ "name": "string",
+ "sourceLanguage": "string",
+ "targetLanguage": "string"
+ },
+ "inputFiles": {
+ "bilingualDocumentUrl": "string",
+ "previewPackageTemplateUrl": "string",
+ "nativeFileUrl": "string",
+ "nativeAnnotatedFileUrl": "string"
+ },
+ "previewResultFileUrl": "string",
+ "callbackUrl": "string",
+ "scope": "source"
+}
+```
+- The response after setting up the background worker, would look like this:
+```json
+{
+ "errorCode": "string",
+ "message": "string",
+ "details": [
+ {
+ "name": "string",
+ "code": "string",
+ "value": "string"
+ }
+ ]
+}
+```
+
+- The final result, which is sent on the callback, is shown below:
+
+```json
+{
+ "previewSessionId": "string",
+ "previewResult": "string",
+ "errors": [
+ {
+ "errorCode": "string",
+ "message": "string",
+ "details": [
+ {
+ "name": "string",
+ "code": "string",
+ "value": "string"
+ }
+ ]
+ }
+ ]
+}
+```
+
+Endpoint usage:
+
+This endpoint is used to initiate a preview session on the app. When this endpoint is called, the app should generate the initial preview and associate it (internally, if any state is kept) - with the `previewSessionId`.
+
+This should be the first endpoint called for any given session - if another endpoint is called for a given session ID before this one, an error should be returned.
+
+
+Please refer to the endpoint's [documentation](../../api/Extensibility-API.v1-fv.html#/operations/StartPreview) for further details.
+
+#### RefreshPreview
+The _refreshPreview_ endpoint refreshes an existing preview. The mechanism for this in entirely up to the Extension implementation in that it might keep state from the initial preview generation from _startPreview_ in order to speed up the refresh.
+
+The request and responses (REST and Callback) are identical to the _startPreview_ endpoint.
+
+ Example:
+```html
+POST https://your-app.com/refresh-preview
+```
+
+Endpoint usage:
+This endpoint is called when a preview refresh is requested by the user. Any state the app holds from the initial preview generation may be used to speed up the refresh.
+
+Please refer to the endpoint's [documentation](../../api/Extensibility-API.v1-fv.html#/operations/RefreshPreview) for further details.
+
+#### UpdateSegment
+The _updateSegment_ endpoint accepts a list of BCM document fragments along with their associated segment IDs. The Extension will generate and return an HTML rendered fragment for each BCM document fragment sent in this manner.
+
+Example:
+```html
+POST https://your-app.com/update-segment
+```
+
+- The request is as follows:
+
+```json
+{
+ "previewSessionId": "string",
+ "segments": [
+ {
+ "segmentId": "string",
+ "fragment": {}
+ }
+ ],
+ "fileInformation": {
+ "name": "string",
+ "sourceLanguage": "string",
+ "targetLanguage": "string"
+ },
+ "scope": "source"
+}
+```
+- `previewSessionId` - unique ID of current preview session.
+- `segments` - an array of segments with the following details:
+ - `segmentId` - ID of segment being rendered.
+ - `fragment` - BCM document JSON fragment.
+- `fileInformation` - provides information relating to the file for which the rendered HTML is being generated.
+- `scope` - indicates whether the generation is happening for source or target content.
+
+- The response would look like this:
+```json
+{
+ "previewSessionId": "string",
+ "renderedTranslations": [
+ {
+ "html": "string",
+ "segmentId": "string",
+ "errorCode": "string"
+ }
+ ]
+}
+```
+- `previewSessionId` - unique ID of current preview session.
+- `renderedTranslations` - an array of rendered translations with the following details:
+ - `html` - rendered HTML content for this segment.
+ - `segmentId` - ID of this segment.
+ - `errorCode` - Error code for this segment (App/Extension specific).
+
+Endpoint usage:
+This endpoint is called when the user is updating one or more segments in the Editor. For each segment, the extension will render an equivalent HTML fragment based on the input BCM document fragment.
+
+Please refer to the endpoint's [documentation](../../api/Extensibility-API.v1-fv.html#/operations/UpdateSegment) for further details.
+
+#### EndPreview
+The _endPreview_ endpoint is called when a given preview session associated with the previewSessionId is finished. This is called so that the app may perform any required cleanup.
+
+Example:
+```html
+POST https://your-app.com/end-preview
+```
+
+```json
+{
+ "previewSessionId": "string"
+}
+```
+
+Endpoint usage:
+Called to indicate a preview session has terminated. Any required cleanup should be performed by the app.
+
+Please refer to the endpoint's [documentation](../../api/Extensibility-API.v1-fv.html#/operations/EndPreview) for further details.
+
+### Javascript Communication Protocol
+
+The Online Editor Container communicates with the Preview Viewer iframe using the Javascript postMessage mechanism. The API is detailed below:
+
+```javascript
+"use strict";
+
+/* Communication Protocol between the RWS Online Editor and the preview loaded into it.
+ *
+ * Based on passing global events back and forth (events on the window object).
+ * Used for:
+ *
+ * - navigation from one segment to the other (either happening on the editor and
+ * getting propagated to the preview, or happening on the preview - by clicking
+ * a segment - and getting propagated to the editor)
+ *
+ * - segment updates: when the translation for a segment changes, the segment
+ * update flow will yield some piece of string (usually html content) that
+ * will be sent to the preview currently being loaded in the editor
+ *
+ * - showing messages (could not navigate to the segment currently selected
+ * in editor / cannot update the translation for certain segment)
+ */
+
+ // IE compatibility
+ Element.prototype.remove = function () {
+ this.parentElement.removeChild(this);
+}
+
+if (!window.sdlPreviewScriptIncludeGuard) {
+ // when the preview package gets inlined into a single html file, the script can
+ // get included multiple times; we use this guard to only subscribe to the events
+ // once
+ window.sdlPreviewScriptIncludeGuard = true;
+
+ //state
+ var selectedSegmentId = "";
+ var segmentIdToSigCache = {};
+ var initialized = false;
+
+ // names of the events
+ var PREVIEW_SEGMENT_SELECTED = "Preview:segmentSelected";
+ var PREVIEW_SHOW_MESSAGE = "Preview:showMessage";
+ var UE_SEGMENT_SELECTED = "UE:segmentSelected";
+ var UE_UPDATE_SEGMENT = "UE:updateSegment";
+
+ document.addEventListener("DOMContentLoaded", function (event) {
+ /* preparations can be done here */
+ });
+
+ window.addEventListener(UE_SEGMENT_SELECTED, function (event) {
+ // event.detail will contain the id of the segment we need to navigate to
+ // the segment with this id can be highlighted and scrolled into view
+
+ // if the segment cannot be highlighted on the preview:
+ reportError("CannotNavigateToSegment");
+ });
+
+ window.addEventListener(UE_UPDATE_SEGMENT, function(event) {
+ // the id of the segment being updated
+ var segmentId = event.detail.segmentId;
+
+ // the string (html snippet) returned by the segment updater
+ var segmentSnippet = event.detail.snippet;
+
+ /* the contents of the corresponding page element can be changed
+ * here according to the snippet
+ */
+
+ // if the update cannot be done:
+ reportError("PreviewCannotUpdate");
+ });
+}
+
+function reportError(type) {
+ // types currently being used are "CannotNavigateToSegment" and "PreviewCannotUpdate"
+ // TBD if we can support custom messages being sent in the detail attribute here
+
+ window.dispatchEvent(new CustomEvent(
+ PREVIEW_SHOW_MESSAGE,
+ { detail: type }
+ ));
+}
+
+function somethingWasClicked() {
+ // can be handler of onclick on page elements corresponding to segments
+
+ var previousSelection = "...";
+ var segmentId = "...";
+
+ if (segmentId !== previousSelection) {
+ window.dispatchEvent(new CustomEvent(
+ PREVIEW_SEGMENT_SELECTED,
+ { detail: segmentId } // this informs the editor which segment it should navigate to
+ ));
+ }
+}
+```
+
+For dynamic previews, a more comprehensive Javascript API is available that handles communication via postMessage between the iframe and the Online Editor. This includes:
+- Navigation between segments
+- Segment updates with translation changes
+- Error messaging
+- Scroll synchronization for side-by-side preview
+- Segment highlighting and selection
+
+### Session Management and Tenant Separation
+It is up to the app to manage any session state internally and have an expiry mechanism for this.
+Also, any data which is tenant specific needs to be kept separate from any other data and the app also needs to manage tenant separation concerns internally.
+
+### Input Files
+The preview provider works with various types of input files:
+- **PreviewPackageTemplate** - a zip package containing content used in preview generation (XML, HTML, images, CSS, XSLT, Javascript etc.)
+- **Native File** - the native format being translated or previewed (Word, Excel, XML documents etc.)
+- **Annotated Native File** - a native file annotated with special characters encoding segment identifiers and boundaries
+
+### Dynamic Preview Concepts (for outputType: "previewUrl")
+When implementing dynamic previews:
+- The app acts as a web server implementing custom endpoints
+- TLS (Transport Layer Security) must be enabled on all custom endpoints
+- Authorization via hard-to-guess access tokens with TTL support
+- Content can be dynamically updated based on user selections
+- Support for different renderings or views of the same BCM document content
+
+The URL format for dynamic preview endpoints:
+```
+https://my.extension/custom-endpoint?sessionId={sessionId}&tenant={tenantId}&accessToken={hard-to-guess-access-token}&page={pageId}
+```
\ No newline at end of file
diff --git a/articles/Extensibility/docs/development/Request-Authentication.md b/articles/Extensibility/docs/development/Request-Authentication.md
new file mode 100644
index 0000000..9425ea8
--- /dev/null
+++ b/articles/Extensibility/docs/development/Request-Authentication.md
@@ -0,0 +1,91 @@
+# Request Authentication
+
+Requests made from Trados to the app are authenticated, except for some public endpoints on the app. Getting the current account identity is explained in this article in the [**Trados Claims** section](#trados-claims).
+
+## Endpoints
+
+All but a few of the endpoints are required to check for valid Authentication. The API documentation specifies for each endpoint if authentication is required.
+
+Trados might send the Authorization header even on the endpoints that do not need authentication, but the app is not required to validate them. If the header is sent, the app should either ignore it or validate it. But if the token is not valid, then this should result in a 401/403 result.
+
+> [!NOTE]
+> Note: the provided blueprints (both Java and .NET Core) have authentication implemented and working out of the box. You can skip the rest of this document unless you're interested in the technical details.
+
+## Authorization header
+
+The HTTPS requests are all authenticated using the `x-lc-signature` header using a JWS token. For example:
+
+```
+x-lc-signature: | Section | +View | +Location key | +Supported element types | +Default on-render selector keys | +Notes | +
|---|---|---|---|---|---|
| Inbox | +Tasks list | +
+ tasks-list-tabpanel
+ 
+ |
+ tab | ++ | + |
| New tasks list | +
+ new-tasks-list-sidebar
+ 
+ |
+ sidebarBox | +inboxActiveTab, selectedNewTasks | ++ | |
+ new-tasks-list-toolbar
+ 
+ |
+ button | +inboxActiveTab, newTaskPreview | ++ | ||
| Active tasks list | +
+ active-tasks-list-toolbar
+ 
+ |
+ button | +inboxActiveTab, selectedActiveTasks | ++ | |
+ active-tasks-list-sidebar
+ 
+ |
+ sidebarBox | +inboxActiveTab, activeTaskPreview | ++ | ||
| Completed tasks list | +
+ completed-tasks-list-toolbar
+ 
+ |
+ button | +inboxActiveTab, selectedCompletedTasks | ++ | |
+ completed-tasks-list-sidebar
+ 
+ |
+ sidebarBox | +inboxActiveTab, completedTaskPreview | ++ | ||
| Task | +
+ task-toolbar
+ 
+ |
+ button | +taskActiveTab, task | ++ | |
+ task-tabpanel
+ 
+ |
+ tab | +taskActiveTab, task | ++ | ||
+ task-sidebar
+ 
+ |
+ sidebarBox | +taskActiveTab, task | ++ | ||
+ task-details-toolbar
+ 
+ |
+ button | +taskActiveTab, task | ++ | ||
+ task-details-main
+ 
+ |
+ panel | +taskActiveTab, task | ++ | ||
+ task-files-toolbar
+ 
+ |
+ button | +taskActiveTab, task | ++ | ||
| Orders | +Orders list | +
+ orders-list-tabpanel
+ 
+ |
+ tab | ++ | + |
| Projects | +Projects list | +
+ projects-list-tabpanel
+ 
+ |
+ tab | ++ | + |
+ projects-list-toolbar
+ 
+ |
+ button | +selectedProjects | ++ | ||
+ project-details-dashboard-sidebar *
+ 
+ |
+ sidebarBox | +projectDetailsActiveTab, projectDetails | +element visible in two views | +||
| Project | +
+ project-details-toolbar
+ 
+ |
+ button | +projectDetailsActiveTab, projectDetails | ++ | |
+ project-details-tabpanel
+ 
+ |
+ tab | +projectDetailsActiveTab, projectDetails | ++ | ||
+ project-details-dashboard-toolbar
+ 
+ |
+ button | +projectDetailsActiveTab, projectDetails | ++ | ||
+ project-details-dashboard-main
+ 
+ |
+ panel | +projectDetailsActiveTab, projectDetails | ++ | ||
|
+ project-details-dashboard-sidebar *
+
+ |
+ sidebarBox | +projectDetailsActiveTab, projectDetails | +element visible in two views | +||
+ project-details-stages-toolbar
+ 
+ |
+ button | +projectDetailsActiveTab, projectDetails, projectStages | ++ | ||
+ project-details-files-toolbar
+ 
+ |
+ button | +projectDetailsActiveTab, projectDetails, projectFiles | ++ | ||
+ project-details-task-history-toolbar
+ 
+ |
+ button | +projectDetailsActiveTab, projectDetails, projectTaskHistory | ++ | ||
+ project-details-task-history-sidebar
+ 
+ |
+ sidebarBox | +projectDetailsActiveTab, projectDetails, projectTaskHistory | ++ | ||
| Reports | +Reports list | +
+ reports-list-tabpanel
+ 
+ |
+ tab | ++ | + |
\nSee https://datatracker.ietf.org/doc/html/rfc7517 for details.", + "properties": { + "kty": { + "type": "string", + "description": "The cryptographic algorithm\n family used with the key." + }, + "n": { + "type": "string", + "description": "The RSA public modulus n." + }, + "e": { + "type": "string", + "description": "The RSA public exponent e." + }, + "alg": { + "type": "string", + "description": "The algorithm intended for use with the key." + }, + "kid": { + "type": "string", + "description": "The \"kid\" (key ID) parameter is used to match a specific key." + }, + "use": { + "type": "string", + "description": "The \"use\" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data." + } + }, + "x-internal": false + }, + "error-response": { + "title": "Error Response", + "type": "object", + "description": "Error response properties.", + "properties": { + "message": { + "type": "string", + "description": "Retrieves a descriptive message that shows what went wrong." + }, + "errorCode": { + "type": "string", + "description": "Concise code that describes the nature of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/components/schemas/error-detail-response" + } + } + }, + "required": [ + "message", + "errorCode" + ] + }, + "error-detail-response": { + "title": "Error Detail Response", + "type": "object", + "description": "Error detail response properties.", + "properties": { + "name": { + "type": "string", + "description": "" + }, + "code": { + "type": "string", + "description": "" + }, + "value": { + "type": "string" + } + } + }, + "well-known-jwks-response": { + "title": "Well Known Keys Response", + "x-stoplight": { + "id": "sf68ge9zrow9r" + }, + "type": "object", + "properties": { + "keys": { + "$ref": "#/components/schemas/list-jwks", + "description": "The list of public keys." + } + }, + "x-internal": false + }, + "list-my-accounts-response": { + "title": "List My Accounts Response", + "type": "object", + "properties": { + "itemCount": { + "type": "integer" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/account" + } + } + }, + "required": [ + "itemCount", + "items" + ], + "description": "A response for the List My Accounts endpoint.", + "x-internal": false + }, + "account": { + "title": "Account", + "type": "object", + "required": [ + "id", + "regionCode" + ], + "properties": { + "id": { + "type": "string", + "description": "The account identifier." + }, + "name": { + "type": "string", + "description": "
default
The account name.
",
+ "x-default-field": true
+ },
+ "regionCode": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "tp3uu68nb4946"
+ },
+ "description": "Region code that uniquely identifies the region."
+ }
+ },
+ "x-internal": false
+ }
+ },
+ "headers": {
+ "X-LC-TraceId": {
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "df680285-adcd-4bda-8f79-0bba4a857287"
+ },
+ "description": "A unique identifier for the request. It should be saved in the logs as it can be used to troubleshoot potential issues. When raising a request for support, it should be provided to help with the investigation."
+ }
+ },
+ "parameters": {
+ "Authorization": {
+ "name": "Authorization",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "The bearer access token provided by Auth0."
+ },
+ "X-LC-Tenant": {
+ "name": "X-LC-Tenant",
+ "in": "header",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "The identifier of the account where the request is executed."
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/articles/LCPublicAPI/api/Global-Public-API.v1.md b/articles/LCPublicAPI/api/Global-Public-API.v1.md
new file mode 100644
index 0000000..af734d3
--- /dev/null
+++ b/articles/LCPublicAPI/api/Global-Public-API.v1.md
@@ -0,0 +1,23 @@
+---
+title: "Global Public API Documentation"
+_disableBreadcrumb: false
+_disableAffix: true
+_enableSearch: false
+_disableToc: false
+---
+
+
+
+
+
+
+
+\r\nA default configuration will be used if not specified." + }, + "quotingOptions": { + "type": "object", + "x-stoplight": { + "id": "5l3iznluoo6kn" + }, + "description": "Set these resources to calculate an estimated translation cost.", + "required": [ + "pricingModelId", + "targetLanguages" + ], + "properties": { + "pricingModelId": { + "type": "string", + "x-stoplight": { + "id": "5rf92aw1gkge2" + }, + "description": "The identifier of the Pricing Model to be used when calculating the cost." + }, + "targetLanguages": { + "type": "array", + "x-stoplight": { + "id": "vyfoxy7wp48vl" + }, + "description": "The target languages for which the cost will be calculated.", + "items": { + "$ref": "#/components/schemas/target-language-request", + "x-stoplight": { + "id": "pwvr1t18i9dym" + } + } + } + } + } + } + } + } + } + }, + "description": "This endpoint allows you to request the word count and an estimated cost for your files. \r\n\r\nUse the [Upload Zip File](#/operations/UploadZipFile) / [Poll Upload Zip File](#/operations/PollUploadZipFile) endpoints to upload your files and get the `fileIds`. Send these `fileIds` together with the `languageProcessingRuleId` and `sourceLanguage` to receive the word count.\r\n\r\nOptionally, send the `quotingOptions` object to receive the `estimatedCosts`.\r\n\r\nUse the [Poll File Analysis](#/operations/PollFileAnalysis) endpoint to monitor the operation and receive the analysis results.\r\n\r\n> File analysis results will be available for 24 hours after generation.", + "tags": [ + "File" + ] + }, + "parameters": [] + }, + "/files/analysis/{operationId}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "operationId", + "in": "path", + "required": true, + "description": "The file analysis operation identifier." + } + ], + "get": { + "summary": "Poll File Analysis", + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/file-analysis-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\r\n* “invalid”: invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\r\n* \"forbidden\": the authenticated user is not allowed to read resource.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\r\n* \"notFound\": the quoting operation could not be found.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "operationId": "PollFileAnalysis", + "x-stoplight": { + "id": "8iqm2m3c577th" + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "description": "Monitor the [File Analysis](#/operations/RequestFileAnalysis) operation and receive the analysis results.\r\n\r\n> File analysis results will be available for 24 hours after generation.", + "tags": [ + "File" + ] + } + }, + "/files/{fileId}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "fileId", + "in": "path", + "required": true, + "description": "The uploaded file id" + } + ], + "get": { + "summary": "Poll Upload Zip File", + "operationId": "PollUploadZipFile", + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/file-metadata-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read uploaded files.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the file could not be found by id.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "description": "Monitors the unzipping operation for a previously uploaded archive and retrieves details about the extracted files.\r\n\r\nOnce the [Upload Zip File](#/operations/UploadZipFile) operation has finished extracting the files, they can be added to the desired project using the [Attach Source Files](#/operations/AddSourceFiles) endpoint.\r\n Alternatively, they can be used to [Request File Analysis](#/operations/RequestFileAnalysis) details like word counts and estimated costs.\r\n", + "tags": [ + "File" + ] + } + }, + "/folders/{folderId}": { + "get": { + "tags": [ + "Folder" + ], + "summary": "Get Folder", + "description": "Retrieves a folder by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/folder" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the folder.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the Folder could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetFolder" + }, + "parameters": [ + { + "$ref": "#/components/parameters/folderId" + } + ] + }, + "/folders/root": { + "get": { + "tags": [ + "Folder" + ], + "summary": "Get Root Folder", + "description": "Retrieves the Root folder in the account.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/folder" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetRootFolder" + } + }, + "/folders": { + "get": { + "tags": [ + "Folder" + ], + "summary": "List Folders", + "description": "Retrieves a list of all the folders in an account. Max 500.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "name": "name", + "in": "query", + "description": "Filter folders by name.", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-folders-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListFolders" + } + }, + "/groups/{groupId}": { + "get": { + "tags": [ + "Group" + ], + "summary": "Get Group", + "description": "Retrieves a group by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/group" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the Group.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the Group could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetGroup" + }, + "parameters": [ + { + "$ref": "#/components/parameters/groupId" + } + ] + }, + "/groups": { + "get": { + "tags": [ + "Group" + ], + "summary": "List Groups", + "description": "Retrieves a list of all the groups in an account.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-groups-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListGroups" + } + }, + "/languages": { + "get": { + "tags": [ + "Language" + ], + "summary": "List Languages", + "description": "Retrieves a list of all the languages.\n\nThe supported values for language `type` filter are: \"all\", \"specific\" or \"neutral\".\\\nThe \"neutral\" languages are the generic languages, e.g.: en -> English.\\\nThe \"specific\" languages are the sub-languages, e.g.: en-150 -> English (Europe), en-us -> English (United States).", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "name": "languageCodes", + "in": "query", + "description": "Filter by language codes.", + "style": "form", + "explode": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "name": "type", + "in": "query", + "description": "Filter by type.", + "schema": { + "type": "string", + "enum": [ + "all", + "specific", + "neutral" + ], + "example": "specific" + } + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-languages-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "operationId": "ListLanguages" + } + }, + "/language-processing-rules": { + "get": { + "summary": "List Language Processing Rules", + "tags": [ + "Language Processing" + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-language-processing-rules" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListLanguageProcessingRules", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "description": "Returns a list of Language Processing Rules." + } + }, + "/language-processing-rules/{languageProcessingRuleId}": { + "get": { + "summary": "Get Language Processing Rule", + "tags": [ + "Language Processing" + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/language-processing-rule" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetLanguageProcessingRule", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "description": "Returns a Language Processing Rule by identifier." + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "languageProcessingRuleId", + "in": "path", + "required": true, + "description": "The language processing rule identifier" + } + ] + }, + "/perfect-match-mappings": { + "post": { + "summary": "Create PerfectMatch Mapping", + "tags": [ + "PerfectMatch Mapping" + ], + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/perfect-match-mapping-create-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes: \r\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\r\n* \"missing\": Missing required field for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes: \r\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\r\n* \"notFound\": the resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\r\n* \"conflict\": the project has no source files.", + "content": { + "application/json": { + "schema": { + "type": "object", + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "CreatePerfectMatchMapping", + "x-stoplight": { + "id": "thyh9npsnqozm" + }, + "description": "For more details on the PerfectMatch feature please consult the [official documentation](https://docs.rws.com/791595/1155478/trados-enterprise---accelerate/perfectmatch-general-information).\r\n\r\nAfter creating a mapping, target files from the `matchingProjects` are automatically matched to the source files in the new project. This is a long-running background operation, and its `status` can be tracked by polling the [Get PerfectMatch Mapping](#/operations/GetPerfectMatchMapping) endpoint.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/perfect-match-mapping-create-request" + } + } + }, + "description": "" + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ] + }, + "parameters": [] + }, + "/perfect-match-mappings/{mappingId}": { + "get": { + "summary": "Get PerfectMatch Mapping", + "tags": [ + "PerfectMatch Mapping" + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/perfect-match-mapping-response" + } + } + } + }, + "400": { + "description": "Error codes: \r\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes: \r\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\r\n* \"notFound\": the resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetPerfectMatchMapping", + "description": "Retrieves the details of a PerfectMatch mapping.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "x-stoplight": { + "id": "gypb1u4fb5r8v" + } + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "mappingId", + "description": "The mapping identifier", + "in": "path", + "required": true + } + ] + }, + "/perfect-match-mappings/{mappingId}/batch-mappings": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "mappingId", + "description": "The mapping identifier", + "in": "path", + "required": true + } + ], + "post": { + "summary": "Add PerfectMatch Batch Mapping", + "tags": [ + "PerfectMatch Mapping" + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/perfect-match-mapping-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes: \r\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes: \r\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\r\n* \"notFound\": the resource could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "409": { + "description": "Error codes: \r\n* “conflict”: A pending batch mapping already exists.", + "content": { + "application/json": { + "schema": { + "type": "object", + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "AddPerfectMatchBatchMapping", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/perfect-match-batch-mapping-update-request" + } + } + } + }, + "description": "Adds a new PerfectMatch batch mapping.\r\n\r\nWhen new source files are introduced to a mid-project, a new batch must be added to the current mapping to leverage PerfectMatch. This action triggers a background operation that identifies matching candidates for the newly added files.", + "x-stoplight": { + "id": "ojtqa1eu0nop1" + } + } + }, + "/perfect-match-mappings/{mappingId}/batch-mappings/{batchMappingId}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "mappingId", + "description": "The mapping identifier", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "batchMappingId", + "in": "path", + "required": true, + "description": "The batch mapping identifier" + } + ], + "put": { + "summary": "Update PerfectMatch Batch Mapping", + "tags": [ + "PerfectMatch Mapping" + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes: \r\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes: \r\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\r\n* \"notFound\": the resource could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "409": { + "description": "Error codes:\r\n* \"updateNotAllowed\": the resource could not be updated at this time.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "operationId": "UpdatePerfectMatchBatchMapping", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/perfect-match-batch-mapping-update-request" + } + } + } + }, + "description": "Updates a PerfectMatch batch mapping.\r\n\r\nPay special attention to how [updating works](../docs/Updating-data-with-PUT.html).", + "x-stoplight": { + "id": "k414o2pdrvauv" + } + } + }, + "/perfect-match-mappings/{mappingId}/batch-mappings/{batchMappingId}/file-mappings/{fileMappingId}/project-file": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "mappingId", + "description": "The mapping identifier", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "batchMappingId", + "description": "The batch mapping identifier", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "fileMappingId", + "description": "The file mapping identifier", + "in": "path", + "required": true + } + ], + "put": { + "summary": "Update File Mapping With Project File", + "tags": [ + "PerfectMatch Mapping" + ], + "responses": { + "204": { + "description": "", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": {} + }, + "400": { + "description": "Error codes: \r\n* \"missing\": Missing required field for the value mentioned in the \"name\" field on the error response.\r\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes: \r\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\r\n* \"notFound\": the resource could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "operationId": "UpdatePerfectMatchFileMappingWithProjectFile", + "x-stoplight": { + "id": "7v7r948reznq7" + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/perfect-match-project-file-mapping-request" + } + } + } + }, + "description": "Updates a PerfectMatch file mapping with an existing target file from a PerfectMatch candidate. Only valid candidates can be used to request an update.\r\n\r\nUse the [Candidates](#/operations/GetPerfectMatchCandidates) endpoint to retrieve a list of valid `fileId` and `projectId` to provide as matching data. " + } + }, + "/perfect-match-mappings/{mappingId}/batch-mappings/{batchMappingId}/file-mappings/{fileMappingId}/file": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "mappingId", + "description": "The mapping identifier", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "batchMappingId", + "description": "The batch mapping identifier", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "fileMappingId", + "description": "The file mapping identifier", + "in": "path", + "required": true + } + ], + "post": { + "summary": "Update File Mapping With Manually Uploaded File", + "tags": [ + "PerfectMatch Mapping" + ], + "responses": { + "204": { + "description": "", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes: \r\n* \"missing\": Missing required field for the value mentioned in the \"name\" field on the error response.\r\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes: \r\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\r\n* \"notFound\": the resource could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "operationId": "UpdatePerfectMatchFileMappingWithManuallyUploadedFile", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/perfect-match-custom-file-mapping-request" + } + } + } + }, + "description": "Updates a PerfectMatch file mapping with a manually uploaded file.", + "x-stoplight": { + "id": "l5u5ir8uz9kr" + } + } + }, + "/perfect-match-mappings/{mappingId}/batch-mappings/{batchMappingId}/file-mappings/{fileMappingId}/target-languages/{targetLanguage}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "mappingId", + "description": "The mapping identifier", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "batchMappingId", + "description": "The batch mapping identifier", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "fileMappingId", + "description": "The file mapping identifier", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "targetLanguage", + "description": "The target language code", + "in": "path", + "required": true + } + ], + "delete": { + "summary": "Delete PerfectMatch File Mapping For a File", + "tags": [ + "PerfectMatch Mapping" + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes: \r\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\r\n* \"notFound\": the resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "DeletePerfectMatchFileMappingForFile", + "x-stoplight": { + "id": "hzhi7qsfd975q" + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "description": "Deletes a PerfectMatch file mapping for a specific file and target language." + } + }, + "/perfect-match-mappings/{mappingId}/batch-mappings/{batchMappingId}/file-mappings/{fileMappingId}/target-languages/{targetLanguage}/candidates": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "mappingId", + "description": "The mapping identifier", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "batchMappingId", + "description": "The batch mapping identifier", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "fileMappingId", + "description": "The file mapping identifier", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "targetLanguage", + "description": "The target language code", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Get PerfectMatch Candidates", + "description": "Retrieves a list of file candidates that can be selected for PerfectMatch.", + "tags": [ + "PerfectMatch Mapping" + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-perfect-match-candidates-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes: \r\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes: \r\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\r\n* \"notFound\": the resource could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "operationId": "GetPerfectMatchCandidates", + "x-stoplight": { + "id": "fbia0pjkxv11t" + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ] + } + }, + "/machine-translation": { + "parameters": [], + "get": { + "summary": "List Machine Translations", + "operationId": "ListMachineTranslations", + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-machine-translations-response" + } + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "description": "Retrieves a list of machine translations that can be used in a translation engine.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "sourceLanguage", + "required": true, + "description": "Language code expressed as generic language (example: \"en\") or specific language (example: \"en-US\")" + }, + { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "in": "query", + "name": "targetLanguage", + "required": true, + "description": "List of language codes separated by comma, values can be generic language code or specific language code." + } + ], + "tags": [ + "Machine Translation" + ], + "x-stoplight": { + "id": "pnd31f3gjids8" + } + } + }, + "/pricing-models": { + "get": { + "tags": [ + "Pricing Model" + ], + "summary": "List Pricing Models", + "description": "Retrieves a list of all the pricing models in an account.\r\n\r\nSorting is supported for the following fields: `name`, `description`, `currencyCode` and `location`.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-pricing-models-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListPricingModels" + }, + "post": { + "summary": "Create Pricing Model", + "tags": [ + "Pricing Model" + ], + "responses": { + "201": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pricing-model" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\r\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\r\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\r\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\r\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response. \r\n", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\r\n* “forbidden”: The authenticated user is not allowed to create the pricing model\r\n", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "operationId": "CreatePricingModel", + "x-stoplight": { + "id": "5xf6yyxydnib9" + }, + "description": "Creates a new pricing model.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pricing-model-create-request" + } + } + } + } + } + }, + "/pricing-models/{pricingModelId}": { + "get": { + "tags": [ + "Pricing Model" + ], + "summary": "Get Pricing Model", + "description": "Retrieves a pricing model by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pricing-model" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the pricing model.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetPricingModel" + }, + "parameters": [ + { + "$ref": "#/components/parameters/pricingModelId" + } + ], + "put": { + "summary": "Update Pricing Model", + "tags": [ + "Pricing Model" + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\r\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\r\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\r\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\r\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\r\n* \"missing\": Missing required field for the value mentioned in the \"name\" field on the error response. ", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\r\n* \"forbidden\": the authenticated user is not allowed to update the pricing model.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\r\n* \"notFound\": the pricing model could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "operationId": "UpdatePricingModel", + "x-stoplight": { + "id": "519y1mm5q2twn" + }, + "description": "Updates a pricing model.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pricing-model-update-request" + } + } + } + } + }, + "delete": { + "summary": "Delete Pricing Model", + "tags": [ + "Pricing Model" + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\r\n* \"forbidden\": the authenticated user is not allowed to delete the pricing model.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\r\n* \"notFound\": the pricing model could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "DeletePricingModel", + "x-stoplight": { + "id": "48vkxmoxbdoz0" + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "description": "Deletes a pricing model." + } + }, + "/projects": { + "get": { + "tags": [ + "Project" + ], + "summary": "List Projects", + "description": "Retrieves a list of all the projects in the account.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "schema": { + "type": "boolean" + }, + "in": "query", + "name": "excludeOnline", + "description": "Excludes projects that are being worked on exclusively in the Online Editor" + }, + { + "schema": { + "type": "string", + "enum": [ + "created", + "inProgress", + "completed", + "archived" + ] + }, + "in": "query", + "name": "status", + "description": "Filter the list to include projects that have this status." + }, + { + "schema": { + "type": "string", + "format": "date-time", + "example": "2022-11-28T16:46:00.00Z" + }, + "in": "query", + "name": "createdFrom", + "description": "Filter the list to include only projects created after the specified date and time." + }, + { + "schema": { + "type": "string", + "format": "date-time", + "example": "2022-11-28T16:46:00.00Z" + }, + "in": "query", + "name": "createdTo", + "description": "Filter the list to include only projects created before the specified date and time." + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "createdBy", + "description": "Filter the list of projects to projects that were created by this user." + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "projectTemplateId", + "description": "Filter the list of projects to projects that were created using this project template." + }, + { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "in": "query", + "name": "projectIds", + "description": "Filter the list of projects to projects have these project identifiers." + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "sourceLanguage", + "description": "Filter the list of projects to projects that were created using this source language." + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "targetLanguage", + "description": "Filter the list of projects to projects that were created using this target language." + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "projectName", + "description": "Filter the list of projects to projects that were created using this project name." + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "dueFrom", + "description": "Filter the list of projects to projects that are due after this date and time.
Accepted format: ISO-8601 `YYYY-MM-DDThh:mm:ss.sssZ`" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "dueTo", + "description": "Filter the list of projects to projects that are due before this date and time.
Accepted format: ISO-8601 `YYYY-MM-DDThh:mm:ss.sssZ`" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "lastModifiedFrom", + "description": "Filter the list of projects to projects that are last modified after this date and time.
Accepted format: ISO-8601 `YYYY-MM-DDThh:mm:ss.sssZ`" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "lastModifiedTo", + "description": "Filter the list of projects to projects that are last modified before this date and time.
Accepted format: ISO-8601 `YYYY-MM-DDThh:mm:ss.sssZ`" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-projects-response" + }, + "examples": { + "numbers": { + "value": { + "itemCount": 1, + "items": [ + { + "id": "test-id", + "quote": { + "additionalCosts": [ + { + "name": "test-additional-cost-name", + "count": 1, + "runningTotal": 1 + } + ] + } + } + ] + } + }, + "missing-required-integer": { + "value": { + "items": [ + { + "id": "test-id", + "quote": { + "additionalCosts": [ + { + "name": "test-additional-cost-name", + "count": 1, + "runningTotal": 1 + } + ] + } + } + ] + } + }, + "missing-optional-integer": { + "value": { + "itemCount": 1, + "items": [ + { + "id": "test-id", + "quote": { + "additionalCosts": [ + { + "name": "test-additional-cost-name", + "runningTotal": 1 + } + ] + } + } + ] + } + }, + "missing-optional-double": { + "value": { + "itemCount": 1, + "items": [ + { + "id": "test-id", + "quote": { + "additionalCosts": [ + { + "name": "test-additional-cost-name", + "count": 1 + } + ] + } + } + ] + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListProjects" + }, + "post": { + "tags": [ + "Project" + ], + "summary": "Create Project", + "description": "Creates a new project.\n\nWhen creating a project using a project template that supports multiple source languages, you must supply the `languageDirections`.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when creating projects.\n\nThe values from a selected project template will take precedence over the individual resources when creating a new project.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-create-request" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project" + }, + "examples": { + "minimal": { + "value": { + "id": "string" + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"missing\": Missing required field for the value mentioned in the \"name\" field on the error response. \n* \"deleted\": Some of the selected values were deleted and cannot be selected for some values of the \"customFields\" field.\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n\"forbidden\": \n- The authenticated user is not allowed to create the project in the specified location.\n- Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "CreateProject" + } + }, + "/projects/{projectId}": { + "get": { + "tags": [ + "Project" + ], + "summary": "Get Project", + "description": "Retrieves a project by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project" + }, + "examples": { + "valid-response": { + "value": { + "id": "test-id", + "name": "test-name", + "description": "test-description", + "dueBy": "2042-07-28T11:13:36.000Z", + "createdAt": "2021-07-28T11:13:36.000Z", + "status": "completed", + "languageDirections": [ + { + "id": "language-direction-id", + "sourceLanguage": { + "languageCode": "test-source-languageCode", + "isNeutral": false + }, + "targetLanguage": { + "languageCode": "test-target-languageCode", + "isNeutral": true + } + } + ] + } + }, + "missing-required-string": { + "value": { + "name": "test-name", + "description": "test-description", + "dueBy": "2042-07-28T11:13:36.000Z", + "createdAt": "2021-07-28T11:13:36.000Z", + "status": "completed" + } + }, + "missing-optional-string": { + "value": { + "id": "test-id", + "description": "test-description", + "dueBy": "2042-07-28T11:13:36.000Z", + "createdAt": "2021-07-28T11:13:36.000Z", + "status": "completed" + } + }, + "missing-optional-datetime": { + "value": { + "id": "test-id", + "name": "test-name", + "description": "test-description", + "createdAt": "2021-07-28T11:13:36.000Z", + "status": "completed" + } + }, + "missing-optional-enum": { + "value": { + "id": "test-id", + "name": "test-name", + "description": "test-description", + "dueBy": "2042-07-28T11:13:36.000Z", + "createdAt": "2021-07-28T11:13:36.000Z" + } + }, + "missing-optional-boolean": { + "value": { + "id": "test-id", + "languageDirections": [ + { + "id": "language-direction-id", + "sourceLanguage": { + "languageCode": "test-source-languageCode" + }, + "targetLanguage": { + "languageCode": "test-target-languageCode" + } + } + ] + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetProject" + }, + "put": { + "tags": [ + "Project" + ], + "summary": "Update Project", + "description": "Updates the project in terms of: name, description, due date, quote, and project resources. Observe the rules of [JSON Merge Patch Semantics](https://tools.ietf.org/html/rfc7386). \n\nProject rescheduling (updating dueBy) is permitted only if: \n* there is no Customer Quote Approval task in the associated flow \n* at least one Customer Quote Approval was closed(in case multiple project batches) \n\nUpdate `projectPlan.taskConfigurations` are now permitted before project is started. Elements are now pre-populated at project creation time.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-update-request" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error responses:\n\n* “invalid”: invalid input on update quote model\n* “invalidStatus”: the quote cannot be edited, the project is in a phase which doesn't allow the quote to be edited\n* \"conflict\": the project does not have a quote to be updated\n* \"limit.exceeded\": a maximum number of users per task was assigned\n \n* \"deleted\": Some of the selected values were deleted and cannot be selected for some values of the \"customFields\" field.\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the Project.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the Project could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error responses:\n\n* “invalidStatus”: a field cannot be edited, because the project is in a status which doesn't allow the field to be edited. `details.name` will provide the field name which is not allowed to be edited.\n\n* updateNotAllowed: a field of the project cannot be edited before the completion of customer approval.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "UpdateProject" + }, + "delete": { + "tags": [ + "Project" + ], + "summary": "Delete Project", + "description": "Deletes a project.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the project.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "DeleteProject" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + } + ] + }, + "/projects/{projectId}/configuration": { + "get": { + "summary": "Get Project Configuration", + "description": "Get the configuration settings of an existing project.", + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-configuration" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to get the project configuration.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetProjectConfiguration", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "tags": [ + "Project" + ] + }, + "put": { + "summary": "Update Project Configuration", + "description": "Updates the configuration settings for an existing project.", + "operationId": "UpdateProjectConfiguration", + "tags": [ + "Project" + ], + "responses": { + "200": { + "description": "", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the project configuration.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-configuration-request" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + } + ] + }, + "/projects/{projectId}/pricing-model": { + "put": { + "tags": [ + "Project" + ], + "summary": "Update Project Pricing Model", + "description": "Update project pricing model only during Customer Quote Review task type.", + "operationId": "UpdateProjectPricingModel", + "responses": { + "204": { + "description": "", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalidPricingModel”: There is mismatch configuration between the project and the new pricing model.\n* \"differentCurrencyCode\": There is a mismatch between the provided pricing model currency and the pricing model currency in the project.\n* “differentFuzzyBands”: There is a mismatch between the provided pricing model fuzzy bands and the pricing model fuzzy bands in the project.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the project configuration.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-pricing-model-update-request" + } + } + }, + "required": true + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "x-stoplight": { + "id": "ypm1hf7wad9at" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + } + ] + }, + "/projects/{projectId}/start": { + "put": { + "tags": [ + "Project" + ], + "summary": "Start Project", + "description": "Starts a project. Translatable files should be uploaded before starting the project. If the action is executed on an already started project, the new translatable files should be uploaded first.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to start the project.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"invalidStatus\": the project's status doesn't permit the start operation.\n* \"missingTranslatableFile\": there was no translatable file attached to the project.\n* \"missingWorkflow\": there was no workflow associated with the project.\n* \"invalidWorkflow\" : the workflow associated with the project is invalid or has errors.\n* \"missingConfigurations\": not all manual task templates have configurations.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "StartProject" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + } + ] + }, + "/projects/{projectId}/complete": { + "put": { + "tags": [ + "Project" + ], + "summary": "Complete Project", + "description": "Marks a project as \"completed\".", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to complete the project.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"projectAlreadyCompleted\": the project it is already in completed state.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "CompleteProject" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + } + ] + }, + "/projects/{projectId}/files/exports": { + "post": { + "tags": [ + "Project" + ], + "summary": "Export Project Files", + "operationId": "ExportProjectFiles", + "description": "Generates an asynchronous export operation. To monitor the progress until completion, use the [Poll Project Files Export](#/operations/ExportProjectFilesStatus) endpoint. \n\nThis operation triggers the packaging of the project files into a `zip` format.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "200": { + "description": "Export Operation was triggered successfully", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/zip-file-export-response" + } + } + } + }, + "400": { + "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to trigger an export on the specified project, or does not have access to the project.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/zip-file-export-request" + } + } + } + }, + "x-stoplight": { + "id": "5hbbqpkqxmfyt" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + } + ] + }, + "/projects/{projectId}/files/exports/{exportId}": { + "get": { + "tags": [ + "Project" + ], + "summary": "Poll Project Files Export", + "operationId": "ExportProjectFilesStatus", + "description": "Retrieves the state of the export operation. \n\n Once the state is marked as `done`, you can download the generated `zip` file using the following endpoint: [Download Exported Project Files](#/operations/DownloadFile).", + "responses": { + "200": { + "description": "OK", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/zip-file-export-response" + } + } + } + }, + "400": { + "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to retrieve the details of the export.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the export operation could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "schema": { + "type": "string" + }, + "name": "exportId", + "in": "path", + "required": true, + "description": "The export identifier." + } + ], + "x-stoplight": { + "id": "uyc9zdzlangtw" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + } + ] + }, + "/projects/{projectId}/files/exports/{exportId}/download": { + "get": { + "tags": [ + "Project" + ], + "summary": "Download Exported Project Files", + "description": "Downloads the generated `zip` file containing the files according to initial export operation parameters. \n\nThe final ZIP file will be named using the project name. \n\n When the export operation is performed with `downloadFlat=true` and one target language specified, the resulting ZIP file name will be a combination of the project name and the target language code, as defined by the [Export Project Files](#/operations/ExportProjectFiles) endpoint.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the file could not be found by identifier.\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"conflict\": the export operation is not done yet.\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "x-codegen-download": true, + "operationId": "DownloadFile", + "x-stoplight": { + "id": "r8ac4c1ortxtw" + } + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "projectId", + "in": "path", + "required": true, + "description": "The identifier of the project." + }, + { + "schema": { + "type": "string" + }, + "name": "exportId", + "in": "path", + "required": true, + "description": "The identifier of the export operation." + } + ] + }, + "/projects/{projectId}/source-files": { + "get": { + "tags": [ + "Source File" + ], + "summary": "List Source Files", + "description": "Retrieves the source files in a project.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-source-files-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": not authorized to retrieve source files on the project.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListSourceFiles" + }, + "post": { + "tags": [ + "Source File" + ], + "summary": "Add Source File", + "description": "Adds a source file to the project. Files can be uploaded before starting a project or after the project has started. When adding a `translatable` file after the project started, a new start project request should be performed.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.\n\n> Note: The maximum character size of the sum between the `name` and the `path` fields must not exceed 255. Otherwise the request cannot be validated.\n\n> Note: Zip files will be added as reference files. If you want to upload zip files, please use the [Upload Zip File](#/operations/UploadZipFile) endpoint.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "required": [ + "properties", + "file" + ], + "properties": { + "properties": { + "$ref": "#/components/schemas/source-file-request" + }, + "file": { + "type": "string", + "format": "binary", + "description": "The source file (binary string)." + } + } + } + } + }, + "required": true, + "description": "For details on how to send multipart/form-data with `properties` see this [article](../docs/How-to-multipart.html)." + }, + "responses": { + "201": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/source-file" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error responses:\n* \"invalid\": invalid input on for the value mentioned in the “name” field on the error response.\n* \"empty\": missing input for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to add a source file to the project.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": duplicate source file name inside a project is not allowed.\n* \"projectAlreadyCompleted\": resource can not be added because the project it is in completed state.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "AddSourceFile" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + } + ], + "put": { + "tags": [ + "Source File" + ], + "summary": "Update Source Files", + "operationId": "UpdateSourceFiles", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to update the source file.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": a file with the same name already exists." + } + }, + "description": "Updates multiple source files. If any of the files fails to be updated, an error will be returned for each file. ", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/source-files-update-request" + } + } + } + } + } + }, + "/projects/{projectId}/source-files/attach-files": { + "post": { + "tags": [ + "Source File" + ], + "summary": "Attach Source Files", + "description": "This endpoint can only be used after files have been uploaded via the [Upload Zip File](#/operations/UploadZipFile) endpoint. It allows you to add multiple source files to a project. \n\n Each file must be individually attached by setting the `fileUrl` to the `associatedFiles.id` returned by the [Poll Upload Zip File](#/operations/PollUploadZipFile) endpoint, once the `unzipStatus` is `extracted`. \n\nIf a file is attached after the project has already been started, a new start project request must be made.\n\n> Note: The maximum character size of the sum between the `name` and the `path` fields must not exceed 255. Otherwise the request cannot be validated.\n", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/source-file-attachment-request" + } + } + }, + "required": true, + "description": "" + }, + "responses": { + "201": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/source-file-attachment-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": invalid input on for the value mentioned in the “name” field on the error response.\n* \"empty\": missing input for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to attach a source file on the project.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": duplicate source file name inside a project is not allowed.\n* \"duplicate\": duplicate fileUrl inside a project is not allowed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "AddSourceFiles" + }, + "parameters": [ + { + "name": "projectId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The project identifier." + } + ] + }, + "/projects/{projectId}/source-files/{sourceFileId}": { + "get": { + "tags": [ + "Source File" + ], + "summary": "Get Source File", + "description": "Retrieves a source file from the project.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/source-file" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project or the source file could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetSourceFile" + }, + "put": { + "tags": [ + "Source File" + ], + "summary": "Update Source File", + "operationId": "UpdateSourceFile", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to update the target file.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project or the source file could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": a file with the same name already exists." + } + }, + "description": "Updates a source file.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/source-file-rename-request" + } + } + } + }, + "parameters": [] + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + }, + { + "$ref": "#/components/parameters/sourceFileId" + } + ] + }, + "/projects/{projectId}/source-files/{sourceFileId}/versions": { + "get": { + "tags": [ + "Source File" + ], + "summary": "List Source File Versions", + "description": "Retrieves all the versions of a source file.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-source-file-versions-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to retrieve the source file versions.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project or the source file could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListSourceFileVersions" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + }, + { + "$ref": "#/components/parameters/sourceFileId" + } + ] + }, + "/tasks/{taskId}/source-files/{sourceFileId}/versions": { + "parameters": [ + { + "name": "sourceFileId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The source file identifier." + }, + { + "schema": { + "type": "string" + }, + "name": "taskId", + "in": "path", + "required": true, + "description": "The task identifier." + } + ], + "post": { + "summary": "Add Source File Version", + "tags": [ + "Source File" + ], + "operationId": "AddSourceFileVersion", + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/source-file-version-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"invalid\": the provided document is not a valid BCM file.\n* \"invalid\": invalid file format\n* \"multiPartOrder\": the multipart order in body is not correct. `properties` must be the first, followed by `file`.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": \\\n \\- the specified task or the source file was not found.\\\n \\- the request is performed in a task that doesn't have the input file type as source file and is used a target file identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"noOwner\": the task has no owner.\n* \"differentOwner\": the authenticated user is not the owner of the task.\n* \"differentServiceUserOwner\": the authenticated service user is not the owner of the task.\n* \"taskCompleted\": adding source file version is not allowed when the task is completed.\n* \"unsupported\" : you cannot add a source file version for this task.\n* \"duplicate\": a file with the same name already exists.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "required": [ + "properties", + "file" + ], + "properties": { + "properties": { + "$ref": "#/components/schemas/source-file-version-properties-create-request", + "description": "Source file properties sent as a JSON inside a text part." + }, + "file": { + "type": "string", + "format": "binary", + "description": "The source file (binary string)." + } + } + } + } + }, + "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." + }, + "description": "Adds a new version of the source file in [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) or native format. More information about file formats can be found on the [File formats](../docs/File-formats.html) page.\n\nThe version is added on the task represented by `taskId`. To successfully execute the add operation the task should already be assigned and accepted by a user. If the task is automatic, it's possible to add a source file version only when the status of task is `inProgress`.\n\nThe file versions added need to respect the output file type declared by the task type of the enclosing task. On the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page from the official RWS Documentation Center, you can find out what output file type is supported by each task.\n\nFor adding a source file version using an extension task, the configuration of the task must declare the `scope`'s value as \"file\".\n\nIf the file type of the new added file is different than the supported source file type, the new `fileTypeSettingsId` must be specified in the body or an update of file type should be performed after the add operation, using the [Update Source File Properties](#/operations/UpdateSourceProperties).\n\nThe value of `fileTypeSettingsId` is one of the identifiers listed by the [List File Type Settings](#/operations/ListFileTypeSettings) endpoint.\n\nThe [List File Type Settings](#/operations/ListFileTypeSettings) endpoint must be called with the File Processing Configuration identifier of your project.\n\nThe File Processing Configuration of your project can be retrieved from [Get Project](#/operations/GetProject) endpoint.\n\nThe multipart parameters in the body should respect and strictly follow the order specified in our documentation. \n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when adding files.\n", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ] + } + }, + "/projects/{projectId}/source-files/{sourceFileId}/versions/{fileVersionId}/download": { + "get": { + "tags": [ + "Source File" + ], + "summary": "Download Source File Version", + "description": "Downloads a source file version.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project, the source file or the file version could not be found by identifier.\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "422": { + "description": "error codes:\n* \"maliciousContent\": the file contains malicious content. The infected file cannot be downloaded.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "x-codegen-download": true, + "operationId": "DownloadSourceFileVersion" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + }, + { + "$ref": "#/components/parameters/sourceFileId" + }, + { + "$ref": "#/components/parameters/fileVersionId" + } + ] + }, + "/tasks/{taskId}/source-files/{sourceFileId}": { + "get": { + "tags": [ + "Source File" + ], + "summary": "Get Source File Properties", + "description": "Retrieves the properties for a source file.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/source-file-properties-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the task or source file could not be found by id.\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetSourceFileProperties" + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "taskId", + "in": "path", + "required": true, + "description": "The task identifier." + }, + { + "schema": { + "type": "string" + }, + "name": "sourceFileId", + "in": "path", + "required": true, + "description": "The source file identifier." + } + ], + "put": { + "summary": "Update Source File Properties", + "tags": [ + "Source File" + ], + "operationId": "UpdateSourceProperties", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error responses:\n* “invalid”: invalid input on update source file properties.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - the specified task or the source file was not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"noOwner\": the task has no owner.\n* \"differentOwner\": the authenticated user is not the owner of the task.\n* \"taskCompleted\": updating the source file properties is not allowed when the task is completed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Updates the properties of the source file.\n\n\nThe value of `fileTypeSettingsId` should be one of the identifiers listed by the [List File Type Settings](#/operations/ListFileTypeSettings) endpoint called with an identifier of a File Processing Configuration that exists on the project. The list of File Processing Configurations from a project can be retrieved by using the [List File Processing Configurations](#/operations/ListFileProcessingConfigurations) endpoint.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/source-file-properties-update-request" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ] + } + }, + "/projects/{projectId}/target-files/{targetFileId}": { + "get": { + "tags": [ + "Target File" + ], + "summary": "Get Target File", + "description": "Retrieves a target file from a project.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/target-file" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project or the target file could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetTargetFile" + }, + "put": { + "tags": [ + "Target File" + ], + "summary": "Update Target File", + "operationId": "UpdateTargetFile", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to update the target file.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the target file could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": a file with the same name already exists." + } + }, + "description": "Updates a target file.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/target-file-rename-request" + } + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + }, + { + "$ref": "#/components/parameters/targetFileId" + } + ] + }, + "/projects/{projectId}/target-files": { + "get": { + "tags": [ + "Target File" + ], + "summary": "List Target Files", + "description": "Retrieves the target files for a project.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "name": "targetFileIds", + "in": "query", + "description": "Filter target files by identifiers.", + "style": "form", + "explode": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "sourceFileIds", + "in": "query", + "description": "Filter target files by the identifiers of the source file they were generated from.", + "style": "form", + "explode": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-target-files-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the target files on the project.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListTargetFiles" + }, + "put": { + "tags": [ + "Target File" + ], + "summary": "Update Target Files", + "operationId": "UpdateTargetFiles", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to update the file.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the target file could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": a file with the same name already exists." + } + }, + "description": "Updates multiple target files. If any of the files fails to be updated, an error will be returned for each file. ", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/target-files-update-request" + } + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + } + ] + }, + "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}": { + "get": { + "tags": [ + "Target File" + ], + "summary": "Get Target File Version", + "description": "Retrieves one version of a target file.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/target-file-version" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project, the target file or its version could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetTargetFileVersion" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + }, + { + "$ref": "#/components/parameters/targetFileId" + }, + { + "$ref": "#/components/parameters/fileVersionId" + } + ] + }, + "/projects/{projectId}/target-files/{targetFileId}/versions": { + "get": { + "tags": [ + "Target File" + ], + "summary": "List Target File Versions", + "description": "Retrieves the versions of a target file.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-target-file-versions-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to retrieve versions on the target file.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project or the target file could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListTargetFileVersions" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + }, + { + "$ref": "#/components/parameters/targetFileId" + } + ] + }, + "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/exports": { + "post": { + "tags": [ + "Target File" + ], + "summary": "Export Target File Version", + "description": "Generates an asynchronous export operation. Use the [Get Target File Version Export](#/operations/PollTargetFileVersionExport) endpoint to poll until the export is completed. Used only for [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) file versions.\n\nThis operation triggers a conversion of the BCM target file version in a native or SDLXLIFF format, based on the value of the `format` query parameter used.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/export-format" + } + ], + "responses": { + "202": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/file-version-export" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to export the target file version.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project, the target file or the version could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"invalidType\": The type of the target file doesn't allow the export operation.\n* \"conflict\": A target file version export is already in progress.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ExportTargetFileVersion" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + }, + { + "$ref": "#/components/parameters/targetFileId" + }, + { + "$ref": "#/components/parameters/fileVersionId" + } + ] + }, + "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/exports/{exportId}": { + "get": { + "tags": [ + "Target File" + ], + "summary": "Poll Target File Version Export", + "description": "Polls a target file version via an export operation. The new version can be downloaded once the status is \"completed\".", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/file-version-export" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to retrieve the export.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "PollTargetFileVersionExport" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + }, + { + "$ref": "#/components/parameters/targetFileId" + }, + { + "$ref": "#/components/parameters/fileVersionId" + }, + { + "$ref": "#/components/parameters/exportId" + } + ] + }, + "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/exports/{exportId}/download": { + "get": { + "tags": [ + "Target File" + ], + "summary": "Download Exported Target File Version", + "description": "Downloads a completed target file version via an export operation.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": not allowed to download the exported target file", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"invalidStatus\": the export is not completed\n* \"conflict\": the export is not in a downloadable state due to another export, or the workflow has progressed since this export was requested", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "x-codegen-download": true, + "operationId": "DownloadExportedTargetFileVersion" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + }, + { + "$ref": "#/components/parameters/targetFileId" + }, + { + "$ref": "#/components/parameters/fileVersionId" + }, + { + "$ref": "#/components/parameters/exportId" + } + ] + }, + "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/download": { + "get": { + "tags": [ + "Target File" + ], + "summary": "Download Target File Version", + "description": "Downloads the file version (native or BCM). \n\nIf the `fileVersionId` path parameter represents a native file version, the native file will be downloaded. If the `fileVersionId` is an identifier of a version in [BCM format](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html), the BCM file will be downloaded.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": not allowed to download the file version.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the file version could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "error codes:\n* \"invalidType\": the type of the file version cannot be downloaded.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "422": { + "description": "error codes:\n* \"maliciousContent\": the file contains malicious content. The infected file cannot be downloaded.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "x-codegen-download": true, + "operationId": "DownloadFileVersion" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + }, + { + "$ref": "#/components/parameters/targetFileId" + }, + { + "$ref": "#/components/parameters/fileVersionId" + } + ] + }, + "/projects/{projectId}/target-files/{targetFileId}/versions/imports": { + "post": { + "tags": [ + "Target File" + ], + "summary": "Import Target File Version", + "description": "Generates an asynchronous import operation. Use [Poll Target File Version Import endpoint](#/operations/PollTargetFileVersionImport) to poll until the import is completed. Only `sdlxliff` files can be imported.\n\nImport should be used when a file is downloaded as an `sdlxliff`, processed and then, replaced. \nThe import operation triggers internally the update of the [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) file associated with the imported file. It should mostly be used for offline work.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "required": [ + "file" + ], + "properties": { + "file": { + "type": "string", + "format": "binary", + "description": "The target file (binary string)." + } + } + } + } + }, + "required": true, + "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/file-version-import" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error code “invalid” in case of:\n * Empty or missing file in request\n * Not valid multipart request\n * File parameter contains other extension than the one expected by specification.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to execute operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - the specified project or target file was not found.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "x-codegen-request-body-name": "body", + "operationId": "ImportTargetFileVersion" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + }, + { + "$ref": "#/components/parameters/targetFileId" + } + ] + }, + "/projects/{projectId}/target-files/{targetFileId}/versions/imports/{importId}": { + "get": { + "tags": [ + "Target File" + ], + "summary": "Poll Target File Version Import", + "description": "Polls a target file version via an import operation. The new version can be seen on the file versions once the status is \"completed\".", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/file-version-import" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - the specified project or target file was not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "PollTargetFileVersionImport" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + }, + { + "$ref": "#/components/parameters/targetFileId" + }, + { + "$ref": "#/components/parameters/importId" + } + ] + }, + "/tasks/{taskId}/target-files/{targetFileId}/versions": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "taskId", + "in": "path", + "required": true, + "description": "The task identifier." + }, + { + "schema": { + "type": "string" + }, + "name": "targetFileId", + "in": "path", + "required": true, + "description": "The target file identifier." + } + ], + "post": { + "summary": "Add Target File Version", + "tags": [ + "Target File" + ], + "operationId": "AddTargetFileVersion", + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/target-file-version-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n\n* \"invalid\": invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"invalid\": the provided document is not a valid BCM file.\n* \"invalid\": invalid file format\n* \"multiPartOrder\": the multipart order in the body is not correct. The `properties` must be first and then, file.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to add a version for the target file.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": \\\n \\- the specified task or the target file was not found.\\\n \\- the request is performed in a task that doesn't have the input file type as target file and is used a source file identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"noOwner\": the task has no owner.\n* \"differentOwner\": the authenticated user is not the owner of the task.\n* \"differentServiceUserOwner\": the authenticated service user is not the owner of the task.\n* \"taskCompleted\": adding target file version is not allowed when the task is completed.\n* \"duplicate\": a file with the same name already exists.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "required": [ + "properties", + "file" + ], + "properties": { + "properties": { + "$ref": "#/components/schemas/target-file-version-properties-create-request", + "description": "Target file properties sent as a JSON inside a text part." + }, + "file": { + "type": "string", + "format": "binary", + "description": "The target file (binary string)." + } + } + } + } + }, + "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." + }, + "description": "Adds a new version of the target file. Only the `native` and `bcm` file formats are accepted. For the `sdlxliff` files, you should use the [Import Target File endpoint](#/operations/ImportTargetFileVersion). More information about file formats can be found on the [File formats](../docs/File-formats.html) page. Additional details on BCM files can be found [here](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html).\n\nThe version is added on the task represented by `taskId`. To be able to execute the add operation the task should be assigned and accepted by user. If the task is automatic, it is possible to add a target file version only if the status is `inProgress`.\n\nThe added file versions need to respect the output file type declared by the task type of the enclosing task. On the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page from the official RWS Documentation Center, you can find out what output file type is supported by each task.\n\nFor adding a target file version using an extension task, the configuration of the task type must declare the `scope`'s value as \"file\".\n\nThe multipart parameters in the body should respect and strictly follow the order specified in our documentation.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ] + } + }, + "/projects/{projectId}/files/{fileId}/cancel": { + "put": { + "summary": "Cancel Project File", + "operationId": "CancelProjectFile", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\r\n* \"alreadyCanceled\": the file was already cancelled.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "description": "Cancels a project file.", + "tags": [ + "Project" + ], + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + }, + { + "$ref": "#/components/parameters/fileId" + } + ] + }, + "/projects/{projectId}/quote-report/export": { + "post": { + "summary": "Export Quote Report", + "operationId": "ExportQuoteReport", + "responses": { + "202": { + "description": "Accepted", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/export-quote-report-response", + "description": "Export quote report response.\n\nThe field is optional and will be returned only if a custom quote template is associated with the project.t.\n\nWe currently have this known issue: when the export is not using a Quote Template, the response for this call will be empty. It will be addressed in the future.e." + } + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"conflict\": the project is in a phase which doesn’t allow the quote to be exported.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Generates an asynchronous quote export operation for the project in either PDF or Excel format. Use the [polling endpoint](#/operations/PollQuoteReportExport) to check when the export is completed.
\nBuilt-in quotes are only available in the same languages as the user interface. See [this page](https://docs.rws.com/791595/1084405/trados-enterprise---accelerate/ui-languages) for more information.
\nCustomers who use non-default quote templates are responsible for the implementation of a suitable localization approach.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/quote-report-format" + }, + { + "$ref": "#/components/parameters/language-id" + } + ], + "tags": [ + "Quote" + ] + }, + "get": { + "summary": "Poll Quote Report Export", + "operationId": "PollQuoteReportExport", + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "inProgress", + "completed" + ] + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Polls a quote report via an export operation. The quote report can be [downloaded](#/operations/DownloadQuoteReport) once the status is \"completed\". The recommended polling interval is 20 seconds. If polling does not return a success status in 20 minutes, it should be abandoned and a new export should be retried.\n\nIf the `exportId` query parameter is not provided, the polling action will return the status for the last generated export.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/quote-report-format" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "exportId", + "description": "The export identifier." + } + ], + "tags": [ + "Quote" + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + } + ] + }, + "/projects/{projectId}/quote-report/download": { + "get": { + "summary": "Download Exported Quote Report", + "operationId": "DownloadQuoteReport", + "responses": { + "200": { + "description": "", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Downloads a quote report generated by the [asynchronous export operation](#/operations/ExportQuoteReport). \n\nIf the `exportId` query parameter is not provided, the last generated export quote will be downloaded.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/quote-report-format" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "exportId", + "description": "The export identifier." + } + ], + "tags": [ + "Quote" + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + } + ] + }, + "/projects/{projectId}/tasks": { + "get": { + "tags": [ + "Project" + ], + "summary": "List Project's Tasks", + "description": "Lists the tasks of a specific project.", + "parameters": [ + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-tasks-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListProjectTasks" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + } + ] + }, + "/project-groups": { + "get": { + "tags": [ + "Project Group" + ], + "summary": "List Project Groups", + "description": "Retrieves a list of all the project groups in an account.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-project-groups-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListProjectGroups" + }, + "post": { + "tags": [ + "Project Group" + ], + "summary": "Create Project Group", + "description": "Creates a new project group.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-group-create-request" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-group-create-response" + }, + "examples": {} + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to create the project group in the specified location.\n* \"benefitNotAvailable\": Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": Project group with the same name already exists.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "CreateProjectGroup" + }, + "parameters": [] + }, + "/project-groups/{projectGroupId}": { + "get": { + "tags": [ + "Project Group" + ], + "summary": "Get Project Group", + "description": "Retrieves a project group by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-group" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the project group.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The project group could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetProjectGroup" + }, + "put": { + "tags": [ + "Project Group" + ], + "summary": "Update Project Group", + "description": "Updates the project group.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-group-update-request" + } + } + }, + "required": true, + "description": "" + }, + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error responses:\n\n* “invalid”: Invalid input on update project group model.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the project group.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project group could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": Project group with the same name already exists.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "operationId": "UpdateProjectGroup" + }, + "delete": { + "tags": [ + "Project Group" + ], + "summary": "Delete Project Group", + "description": "Deletes a project group.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the project group.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project group could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"conflict\": there might be projects that are still `attaching`.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "DeleteProjectGroup" + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "projectGroupId", + "in": "path", + "required": true, + "description": "The project group identifier." + } + ] + }, + "/project-groups/{projectGroupId}/projects": { + "post": { + "tags": [ + "Project Group" + ], + "summary": "Add Projects To Group", + "description": "Adds projects to the project group.\n\nThe projects are not added instantly. To check the status use the [Get Project Group](#/operations/GetProjectGroup) endpoint.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/add-projects-to-group-request" + } + } + }, + "required": true + }, + "responses": { + "202": { + "description": "Accepted", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/add-projects-to-group-response" + } + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to add the projects to group.\n* \"forbidden\": The projects are not found or the authenticated user does not have acces to them.\n* \"benefitNotAvailable\": Your subscription does not include access to the requested type of benefit.\n* \"quotaReached\": The maximum number of projects allowed for your project group has already been reached.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The project group could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* “conflict”: A project with status \"detaching\" cannot be added.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "AddProjectsToGroup" + }, + "delete": { + "tags": [ + "Project Group" + ], + "summary": "Remove Projects From Group", + "description": "Removes projects from the project group.\n\nThe projects are not removed instantly. To check the status use the [Get Project Group](#/operations/GetProjectGroup) endpoint.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to remove the projects from the project group.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The project group could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* “conflict”: A project with status \"attaching\" cannot be removed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "RemoveProjectsFromGroup", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/remove-projects-from-group-request" + } + } + } + } + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "projectGroupId", + "in": "path", + "required": true, + "description": "The Project Group identifier." + } + ] + }, + "/project-templates/{projectTemplateId}": { + "get": { + "tags": [ + "Project Template" + ], + "summary": "Get Project Template", + "description": "Retrieves a project template by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-template-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the project template.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project template could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetProjectTemplate" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectTemplateId" + } + ], + "put": { + "summary": "Update Project Template", + "operationId": "UpdateProjectTemplate", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-template-update-request" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input mentioned in the “name” field on the error response. \n* \"deleted\": Some of the selected values were deleted and cannot be selected for some values of the \"customFields\" field.\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the project template.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project template could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "description": "Updates a project template by id.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "tags": [ + "Project Template" + ] + }, + "delete": { + "summary": "Delete Project Template", + "operationId": "DeleteProjectTemplate", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the project template.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project template could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "description": "Deletes a project template by id.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "tags": [ + "Project Template" + ] + } + }, + "/project-templates": { + "get": { + "tags": [ + "Project Template" + ], + "summary": "List Project Templates", + "description": "Retrieves a list of all the project templates in an account.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/name" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-project-templates-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListProjectTemplates" + }, + "post": { + "tags": [ + "Project Template" + ], + "summary": "Create Project Template", + "description": "Creates a new project template.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-template-create-request" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-template-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input mentioned in the “name” field on the error response. \n* \"deleted\": Some of the selected values were deleted and cannot be selected for some values of the \"customFields\" field.\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to create a project template.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": A project template with the same name already exists in the same location.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "operationId": "CreateProjectTemplate" + } + }, + "/rate-limits": { + "get": { + "tags": [ + "Rate Limits" + ], + "summary": "List Rate Limits", + "description": "Retrieves a list of all rate limits applicable for an account.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-rate-limits-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListRateLimits" + } + }, + "/schedule-templates": { + "get": { + "summary": "List Schedule Templates", + "description": "Retrieves a list of all the schedule templates in an account.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/name" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-schedule-templates-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListScheduleTemplates", + "tags": [ + "Schedule Template" + ] + }, + "parameters": [], + "post": { + "summary": "Create Schedule Template", + "operationId": "CreateScheduleTemplate", + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/schedule-template" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error responses:\n\n* “invalid”: invalid input on update schedule template model.\n* \"invalidLanguage\": The language used in configurations is invalid. Check the error message for more details.\n* \"maxSize\": The maximum size was exceeded for the value mentioned in the \"name\" or in the \"description\" fields.\n* \"invalidType\": The value provided for the \"taskTypeId\" field is invalid.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to create a schedule template.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": A schedule template with the same name already exists in the same location.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Creates a new schedule template.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/schedule-template-create-request" + } + } + } + }, + "tags": [ + "Schedule Template" + ] + } + }, + "/schedule-templates/{scheduleTemplateId}": { + "get": { + "summary": "Get Schedule Template", + "description": "Retrieves a schedule template by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/schedule-template" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* “empty”: Empty input for the “scheduleTemplateId” path parameter variable.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the schedule template.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the schedule template could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetScheduleTemplate", + "tags": [ + "Schedule Template" + ] + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "scheduleTemplateId", + "in": "path", + "required": true, + "description": "The id of the schedule template." + } + ], + "delete": { + "summary": "Delete Schedule Template", + "operationId": "DeleteScheduleTemplate", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the schedule template.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the schedule template could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "description": "Deletes a schedule template.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "tags": [ + "Schedule Template" + ] + }, + "put": { + "summary": "Update Schedule Template", + "operationId": "UpdateScheduleTemplate", + "responses": { + "204": { + "description": "No content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error responses:\n\n* “invalid”: invalid input on update schedule template model.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response or in “scheduleTemplateId” path variable.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" or in the \"description\" fields. \n* \"invalidType\": The value provided for the \"taskTypeId\" field is invalid.", + "headers": { + "X-LC-TraceId": { + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the schedule template.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the schedule template could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": A schedule template with the same name already exists in the same location.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "description": "Updates the schedule template identified by `scheduleTemplateId`.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/schedule-template-update-request" + } + } + } + }, + "tags": [ + "Schedule Template" + ] + } + }, + "/tasks/{taskId}": { + "get": { + "tags": [ + "Task" + ], + "summary": "Get Task", + "description": "Retrieves a task.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/task" + }, + "examples": { + "simple": { + "value": { + "id": "df680285-adcd-4bda-8f79-0bba4a857287", + "status": "created" + } + }, + "unexpected-enum": { + "value": { + "id": "df680285-adcd-4bda-8f79-0bba4a857287", + "status": "unexpectedEnumValue" + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the task.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetTask" + }, + "parameters": [ + { + "$ref": "#/components/parameters/taskId" + } + ] + }, + "/tasks/assigned": { + "get": { + "tags": [ + "Task" + ], + "summary": "List Tasks assigned to me", + "description": "Retrieves the tasks assigned to the authenticated user.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "name": "status", + "in": "query", + "description": "If specified, this filters tasks by status.", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-tasks-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListTasksAssignedToMe" + } + }, + "/tasks/{taskId}/accept": { + "put": { + "tags": [ + "Task" + ], + "summary": "Accept Task", + "description": "Accepts a task. The authenticated user becomes the owner of the accepted task and can start work on it.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"alreadyOwned\": the task is already owned\n* \"invalidStatus\": the task status doesn't permit the accept operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "AcceptTask" + }, + "parameters": [ + { + "$ref": "#/components/parameters/taskId" + } + ] + }, + "/tasks/{taskId}/reject": { + "put": { + "tags": [ + "Task" + ], + "summary": "Reject Task", + "description": "Rejects a task. The authenticated user will be removed from the task's list of available assignee users.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"alreadyOwned\": The task is already owned. It can't be rejected.\n* \"invalidStatus\": The task status doesn't permit the reject operation.\n* \"singleAssignee\": The authenticated user is the single assignee of the task, therefore the task can't be rejected.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "RejectTask" + }, + "parameters": [ + { + "$ref": "#/components/parameters/taskId" + } + ] + }, + "/tasks/{taskId}/complete": { + "put": { + "tags": [ + "Task" + ], + "summary": "Complete Task", + "description": "Completes a task. The task is required to be in \"inProgress\" state and will be marked as \"completed\".", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/task-complete-request" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “maxSize“: Maximum size exceeded for the value mentioned in the “name“ field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to complete the task.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"invalidStatus\": The current task status doesn't permit this operation.\n* \"noOwner\": The current task was not accepted in advance.\n* \"differentOwner\": The current task is accepted by another user.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "CompleteTask" + }, + "parameters": [ + { + "$ref": "#/components/parameters/taskId" + } + ] + }, + "/tasks/{taskId}/release": { + "put": { + "tags": [ + "Task" + ], + "summary": "Release Task", + "description": "Releases the task from its owner so that other task assignees will be able to accept it.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to release the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"noOwner\": the task currently has no owner.\n* \"differentOwner\": the authenticated user is not the owner of the task.\n* \"invalidStatus\": the task's status does not permit this operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ReleaseTask" + }, + "parameters": [ + { + "$ref": "#/components/parameters/taskId" + } + ] + }, + "/tasks/{taskId}/reclaim": { + "put": { + "tags": [ + "Task" + ], + "summary": "Reclaim Task", + "description": "The current owner of task is removed so that other assignees can accept it. \nThe task is not reassigned automatically.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty value for variable mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to reclaim the task.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"invalidStatus\": the current task's status doesn't permit this operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ReclaimTask" + }, + "parameters": [ + { + "$ref": "#/components/parameters/taskId" + } + ] + }, + "/tasks/{taskId}/assign": { + "put": { + "tags": [ + "Task" + ], + "summary": "Assign Task", + "description": "Assigns a task. The task assignees will be updated.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/task-assign-request" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input mentioned in the “name” field on the error response.\n* \"limit.exceeded\": a maximum number of users per task was assigned\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to assign the task.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"invalidStatus\": the current task's status doesn't permit the operation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "AssignTask" + }, + "parameters": [ + { + "$ref": "#/components/parameters/taskId" + } + ] + }, + "/task-types/{taskTypeId}": { + "get": { + "tags": [ + "Task Type" + ], + "summary": "Get Task Type", + "description": "Retrieves a task type by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/task-type" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the task type.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetTaskType" + }, + "parameters": [ + { + "$ref": "#/components/parameters/taskTypeId" + } + ] + }, + "/task-types": { + "get": { + "tags": [ + "Task Type" + ], + "summary": "List Task Types", + "description": "Retrieves all the task types in an account.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "name": "key", + "in": "query", + "description": "Filter by keys.", + "style": "form", + "explode": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "automatic", + "in": "query", + "description": "Filter by automatic or human tasks.", + "schema": { + "type": "boolean" + } + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-task-types-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListTaskTypes" + } + }, + "/translation-engines/{translationEngineId}": { + "get": { + "tags": [ + "Translation Engine" + ], + "summary": "Get Translation Engine", + "description": "Retrieves a translation engine.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-engine" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n\n* \"forbidden\": - The authenticated user is not allowed to read resource.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The translation engine could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "operationId": "GetTranslationEngine" + }, + "parameters": [ + { + "$ref": "#/components/parameters/translationEngineId" + } + ], + "put": { + "summary": "Update Translation Engine", + "operationId": "UpdateTranslationEngine", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty input in the update translation engine model. Check error details.\n* \"invalidLanguage\": Invalid language code used in language-pair\n* \"duplicate\": Duplicate resources found for the language pair specified in the error details.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to update the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n\n * \"updateNotAllowed\": Property specified in error response can not be updated because the translation engine provided is a copy assigned to a project.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Updates a translation engine. \n\nIt can be used to update a stand-alone translation engine or a project's translation engine. \nThe identifier of a project's translation engine can be retrieved only by calling [Get Project](https://sdl-language-tech.stoplight.io/docs/lcpublicapi/fd9ee0beb37ca-get-project) endpoint.\n\nPay special attention that some properties can not be changed for a project's translation engine. These include: name, description, definition.languageProcessingId, and language pairs can not be added/removed from definition.languagePairDefinitions. \n\nPay special attention to how [updating](https://languagecloud.sdl.com/lc/api-docs/updating-data-with-put) works.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-engine-update-request" + } + } + }, + "description": "" + }, + "tags": [ + "Translation Engine" + ] + } + }, + "/translation-engines": { + "get": { + "tags": [ + "Translation Engine" + ], + "summary": "List Translation Engines", + "description": "Retrieves all the translation engines in an account.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-translation-engines-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListTranslationEngines" + } + }, + "/termbase-templates": { + "get": { + "summary": "List Termbase Templates", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-termbase-templates-response" + }, + "examples": { + "termbase-templates-list": { + "value": { + "items": [ + { + "id": "test-id-1", + "name": "test-name-1", + "location": { + "id": "test-location-id-1", + "name": "test-location-name-1" + }, + "type": "system", + "languages": [ + { + "languageCode": "test-language-code-1" + } + ], + "fields": [ + { + "id": "test-field-id-1", + "name": "test-field-name-1", + "type": "system", + "level": "entry", + "dataType": "text" + } + ] + }, + { + "id": "test-id-2", + "name": "test-name-2", + "location": { + "id": "test-location-id-2", + "name": "test-location-name-2" + }, + "type": "userDefined", + "languages": [ + { + "languageCode": "test-language-code-2" + } + ], + "fields": [ + { + "id": "test-field-id-2", + "name": "test-field-name-2", + "type": "userDefined", + "level": "language", + "dataType": "boolean" + } + ] + } + ], + "itemCount": 2 + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the resources.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListTermbaseTemplates", + "description": "List termbase templates.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "in": "query", + "name": "location", + "description": "The identifiers of the resource folders. ", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "schema": { + "type": "string", + "enum": [ + "system", + "userDefined" + ] + }, + "in": "query", + "name": "type", + "description": "The type of the termbase template to retrieve. If not specified, both types will be returned" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + } + ], + "tags": [ + "Termbase Template" + ] + }, + "parameters": [], + "post": { + "summary": "Create Termbase Template", + "operationId": "CreateTermbaseTemplate", + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-template" + }, + "examples": { + "Example 1": { + "value": { + "id": "string", + "name": "string", + "description": "string", + "copyright": "string", + "location": { + "id": "string", + "name": "string", + "hasParent": true, + "path": [ + { + "id": "string", + "name": "string", + "location": "string", + "hasParent": true + } + ] + }, + "createdAt": "2022-01-12T12:00:00.000Z", + "lastModifiedAt": "2022-01-12T12:00:00.000Z", + "type": "system", + "languages": [ + { + "languageCode": "string", + "englishName": "string", + "direction": "string", + "parentLanguageCode": "string", + "defaultSpecificLanguageCode": "string", + "isNeutral": true + } + ], + "fields": [ + { + "id": "string", + "name": "string", + "description": "string", + "type": "system", + "level": "entry", + "dataType": "text", + "pickListValues": [ + "string" + ], + "allowCustomValues": true, + "allowMultiple": true, + "isMandatory": true + } + ] + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"duplicate\": The field name must be unique within the list.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to create a termbase template in the specified location.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - The specified location was not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": There is already a termbase template with the same name.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "description": "Creates a new termbase template.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-template-create-request" + } + } + } + }, + "tags": [ + "Termbase Template" + ] + } + }, + "/termbase-templates/{termbaseTemplateId}": { + "get": { + "summary": "Get Termbase Template", + "tags": [ + "Termbase Template" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-template" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n\n* \"forbidden\": - The authenticated user is not allowed to read resource\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the termbase template could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetTermbaseTemplate", + "description": "Get a termbase template by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ] + }, + "delete": { + "summary": "Delete Termbase Template", + "operationId": "DeleteTermbaseTemplate", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the termbase template\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the termbase template could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"conflict\": cannot delete system termbase templates", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Deletes a termbase template by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "tags": [ + "Termbase Template" + ] + }, + "put": { + "summary": "Update Termbase Template", + "operationId": "UpdateTermbaseTemplate", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"duplicate\": The field name must be unique within the list.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to update the termbase template.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": There is already a termbase template with the same name.\n* \"conflict\": cannot update system termbase template", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-template-update-request" + } + } + } + }, + "description": "Updates the termbase template.", + "tags": [ + "Termbase Template" + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/termbaseTemplateId" + } + ] + }, + "/termbase-templates/convert-xdt": { + "post": { + "summary": "Convert XDT to Termbase Structure", + "operationId": "ConvertTermbaseTemplate", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-structure" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error code “invalid” in case of:\r\n * Empty or missing file in request\r\n * Not valid multipart request\r\n * File parameter contains other extension than the one expected by specification.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Converts a termbase definition (XDT file) to a termbase structure that will be returned in the response.
\nThe structure will not be stored in the Trados Cloud Platform.", + "parameters": [ + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "required": [ + "file" + ], + "properties": { + "file": { + "type": "string", + "format": "binary", + "description": "The .xdt file (binary string) used for conversion." + } + } + } + } + }, + "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." + }, + "tags": [ + "Termbase Template" + ] + }, + "parameters": [] + }, + "/termbases": { + "get": { + "summary": "List Termbases", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-termbases-response" + }, + "examples": { + "termbases-list": { + "value": { + "items": [ + { + "id": "test-id-1", + "name": "test-name-1", + "location": { + "id": "test-location-id-1", + "name": "test-location-name-1" + }, + "termbaseStructure": { + "languages": [ + { + "languageCode": "test-language-code-1" + } + ], + "fields": [ + { + "id": "test-field-id-1", + "name": "test-field-name-1", + "type": "system", + "level": "entry", + "dataType": "text" + } + ] + }, + "numberOfEntries": 1, + "status": "ready" + }, + { + "id": "test-id-2", + "name": "test-name-2", + "location": { + "id": "test-location-id-2", + "name": "test-location-name-2" + }, + "termbaseStructure": { + "languages": [ + { + "languageCode": "test-language-code-2" + } + ], + "fields": [ + { + "id": "test-field-id-2", + "name": "test-field-name-2", + "type": "userDefined", + "level": "language", + "dataType": "boolean" + } + ] + }, + "numberOfEntries": 2, + "status": "ready" + } + ], + "itemCount": 2 + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListTermbase", + "description": "List termbases.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + } + ], + "tags": [ + "Termbase" + ] + }, + "post": { + "summary": "Create Termbase", + "operationId": "CreateTermbase", + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase" + }, + "examples": { + "Example 1": { + "value": { + "id": "string", + "name": "string", + "description": "string", + "copyright": "string", + "location": { + "id": "string", + "name": "string", + "hasParent": true, + "path": [ + { + "id": "string", + "name": "string", + "location": "string", + "hasParent": true + } + ] + }, + "termbaseStructure": { + "languages": [ + { + "languageCode": "string", + "englishName": "string", + "direction": "string", + "parentLanguageCode": "string", + "defaultSpecificLanguageCode": "string", + "isNeutral": true + } + ], + "fields": [ + { + "id": "string", + "name": "string", + "description": "string", + "type": "system", + "level": "entry", + "dataType": "text", + "pickListValues": [ + "string" + ], + "allowCustomValues": true, + "allowMultiple": true, + "isMandatory": true + } + ] + }, + "numberOfEntries": 0, + "status": "ready", + "createdAt": "2022-01-12T12:00:00.000Z", + "lastModifiedAt": "2022-01-12T12:00:00.000Z" + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to create a termbase.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.\n* \"quotaReached\": - You have reached the maximum allowable number of termbases for your account.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - The specified location was not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": There is already a termbase with the same name.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "description": "Creates a new termbase.\nThe termbase can be created with a termbase template by providing the templateId or by providing a custom termbaseStructure. \nIf only a `termbaseTemplateId` was provided, the termbase will be created using data from the template. \nIf only a `termbaseStructure` was provided, the termbase will be created using data from the structure. \nIf both, `termbaseTemplateId` and `termbaseStructure` are added in the request, the `termbaseStructure` takes precedence.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-create-request" + } + } + }, + "description": "" + }, + "tags": [ + "Termbase" + ] + } + }, + "/termbases/{termbaseId}": { + "get": { + "summary": "Get Termbase", + "tags": [ + "Termbase" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the resource.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetTermbase", + "description": "Retrieves a termbase by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ] + }, + "delete": { + "summary": "Delete Termbase", + "operationId": "DeleteTermbase", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the termbase\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the termbase could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"invalidStatus\": The termbase cannot be deleted as is currently being processed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Deletes a termbase by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "tags": [ + "Termbase" + ] + }, + "put": { + "summary": "Update Termbase", + "operationId": "UpdateTermbase", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"duplicate\": The field name must be unique within the list.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to update the termbase.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - The specified termbase identifier was not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": There is already a termbase with the same name.\n* \"invalidStatus\": The termbase cannot be updated as is currently being processed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-update-request" + } + } + } + }, + "description": "Updates the termbase.\nThe termbase can be updated with a termbase template by providing the termbaseTemplateId or by providing a custom termbaseStructure. \n\nIf only a `termbaseTemplateId ` was provided, the termbase will be updated using data from the template. \nIf only a `termbaseStructure` was provided, the termbase will be updated using data from the structure. \nIf both, `termbaseTemplateId` and `termbaseStructure` are added in the request, the `termbaseStructure` takes precedence.", + "tags": [ + "Termbase" + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + } + ] + }, + "/termbases/{termbaseId}/entries": { + "post": { + "summary": "Create Termbase Entry", + "operationId": "CreateTermbaseEntry", + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-entry" + }, + "examples": { + "termbase-entry-create": { + "value": { + "id": "string", + "humanReadableId": "string", + "languages": [ + { + "id": "string", + "language": { + "languageCode": "string", + "englishName": "string", + "direction": "string", + "parentLanguageCode": "string", + "defaultSpecificLanguageCode": "string", + "isNeutral": true + }, + "terms": [ + { + "id": "string", + "text": "string", + "termbaseFieldValues": [ + { + "id": "string", + "name": "string", + "termbaseFieldId": "string", + "value": "string", + "fieldValueLinks": [ + { + "type": "term", + "value": "string" + } + ], + "createdAt": "2019-08-24T14:15:22.000Z", + "createdBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + }, + "lastModifiedAt": "2019-08-24T14:15:22.000Z", + "lastModifiedBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + } + } + ], + "createdAt": "2019-08-24T14:15:22.000Z", + "createdBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + }, + "lastModifiedAt": "2019-08-24T14:15:22.000Z", + "lastModifiedBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + } + } + ], + "termbaseFieldValues": [ + { + "id": "string", + "name": "string", + "termbaseFieldId": "string", + "value": "string", + "fieldValueLinks": [ + { + "type": "term", + "value": "string" + } + ], + "createdAt": "2019-08-24T14:15:22.000Z", + "createdBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + }, + "lastModifiedAt": "2019-08-24T14:15:22.000Z", + "lastModifiedBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + } + } + ], + "createdAt": "2019-08-24T14:15:22.000Z", + "createdBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + }, + "lastModifiedAt": "2019-08-24T14:15:22.000Z", + "lastModifedBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + } + } + ], + "termbaseFieldValues": [ + { + "id": "string", + "name": "string", + "termbaseFieldId": "string", + "value": "string", + "fieldValueLinks": [ + { + "type": "term", + "value": "string" + } + ], + "createdAt": "2019-08-24T14:15:22.000Z", + "createdBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + }, + "lastModifiedAt": "2019-08-24T14:15:22.000Z", + "lastModifiedBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + } + } + ], + "createdAt": "2019-08-24T14:15:22.000Z", + "createdBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + }, + "lastModifiedAt": "2019-08-24T14:15:22.000Z", + "lastModifiedBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + } + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"invalidLevel\" : The termbaseFieldId is invalid for the current termbaseField type\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to create an entry.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"invalidStatus\": The termbase cannot be updated as is currently being processed.\n* \"duplicate\" : An entry with the same value already exists.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "description": "Creates a new termbase entry. For more information about how to use `fieldValueLinks` see [`Create termbase entry`](../docs/termbase/Termbase-entries.html#creating-a-termbase-entry).", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-entry-create-request" + } + } + } + }, + "tags": [ + "Termbase" + ] + }, + "get": { + "summary": "List Termbase Entries", + "operationId": "ListTermbaseEntries", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-termbase-entries-response" + }, + "examples": { + "termbase-entries-list": { + "value": { + "items": [ + { + "id": "test-id-1", + "humanReadableId": "test-humanReadableId-1", + "languages": [ + { + "id": "test-languages-id-1", + "language": { + "languageCode": "test-language-code-1" + }, + "terms": [ + { + "id": "test-terms-id-1", + "text": "test-terms-test-1" + } + ] + } + ], + "termbaseFieldValues": [ + { + "id": "test-termbaseFieldValues-id-1", + "name": "test-termbaseFieldValues-name-1", + "termbaseFieldId": "test-termbaseFieldValues-termbaseFieldId-1", + "value": "test-termbaseFieldValues-value-1", + "fieldValueLinks": [ + { + "type": "term", + "value": "test-value-1" + } + ] + } + ] + }, + { + "id": "test-id-2", + "humanReadableId": "test-humanReadableId-2", + "languages": [ + { + "id": "test-languages-id-2", + "language": { + "languageCode": "test-language-code-2" + }, + "terms": [ + { + "id": "test-terms-id-2", + "text": "test-terms-test-2" + } + ] + } + ], + "termbaseFieldValues": [ + { + "id": "test-termbaseFieldValues-id-2", + "name": "test-termbaseFieldValues-name-2", + "termbaseFieldId": "test-termbaseFieldValues-termbaseFieldId-2", + "value": "test-termbaseFieldValues-value-2", + "fieldValueLinks": [ + { + "type": "term", + "value": "test-value-2" + } + ] + } + ] + } + ], + "itemCount": 2 + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the entries.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Retrieves a list of all the entries in a termbase.", + "tags": [ + "Termbase" + ], + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/humanReadableIds" + } + ] + }, + "delete": { + "summary": "Delete Termbase Entries", + "operationId": "DeleteTermbaseEntries", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to delete an entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Deletes all the entries in the termbase.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "tags": [ + "Termbase" + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + } + ] + }, + "/termbases/{termbaseId}/entries/{entryId}": { + "get": { + "summary": "Get Termbase Entry", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-entry" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the entry could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetTermbaseEntry", + "description": "Retrieves a termbase entry by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "tags": [ + "Termbase" + ] + }, + "put": { + "summary": "Update Termbase Entry", + "operationId": "UpdateTermbaseEntry", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to update the entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"invalidStatus\": The termbase cannot be updated as is currently being processed.\n* \"duplicate\" : An entry with the same value already exists.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Updates a termbase entry by identifier.\nThe request body will overwrite the existing data.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "tags": [ + "Termbase" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-entry-update-request" + } + } + } + } + }, + "delete": { + "summary": "Delete Termbase Entry", + "operationId": "DeleteTermbaseEntry", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to delete the termbase entries.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Deletes a termbase entry.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "tags": [ + "Termbase" + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + }, + { + "$ref": "#/components/parameters/entryId" + } + ] + }, + "/termbases/{termbaseId}/exports": { + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + } + ], + "post": { + "summary": "Export Termbase", + "operationId": "ExportTermbase", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-export-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - The specified termbase was not found.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "format": { + "type": "string", + "enum": [ + "xml", + "tbx" + ], + "default": "tbx", + "description": "The file format used to export the termbase." + }, + "properties": { + "$ref": "#/components/schemas/termbase-export-properties-request" + } + } + } + } + } + }, + "description": "Generates an asynchronous export operation.
\nUse the [Poll Export Termbase](#/operations/PollExportTermbase) endpoint to poll until the export status is `done`.", + "tags": [ + "Termbase Export" + ] + } + }, + "/termbases/{termbaseId}/exports/{exportId}": { + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + }, + { + "$ref": "#/components/parameters/exportId" + } + ], + "get": { + "summary": "Poll Termbase Export", + "operationId": "PollExportTermbase", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-export-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - The specified export was not found." + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "description": "Polls a termbase via an export operation. The exported termbase can be downloaded once the status is `done`.", + "tags": [ + "Termbase Export" + ] + } + }, + "/termbases/{termbaseId}/exports/{exportId}/download": { + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + }, + { + "$ref": "#/components/parameters/exportId" + } + ], + "get": { + "summary": "Download Exported Termbase", + "operationId": "DownloadExportedTermbase", + "responses": { + "200": { + "description": "OK", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - The specified termbase or export was not found.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "description": "Downloads the exported termbase when the poll operation status is `done`.", + "tags": [ + "Termbase Export" + ] + } + }, + "/termbases/{termbaseId}/export-template": { + "parameters": [ + { + "name": "termbaseId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The termbase identifier." + } + ], + "get": { + "summary": "Export Termbase Template", + "tags": [ + "Termbase Export" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "DownloadTermbaseDefinition", + "description": "Downloads the termbase definition.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ] + } + }, + "/termbases/{termbaseId}/terms/{sourceLanguageCode}": { + "get": { + "summary": "List Termbase Terms", + "operationId": "ListTermbaseTerms", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-termbase-terms-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the entries.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "schema": { + "type": "string", + "maxLength": 100 + }, + "in": "query", + "name": "search", + "description": "The text to search for." + }, + { + "schema": { + "type": "string", + "enum": [ + "normal", + "linguistic", + "fuzzy" + ], + "default": "normal" + }, + "in": "query", + "name": "searchType", + "description": "The type of the search performed." + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "targetLanguageCode", + "description": "The target language code used to list the terms." + } + ], + "description": "Retrieves a list of all the terms of the termbase.\nSearch types:\n- normal: Use normal search to look for terms that match the text exactly as entered.\n- linguistic: Use linguistic search to look for terms that are similar to the search term. Linguistic search is based on stemming and other language-dependent aspects.\n- fuzzy: Use fuzzy search to look for terms that are similar to the search term. Fuzzy search is more fault-tolerant than linguistic search.", + "tags": [ + "Termbase" + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + }, + { + "schema": { + "type": "string" + }, + "name": "sourceLanguageCode", + "in": "path", + "required": true, + "description": "The source language code used to list the terms." + } + ] + }, + "/termbases/{termbaseId}/imports": { + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + } + ], + "get": { + "summary": "Get Termbase Import History", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-termbase-import-history" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetImportHistory", + "description": "Gets the import history for a termbase.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + } + ], + "tags": [ + "Termbase Import" + ] + }, + "post": { + "summary": "Import Termbase", + "operationId": "ImportTermbase", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-import-response" + }, + "examples": { + "import-termbase-ok": { + "value": { + "id": "test-import-id", + "status": "queued" + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"invalidStatus\": Cannot import as the termbase is currently being processed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "schema": { + "type": "boolean", + "default": true + }, + "in": "query", + "name": "strictImport", + "description": "Specifies if the entries are only imported into the exact language that matches your imported file.
`true` - The import will only occur if the language in your import file matches exactly with a language in your termbase.
`false` - The import will occur even there are non-matching languages, by trying to match them to a relevant main language or language variant, if available." + }, + { + "schema": { + "type": "string", + "enum": [ + "ignore", + "merge", + "overwrite" + ], + "default": "overwrite" + }, + "in": "query", + "name": "duplicateEntriesStrategy", + "description": "The strategy for duplicate entries. Determines how the duplicate entries will be handled.
`ignore` - The content of the current entry with the same identifier will be kept, and the new entry will be ignored
`merge` - The content of the current entry with the same identifier will be merged with the imported entry. If the identifier is not provided the content will be merged by text.
`overwrite` - The content of the current entry with the same identifier will be replaced by the imported entry." + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "required": [ + "file" + ], + "properties": { + "properties": { + "$ref": "#/components/schemas/termbase-import-request" + }, + "file": { + "type": "string", + "format": "binary", + "description": "The file (binary string) to import into the termbase.
\nAccepted file types: .xml, .tbx\n
" + } + } + }, + "examples": {} + } + }, + "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." + }, + "description": "Generates an asynchronous import operation.
\nUse the Poll Import Termbase endpoint to poll until the import status is `done`.
", + "tags": [ + "Termbase Import" + ] + } + }, + "/termbases/{termbaseId}/imports/{importId}": { + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + }, + { + "$ref": "#/components/parameters/importId" + } + ], + "get": { + "summary": "Poll Termbase Import", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-poll-import-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "PollTermbaseImport", + "description": "Polls a termbase import operation.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "tags": [ + "Termbase Import" + ] + } + }, + "/termbases/{termbaseId}/imports/{importId}/logs": { + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + }, + { + "$ref": "#/components/parameters/importId" + } + ], + "get": { + "summary": "Download Termbase Import Logs", + "operationId": "DownloadTermbaseImportLog", + "description": "Downloads the termbase import logs.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "tags": [ + "Termbase Import" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error code: \n * \"invalid\": the value specified in the field \"name\" of the errorDetails is not an accepted value." + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + } + } + }, + "/tqa-profiles": { + "get": { + "summary": "List TQA Profiles", + "tags": [ + "TQA Profile" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-tqa-profiles-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListTqaProfiles", + "description": "List TQA Profiles.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" + } + ] + } + }, + "/tqa-profiles/{profileId}": { + "get": { + "summary": "Get TQA Profile", + "tags": [ + "TQA Profile" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tqa-profile" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the User could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetTqaProfile", + "description": "Get a TQA Profile By identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/profileId" + } + ] + }, + "/translation-memory/{translationMemoryId}": { + "get": { + "summary": "Get Translation Memory", + "tags": [ + "Translation Memory" + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-memory" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetTranslationMemory", + "description": "Get a single Translation Memory by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/fields" + } + ] + }, + "put": { + "summary": "Update Translation Memory", + "operationId": "UpdateTranslationMemory", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"minSize\": Minimum size not met for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Updates a Translation Memory. We recommend reading this page too [Updating data with PUT](../docs/Updating-data-with-PUT.html).", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-memory-update-request" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/Authorization" + } + ], + "tags": [ + "Translation Memory" + ] + }, + "delete": { + "summary": "Delete Translation Memory", + "operationId": "DeleteTranslationMemory", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Deletes a Translation Memory.", + "parameters": [ + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/Authorization" + } + ], + "tags": [ + "Translation Memory" + ] + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "translationMemoryId", + "in": "path", + "required": true, + "description": "The identifier of the translation memory" + } + ] + }, + "/translation-memory/{translationMemoryId}/copy": { + "post": { + "summary": "Copy Translation Memory", + "tags": [ + "Translation Memory" + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-memory" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "CopyTranslationMemory", + "description": "Creates a copy of a Translation Memory. The name will be suffixed with ' (Copy) '", + "parameters": [ + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/fields" + } + ] + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "translationMemoryId", + "in": "path", + "required": true, + "description": "The identifier of the translation memory" + } + ] + }, + "/translation-memory": { + "get": { + "summary": "List Translation Memories", + "tags": [ + "Translation Memory" + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-translation-memories-reposne" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListTranslationMemories", + "description": "Retrieves all the Translation Memories.", + "parameters": [ + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" + } + ] + }, + "post": { + "summary": "Create Translation Memory", + "operationId": "CreateTranslationMemory", + "responses": { + "201": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-memory-base" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"minSize\": Minimum size not met for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Create a new Translation Memory.", + "parameters": [ + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-memory-create-request" + } + } + } + }, + "tags": [ + "Translation Memory" + ] + } + }, + "/translation-memory/field-templates": { + "get": { + "summary": "List Field Templates", + "tags": [ + "Translation Memory" + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-translation-memory-field-templates" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListFieldTemplates", + "parameters": [ + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "description": "Retrieves all the Field Templates." + }, + "parameters": [] + }, + "/translation-memory/field-templates/{fieldTemplateId}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "fieldTemplateId", + "in": "path", + "required": true, + "description": "The field template identifier" + } + ], + "get": { + "summary": "Get Field Template", + "tags": [ + "Translation Memory" + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-memory-field-template" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetFieldTemplate", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "description": "Get a single Field Template by identifier." + } + }, + "/translation-memory/{translationMemoryId}/imports": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "translationMemoryId", + "description": "The identifier of the Translation Memory.", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Get Translation Memory Import History", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-translation-memory-import-history" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the entry.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetTMImportHistory", + "description": "Gets the import history for a translation memory. It returns the history of last 7 days.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + } + ], + "tags": [ + "Translation Memory Import" + ] + }, + "post": { + "summary": "Import Translation Memory", + "operationId": "ImportTranslationMemory", + "responses": { + "200": { + "description": "OK - returned when the `status` field has one of the following values: `failed`, `done`, `cancelled`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-memory-import-response" + }, + "examples": { + "import-termbase-ok": { + "value": { + "id": "test-import-id", + "status": "queued" + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "202": { + "description": "Accepted - returned when the `status` field has one of the following values: `queued`, `inProgress`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-memory-import-response" + }, + "examples": { + "import-termbase-ok": { + "value": { + "id": "test-import-id", + "status": "queued" + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query/form parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"multiPartOrder\": The multipart order in the body is not correct. The `properties` must be first and then, file.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": Not authorized to import translation memories.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "required": [ + "properties", + "file" + ], + "properties": { + "properties": { + "$ref": "#/components/schemas/translation-memory-import-request" + }, + "file": { + "type": "string", + "format": "binary", + "description": "The file (binary string) to import into the translation memory.
Accepted file types: .tmx, .sdltm, .zip, .tmx.gz, .sdlxliff" + } + } + }, + "examples": {} + } + }, + "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." + }, + "description": "Generates an asynchronous import operation. \n
\n
Read more about prerequisites and limitations on the [official documentation center](https://docs.rws.com/791595/741139/trados-enterprise/importing-tm-content).\n
\nNote: The order of the multipart form parameter must be implemented as such: properties first, file second.\n
\nUse the Poll Translation Memory Import endpoint to poll until the import status is `done`.
\nTo track the progress of the import please refer to [Poll Translation Memory Import](#/operations/PollTMImport).", + "tags": [ + "Translation Memory Import" + ] + } + }, + "/translation-memory/imports/{importId}": { + "parameters": [ + { + "name": "importId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The import identifier." + } + ], + "get": { + "summary": "Poll Translation Memory Import", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-memory-import-poll-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the path parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the entry.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "PollTMImport", + "description": "Polls a Translation Memory import operation. The import is finished when the status is `done`.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "tags": [ + "Translation Memory Import" + ] + } + }, + "/translation-memory/{translationMemoryId}/exports": { + "parameters": [ + { + "$ref": "#/components/parameters/translationMemoryId" + } + ], + "post": { + "summary": "Export Translation Memory", + "operationId": "ExportTranslationMemory", + "responses": { + "200": { + "description": "OK - returned when the `status` field has one of the following values: `failed`, `done`, `cancelled`", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-memory-export-response" + } + } + } + }, + "202": { + "description": "Accepted - returned when the `status` field has one of the following values: `queued`, `inProgress`", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-memory-export-response" + } + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the request parameters. Either the `translationMemoryId` or the `sourceLanguageCode`/`targetLanguageCode` are invalid.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to export the translation memory.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "description": "Generates an asynchronous export operation.\nUse the [Poll Translation Memory Export](#/operations/PollTranslationMemoryExport) endpoint to poll until the export status is `done`.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-memory-export-request" + } + } + } + }, + "tags": [ + "Translation Memory Export" + ] + } + }, + "/translation-memory/exports/{exportId}": { + "parameters": [ + { + "$ref": "#/components/parameters/exportId" + } + ], + "get": { + "summary": "Poll Translation Memory Export", + "tags": [ + "Translation Memory Export" + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-memory-poll-export-response" + } + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid `exportId` in the path parameters.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "operationId": "PollTranslationMemoryExport", + "description": "Polls a translation memory via an export operation. The exported translation memory can be downloaded once the status is `done`.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ] + } + }, + "/translation-memory/exports/{exportId}/download": { + "parameters": [ + { + "$ref": "#/components/parameters/exportId" + } + ], + "get": { + "summary": "Download Exported Translation Memory", + "tags": [ + "Translation Memory Export" + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid `exportId` in the path parameters.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "operationId": "DownloadExportedTranslationMemory", + "description": "Downloads the exported translation memory in the `tmx.gz` format when the poll operation status is `done`.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ] + } + }, + "/translations/lookup": { + "post": { + "summary": "Lookup", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-search-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response. \n\n * \"invalid\": Invalid input mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Unauthorized to use translation engine.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - translation engine not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "TranslationsLookup", + "x-stoplight": { + "id": "e1b35d4bkp1dq" + }, + "tags": [ + "Translation" + ], + "description": "Translates a phrase in plain text or a BCM fragment containing a single segment. The translated content will be returned as a BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html) or [term](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Skeleton.Term.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.html) page.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-search-request" + } + } + }, + "description": "Learn more about Translation Memory standard penalties [here](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/trados-tm-penalties-1159224).\r\n
\r\nLearn more about Translation Unit status penalties [here](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/editing-project-tm-and-verification-settings-800732)." + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ] + }, + "parameters": [] + }, + "/translations/concordance": { + "post": { + "summary": "Concordance", + "tags": [ + "Translation" + ], + "responses": { + "200": { + "description": "OK.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-concordance-search-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response. \n\n * \"invalid\": Invalid input mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Unauthorized to use translation engine.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - translation engine not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "TranslationsConcordanceSearch", + "x-stoplight": { + "id": "w7q4r8d7hum33" + }, + "description": "Performs a concordance search for a given text within the TM linked to the specified translation engine. The translated content will be returned as a BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html) or [term](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Skeleton.Term.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.html) page.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-concordance-search-request" + } + } + }, + "description": "Learn more about Translation Memory standard penalties [here](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/trados-tm-penalties-1159224).\r\n
\r\nLearn more about Translation Unit status penalties [here](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/editing-project-tm-and-verification-settings-800732)." + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ] + }, + "parameters": [] + }, + "/translations/translation-unit": { + "put": { + "summary": "Update Translation Unit", + "tags": [ + "Translation" + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-unit-add-update-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response. \n\n * \"invalid\": Invalid input mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Unauthorized to use translation engine.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - translation engine not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "TranslationsUpdate", + "x-stoplight": { + "id": "pyjdd2h02zm8z" + }, + "description": "Updates a translation unit. The system identifies matching translation units in the TM based on the provided BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.html) page.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-update-request" + } + } + } + } + }, + "post": { + "summary": "Add Translation Unit", + "tags": [ + "Translation" + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-unit-add-update-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response. \n\n * \"invalid\": Invalid input mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Unauthorized to use translation engine.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - translation engine not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "TranslationsAdd", + "description": "Adds a translation unit. The system identifies matching translation units in the TM based on the provided BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.html) page.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-add-request" + } + } + } + } + } + }, + "/users/me": { + "get": { + "tags": [ + "User" + ], + "summary": "Get my User", + "description": "Retrieves the authenticated user.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetMyUser" + } + }, + "/users": { + "get": { + "tags": [ + "User" + ], + "summary": "List Users", + "description": "Retrieves a list of all the users in an account.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-users-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListUsers" + } + }, + "/users/{userId}": { + "get": { + "tags": [ + "User" + ], + "summary": "Get User", + "description": "Retrieves a user by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/user" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "error codes:\n* \"notFound\": the User could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetUser" + }, + "parameters": [ + { + "$ref": "#/components/parameters/userId" + } + ] + }, + "/.well-known/jwks.json": { + "get": { + "summary": "List Public Keys", + "tags": [ + "Public Keys" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/well-known-jwks-response" + }, + "examples": { + "list-keys-ok": { + "value": { + "keys": [ + { + "kty": "test-kty-1", + "n": "test-n-1", + "e": "test-e-1", + "alg": "test-alg-1", + "kid": "test-kid-1", + "use": "test-use-1" + }, + { + "kty": "test-kty-2", + "n": "test-n-2", + "e": "test-e-2", + "alg": "test-alg-2", + "kid": "test-kid-2", + "use": "test-use-2" + } + ] + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListPublicKeys", + "description": "List all available Public Keys." + } + }, + "/.well-known/jwks.json/{kid}": { + "get": { + "summary": "Get Public Key", + "tags": [ + "Public Keys" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/jwk" + }, + "examples": { + "get-key-ok": { + "value": { + "kty": "test-kty", + "n": "test-n", + "e": "test-e", + "alg": "test-alg", + "kid": "test-kid", + "use": "test-use" + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the public key could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetPublicKey", + "description": "Retrieves a public key by it's identifier." + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "kid", + "in": "path", + "required": true, + "description": "The key identifier." + } + ] + }, + "/workflows/{workflowId}": { + "get": { + "tags": [ + "Workflow" + ], + "summary": "Get Workflow", + "description": "Retrieves a workflow by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the workflow.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetWorkflow" + }, + "put": { + "tags": [ + "Workflow" + ], + "summary": "Update Workflow", + "description": "Updates the workflow in terms of: name, description, and task configuration (and its details). Observe the rules of [JSON Merge Patch Semantics](https://tools.ietf.org/html/rfc7386).", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow-update-request" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the body parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty input in the body parameter mentioned in the \"name\" field on the error response.\n* \"limit.exceeded\": a maximum number of users per task was assigned\n", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the Workflow.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the Workflow could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\r\n* \"projectPlanChanged\": The associated project has already been changed at the level of `projectPlan.taskConfigurations`. Updating the workflow is no longer possible; the project should be updated to set the relevant `projectPlan.taskConfigurations` fields. \r\n", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "operationId": "UpdateWorkflow" + }, + "parameters": [ + { + "$ref": "#/components/parameters/workflowId" + } + ] + }, + "/workflows": { + "get": { + "tags": [ + "Workflow" + ], + "summary": "List Workflows", + "description": "Retrieves all the workflows in an account.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-workflows-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListWorkflows" + } + }, + "/projects/{projectId}/custom-fields/{customFieldKey}": { + "parameters": [ + { + "name": "projectId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The project identifier." + }, + { + "schema": { + "type": "string" + }, + "name": "customFieldKey", + "in": "path", + "required": true, + "description": "The custom field key." + } + ], + "put": { + "summary": "Update Custom Field", + "operationId": "UpdateCustomField", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input for a readOnly field, with a different value than the deafult one. Also this code is used for invalid input values", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the Custom field for the Project.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the Project could not be found by identifier or Custom field key could not be found or does not belong to the desired resource type.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/custom-field-update-request", + "description": "Thew new value along wit" + } + } + } + }, + "tags": [ + "Project" + ], + "description": "Allows updating individual custom fields on a project.", + "parameters": [] + } + }, + "/translation-domain/service-types": { + "get": { + "summary": "List Service Types", + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-translation-service-types-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListTranslationServiceTypes", + "x-stoplight": { + "id": "014dsosfughtk" + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "tags": [ + "Translation Domain" + ], + "description": "List all available service types." + } + } + }, + "components": { + "schemas": { + "account": { + "title": "Account", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The account identifier." + }, + "name": { + "type": "string", + "description": "
default
The account name.
",
+ "x-default-field": true
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "add-projects-to-group-request": {
+ "title": "Add Projects To Group Request",
+ "type": "object",
+ "description": "Input for adding projects to group.",
+ "properties": {
+ "projects": {
+ "type": "array",
+ "description": "The projects to be added to group.",
+ "items": {
+ "$ref": "#/components/schemas/project-group-project-request"
+ }
+ }
+ },
+ "required": [
+ "projects"
+ ]
+ },
+ "add-projects-to-group-response": {
+ "title": "Add Projects To Group Response",
+ "type": "object",
+ "description": "Add Projects To Group response.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The project group identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "The project group name."
+ },
+ "description": {
+ "type": "string",
+ "description": "The project group description."
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of the projects in the project group.\n\n- `new`: the group is new created, or all projects in the group have status New\n\n- `inProgress`: at least one project in the group is in progress\n\n- `completed`: all projects in the group have status Completed\n\n- `deleting`: the group is getting deleted and the projects are removing from it",
+ "enum": [
+ "new",
+ "inProgress",
+ "completed",
+ "deleting"
+ ]
+ },
+ "projects": {
+ "type": "array",
+ "description": "The projects in the project group.",
+ "items": {
+ "$ref": "#/components/schemas/project-group-project"
+ }
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder-v2"
+ },
+ "shortId": {
+ "type": "string"
+ },
+ "createdAt": {
+ "type": "string",
+ "example": "2022-01-12T12:00:00.000Z",
+ "description": "The date and time when the project group was created. UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time" + }, + "lastModifiedAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the project group was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "format": "date-time" + } + }, + "required": [ + "id" + ] + }, + "project-cost": { + "title": "Project Cost", + "x-stoplight": { + "id": "34d171ee75017" + }, + "type": "object", + "required": [ + "name", + "type", + "index", + "costPerUnit", + "unitCount" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the additional cost. " + }, + "type": { + "$ref": "#/components/schemas/project-cost-type", + "description": "The type of the additional cost." + }, + "index": { + "type": "number", + "description": "The number of the additional cost." + }, + "costPerUnit": { + "type": "number", + "description": "The cost of a unit." + }, + "unitCount": { + "type": "number", + "description": "The number of units for which a cost is applied." + }, + "volumeUnitType": { + "$ref": "#/components/schemas/volume-unit-type", + "description": "The unit type of the 'volume' cost, used as reference for the unit cost." + }, + "conditionalCostType": { + "$ref": "#/components/schemas/conditional-cost-type", + "description": "Only for the Conditional type." + }, + "costOperator": { + "$ref": "#/components/schemas/conditional-cost-operator", + "description": "Only for the Conditional type.", + "x-stoplight": { + "id": "dw5wpcfk70z9c" + } + }, + "costVariable": { + "$ref": "#/components/schemas/conditional-cost-variable", + "description": "Only for the Conditional type.", + "x-stoplight": { + "id": "np7a8b8w5ra70" + } + }, + "operand": { + "type": "number", + "description": "Operand of the Conditional type cost." + }, + "serviceTypes": { + "type": "array", + "x-stoplight": { + "id": "gkyey7knc4j3v" + }, + "description": "
default
Array of Service Type identifiers where this additional cost is applied. ",
+ "items": {
+ "x-stoplight": {
+ "id": "3e6kwmu58ut0p"
+ },
+ "type": "string"
+ }
+ },
+ "customUnitName": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "rovgmbrayoltf"
+ },
+ "description": "The name of the custom unit."
+ }
+ }
+ },
+ "language-cost": {
+ "title": "Language Cost",
+ "x-stoplight": {
+ "id": "28d3xstakbk6t"
+ },
+ "type": "object",
+ "required": [
+ "name",
+ "type",
+ "index",
+ "costPerUnit",
+ "unitCount"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the additional cost. "
+ },
+ "type": {
+ "$ref": "#/components/schemas/language-cost-type",
+ "description": "The type of the additional cost."
+ },
+ "index": {
+ "type": "number",
+ "description": "The number of the additional cost."
+ },
+ "costPerUnit": {
+ "type": "number",
+ "description": "The cost of a unit."
+ },
+ "unitCount": {
+ "type": "number",
+ "description": "The number of units for which a cost is applied."
+ },
+ "volumeUnitType": {
+ "$ref": "#/components/schemas/volume-unit-type",
+ "description": "The unit type of the 'volume' cost, used as reference for the unit cost."
+ },
+ "conditionalCostType": {
+ "$ref": "#/components/schemas/conditional-cost-type",
+ "description": "Only for the Conditional type."
+ },
+ "costOperator": {
+ "$ref": "#/components/schemas/conditional-cost-operator",
+ "description": "Only for the Conditional type.",
+ "x-stoplight": {
+ "id": "ak744d5hs26tb"
+ }
+ },
+ "costVariable": {
+ "$ref": "#/components/schemas/conditional-cost-variable",
+ "description": "default
Only for the Conditional type.",
+ "x-stoplight": {
+ "id": "la3r0xwre29qy"
+ }
+ },
+ "operand": {
+ "type": "number",
+ "description": "default
Operand of the Conditional type cost."
+ },
+ "serviceTypes": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "gkyey7knc4j3v"
+ },
+ "description": "default
Array of Service Type identifiers where this additional cost is applied. ",
+ "items": {
+ "x-stoplight": {
+ "id": "3e6kwmu58ut0p"
+ },
+ "type": "string"
+ }
+ },
+ "customUnitName": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "6o3o1f3p0863z"
+ },
+ "description": "The name of the custom unit."
+ }
+ }
+ },
+ "analysis-statistics": {
+ "title": "Analysis Statistics",
+ "type": "object",
+ "properties": {
+ "exactMatch": {
+ "$ref": "#/components/schemas/count",
+ "description": "default
Statistics count.
",
+ "x-default-field": true
+ },
+ "inContextExactMatch": {
+ "$ref": "#/components/schemas/count",
+ "description": "default
Statistics count.
",
+ "x-default-field": true
+ },
+ "perfectMatch": {
+ "$ref": "#/components/schemas/count",
+ "description": "default
Statistics count.
",
+ "x-default-field": true
+ },
+ "new": {
+ "$ref": "#/components/schemas/count",
+ "description": "default
Statistics count.
",
+ "x-default-field": true
+ },
+ "repetitions": {
+ "$ref": "#/components/schemas/count",
+ "description": "default
Statistics count.
",
+ "x-default-field": true
+ },
+ "crossDocumentRepetitions": {
+ "$ref": "#/components/schemas/count",
+ "description": "default
Statistics count.
",
+ "x-default-field": true
+ },
+ "machineTranslation": {
+ "$ref": "#/components/schemas/count",
+ "description": "default
Statistics count.
",
+ "x-default-field": true
+ },
+ "fuzzyMatch": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/fuzzy-count"
+ },
+ "description": "default
Statistics count.
",
+ "x-default-field": true
+ },
+ "total": {
+ "$ref": "#/components/schemas/count",
+ "description": "default
Statistics count.
",
+ "x-default-field": true
+ }
+ }
+ },
+ "analytics": {
+ "title": "Analytics",
+ "type": "object",
+ "properties": {
+ "progress": {
+ "$ref": "#/components/schemas/analytics-progress"
+ },
+ "overdueStatistics": {
+ "$ref": "#/components/schemas/analytics-overdue-statistics"
+ },
+ "sourceFileStatistics": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/analytics-source-file-statistics"
+ }
+ },
+ "workloadStatistics": {
+ "$ref": "#/components/schemas/analytics-workload-statistics"
+ },
+ "taskTypeStatistics": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/analytics-task-type-statistics"
+ }
+ },
+ "phaseStatistics": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/analytics-phase-statistics"
+ }
+ }
+ },
+ "description": "Project analytics."
+ },
+ "analytics-progress": {
+ "title": "Analytics Progress",
+ "type": "object",
+ "description": "Overall progress.",
+ "properties": {
+ "overall": {
+ "type": "integer",
+ "nullable": true,
+ "description": "default
The overall progress.
",
+ "x-default-field": true
+ }
+ }
+ },
+ "analytics-overdue-statistics": {
+ "title": "Analytics Overdue Statistics",
+ "type": "object",
+ "description": "Statistics on overdue work.",
+ "properties": {
+ "overdueTasks": {
+ "type": "integer",
+ "nullable": true,
+ "description": "default
The number of overdue tasks.
",
+ "x-default-field": true
+ },
+ "dueDateCloseTasks": {
+ "type": "integer",
+ "nullable": true,
+ "description": "default
The number of tasks closed after the due date.
",
+ "x-default-field": true
+ }
+ }
+ },
+ "analytics-source-file-statistics": {
+ "title": "Analytics Source File Statistics",
+ "type": "object",
+ "description": "Source file statistics grouped by role.",
+ "properties": {
+ "role": {
+ "$ref": "#/components/schemas/file-role",
+ "description": "default
The file role.
",
+ "x-default-field": true
+ },
+ "count": {
+ "type": "integer",
+ "nullable": true,
+ "description": "default
The file count.
",
+ "x-default-field": true
+ }
+ }
+ },
+ "analytics-workload-statistics": {
+ "title": "Analytics Workload Statistics",
+ "type": "object",
+ "description": "Statistics on workload progress.",
+ "properties": {
+ "completed": {
+ "type": "integer",
+ "nullable": true,
+ "description": "default
",
+ "x-default-field": true
+ },
+ "total": {
+ "type": "integer",
+ "nullable": true,
+ "description": "default
",
+ "x-default-field": true
+ }
+ }
+ },
+ "analytics-task-type-statistics": {
+ "title": "Analytics Task Type Statistics",
+ "type": "object",
+ "description": "Task Type statistics grouped.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "default
",
+ "x-default-field": true
+ },
+ "key": {
+ "type": "string",
+ "description": "default
",
+ "x-default-field": true
+ },
+ "total": {
+ "type": "integer",
+ "nullable": true,
+ "description": "default
",
+ "x-default-field": true
+ },
+ "current": {
+ "type": "integer",
+ "nullable": true,
+ "description": "default
",
+ "x-default-field": true
+ },
+ "completed": {
+ "type": "integer",
+ "nullable": true,
+ "description": "default
",
+ "x-default-field": true
+ },
+ "error": {
+ "type": "integer",
+ "nullable": true,
+ "description": "default
",
+ "x-default-field": true
+ }
+ }
+ },
+ "analytics-phase-statistics": {
+ "title": "Analytics Phase Statistics",
+ "type": "object",
+ "description": "Statistics for phases grouped.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "default
",
+ "x-default-field": true
+ },
+ "total": {
+ "type": "integer",
+ "nullable": true,
+ "description": "default
",
+ "x-default-field": true
+ },
+ "completed": {
+ "type": "integer",
+ "nullable": true,
+ "description": "default
",
+ "x-default-field": true
+ }
+ }
+ },
+ "asynchronous-result": {
+ "title": "Asynchronous Result",
+ "type": "object",
+ "description": "Represents the result of an asynchronous operation, including status and potential error information.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique identifier for the asynchronous operation."
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of the asynchronous operation.",
+ "enum": [
+ "created",
+ "inProgress",
+ "completed",
+ "failed"
+ ]
+ },
+ "errorMessage": {
+ "type": "string",
+ "description": "When the status is 'failed', it contains the error message explaining what went wrong."
+ }
+ },
+ "required": [
+ "id",
+ "status"
+ ]
+ },
+ "count": {
+ "title": "Count",
+ "type": "object",
+ "description": "Statistics count.",
+ "properties": {
+ "words": {
+ "type": "integer",
+ "description": "default
Number of words.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "segments": {
+ "type": "integer",
+ "description": "default
Number of segments.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "characters": {
+ "type": "integer",
+ "description": "default
Number of characters.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "placeables": {
+ "type": "integer",
+ "description": "default
Number of placeables.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "tags": {
+ "type": "integer",
+ "description": "default
Number of tags.
",
+ "nullable": true,
+ "x-default-field": true
+ }
+ }
+ },
+ "configuration-resource-request": {
+ "title": "Configuration Resource Request",
+ "type": "object",
+ "description": "Resource configuration properties.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Configuration resource identifier."
+ },
+ "strategy": {
+ "type": "string",
+ "description": "\"copy\": A copy of the resource will be used for the project execution. This is the default strategy.\n\n\"use\": The actual resource will be used for the project execution.",
+ "default": "copy",
+ "enum": [
+ "copy",
+ "use"
+ ]
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "completion-config-request": {
+ "title": "Completion Configuration",
+ "x-stoplight": {
+ "id": "9mwe1gdglduma"
+ },
+ "type": "object",
+ "description": "Completion configuration properties.",
+ "properties": {
+ "completeDays": {
+ "type": "number",
+ "description": "Number of days until automatic completion of the project. Starting from project creation date.",
+ "x-stoplight": {
+ "id": "ceanv1mabx8qq"
+ },
+ "minimum": 1,
+ "maximum": 365,
+ "default": 90
+ },
+ "archiveDays": {
+ "type": "number",
+ "x-stoplight": {
+ "id": "l8bju7xnl0r40"
+ },
+ "minimum": 1,
+ "maximum": 365,
+ "default": 90,
+ "description": "Number of days after project completion when the project will be \r\narchived.."
+ },
+ "archiveReminderDays": {
+ "type": "number",
+ "x-stoplight": {
+ "id": "bclu4cm76o4w4"
+ },
+ "minimum": 1,
+ "maximum": 365,
+ "default": 7,
+ "description": "Number of days before archiving when a reminder will be sent."
+ }
+ }
+ },
+ "completion-config-response": {
+ "title": "Completion Configuration",
+ "x-stoplight": {
+ "id": "0z2k59nqy13cl"
+ },
+ "type": "object",
+ "description": "Completion configuration properties.",
+ "properties": {
+ "completeDate": {
+ "$ref": "#/components/schemas/date-time",
+ "x-stoplight": {
+ "id": "f7adiaz6qf6b4"
+ },
+ "description": "default
"
+ },
+ "completeDays": {
+ "type": "number",
+ "description": "default
Number of days until automatic completion of the project. Starting from project creation date.
",
+ "minimum": 1,
+ "maximum": 365,
+ "default": 90
+ },
+ "archiveDate": {
+ "$ref": "#/components/schemas/date-time",
+ "x-stoplight": {
+ "id": "z7g5nb84eytoc"
+ },
+ "description": "default
"
+ },
+ "archiveDays": {
+ "type": "number",
+ "minimum": 1,
+ "maximum": 365,
+ "default": 90,
+ "description": "default
Number of days after project completion when the workflow will be stopped and the project will enter *archived* state.
",
+ "x-stoplight": {
+ "id": "s30y2qk8d359o"
+ }
+ },
+ "archiveReminderDays": {
+ "type": "number",
+ "minimum": 1,
+ "maximum": 365,
+ "default": 7,
+ "description": "default
Number of days before workflow stoppage when a reminder will be sent.
",
+ "x-stoplight": {
+ "id": "z0iqmdumocd9v"
+ }
+ }
+ }
+ },
+ "conditional-cost-operator": {
+ "title": "Conditional Cost Operator",
+ "x-stoplight": {
+ "id": "u0in7jsh95abi"
+ },
+ "enum": [
+ "less",
+ "lessOrEqual",
+ "greater",
+ "greaterOrEqual"
+ ]
+ },
+ "conditional-cost-type": {
+ "title": "Conditional Cost Type",
+ "x-stoplight": {
+ "id": "br34ph3abddli"
+ },
+ "enum": [
+ "absolute",
+ "relative",
+ "percentage"
+ ]
+ },
+ "conditional-cost-variable": {
+ "title": "Conditional Cost Variable",
+ "x-stoplight": {
+ "id": "e97vbe2580u68"
+ },
+ "enum": [
+ "wordCount",
+ "runningTotal"
+ ]
+ },
+ "customer": {
+ "title": "Customer",
+ "type": "object",
+ "description": "Customer resource.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Customer identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
Customer name.
",
+ "x-default-field": true
+ },
+ "keyContact": {
+ "$ref": "#/components/schemas/user"
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder-v2"
+ },
+ "ragStatus": {
+ "x-stoplight": {
+ "id": "z7v6f1w7qrqdj"
+ },
+ "enum": [
+ "green",
+ "amber",
+ "red"
+ ]
+ },
+ "customFieldDefinitions": {
+ "type": "array",
+ "description": "The custom field definitions.",
+ "items": {
+ "$ref": "#/components/schemas/custom-field-resource"
+ }
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "custom-field": {
+ "title": "Custom Field",
+ "type": "object",
+ "description": "A Custom Field model.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Custom Field identifier."
+ },
+ "name": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "ln5wrk75uaby5"
+ },
+ "description": "Custom Field name. (Not available for List Projects, Get Project Template and List Project Templates endpoints)"
+ },
+ "key": {
+ "type": "string",
+ "description": "Custom Field friendly key."
+ },
+ "value": {
+ "type": "object",
+ "description": "The value of the custom property. A date will be serialised as an ISO_8601 string."
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "customer-create-request": {
+ "title": "Customer Create Request",
+ "x-stoplight": {
+ "id": "f8bca95391ffb"
+ },
+ "type": "object",
+ "description": "Input for Customer creation.\n\n It will create an invitation for an account user account.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the customer.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`",
+ "maxLength": 50
+ },
+ "location": {
+ "type": "string",
+ "description": "The identifier of the parent folder for the customer."
+ },
+ "firstName": {
+ "type": "string",
+ "description": "Key contact first name. If you provide this field, pleaase also provide email and last name"
+ },
+ "lastName": {
+ "type": "string",
+ "description": "Key contact last name. If you provide this field, pleaase also provide email and first name"
+ },
+ "email": {
+ "type": "string",
+ "description": "Key contact email.. If you provide this field, pleaase also provide first name and last name"
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "customer-update-request": {
+ "title": "Customer Update Request",
+ "x-stoplight": {
+ "id": "03m0q1ecjc9q0"
+ },
+ "type": "object",
+ "description": "Input for Customer update.\n\n",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the customer.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`",
+ "maxLength": 50
+ },
+ "keyContactId": {
+ "type": "string",
+ "description": "The ID of the account user set as key contact."
+ },
+ "ragStatus": {
+ "type": "string",
+ "description": "The color tag used to mark-up a customer in the UI.",
+ "enum": [
+ "green",
+ "amber",
+ "red"
+ ]
+ },
+ "customFieldDefinitions": {
+ "description": "The Custom Fields",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/custom-field-resource",
+ "x-stoplight": {
+ "id": "jwte0fv6wp2z7"
+ }
+ }
+ },
+ "folderVisibility": {
+ "type": "string",
+ "description": "The folder visibility to its subfolders.",
+ "enum": [
+ "default",
+ "private"
+ ]
+ }
+ }
+ },
+ "custom-field-resource": {
+ "title": "Custom Field Resource",
+ "type": "object",
+ "description": "A Custom Field resource model.",
+ "required": [
+ "key",
+ "value"
+ ],
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Custom Field friendly key."
+ },
+ "value": {
+ "type": "object",
+ "description": "The value of the custom property. A date will be serialized as an ISO_8601 string."
+ }
+ }
+ },
+ "custom-field-definition": {
+ "title": "Custom Field Definition",
+ "type": "object",
+ "description": "The Custom Field definition.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The identifier of the Custom Field Definition, generated by the service."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The display name of the Custom Field.
",
+ "x-default-field": true
+ },
+ "key": {
+ "type": "string",
+ "description": "The key of the Custom Field, used for querying purposes."
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the Custom Field."
+ },
+ "type": {
+ "type": "string",
+ "description": "The value type supported by this Custom Field.",
+ "enum": [
+ "long",
+ "double",
+ "boolean",
+ "date",
+ "string",
+ "checkbox",
+ "longtext",
+ "picklist",
+ "multiSelectPicklist"
+ ],
+ "nullable": true
+ },
+ "pickListOptions": {
+ "type": "array",
+ "description": "Possible values if the type selected is \"picklist\" or \"multiSelectPicklist\".",
+ "uniqueItems": true,
+ "items": {
+ "type": "string"
+ }
+ },
+ "resourceType": {
+ "type": "string",
+ "description": "The resource type to which this Custom Field can be applied.",
+ "enum": [
+ "project",
+ "customer"
+ ]
+ },
+ "isReadOnly": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "defaultValue": {
+ "type": "string",
+ "description": "Specifies a default value for this Custom Field. This is required if the \"isReadOnly\" field is True."
+ },
+ "isMandatory": {
+ "type": "boolean",
+ "description": "Specifies if this Custom Field is mandatory when creating a resource of the supported type.",
+ "nullable": true
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder-v2"
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "custom-field-request": {
+ "title": "Custom Field Request",
+ "type": "object",
+ "description": "A Custom Field model used at project creation or project update.",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Custom Field friendly key."
+ },
+ "value": {
+ "type": "object",
+ "description": "The value of the custom field. A date will be serialized as a ISO_8601 string. For read only custom fields (`isReadOnly`), it must be set exactly as the `defaultValue` from custom field definition. "
+ }
+ },
+ "required": [
+ "key"
+ ]
+ },
+ "custom-field-update-request": {
+ "title": "Custom Field Update Request",
+ "x-stoplight": {
+ "id": "69hm58ubq50j6"
+ },
+ "type": "object",
+ "description": "",
+ "properties": {
+ "value": {
+ "type": "object",
+ "description": "The value of the custom field. A date will be serialized as a ISO_8601 string. For read only custom fields (`isReadOnly`), it must be set exactly as the `defaultValue` from custom field definition. "
+ }
+ },
+ "required": [
+ "value"
+ ]
+ },
+ "date-time": {
+ "type": "string",
+ "title": "DateTime",
+ "example": "2022-01-12T12:00:00.000Z",
+ "description": "UTC Timezone Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time", + "nullable": true + }, + "error-response": { + "title": "Error Response", + "type": "object", + "description": "Error response properties.", + "properties": { + "message": { + "type": "string", + "description": "Retrieves a descriptive message that shows what went wrong." + }, + "errorCode": { + "type": "string", + "description": "Concise code that describes the nature of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/components/schemas/error-detail-response" + } + } + }, + "required": [ + "message", + "errorCode" + ] + }, + "error-detail-response": { + "title": "Error Detail Response", + "type": "object", + "description": "Error detail response properties.", + "properties": { + "name": { + "type": "string", + "description": "" + }, + "code": { + "type": "string", + "description": "" + }, + "value": { + "type": "string" + } + } + }, + "translation-error-detail-response": { + "title": "Translation Errors Response", + "type": "object", + "description": "Translation error details response properties.", + "properties": { + "name": { + "type": "string", + "description": "
default
",
+ "x-default-field": true
+ },
+ "code": {
+ "type": "string",
+ "description": "default
",
+ "x-default-field": true
+ },
+ "value": {
+ "type": "string",
+ "description": "default
",
+ "x-default-field": true
+ }
+ }
+ },
+ "export-quote-report-response": {
+ "title": "Export Quote Report Response",
+ "type": "object",
+ "description": "Export quote report response.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The export quote report identifier."
+ }
+ }
+ },
+ "failed-task": {
+ "title": "Failed Task",
+ "type": "object",
+ "description": "Failed Task.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The failed task identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "The failed task name."
+ },
+ "errors": {
+ "type": "array",
+ "description": "The failed task errors.",
+ "items": {
+ "$ref": "#/components/schemas/task-error"
+ }
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ]
+ },
+ "file-analysis-response": {
+ "title": "File Analysis Response",
+ "x-stoplight": {
+ "id": "jzn363iiki313"
+ },
+ "type": "object",
+ "required": [
+ "status"
+ ],
+ "properties": {
+ "status": {
+ "x-stoplight": {
+ "id": "dfww4v5fop36i"
+ },
+ "description": "The status of the file analysis operation.\r\n\r\n`converting` - The files are being converted for analysis.\r\n`analysis` - Extracting the word count from the files.
\r\n`costEstimation` - Estimating the cost.
\r\n`completed` - The file analysis is completed.
\r\n`error` - The file analysis was unsuccessful. See the `errorMessage` field for more details.", + "enum": [ + "converting", + "analysis", + "costCalculation", + "completed", + "error" + ] + }, + "wordCount": { + "type": "integer", + "x-stoplight": { + "id": "hprd8di53gl2v" + }, + "description": "
default
The total word count of the files.
",
+ "x-default-field": true
+ },
+ "estimatedCosts": {
+ "$ref": "#/components/schemas/file-analysis-cost-response",
+ "x-stoplight": {
+ "id": "z0yw6q0m1yaq3"
+ },
+ "description": "The estimated costs."
+ },
+ "fileStatistics": {
+ "x-stoplight": {
+ "id": "0v204bl8ergop"
+ },
+ "description": "default
The word count breakdown by files.
",
+ "x-default-field": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/file-analysis-file-statistics",
+ "x-stoplight": {
+ "id": "umj4xnnmpqam9"
+ }
+ }
+ },
+ "errorMessage": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "trjzuxk6rorpo"
+ },
+ "description": "The cause of the error when the status is `error`."
+ }
+ }
+ },
+ "file-analysis-operation-response": {
+ "x-stoplight": {
+ "id": "0ptcnthovbi2q"
+ },
+ "title": "File Analysis Operation Response",
+ "type": "object",
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "20knift0n9bey"
+ },
+ "description": "The analysis operation id. Use this to poll it's status."
+ }
+ }
+ },
+ "file-analysis-cost-response": {
+ "title": "File Analysis Cost Response",
+ "x-stoplight": {
+ "id": "w8nmywx87l747"
+ },
+ "type": "object",
+ "required": [
+ "total"
+ ],
+ "properties": {
+ "currencyCode": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "hprd8di53gl2v"
+ },
+ "description": "The currency code (ISO 4217)."
+ },
+ "total": {
+ "type": "number",
+ "x-stoplight": {
+ "id": "dfww4v5fop36i"
+ },
+ "description": "The total cost calculated for the provided files and language pairs. \r\nIt represents the sum of the `translationCosts`, `languageCosts` and `additionalCosts`." + }, + "translationCosts": { + "type": "number", + "x-stoplight": { + "id": "8tiwwuff0g2eh" + }, + "description": "The base translation costs." + }, + "languageCosts": { + "type": "number", + "x-stoplight": { + "id": "z0yw6q0m1yaq3" + }, + "description": "The additional language costs." + }, + "additionalCosts": { + "type": "number", + "x-stoplight": { + "id": "ardngvieg6vrm" + }, + "description": "The additional translation costs." + } + } + }, + "file-analysis-file-statistics": { + "title": "File Analysis File Statistics", + "x-stoplight": { + "id": "67ic0f0jm8by8" + }, + "type": "object", + "required": [ + "fileId", + "wordCount" + ], + "properties": { + "fileId": { + "type": "string", + "x-stoplight": { + "id": "2azn3zm063bur" + }, + "description": "The file identifier." + }, + "wordCount": { + "type": "integer", + "x-stoplight": { + "id": "ivreutiffxph6" + }, + "description": "The number of words in this file." + } + } + }, + "file-processing-configuration": { + "title": "File Processing Configuration", + "type": "object", + "description": "File Processing Configuration resource. (Not available for List Projects endpoint)", + "properties": { + "id": { + "type": "string", + "description": "The file processing configuration identifier." + }, + "name": { + "type": "string", + "description": "
default
The file processing configuration name.
",
+ "x-default-field": true
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder-v2"
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "file-type-setting": {
+ "title": "File Type Setting",
+ "x-stoplight": {
+ "id": "twyoqd5uer5g0"
+ },
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The file type setting identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The file type name.
",
+ "x-default-field": true
+ },
+ "description": {
+ "type": "string"
+ },
+ "typeId": {
+ "type": "string",
+ "description": "A short string representation of the file type identifier. The ID displayed in the Trados Cloud Platform UI."
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "default
Is this file type setting enabled. Disabled file types will not be included in operations (ex. Scan)
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "excluded": {
+ "type": "boolean",
+ "description": "Is this file type setting included in the file processing configuration. \n\nFile types will be added to a configuration as excluded = true by default and can be included by a consumer when needed (via the Trados Cloud Platform UI)\n\nExcluded file types will not be included in operations (ex. Scan)",
+ "nullable": true
+ },
+ "deprecated": {
+ "type": "boolean",
+ "description": "This file type setting is planned for deprecation and will be removed in the future.",
+ "nullable": true
+ },
+ "orderNumber": {
+ "type": "integer",
+ "description": "The order of the setting in the file type configuration."
+ },
+ "extensions": {
+ "type": "array",
+ "description": "A collection of extensions supported by this file type. Ex: \"*.xlsx\"",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "id"
+ ],
+ "description": ""
+ },
+ "file-upload-response": {
+ "title": "File Upload Response",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The identifier of the uploaded file"
+ },
+ "fileName": {
+ "type": "string",
+ "description": "The name of the uploaded file"
+ },
+ "unzipStatus": {
+ "type": "string",
+ "enum": [
+ "queued",
+ "extracting",
+ "extracted",
+ "unzipError"
+ ],
+ "description": "The status of the unzipping operation. You can use this to determine if your .zip file has been extracted successfully."
+ }
+ },
+ "required": [
+ "id",
+ "fileName"
+ ]
+ },
+ "file-metadata-response": {
+ "title": "File Metadata Response",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The identifier of the uploaded file"
+ },
+ "fileName": {
+ "type": "string",
+ "description": "The name of the uploaded file"
+ },
+ "unzipStatus": {
+ "type": "string",
+ "enum": [
+ "queued",
+ "extracting",
+ "extracted",
+ "unzipError"
+ ],
+ "description": "The status of the unzipping operation. You can use this to determine if your .zip file has been extracted successfully."
+ },
+ "associatedFiles": {
+ "type": "array",
+ "description": "The files that were extracted from the uploaded .zip archive.",
+ "items": {
+ "$ref": "#/components/schemas/file-extracted-response"
+ }
+ }
+ },
+ "required": [
+ "id",
+ "fileName"
+ ]
+ },
+ "file-extracted-response": {
+ "title": "File Extracted Response",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The identifier of the extracted file."
+ },
+ "fileName": {
+ "type": "string",
+ "description": "The name of the extracted file."
+ },
+ "filePath": {
+ "type": "string",
+ "description": "The file path of the extracted file. This is relative to the archive root."
+ }
+ },
+ "required": [
+ "id",
+ "fileName",
+ "filePath"
+ ]
+ },
+ "file-role": {
+ "type": "string",
+ "title": "File-Role",
+ "enum": [
+ "translatable",
+ "reference",
+ "localizable",
+ "unknown"
+ ],
+ "nullable": true
+ },
+ "file-version-export": {
+ "title": "File Version Export",
+ "description": "File Version Export. The resulted version can be downloaded once the status is completed.",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/asynchronous-result"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "downloadUrl": {
+ "type": "string",
+ "description": "The url where the file can be downloaded."
+ }
+ }
+ }
+ ]
+ },
+ "file-version-import": {
+ "title": "File Version Import",
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/asynchronous-result"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "fileVersionId": {
+ "type": "string"
+ }
+ }
+ }
+ ]
+ },
+ "folder": {
+ "title": "Folder",
+ "type": "object",
+ "description": "Folder used for resource storage.",
+ "examples": [
+ {
+ "id": "1de8f71c357c4bb5a32626faf5f53ef1",
+ "name": "consumer_A",
+ "path": [
+ {
+ "id": "7fb808326daa4bb1988ckedcd0734aa6",
+ "location": "0e6d1f1aa8df46e6b9b111ca9f388c9e",
+ "name": "dexters_extensibility_consumer",
+ "hasParent": true
+ },
+ {
+ "id": "0e6d1f1aa8df46e6b9b111ca9f388c9e",
+ "location": "61e801fa3d600fe2cfs12dd08",
+ "name": "Customers",
+ "hasParent": true
+ },
+ {
+ "id": "61e801fa3d600fe2cfs12dd08",
+ "name": "61e801fa3d600fe2cfs12dd08",
+ "hasParent": false
+ }
+ ]
+ }
+ ],
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The folder identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The name of the folder.
",
+ "x-default-field": true
+ },
+ "hasParent": {
+ "type": "boolean",
+ "description": "Indicates if the folder has a parent folder.",
+ "nullable": true
+ },
+ "path": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "31bd3get7o6hk"
+ },
+ "description": "The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.",
+ "items": {
+ "$ref": "#/components/schemas/folder-path",
+ "x-stoplight": {
+ "id": "i4c2vlnydf80m"
+ }
+ }
+ }
+ }
+ },
+ "folder-v2": {
+ "title": "Folder",
+ "type": "object",
+ "description": "Folder used for resource storage.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The folder identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The name of the folder.
",
+ "x-default-field": true
+ },
+ "hasParent": {
+ "type": "boolean",
+ "description": "Indicates if the folder has a parent folder.",
+ "nullable": true
+ },
+ "path": {
+ "type": "array",
+ "description": "The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.",
+ "items": {
+ "$ref": "#/components/schemas/folder-path"
+ }
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "folder-path": {
+ "title": "Folder Path",
+ "type": "object",
+ "description": "Path of a folder.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The folder identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the folder."
+ },
+ "location": {
+ "type": "string",
+ "description": "default
The location identifier."
+ },
+ "hasParent": {
+ "type": "boolean",
+ "description": "default
Indicates if the folder has a parent folder.",
+ "nullable": true
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ]
+ },
+ "fuzzy-category": {
+ "title": "Fuzzy Category",
+ "type": "object",
+ "description": "Fuzzy category range. Example of Fuzzy bands: 100-100%, 95-99%, 85-94%, 75-84%, 50-74%.",
+ "properties": {
+ "minimum": {
+ "type": "integer",
+ "description": "default
The minimum of the range.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "maximum": {
+ "type": "integer",
+ "description": "default
The maximum of the range.
",
+ "nullable": true,
+ "x-default-field": true
+ }
+ }
+ },
+ "fuzzy-count": {
+ "title": "Fuzzy Count",
+ "type": "object",
+ "description": "Statistics count for fuzzy matches.",
+ "properties": {
+ "count": {
+ "$ref": "#/components/schemas/count",
+ "description": "default
Statistics count.
",
+ "x-default-field": true
+ },
+ "category": {
+ "$ref": "#/components/schemas/fuzzy-category",
+ "description": "default
Fuzzy category range.
",
+ "x-default-field": true
+ }
+ }
+ },
+ "fuzzy-match-category": {
+ "title": "Fuzzy Match Category",
+ "type": "object",
+ "description": "Fuzzy match category range.",
+ "properties": {
+ "minimumMatchValue": {
+ "type": "integer",
+ "nullable": true,
+ "description": "Minimum matching value of this range."
+ },
+ "maximumMatchValue": {
+ "type": "integer",
+ "nullable": true,
+ "description": "Maximum matching value of this range."
+ }
+ },
+ "required": [
+ "minimumMatchValue",
+ "maximumMatchValue"
+ ]
+ },
+ "fuzzy-match": {
+ "title": "Fuzzy Match",
+ "type": "object",
+ "description": "Fuzzy match model.",
+ "properties": {
+ "price": {
+ "type": "number",
+ "description": "Fuzzy match price for the range expressed in the category field."
+ },
+ "category": {
+ "$ref": "#/components/schemas/fuzzy-match-category"
+ }
+ },
+ "required": [
+ "price",
+ "category"
+ ]
+ },
+ "group": {
+ "title": "Group",
+ "type": "object",
+ "description": "Group of Users.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The group identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The group name.
",
+ "x-default-field": true
+ },
+ "description": {
+ "type": "string",
+ "description": "The group description."
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder-v2"
+ },
+ "users": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/user"
+ }
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "group-request": {
+ "title": "Group Request",
+ "type": "object",
+ "description": "Group of users.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The group identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "The group name."
+ },
+ "description": {
+ "type": "string",
+ "description": "The group description."
+ },
+ "location": {
+ "$ref": "#/components/schemas/resource-folder-request"
+ },
+ "users": {
+ "type": "array",
+ "description": "The group users.",
+ "items": {
+ "$ref": "#/components/schemas/user-request"
+ }
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "jwk": {
+ "title": "JWK",
+ "type": "object",
+ "description": "A Json Web Key. \n\nSee https://datatracker.ietf.org/doc/html/rfc7517 for details.", + "properties": { + "kty": { + "type": "string", + "description": "The cryptographic algorithm\n family used with the key." + }, + "n": { + "type": "string", + "description": "The RSA public modulus n." + }, + "e": { + "type": "string", + "description": "The RSA public exponent e." + }, + "alg": { + "type": "string", + "description": "The algorithm intended for use with the key." + }, + "kid": { + "type": "string", + "description": "The \"kid\" (key ID) parameter is used to match a specific key." + }, + "use": { + "type": "string", + "description": "The \"use\" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data." + } + } + }, + "language": { + "title": "Language", + "type": "object", + "description": "The language object.", + "properties": { + "languageCode": { + "type": "string", + "description": "Language code. ex: \"en-US\", \"de-DE\"." + }, + "englishName": { + "type": "string", + "description": "
default
Human readable name.
",
+ "x-default-field": true
+ },
+ "direction": {
+ "type": "string"
+ },
+ "parentLanguageCode": {
+ "type": "string"
+ },
+ "defaultSpecificLanguageCode": {
+ "type": "string"
+ },
+ "isNeutral": {
+ "type": "boolean",
+ "nullable": true
+ }
+ },
+ "required": [
+ "languageCode"
+ ]
+ },
+ "language-cost-request": {
+ "title": "Language Cost Request",
+ "x-stoplight": {
+ "id": "jnli6j6ma7ofy"
+ },
+ "type": "object",
+ "required": [
+ "name",
+ "type"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the additional cost. "
+ },
+ "type": {
+ "$ref": "#/components/schemas/language-cost-type",
+ "description": "The type of the cost."
+ },
+ "index": {
+ "type": "number",
+ "description": "The number of the cost."
+ },
+ "costPerUnit": {
+ "type": "number",
+ "description": "The cost of a unit."
+ },
+ "unitCount": {
+ "type": "number",
+ "description": "The number of units for which a cost is applied."
+ },
+ "volumeUnitType": {
+ "$ref": "#/components/schemas/volume-unit-type",
+ "description": "The unit type of the 'volume' cost, used as reference for the unit cost."
+ },
+ "conditionalCostType": {
+ "$ref": "#/components/schemas/conditional-cost-type",
+ "description": "Only for the Conditional type."
+ },
+ "conditionalCostOperator": {
+ "$ref": "#/components/schemas/conditional-cost-operator",
+ "description": "Only for the Conditional type."
+ },
+ "conditionalCostVariable": {
+ "$ref": "#/components/schemas/conditional-cost-variable",
+ "description": "Only for the Conditional type."
+ },
+ "operand": {
+ "type": "number",
+ "description": "Operand of the Conditional type cost."
+ },
+ "serviceTypes": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "pm59yzs7tif7v"
+ },
+ "description": "Array of Service Type identifiers where this cost is applied.",
+ "items": {
+ "x-stoplight": {
+ "id": "24m354vpsw2oa"
+ },
+ "type": "string"
+ }
+ },
+ "customUnitName": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "5khq8y9o6v7pg"
+ },
+ "maxLength": 100,
+ "description": "The name of the custom unit. Required when `volumeUnitType` is `custom`."
+ }
+ }
+ },
+ "language-cost-type": {
+ "title": "Language Cost Type",
+ "x-stoplight": {
+ "id": "95486073d14e0"
+ },
+ "enum": [
+ "volume",
+ "hourly",
+ "percentage",
+ "perPage",
+ "conditional",
+ "adhoc",
+ "adhocVolume"
+ ]
+ },
+ "language-direction": {
+ "title": "Language Direction",
+ "type": "object",
+ "description": "A Language Direction.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The language direction identifier."
+ },
+ "sourceLanguage": {
+ "$ref": "#/components/schemas/language"
+ },
+ "targetLanguage": {
+ "$ref": "#/components/schemas/language"
+ },
+ "analysisStatistics": {
+ "$ref": "#/components/schemas/analysis-statistics"
+ }
+ },
+ "required": [
+ "id",
+ "sourceLanguage",
+ "targetLanguage"
+ ]
+ },
+ "language-direction-cost-request": {
+ "title": "Language Direction Cost Request",
+ "x-stoplight": {
+ "id": "e9lv9sdx92twt"
+ },
+ "type": "object",
+ "required": [
+ "sourceLanguage",
+ "targetLanguage"
+ ],
+ "properties": {
+ "sourceLanguage": {
+ "type": "string",
+ "description": "The source language code. For example: \"en-US\", \"de-DE\"."
+ },
+ "targetLanguage": {
+ "type": "string",
+ "description": "The target language code. For example: \"en-US\", \"de-DE\"."
+ },
+ "contextMatch": {
+ "type": "number",
+ "description": "The price of context matches.",
+ "x-default-field": true
+ },
+ "exactMatch": {
+ "type": "number",
+ "description": "The price of exact matches.",
+ "x-default-field": true
+ },
+ "new": {
+ "description": "The price of new matches.",
+ "type": "number",
+ "x-default-field": true
+ },
+ "perfectMatch": {
+ "type": "number",
+ "description": "The price of PerfectMatches.",
+ "x-default-field": true
+ },
+ "repetition": {
+ "type": "number",
+ "description": "The price of repetition matches.",
+ "x-default-field": true
+ },
+ "machineTranslation": {
+ "type": "number",
+ "description": "The price of machine translation matches.",
+ "x-default-field": true
+ },
+ "pricingUnit": {
+ "$ref": "#/components/schemas/pricing-unit-type",
+ "x-default-field": true,
+ "description": "The type of the pricing unit. If not specified, `words` will be used as the default value."
+ },
+ "fuzzyMatches": {
+ "type": "array",
+ "x-default-field": true,
+ "description": "All fuzzyMatches categories should be the same for all the language directions.",
+ "items": {
+ "$ref": "#/components/schemas/fuzzy-match",
+ "x-stoplight": {
+ "id": "0m8m8t4mg06hy"
+ }
+ }
+ },
+ "additionalCosts": {
+ "x-default-field": true,
+ "description": "Additional costs applied at language level.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/language-cost-request",
+ "x-stoplight": {
+ "id": "p0j2ohoyogy3q"
+ }
+ }
+ }
+ }
+ },
+ "language-direction-no-statistics": {
+ "title": "Language Direction",
+ "x-stoplight": {
+ "id": "o2ahlu8d180l0"
+ },
+ "type": "object",
+ "description": "A Language Direction.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The language direction identifier."
+ },
+ "sourceLanguage": {
+ "$ref": "#/components/schemas/language"
+ },
+ "targetLanguage": {
+ "$ref": "#/components/schemas/language"
+ }
+ },
+ "required": [
+ "id",
+ "sourceLanguage",
+ "targetLanguage"
+ ]
+ },
+ "language-direction-item": {
+ "title": "Language Direction Item",
+ "type": "object",
+ "description": "",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The language direction identifier."
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "language-direction-cost": {
+ "title": "Language Direction Cost",
+ "x-stoplight": {
+ "id": "a0c8ffb7ad3c9"
+ },
+ "type": "object",
+ "required": [
+ "sourceLanguage",
+ "targetLanguage"
+ ],
+ "properties": {
+ "sourceLanguage": {
+ "type": "string",
+ "description": "The source language code. For example: \"en-US\", \"de-DE\"."
+ },
+ "targetLanguage": {
+ "type": "string",
+ "description": "The target language code. For example: \"en-US\", \"de-DE\"."
+ },
+ "contextMatch": {
+ "type": "number",
+ "description": "default
The price of context matches.",
+ "x-default-field": true
+ },
+ "exactMatch": {
+ "type": "number",
+ "description": "
default
The price of exact matches.",
+ "x-default-field": true
+ },
+ "new": {
+ "description": "
default
The price of new matches.",
+ "type": "number",
+ "x-default-field": true
+ },
+ "perfectMatch": {
+ "type": "number",
+ "description": "
default
The price of PerfectMatches.",
+ "x-default-field": true
+ },
+ "repetition": {
+ "type": "number",
+ "description": "
default
The price of repetition matches.",
+ "x-default-field": true
+ },
+ "machineTranslation": {
+ "type": "number",
+ "description": "
default
The price of machine translation matches.",
+ "x-default-field": true
+ },
+ "pricingUnit": {
+ "$ref": "#/components/schemas/pricing-unit-type",
+ "description": "
default
",
+ "x-default-field": true,
+ "nullable": true
+ },
+ "fuzzyMatches": {
+ "type": "array",
+ "description": "
default
",
+ "x-default-field": true,
+ "items": {
+ "$ref": "#/components/schemas/fuzzy-match",
+ "x-stoplight": {
+ "id": "i06cxve7hjibt"
+ }
+ }
+ },
+ "additionalCosts": {
+ "type": "array",
+ "description": "
default
",
+ "x-default-field": true,
+ "items": {
+ "$ref": "#/components/schemas/language-cost",
+ "x-stoplight": {
+ "id": "eskiho7o9q38f"
+ }
+ }
+ }
+ }
+ },
+ "language-direction-request": {
+ "title": "Language Direction Request",
+ "type": "object",
+ "description": "The language directions model used for creating or updating a project.",
+ "properties": {
+ "sourceLanguage": {
+ "$ref": "#/components/schemas/source-language-request"
+ },
+ "targetLanguage": {
+ "$ref": "#/components/schemas/target-language-request"
+ }
+ },
+ "required": [
+ "sourceLanguage",
+ "targetLanguage"
+ ]
+ },
+ "language-processing-rule": {
+ "title": "Language Processing Rule",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The language processing rule identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time", + "nullable": true + }, + "deliveredBy": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": " UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time", + "nullable": true, + "x-stoplight": { + "id": "xxmhjuc5d6ohd" + } + }, + "createdAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The project's creation date and time.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time", + "nullable": true + }, + "status": { + "type": "string", + "description": "The project's status.", + "enum": [ + "created", + "inProgress", + "completed", + "archived" + ], + "nullable": true + }, + "statusHistory": { + "type": "array", + "description": "The project's status history.", + "nullable": true, + "items": { + "$ref": "#/components/schemas/project-status-history" + } + }, + "languageDirections": { + "type": "array", + "description": "
Note: The values for source and targe language must have the same value as the source and target language from project template.", + "items": { + "$ref": "#/components/schemas/language-direction-request" + } + }, + "location": { + "type": "string", + "description": "The folder identifier where the project should be created." + }, + "translationEngine": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "fileProcessingConfiguration": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "workflow": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "pricingModel": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "customFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-field-request" + } + }, + "tqaProfile": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "forceOnline": { + "type": "boolean", + "description": "This forces the project to be translated using the Trados Cloud Platform Online Editor exclusively." + }, + "projectManagers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/project-manager-request" + } + }, + "scheduleTemplate": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "settings": { + "$ref": "#/components/schemas/project-settings-request", + "x-stoplight": { + "id": "53re0us2no8zk" + } + } + } + }, + "project-configuration": { + "title": "Project Configuration", + "x-stoplight": { + "id": "qx05l6h0joh9h" + }, + "description": "The configuration settings for a project.", + "type": "object", + "properties": { + "translationMemoryFields": { + "$ref": "#/components/schemas/translation-memory-fields", + "description": "
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\" ", + "format": "date-time" + }, + "lastModifiedAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the project group was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time" + } + }, + "required": [ + "id" + ] + }, + "project-group-create-response": { + "title": "Project Group Create Response", + "type": "object", + "description": "The Project Group Create response. ", + "properties": { + "id": { + "type": "string", + "description": "The project group identifier." + }, + "name": { + "type": "string", + "description": "The project group name." + }, + "description": { + "type": "string", + "description": "The project group description." + }, + "status": { + "type": "string", + "description": "The status of the projects in the project group.\n\n- `new`: the group is newly created, or all the projects in the group have the \"New\" status \n\n- `inProgress`: at least one project in the group is in progress\n\n- `completed`: all projects in the group have the \"Completed\" status \n\n- `deleting`: the group is being deleted and the projects will be removed", + "enum": [ + "new", + "inProgress", + "completed", + "deleting" + ] + }, + "location": { + "$ref": "#/components/schemas/folder-v2" + }, + "shortId": { + "type": "string", + "x-stoplight": { + "id": "g72simvju3z9z" + } + }, + "createdAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the project group was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time" + }, + "lastModifiedAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the project group was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time" + } + }, + "required": [ + "id" + ] + }, + "project-group-project": { + "title": "Project Group Project", + "type": "object", + "description": "Project resource for project group.", + "properties": { + "id": { + "type": "string", + "description": "The project identifier." + }, + "status": { + "type": "string", + "description": "The project's status.", + "enum": [ + "attaching", + "attached", + "detaching", + "updating", + "failed" + ] + } + }, + "required": [ + "id" + ], + "x-stoplight": { + "id": "kia482tzj55ou" + } + }, + "project-group-project-request": { + "title": "Project Group Project Request", + "x-stoplight": { + "id": "abqotabie1tzm" + }, + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "A project id." + } + }, + "required": [ + "id" + ] + }, + "project-group-create-request": { + "title": "Project Group Create Request", + "type": "object", + "description": "Input for project group creation.", + "properties": { + "name": { + "type": "string", + "description": "The project group name.\\\nMust be unique per location.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", + "minLength": 1, + "maxLength": 100 + }, + "description": { + "type": "string", + "description": "The project group description.", + "maxLength": 1000 + }, + "location": { + "type": "string", + "description": "The folder identifier where the project group should be created. If it isn't mentioned, it will be created in the Root folder. If the user does not have access in Root, the request will fail with forbidden error. " + } + }, + "required": [ + "name" + ] + }, + "project-group-update-request": { + "title": "Project Group Update Request", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The project group name.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", + "minLength": 1, + "maxLength": 100 + }, + "description": { + "type": "string", + "description": "The project group description.", + "maxLength": 1000 + } + } + }, + "project-manager-request": { + "title": "Project Manager Request", + "x-stoplight": { + "id": "6j883j92igshf" + }, + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Depending on the type, User identifier or Group identifier." + }, + "type": { + "type": "string", + "enum": [ + "group", + "user" + ] + } + }, + "required": [ + "id", + "type" + ] + }, + "project-manager-response": { + "title": "Project Manager Response", + "x-stoplight": { + "id": "jpzqsh6pvehw6" + }, + "type": "object", + "description": "", + "properties": { + "type": { + "type": "string", + "enum": [ + "group", + "user" + ] + }, + "user": { + "$ref": "#/components/schemas/user" + }, + "group": { + "$ref": "#/components/schemas/group" + } + } + }, + "project-settings-request": { + "title": "Project Settings", + "x-stoplight": { + "id": "7hz2hdu01vw0w" + }, + "type": "object", + "properties": { + "general": { + "$ref": "#/components/schemas/project-settings-general-request", + "x-stoplight": { + "id": "uv85h82rgn4ao" + } + } + } + }, + "project-settings-response": { + "title": "Project Settings", + "x-stoplight": { + "id": "79vl39jda1he7" + }, + "type": "object", + "properties": { + "general": { + "$ref": "#/components/schemas/project-settings-general-response", + "description": "
Note: The values for source and targe language must have the same value as the source and target language from project template.", + "items": { + "$ref": "#/components/schemas/language-direction-request" + } + }, + "customFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-field-request" + } + }, + "translationEngine": { + "$ref": "#/components/schemas/configuration-resource-request", + "x-stoplight": { + "id": "thx33vvuk5gyo" + } + }, + "pricingModel": { + "$ref": "#/components/schemas/configuration-resource-request", + "x-stoplight": { + "id": "qmx22fog888cz" + } + }, + "workflow": { + "$ref": "#/components/schemas/configuration-resource-request", + "x-stoplight": { + "id": "7djywbuahg9ha" + } + }, + "settings": { + "$ref": "#/components/schemas/project-template-settings-request", + "x-stoplight": { + "id": "ygnao3kecn7hc" + } + } + } + }, + "project-template-update-request": { + "title": "Project Template Update Request", + "x-stoplight": { + "id": "udaysucy7sgy4" + }, + "type": "object", + "description": "Input for Project Template creation.", + "properties": { + "name": { + "type": "string", + "description": "The project template name.", + "minLength": 1, + "maxLength": 100 + }, + "description": { + "type": "string", + "description": "The project description.", + "maxLength": 1000 + }, + "fileProcessingConfiguration": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "projectManagers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/project-manager-request" + } + }, + "scheduleTemplate": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "languageDirections": { + "type": "array", + "description": "The language directions.\n\nWhen creating a project using a project template that supports multiple source languages, you must supply the `languageDirections`.
Note: The values for source and targe language must have the same value as the source and target language from project template.", + "items": { + "$ref": "#/components/schemas/language-direction-request" + } + }, + "customFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-field-request" + } + }, + "translationEngine": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "pricingModel": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "workflow": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "settings": { + "$ref": "#/components/schemas/project-template-settings-update-request" + } + } + }, + "project-template-response": { + "title": "Project Template", + "x-stoplight": { + "id": "f513d3d83fd5d" + }, + "type": "object", + "description": "Project Template resource. (Not available for List Projects endpoint)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "description": "The project template identifier." + }, + "name": { + "type": "string", + "description": "
default
The language processing rule name.
",
+ "x-default-field": true
+ },
+ "description": {
+ "type": "string",
+ "description": "The language processing rule description."
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "language-request": {
+ "title": "Language Request",
+ "type": "object",
+ "properties": {
+ "languageCode": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "languageCode"
+ ]
+ },
+ "language-pair": {
+ "title": "Language Pair",
+ "x-stoplight": {
+ "id": "61t8792ya7zez"
+ },
+ "type": "object",
+ "properties": {
+ "source": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "0xwwyeclt9qb9"
+ },
+ "description": "Language code. ex: \"en-US\", de-DE\"."
+ },
+ "target": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "0ndrvic0areb1"
+ },
+ "description": "Language code. ex: \"en-US\", de-DE\"."
+ }
+ },
+ "required": [
+ "source",
+ "target"
+ ],
+ "description": ""
+ },
+ "language-pair-resource": {
+ "title": "Language Pair Resource",
+ "x-stoplight": {
+ "id": "62g4076dmqp0x"
+ },
+ "type": "object",
+ "description": "Resource describing a Translation Memory, Termbase or Machine Translation used in a Translation Engine.",
+ "required": [
+ "id",
+ "type"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "0xwwyeclt9qb9"
+ },
+ "description": "The identifier of the Translation Memory, Termbase, Machine Translation or LLM."
+ },
+ "systemId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "xvf797250xe34"
+ },
+ "description": "Required only for neural Machine Translation resources."
+ },
+ "type": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "1smtmeliso6fm"
+ },
+ "description": "The resource type. ",
+ "enum": [
+ "TM",
+ "MT",
+ "TB",
+ "LLM"
+ ]
+ },
+ "penalty": {
+ "type": "integer",
+ "x-stoplight": {
+ "id": "465u0rm7i1n97"
+ },
+ "description": "Only for TM"
+ },
+ "lookup": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "bnsbqsinf3azu"
+ },
+ "description": "Only for TM, TB"
+ },
+ "concordance": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "6h3n7qz9llokc"
+ },
+ "description": "Only for TM"
+ },
+ "update": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "euo2zyycwz99m"
+ },
+ "description": "Only for TM, TB"
+ },
+ "generativeTranslation": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "inxa0qoemlw46"
+ },
+ "description": "Only for LLM"
+ },
+ "smartReview": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "s7x3mcw5kgyr4"
+ },
+ "description": "Only for LLM"
+ }
+ }
+ },
+ "list-customers-response": {
+ "title": "List Customers Response",
+ "type": "object",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/customer"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "description": "A response for the List Customers endpoint."
+ },
+ "list-custom-field-definitions-response": {
+ "title": "List Custom Field Definitions Response",
+ "type": "object",
+ "description": "A response for the List Custom Field Definitions endpoint.",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/custom-field-definition"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ]
+ },
+ "list-file-processing-configurations-response": {
+ "title": "List File Processing Configurations Response",
+ "type": "object",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/file-processing-configuration"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "description": "A response for the List File Processing Configurations endpoint."
+ },
+ "list-file-type-settings-response": {
+ "title": "List File Type Settings Response",
+ "type": "object",
+ "description": "A response for the List File Type Settings endpoint.",
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/file-type-setting"
+ }
+ }
+ }
+ },
+ "list-folders-response": {
+ "title": "List Folders Response",
+ "type": "object",
+ "description": "A response for the List Folders endpoint.",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/folder"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ]
+ },
+ "list-groups-response": {
+ "title": "List Groups Response",
+ "type": "object",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/group"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "description": "A response for the List Groups endpoint."
+ },
+ "list-jwks": {
+ "title": "List JWKs Response",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/jwk"
+ }
+ },
+ "list-languages-response": {
+ "title": "List Languages Response",
+ "type": "object",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/language"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "description": "A response for the List Languages endpoint."
+ },
+ "list-language-processing-rules": {
+ "title": "List Language Processing Rules",
+ "type": "object",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/language-processing-rule"
+ }
+ },
+ "itemCount": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "items",
+ "itemCount"
+ ]
+ },
+ "list-machine-translations-response": {
+ "title": "List Machine Translations Response",
+ "x-stoplight": {
+ "id": "fhk9xi0bpvf3x"
+ },
+ "type": "object",
+ "description": "A response for the List Machine Translations endpoint.",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/machine-translation"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ]
+ },
+ "list-my-accounts-response": {
+ "title": "List My Accounts Response",
+ "type": "object",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/account"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "description": "A response for the List My Accounts endpoint."
+ },
+ "list-pricing-models-response": {
+ "title": "List Pricing Models Response",
+ "type": "object",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/pricing-model"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "description": "A response for the List Pricing Models endpoint."
+ },
+ "list-project-templates-response": {
+ "title": "List Project Templates Response",
+ "type": "object",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/project-template-response"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "description": "A response for the List Project Templates endpoint."
+ },
+ "list-schedule-templates-response": {
+ "title": "List Schedule Templates Response",
+ "x-stoplight": {
+ "id": "1rzz3ctuczv9f"
+ },
+ "type": "object",
+ "description": "A response for the List Schedule Templates endpoint.",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/schedule-template"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ]
+ },
+ "list-rate-limits-response": {
+ "title": "List Rate Limits Response",
+ "type": "object",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/rate-limit"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "description": "A response for the List Rate Limits endpoint."
+ },
+ "list-perfect-match-candidates-response": {
+ "title": "List PerfectMatch Candidates Response",
+ "x-stoplight": {
+ "id": "i66skbktv8vko"
+ },
+ "type": "object",
+ "description": "A response for the Get PerfectMatch Candidates endpoint.",
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/perfect-match-candidate"
+ }
+ }
+ }
+ },
+ "list-project-groups-response": {
+ "title": "List Project Groups Response",
+ "type": "object",
+ "description": "A response for the List Project Groups endpoint.",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/project-group"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ]
+ },
+ "list-projects-response": {
+ "title": "List Projects Response",
+ "type": "object",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/project"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "description": "A response for the List Projects endpoint."
+ },
+ "list-source-files-response": {
+ "title": "List Source Files Response",
+ "type": "object",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/source-file"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "description": "A response for the List Source Files endpoint."
+ },
+ "list-source-file-versions-response": {
+ "title": "List Source File Versions Response",
+ "type": "object",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/source-file-version"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "description": "A response for the List Source File Versions endpoint."
+ },
+ "list-target-files-response": {
+ "title": "List Target Files Response",
+ "type": "object",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/target-file"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "description": "A response for the List Target Files endpoint."
+ },
+ "list-target-file-versions-response": {
+ "title": "List Target File Versions Response",
+ "type": "object",
+ "description": "A response for the List Target Files Versions endpoint.",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/target-file-version"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ]
+ },
+ "list-tasks-response": {
+ "title": "List Tasks Response",
+ "type": "object",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/task"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "description": "A response for the List Tasks endpoint."
+ },
+ "list-task-types-response": {
+ "title": "List Task Types Response",
+ "type": "object",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/task-type"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "description": "A response for the List Task types endpoint."
+ },
+ "list-tqa-profiles-response": {
+ "title": "List TQA Profiles Response",
+ "type": "object",
+ "description": "",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/tqa-profile"
+ }
+ },
+ "itemCount": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "items",
+ "itemCount"
+ ]
+ },
+ "list-termbase-templates-response": {
+ "title": "List Termbase Templates Response",
+ "type": "object",
+ "description": "The termbase templates response.",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/termbase-template"
+ }
+ },
+ "itemCount": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "items",
+ "itemCount"
+ ]
+ },
+ "list-termbases-response": {
+ "title": "List Termbases Response",
+ "type": "object",
+ "description": "The list termbases response.",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/termbase"
+ }
+ },
+ "itemCount": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "items",
+ "itemCount"
+ ]
+ },
+ "list-termbase-terms-response": {
+ "title": "List Termbase Terms Response",
+ "type": "object",
+ "description": "The list termbase terms response.",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/termbase-term"
+ }
+ },
+ "itemCount": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "items",
+ "itemCount"
+ ]
+ },
+ "list-termbase-entries-response": {
+ "title": "List Termbase Entries Response",
+ "type": "object",
+ "description": "The list termbase entries response.",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/termbase-entry"
+ }
+ },
+ "itemCount": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "items",
+ "itemCount"
+ ]
+ },
+ "list-termbase-import-history": {
+ "title": "Get Termbase Import History",
+ "type": "object",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/termbase-import-history-response"
+ }
+ },
+ "itemCount": {
+ "type": "integer"
+ }
+ }
+ },
+ "list-translation-engines-response": {
+ "title": "List Translation Engines Response",
+ "type": "object",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/translation-engine"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "description": "A response for the List Translation Engines endpoint."
+ },
+ "list-translation-memories-reposne": {
+ "title": "List Translation Memories Response",
+ "type": "object",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/translation-memory"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "description": "A response for the List Translation Memories endpoint."
+ },
+ "list-translation-memory-import-history": {
+ "title": "Get Translation Memory Import History",
+ "type": "object",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/translation-memory-import-history-response"
+ }
+ },
+ "itemCount": {
+ "type": "integer"
+ }
+ }
+ },
+ "list-translation-memory-field-templates": {
+ "title": "List Translation Memory Field Templates",
+ "x-stoplight": {
+ "id": "icrpz2hliblzj"
+ },
+ "type": "object",
+ "description": "A response for the List Translation Memory Field Templates endpoint.",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/translation-memory-field-template"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ]
+ },
+ "list-translation-service-types-response": {
+ "title": "List Translation Service Types Response",
+ "x-stoplight": {
+ "id": "hfotzd0fq5zx2"
+ },
+ "type": "object",
+ "description": "A response for the List Translation Service Types endpoint.",
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "properties": {
+ "itemCount": {
+ "type": "integer",
+ "x-stoplight": {
+ "id": "izsgcvo2ilhmt"
+ }
+ },
+ "items": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "dvdp579kl1cc5"
+ },
+ "items": {
+ "$ref": "#/components/schemas/translation-service-type",
+ "x-stoplight": {
+ "id": "b2c2bbjsoepdb"
+ }
+ }
+ }
+ }
+ },
+ "list-users-response": {
+ "title": "List Users Response",
+ "type": "object",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/user"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "description": "A response for the List Users endpoint."
+ },
+ "list-workflows-response": {
+ "title": "List Workflows Response",
+ "type": "object",
+ "properties": {
+ "itemCount": {
+ "type": "integer"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/workflow"
+ }
+ }
+ },
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "description": "A response for the List Workflows endpoint."
+ },
+ "llm-configuration-response": {
+ "title": "LLM Configuration Response",
+ "x-stoplight": {
+ "id": "kp7sn68d75t8z"
+ },
+ "type": "object",
+ "description": "The LLM configuration details",
+ "required": [
+ "id",
+ "model",
+ "type",
+ "isDefault",
+ "isActive"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "53ri5rgnwgj3c"
+ },
+ "description": "The LLM configuraiton identifier."
+ },
+ "description": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "l1t1rrfi16rl6"
+ },
+ "description": "The configuration description."
+ },
+ "model": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "83vangex352aj"
+ },
+ "description": "The model name."
+ },
+ "type": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "lsb4gvpmerg7z"
+ },
+ "enum": [
+ "azureOpenAI",
+ "awsBedrock"
+ ],
+ "description": "The LLM provider type."
+ },
+ "isDefault": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "8co4b9p37he2y"
+ },
+ "description": "Flag representing whether the LLM configuration is default."
+ },
+ "isActive": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "1bw7exz7k43o4"
+ },
+ "description": "Flag representing whether the LLM configuration is active."
+ }
+ }
+ },
+ "list-llm-configurations-response": {
+ "title": "List LLM Configurations Response",
+ "x-stoplight": {
+ "id": "zax5a75zj3u5f"
+ },
+ "type": "object",
+ "required": [
+ "itemCount",
+ "items"
+ ],
+ "properties": {
+ "itemCount": {
+ "type": "integer",
+ "x-stoplight": {
+ "id": "xt0e6xcbjnlds"
+ },
+ "description": "The total item count."
+ },
+ "items": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "zdj0fmsdrjuma"
+ },
+ "items": {
+ "$ref": "#/components/schemas/llm-configuration-response",
+ "x-stoplight": {
+ "id": "834zntr25p2xt"
+ }
+ }
+ }
+ },
+ "description": "A response for the List LLM Configurations endpoint."
+ },
+ "machine-translation": {
+ "title": "Machine Translation",
+ "x-stoplight": {
+ "id": "q83tushwc71wu"
+ },
+ "type": "object",
+ "description": "Machine translation resource.",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string",
+ "description": "Provider of the machine translation.
",
+ "x-default-field": true,
+ "x-stoplight": {
+ "id": "o2vxfwxx5ypjq"
+ }
+ },
+ "type": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "027ukef1wajci"
+ },
+ "description": "Type of the machine translation. Can be generic or neural."
+ },
+ "systemId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "6inesg0lkfqtn"
+ },
+ "description": "default
Appears if the machine translation is neural."
+ },
+ "modelSourceLanguage": {
+ "x-stoplight": {
+ "id": "ujzglo1mwl4pl"
+ },
+ "type": "string",
+ "description": "Model Source language"
+ },
+ "modelTargetLanguage": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "dssycbmasvpyc"
+ },
+ "description": "Model Target language"
+ },
+ "matchingSourceLanguage": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "rxm5xpz6oj11t"
+ },
+ "description": "Specific source language supported by the model, matching the query "
+ },
+ "matchingTargetLanguages": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "ncr79i78eof3x"
+ },
+ "description": "Specific target languages supported by the model, matching the query ",
+ "items": {
+ "x-stoplight": {
+ "id": "7ekyl863df2e7"
+ },
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "id",
+ "provider",
+ "type",
+ "modelSourceLanguage",
+ "modelTargetLanguage",
+ "matchingSourceLanguage",
+ "matchingTargetLanguages"
+ ]
+ },
+ "object-id": {
+ "title": "Object Identifier",
+ "type": "object",
+ "description": "An object with identifier.",
+ "properties": {
+ "id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "object-id-request": {
+ "title": "Object Identifier Request",
+ "type": "object",
+ "description": "An object with identifier.",
+ "properties": {
+ "id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "perfect-match-candidate": {
+ "title": "PerfectMatch Candidate",
+ "x-stoplight": {
+ "id": "fx87e3hzcrq7z"
+ },
+ "type": "object",
+ "x-internal": false,
+ "required": [
+ "score",
+ "fileId"
+ ],
+ "properties": {
+ "score": {
+ "type": "number",
+ "x-stoplight": {
+ "id": "fm35hes639la9"
+ },
+ "format": "double",
+ "description": "The match score.",
+ "minimum": 0,
+ "maximum": 100
+ },
+ "fileId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "vs2ndi7jr87fl"
+ },
+ "description": "The file identifier:\r\n- `targetFileId` if file is a project file\r\n- `fileId` if file is user provided"
+ },
+ "project": {
+ "$ref": "#/components/schemas/project",
+ "x-stoplight": {
+ "id": "umsyu9xmi8sqp"
+ },
+ "description": "The project from where the candidate was selected."
+ }
+ },
+ "description": "A project file that can be used as a match for PerfectMatch"
+ },
+ "perfect-match-custom-file-mapping-request": {
+ "title": "PerfectMatch Custom File Mapping Request",
+ "x-stoplight": {
+ "id": "c787724801aca"
+ },
+ "description": "Provide you own matching file.",
+ "type": "object",
+ "required": [
+ "properties",
+ "file"
+ ],
+ "properties": {
+ "properties": {
+ "type": "object",
+ "x-stoplight": {
+ "id": "q75mghzupqq7g"
+ },
+ "required": [
+ "name",
+ "targetLanguage"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "df0d1cic1j71s"
+ },
+ "description": "The file name."
+ },
+ "targetLanguage": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "2pdl6nnrb1ar4"
+ }
+ }
+ }
+ },
+ "file": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "1yko3sjshe3k8"
+ },
+ "format": "binary",
+ "description": "The source file (binary string). Only SDLXLIFF files are accepted."
+ }
+ }
+ },
+ "perfect-match-mapping-create-request": {
+ "title": "PerfectMatch Mapping Create Request",
+ "x-stoplight": {
+ "id": "q81dfuu1hzfp8"
+ },
+ "type": "object",
+ "description": "A request to create a new PerfectMatch mapping.",
+ "required": [
+ "projectId"
+ ],
+ "properties": {
+ "projectId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "nemjj434jweo7"
+ },
+ "description": "The project identifier this mapping will be used on."
+ },
+ "matchingProjects": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "cizz5j6yddvzh"
+ },
+ "description": "A collection of projects that will be used to find matches and candidates for PerfectMatch mapping.",
+ "minItems": 0,
+ "maxItems": 10,
+ "items": {
+ "x-stoplight": {
+ "id": "52fzpqwxdoc9p"
+ },
+ "type": "string"
+ }
+ }
+ }
+ },
+ "perfect-match-mapping-response": {
+ "type": "object",
+ "x-examples": {
+ "Example 1": {
+ "id": "string",
+ "projectId": "string",
+ "createdBy": "string",
+ "mappings": [
+ {
+ "id": "string",
+ "projectMappingId": "string",
+ "batch": 1073741824,
+ "mappingStatus": "GENERATED",
+ "mappingProviders": [
+ {
+ "projectId": "string"
+ }
+ ],
+ "files": [
+ {
+ "id": "string",
+ "fileId": "string",
+ "fileStorageId": "string",
+ "fileName": "string",
+ "path": [
+ "string"
+ ],
+ "languageMappings": [
+ {
+ "targetLanguage": "string",
+ "match": {
+ "fileName": "string",
+ "path": [
+ "string"
+ ],
+ "origin": {
+ "fileId": "string",
+ "projectId": "string",
+ "matchSource": "USER",
+ "type": "BCM"
+ }
+ }
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "title": "PerfectMatch Mapping Response",
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The mapping identifier."
+ },
+ "project": {
+ "$ref": "#/components/schemas/project",
+ "description": "The project id where this mapping is used.",
+ "x-stoplight": {
+ "id": "cw1yohtjvixag"
+ }
+ },
+ "createdBy": {
+ "$ref": "#/components/schemas/user",
+ "description": "The account user who created the mapping."
+ },
+ "batchMappings": {
+ "type": "array",
+ "description": "A collection of mappings per project batches.",
+ "items": {
+ "$ref": "#/components/schemas/perfect-match-batch-mapping",
+ "x-stoplight": {
+ "id": "gp890bw2rx06u"
+ }
+ }
+ }
+ }
+ },
+ "perfect-match-mapping-simple-response": {
+ "type": "object",
+ "x-stoplight": {
+ "id": "y1b8w4daohpzi"
+ },
+ "x-examples": {
+ "Example 1": {
+ "id": "string",
+ "projectId": "string",
+ "createdBy": "string",
+ "mappings": [
+ {
+ "id": "string",
+ "projectMappingId": "string",
+ "batch": 1073741824,
+ "mappingStatus": "GENERATED",
+ "mappingProviders": [
+ {
+ "projectId": "string"
+ }
+ ],
+ "files": [
+ {
+ "id": "string",
+ "fileId": "string",
+ "fileStorageId": "string",
+ "fileName": "string",
+ "path": [
+ "string"
+ ],
+ "languageMappings": [
+ {
+ "targetLanguage": "string",
+ "match": {
+ "fileName": "string",
+ "path": [
+ "string"
+ ],
+ "origin": {
+ "fileId": "string",
+ "projectId": "string",
+ "matchSource": "USER",
+ "type": "BCM"
+ }
+ }
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "title": "PerfectMatch Mapping Response",
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The mapping identifier."
+ },
+ "createdBy": {
+ "$ref": "#/components/schemas/user",
+ "description": "The account user who created the mapping."
+ },
+ "batchMappings": {
+ "type": "array",
+ "description": "A collection of mappings per project batches.",
+ "items": {
+ "$ref": "#/components/schemas/perfect-match-batch-mapping"
+ }
+ }
+ },
+ "description": "PerfectMatch Mapping (Not available for List Projects endpoint)"
+ },
+ "perfect-match-mapping-create-response": {
+ "type": "object",
+ "x-stoplight": {
+ "id": "ztgh3mwksij6k"
+ },
+ "x-examples": {
+ "Example 1": {
+ "id": "string",
+ "projectId": "string",
+ "createdBy": "string",
+ "mappings": [
+ {
+ "id": "string",
+ "projectMappingId": "string",
+ "batch": 1073741824,
+ "mappingStatus": "GENERATED",
+ "mappingProviders": [
+ {
+ "projectId": "string"
+ }
+ ],
+ "files": [
+ {
+ "id": "string",
+ "fileId": "string",
+ "fileStorageId": "string",
+ "fileName": "string",
+ "path": [
+ "string"
+ ],
+ "languageMappings": [
+ {
+ "targetLanguage": "string",
+ "match": {
+ "fileName": "string",
+ "path": [
+ "string"
+ ],
+ "origin": {
+ "fileId": "string",
+ "projectId": "string",
+ "matchSource": "USER",
+ "type": "BCM"
+ }
+ }
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ },
+ "title": "PerfectMatch Mapping Create Response",
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The mapping identifier."
+ },
+ "project": {
+ "$ref": "#/components/schemas/project",
+ "description": "The project id where this mapping is used."
+ },
+ "createdBy": {
+ "$ref": "#/components/schemas/user",
+ "description": "The account user who created the mapping."
+ },
+ "batchMappings": {
+ "type": "array",
+ "description": "A collection of mappings per project batches.",
+ "items": {
+ "$ref": "#/components/schemas/perfect-match-batch-mapping-created-response"
+ }
+ }
+ }
+ },
+ "perfect-match-project-file-mapping-request": {
+ "type": "object",
+ "title": "PerfectMatch Project File Mapping Request",
+ "description": "Provide a matching file from an existing project.",
+ "required": [
+ "fileId",
+ "projectId"
+ ],
+ "properties": {
+ "fileId": {
+ "type": "string",
+ "description": "The `targetFileId` from the referenced project. Must be from a PerfectMatch Candidate."
+ },
+ "projectId": {
+ "type": "string",
+ "description": "Specifies which project the matching file belongs to. Must be from a PerfectMatch Candidate."
+ }
+ }
+ },
+ "perfect-match-batch-mapping-created-response": {
+ "title": "PerfectMatch Batch Mapping Created Response",
+ "x-stoplight": {
+ "id": "sd4wox8a8yxu0"
+ },
+ "type": "object",
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The identifier of this batch mapping."
+ },
+ "batch": {
+ "type": "integer",
+ "minimum": 1,
+ "description": "The project batch associated with this mapping."
+ },
+ "status": {
+ "description": "The status of the matching operation.\r\n\r\n- `pending` - The matching background operation has not started yet.\r\n- `generating` - The system is currently matching candidates.\r\n- `generated` - The matching background operation has finished and any possible candidates have been found.",
+ "type": "string",
+ "enum": [
+ "generating",
+ "generated",
+ "pending"
+ ]
+ },
+ "matchingProjects": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/project"
+ }
+ }
+ }
+ },
+ "perfect-match-batch-mapping-update-request": {
+ "title": "PerfectMatch Batch Mapping Update Request",
+ "type": "object",
+ "required": [
+ "languageDirections",
+ "files"
+ ],
+ "properties": {
+ "languageDirections": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "wx7ycae79bp99"
+ },
+ "items": {
+ "$ref": "#/components/schemas/language-direction-request",
+ "x-stoplight": {
+ "id": "onvc9ppeqn9nx"
+ }
+ }
+ },
+ "files": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "bfels2gzsvw4f"
+ },
+ "items": {
+ "$ref": "#/components/schemas/perfect-match-file-mapping-request",
+ "x-stoplight": {
+ "id": "c174aqqs2sxuq"
+ }
+ }
+ },
+ "matchingProjects": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "1i0ai06fg30tf"
+ },
+ "maxItems": 10,
+ "description": "A collection of project identifiers that will be used to find matches and candidates for PerfectMatch mapping.",
+ "items": {
+ "x-stoplight": {
+ "id": "1tzpb2tsqipah"
+ },
+ "type": "string"
+ }
+ }
+ }
+ },
+ "perfect-match-batch-mapping": {
+ "title": "PerfectMatch Batch Mapping",
+ "x-stoplight": {
+ "id": "9cda3eljxhu3a"
+ },
+ "type": "object",
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "oxnybhlyo0zi7"
+ },
+ "description": "The identifier of this batch mapping."
+ },
+ "batch": {
+ "type": "integer",
+ "x-stoplight": {
+ "id": "s6rq1wfw9jdy1"
+ },
+ "minimum": 1,
+ "description": "The project batch associated with this mapping."
+ },
+ "status": {
+ "x-stoplight": {
+ "id": "vaorrbeajdfu5"
+ },
+ "description": "The status of the matching operation.\r\n\r\n- `pending` - The matching background operation has not started yet.\r\n- `generating` - The system is currently matching candidates.\r\n- `generated` - The matching background operation has finished and any possible candidates have been found.",
+ "type": "string",
+ "enum": [
+ "generating",
+ "generated",
+ "pending"
+ ]
+ },
+ "matchingProjects": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "friowu6zupizf"
+ },
+ "items": {
+ "$ref": "#/components/schemas/project",
+ "x-stoplight": {
+ "id": "oc87tuszl8nfk"
+ }
+ }
+ },
+ "matchingFiles": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "9jd93fqm2ltik"
+ },
+ "description": "The file matches identified based on this mapping. Matching files will be available when status is `generated`.",
+ "items": {
+ "$ref": "#/components/schemas/perfect-match-file-mapping",
+ "x-stoplight": {
+ "id": "9pjk6n73h08ny"
+ }
+ }
+ }
+ }
+ },
+ "perfect-match-file-match": {
+ "title": "PerfectMatch File Match",
+ "x-stoplight": {
+ "id": "6cznfvzrl2f6u"
+ },
+ "type": "object",
+ "required": [
+ "fileName",
+ "targetLanguage"
+ ],
+ "properties": {
+ "fileName": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "1p98snhwpm9z2"
+ },
+ "description": "The file name."
+ },
+ "targetLanguage": {
+ "$ref": "#/components/schemas/language",
+ "x-stoplight": {
+ "id": "08vniy685mxh2"
+ },
+ "description": "The target language this is matched to."
+ },
+ "origin": {
+ "$ref": "#/components/schemas/perfect-match-file-origin",
+ "x-stoplight": {
+ "id": "id0ppt1te182q"
+ },
+ "description": "The source of this match."
+ }
+ }
+ },
+ "perfect-match-file-mapping": {
+ "title": "PerfectMatch File Mapping",
+ "x-stoplight": {
+ "id": "03dgg9mbsdrab"
+ },
+ "type": "object",
+ "required": [
+ "fileMappingId",
+ "targetLanguages",
+ "matches"
+ ],
+ "properties": {
+ "fileMappingId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "a3wt6g7te3bf4"
+ },
+ "description": "The identifier of this file mapping."
+ },
+ "fileId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "z52hcnkibqypu"
+ },
+ "description": "The file identifier."
+ },
+ "fileName": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "8ol3pommxgmwx"
+ },
+ "description": "The file name."
+ },
+ "targetLanguages": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "r4uvpx3hkfk6r"
+ },
+ "description": "File target languages.",
+ "items": {
+ "$ref": "#/components/schemas/language",
+ "x-stoplight": {
+ "id": "wgqj3aq90fxrl"
+ }
+ }
+ },
+ "matches": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "lrkirjzhqym3j"
+ },
+ "description": "The file matches.",
+ "items": {
+ "$ref": "#/components/schemas/perfect-match-file-match",
+ "x-stoplight": {
+ "id": "h0414pn1x8ebh"
+ }
+ }
+ }
+ }
+ },
+ "perfect-match-file-mapping-request": {
+ "title": "PerfectMatch File Mapping Request",
+ "x-stoplight": {
+ "id": "mtvcmglyse666"
+ },
+ "type": "object",
+ "required": [
+ "sourceFileId",
+ "fileName"
+ ],
+ "properties": {
+ "sourceFileId": {
+ "type": "string",
+ "description": "The source file identifier.",
+ "x-stoplight": {
+ "id": "6gsxau7p4z2t8"
+ }
+ },
+ "fileName": {
+ "type": "string",
+ "description": "The file name."
+ },
+ "targetLanguages": {
+ "type": "array",
+ "description": "File target languages. If no languages are specified, all language directions from the batch mapping will be used.",
+ "items": {
+ "$ref": "#/components/schemas/target-language-request"
+ }
+ }
+ }
+ },
+ "perfect-match-file-origin": {
+ "title": "PerfectMatch File Origin",
+ "x-stoplight": {
+ "id": "bv5cnpx9k3iny"
+ },
+ "type": "object",
+ "required": [
+ "fileId"
+ ],
+ "properties": {
+ "fileId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "f2apl2q7ak1dd"
+ }
+ },
+ "matchSource": {
+ "x-stoplight": {
+ "id": "hnztp78j7k3kv"
+ },
+ "type": "string",
+ "enum": [
+ "userUpload",
+ "perfectMatch",
+ "candidateConfirm",
+ "userSelection"
+ ]
+ },
+ "projectId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "zq9xsxg01n4cr"
+ }
+ },
+ "type": {
+ "x-stoplight": {
+ "id": "plrs8n0348nq8"
+ },
+ "type": "string",
+ "enum": [
+ "bcm",
+ "sdlXliff"
+ ]
+ }
+ }
+ },
+ "pricing-model": {
+ "title": "Pricing Model",
+ "type": "object",
+ "description": "Pricing Model resource. (Not available for List Projects endpoint)",
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The pricing model identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The name of the Pricing Model.
"
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the Pricing Model. ",
+ "x-stoplight": {
+ "id": "ip7d3npquqhtm"
+ }
+ },
+ "currencyCode": {
+ "type": "string",
+ "description": "default
The currency code (ISO 4217).
",
+ "x-default-field": true
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder-v2",
+ "x-default-field": true
+ },
+ "languageDirectionPricing": {
+ "type": "array",
+ "description": "Costs applied for languages.",
+ "items": {
+ "$ref": "#/components/schemas/language-direction-cost",
+ "x-stoplight": {
+ "id": "iulcrkpbt2dkl"
+ }
+ }
+ },
+ "additionalCosts": {
+ "description": "Additional costs applied at project level.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/project-cost",
+ "x-stoplight": {
+ "id": "8mgl2ge6it23h"
+ }
+ }
+ }
+ }
+ },
+ "pricing-model-create-request": {
+ "title": "Pricing Model Create Request",
+ "x-stoplight": {
+ "id": "84rdt11xy57je"
+ },
+ "type": "object",
+ "required": [
+ "name",
+ "currencyCode",
+ "location",
+ "languageDirectionPricing"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "ux0n1of3l2fcg"
+ },
+ "minLength": 1,
+ "maxLength": 100,
+ "description": "The name of the Pricing Model. "
+ },
+ "description": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "lqs1u6y1jp99p"
+ },
+ "maxLength": 1000,
+ "description": "The description of the Pricing Model. "
+ },
+ "currencyCode": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "p7je5zmdu0oft"
+ },
+ "description": "The currency code (ISO 4217)."
+ },
+ "location": {
+ "x-stoplight": {
+ "id": "ut6kllrmvrxi3"
+ },
+ "type": "string",
+ "description": "The location of the pricing model."
+ },
+ "languageDirectionPricing": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "5fvs81l6ulki3"
+ },
+ "description": "Costs applied for languages.",
+ "items": {
+ "$ref": "#/components/schemas/language-direction-cost-request",
+ "x-stoplight": {
+ "id": "bx0acxg9bor4s"
+ }
+ }
+ },
+ "additionalCosts": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "ibv6uo16upgzt"
+ },
+ "description": "Additional costs applied at project level.",
+ "items": {
+ "$ref": "#/components/schemas/project-cost-request",
+ "x-stoplight": {
+ "id": "lj22tg789rgr1"
+ }
+ }
+ }
+ }
+ },
+ "pricing-model-update-request": {
+ "title": "Pricing Model Update Request",
+ "x-stoplight": {
+ "id": "1c3gw712tops3"
+ },
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "xv08h2p68irht"
+ },
+ "description": "The name of the Pricing Model. ",
+ "minLength": 1,
+ "maxLength": 100
+ },
+ "description": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "kqq1pm5c0nbkt"
+ },
+ "description": "The description of the Pricing Model. ",
+ "maxLength": 1000
+ },
+ "currencyCode": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "640ojrh29nljb"
+ },
+ "description": "The currency code (ISO 4217)."
+ },
+ "languageDirectionPricing": {
+ "x-stoplight": {
+ "id": "24gog5ehhl04i"
+ },
+ "description": "Costs applied for languages.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/language-direction-cost-request",
+ "x-stoplight": {
+ "id": "8bkrkdfcb2s15"
+ }
+ }
+ },
+ "additionalCosts": {
+ "x-stoplight": {
+ "id": "buk3e62if233x"
+ },
+ "description": "Additional costs applied at project level.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/project-cost-request",
+ "x-stoplight": {
+ "id": "dd4fhfzp4hqx2"
+ }
+ }
+ }
+ }
+ },
+ "project-pricing-model-update-request": {
+ "title": "Update project pricing model request",
+ "type": "object",
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The pricing model identifier."
+ },
+ "strategy": {
+ "type": "string",
+ "description": "\"copy\": A copy of the resource will be used for the project execution. This is the default strategy.\n\n\"use\": The actual resource will be used for the project execution.",
+ "default": "copy",
+ "enum": [
+ "copy",
+ "use"
+ ]
+ }
+ }
+ },
+ "pricing-unit-type": {
+ "title": "Pricing Unit Type",
+ "enum": [
+ "words",
+ "characters"
+ ]
+ },
+ "project": {
+ "title": "Project",
+ "type": "object",
+ "description": "Project resource.",
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The project identifier."
+ },
+ "shortId": {
+ "type": "string",
+ "description": "The short identifier of the project."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The project name.
",
+ "x-default-field": true
+ },
+ "description": {
+ "type": "string",
+ "description": "The project description."
+ },
+ "dueBy": {
+ "type": "string",
+ "example": "2022-01-12T12:00:00.000Z",
+ "description": "The project due date. UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time", + "nullable": true + }, + "deliveredBy": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": " UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time", + "nullable": true, + "x-stoplight": { + "id": "xxmhjuc5d6ohd" + } + }, + "createdAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The project's creation date and time.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time", + "nullable": true + }, + "status": { + "type": "string", + "description": "The project's status.", + "enum": [ + "created", + "inProgress", + "completed", + "archived" + ], + "nullable": true + }, + "statusHistory": { + "type": "array", + "description": "The project's status history.", + "nullable": true, + "items": { + "$ref": "#/components/schemas/project-status-history" + } + }, + "languageDirections": { + "type": "array", + "description": "
default
The project's language directions.
",
+ "x-default-field": true,
+ "items": {
+ "$ref": "#/components/schemas/language-direction"
+ }
+ },
+ "customer": {
+ "$ref": "#/components/schemas/customer"
+ },
+ "createdBy": {
+ "$ref": "#/components/schemas/user"
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder-v2",
+ "description": "default
The resource folder.
",
+ "x-default-field": true
+ },
+ "projectTemplate": {
+ "$ref": "#/components/schemas/project-template-response"
+ },
+ "translationEngine": {
+ "$ref": "#/components/schemas/translation-engine"
+ },
+ "fileProcessingConfiguration": {
+ "$ref": "#/components/schemas/file-processing-configuration"
+ },
+ "pricingModel": {
+ "$ref": "#/components/schemas/pricing-model"
+ },
+ "workflow": {
+ "$ref": "#/components/schemas/workflow"
+ },
+ "projectPlan": {
+ "$ref": "#/components/schemas/project-plan"
+ },
+ "analytics": {
+ "$ref": "#/components/schemas/analytics"
+ },
+ "analysisStatistics": {
+ "$ref": "#/components/schemas/analysis-statistics"
+ },
+ "quote": {
+ "$ref": "#/components/schemas/quote"
+ },
+ "customFields": {
+ "type": "array",
+ "description": "The Custom Fields",
+ "items": {
+ "$ref": "#/components/schemas/custom-field"
+ }
+ },
+ "tqaProfile": {
+ "$ref": "#/components/schemas/tqa-profile"
+ },
+ "forceOnline": {
+ "type": "boolean",
+ "description": "This forces the project to be translated using the Trados Cloud Platform Online Editor exclusively."
+ },
+ "quoteTemplate": {
+ "$ref": "#/components/schemas/project-quote-template"
+ },
+ "projectGroup": {
+ "$ref": "#/components/schemas/project-group"
+ },
+ "projectManagers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/project-manager-response"
+ }
+ },
+ "scheduleTemplate": {
+ "$ref": "#/components/schemas/schedule-template",
+ "x-stoplight": {
+ "id": "dsvy1i7nqqv3z"
+ }
+ },
+ "perfectMatchMapping": {
+ "$ref": "#/components/schemas/perfect-match-mapping-simple-response",
+ "x-stoplight": {
+ "id": "15ak4sadvjb89"
+ }
+ },
+ "settings": {
+ "$ref": "#/components/schemas/project-settings-response",
+ "x-stoplight": {
+ "id": "k0yk2u3skecpf"
+ }
+ }
+ }
+ },
+ "project-create-request": {
+ "title": "Project Create Request",
+ "type": "object",
+ "description": "Input for Project creation.\n\nBefore starting the project, the required configuration resources (translation engine, file processing configuration and workflow) should be set either explicitly or through a project template that contains references to these configuration resources.",
+ "required": [
+ "name",
+ "dueBy",
+ "languageDirections",
+ "location"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The project name.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`",
+ "minLength": 1,
+ "maxLength": 100
+ },
+ "description": {
+ "type": "string",
+ "description": "The project description.",
+ "maxLength": 1000
+ },
+ "dueBy": {
+ "$ref": "#/components/schemas/date-time"
+ },
+ "projectTemplate": {
+ "$ref": "#/components/schemas/object-id-request"
+ },
+ "languageDirections": {
+ "type": "array",
+ "description": "The language directions.\n\nWhen creating a project using a project template that supports multiple source languages, you must supply the `languageDirections`.Note: The values for source and targe language must have the same value as the source and target language from project template.", + "items": { + "$ref": "#/components/schemas/language-direction-request" + } + }, + "location": { + "type": "string", + "description": "The folder identifier where the project should be created." + }, + "translationEngine": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "fileProcessingConfiguration": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "workflow": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "pricingModel": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "customFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-field-request" + } + }, + "tqaProfile": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "forceOnline": { + "type": "boolean", + "description": "This forces the project to be translated using the Trados Cloud Platform Online Editor exclusively." + }, + "projectManagers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/project-manager-request" + } + }, + "scheduleTemplate": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "settings": { + "$ref": "#/components/schemas/project-settings-request", + "x-stoplight": { + "id": "53re0us2no8zk" + } + } + } + }, + "project-configuration": { + "title": "Project Configuration", + "x-stoplight": { + "id": "qx05l6h0joh9h" + }, + "description": "The configuration settings for a project.", + "type": "object", + "properties": { + "translationMemoryFields": { + "$ref": "#/components/schemas/translation-memory-fields", + "description": "
default
",
+ "x-default-field": true
+ },
+ "updateTranslationMemory": {
+ "$ref": "#/components/schemas/update-translation-memory",
+ "x-stoplight": {
+ "id": "akhqz2lu4ks2b"
+ }
+ }
+ }
+ },
+ "project-configuration-request": {
+ "title": "Project Configuration Request",
+ "x-stoplight": {
+ "id": "5ivmv9i754acq"
+ },
+ "type": "object",
+ "description": "A request used to update the configuration settings for a project.",
+ "properties": {
+ "translationMemoryFieldsSettings": {
+ "$ref": "#/components/schemas/translation-memory-fields-update-request"
+ },
+ "updateTranslationMemory": {
+ "$ref": "#/components/schemas/update-translation-memory",
+ "x-stoplight": {
+ "id": "zx6orwsjfd51g"
+ }
+ },
+ "perfectMatchMappingId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "84cmud84h1lf6"
+ },
+ "description": "The PerfectMatch mapping to be associated with the project."
+ }
+ }
+ },
+ "project-cost-request": {
+ "title": "Project Cost Request",
+ "x-stoplight": {
+ "id": "c3890498b55df"
+ },
+ "type": "object",
+ "required": [
+ "name",
+ "type"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the additional cost. "
+ },
+ "type": {
+ "$ref": "#/components/schemas/project-cost-type",
+ "description": "The type of the additional cost."
+ },
+ "index": {
+ "type": "number",
+ "description": "The number of the additional cost."
+ },
+ "costPerUnit": {
+ "type": "number",
+ "description": "The cost of a unit."
+ },
+ "unitCount": {
+ "type": "number",
+ "description": "The number of units for which a cost is applied."
+ },
+ "volumeUnitType": {
+ "$ref": "#/components/schemas/volume-unit-type",
+ "description": "The unit type of the 'volume' cost, used as reference for the unit cost."
+ },
+ "conditionalCostType": {
+ "$ref": "#/components/schemas/conditional-cost-type",
+ "description": "Only for the Conditional type."
+ },
+ "costOperator": {
+ "$ref": "#/components/schemas/conditional-cost-operator",
+ "description": "Only for the Conditional type.",
+ "x-stoplight": {
+ "id": "zqif0hjssiw1a"
+ }
+ },
+ "costVariable": {
+ "$ref": "#/components/schemas/conditional-cost-variable",
+ "description": "Only for the Conditional type.",
+ "x-stoplight": {
+ "id": "3a5ok8ukdtldt"
+ }
+ },
+ "operand": {
+ "type": "number",
+ "description": "Operand of the Conditional type cost."
+ },
+ "serviceTypes": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "k49y0alzptb99"
+ },
+ "description": "Array of Service Type identifiers where this additional cost is applied.",
+ "items": {
+ "x-stoplight": {
+ "id": "mg7w7sqohrgze"
+ },
+ "type": "string"
+ }
+ },
+ "customUnitName": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "1jvy04hcveeqt"
+ },
+ "maxLength": 100,
+ "description": "The name of the custom unit. Required when `volumeUnitType` is `custom`."
+ }
+ }
+ },
+ "project-cost-type": {
+ "title": "Project Cost Type",
+ "x-stoplight": {
+ "id": "nu6db8fhwsnqb"
+ },
+ "enum": [
+ "volume",
+ "perTargetLanguage",
+ "perFile",
+ "hourly",
+ "percentage",
+ "perPage",
+ "conditional",
+ "adhoc",
+ "adhocVolume"
+ ]
+ },
+ "project-group": {
+ "title": "Project Group",
+ "type": "object",
+ "description": "Project Group resource. (Not available for List Projects endpoint)",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The project group identifier."
+ },
+ "shortId": {
+ "type": "string",
+ "description": "The short identifier of the project group."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The project group name.
",
+ "x-default-field": true
+ },
+ "description": {
+ "type": "string",
+ "description": "The project group description."
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of the projects in the project group.\n\n- `new`: the group is new created, or all projects in the group have status New\n\n- `inProgress`: at least one project in the group is in progress\n\n- `completed`: all projects in the group have status Completed\n\n- `deleting`: the group is getting deleted and the projects are removing from it",
+ "enum": [
+ "new",
+ "inProgress",
+ "completed",
+ "deleting"
+ ]
+ },
+ "projects": {
+ "type": "array",
+ "description": "The projects in the project group.",
+ "items": {
+ "$ref": "#/components/schemas/project-group-project"
+ }
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder-v2"
+ },
+ "createdAt": {
+ "type": "string",
+ "example": "2022-01-12T12:00:00.000Z",
+ "description": "The date and time when the project group was created. UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\" ", + "format": "date-time" + }, + "lastModifiedAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the project group was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time" + } + }, + "required": [ + "id" + ] + }, + "project-group-create-response": { + "title": "Project Group Create Response", + "type": "object", + "description": "The Project Group Create response. ", + "properties": { + "id": { + "type": "string", + "description": "The project group identifier." + }, + "name": { + "type": "string", + "description": "The project group name." + }, + "description": { + "type": "string", + "description": "The project group description." + }, + "status": { + "type": "string", + "description": "The status of the projects in the project group.\n\n- `new`: the group is newly created, or all the projects in the group have the \"New\" status \n\n- `inProgress`: at least one project in the group is in progress\n\n- `completed`: all projects in the group have the \"Completed\" status \n\n- `deleting`: the group is being deleted and the projects will be removed", + "enum": [ + "new", + "inProgress", + "completed", + "deleting" + ] + }, + "location": { + "$ref": "#/components/schemas/folder-v2" + }, + "shortId": { + "type": "string", + "x-stoplight": { + "id": "g72simvju3z9z" + } + }, + "createdAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the project group was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time" + }, + "lastModifiedAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the project group was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time" + } + }, + "required": [ + "id" + ] + }, + "project-group-project": { + "title": "Project Group Project", + "type": "object", + "description": "Project resource for project group.", + "properties": { + "id": { + "type": "string", + "description": "The project identifier." + }, + "status": { + "type": "string", + "description": "The project's status.", + "enum": [ + "attaching", + "attached", + "detaching", + "updating", + "failed" + ] + } + }, + "required": [ + "id" + ], + "x-stoplight": { + "id": "kia482tzj55ou" + } + }, + "project-group-project-request": { + "title": "Project Group Project Request", + "x-stoplight": { + "id": "abqotabie1tzm" + }, + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "A project id." + } + }, + "required": [ + "id" + ] + }, + "project-group-create-request": { + "title": "Project Group Create Request", + "type": "object", + "description": "Input for project group creation.", + "properties": { + "name": { + "type": "string", + "description": "The project group name.\\\nMust be unique per location.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", + "minLength": 1, + "maxLength": 100 + }, + "description": { + "type": "string", + "description": "The project group description.", + "maxLength": 1000 + }, + "location": { + "type": "string", + "description": "The folder identifier where the project group should be created. If it isn't mentioned, it will be created in the Root folder. If the user does not have access in Root, the request will fail with forbidden error. " + } + }, + "required": [ + "name" + ] + }, + "project-group-update-request": { + "title": "Project Group Update Request", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The project group name.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", + "minLength": 1, + "maxLength": 100 + }, + "description": { + "type": "string", + "description": "The project group description.", + "maxLength": 1000 + } + } + }, + "project-manager-request": { + "title": "Project Manager Request", + "x-stoplight": { + "id": "6j883j92igshf" + }, + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Depending on the type, User identifier or Group identifier." + }, + "type": { + "type": "string", + "enum": [ + "group", + "user" + ] + } + }, + "required": [ + "id", + "type" + ] + }, + "project-manager-response": { + "title": "Project Manager Response", + "x-stoplight": { + "id": "jpzqsh6pvehw6" + }, + "type": "object", + "description": "", + "properties": { + "type": { + "type": "string", + "enum": [ + "group", + "user" + ] + }, + "user": { + "$ref": "#/components/schemas/user" + }, + "group": { + "$ref": "#/components/schemas/group" + } + } + }, + "project-settings-request": { + "title": "Project Settings", + "x-stoplight": { + "id": "7hz2hdu01vw0w" + }, + "type": "object", + "properties": { + "general": { + "$ref": "#/components/schemas/project-settings-general-request", + "x-stoplight": { + "id": "uv85h82rgn4ao" + } + } + } + }, + "project-settings-response": { + "title": "Project Settings", + "x-stoplight": { + "id": "79vl39jda1he7" + }, + "type": "object", + "properties": { + "general": { + "$ref": "#/components/schemas/project-settings-general-response", + "description": "
default
\r\n"
+ }
+ }
+ },
+ "project-settings-general-request": {
+ "title": "Project General Settings",
+ "x-stoplight": {
+ "id": "6dnig61u68hsr"
+ },
+ "type": "object",
+ "properties": {
+ "completionConfiguration": {
+ "$ref": "#/components/schemas/completion-config-request",
+ "x-stoplight": {
+ "id": "k15wt6trvjgbt"
+ }
+ }
+ }
+ },
+ "project-settings-general-response": {
+ "title": "Project General Settings",
+ "x-stoplight": {
+ "id": "v82ei22cerb0w"
+ },
+ "type": "object",
+ "properties": {
+ "completionConfiguration": {
+ "$ref": "#/components/schemas/completion-config-response",
+ "description": "default
"
+ }
+ }
+ },
+ "project-update-request": {
+ "title": "Project Update Request",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The project name.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`",
+ "minLength": 1,
+ "maxLength": 100
+ },
+ "description": {
+ "type": "string",
+ "description": "The project description.",
+ "maxLength": 1000
+ },
+ "dueBy": {
+ "$ref": "#/components/schemas/date-time"
+ },
+ "deliveredBy": {
+ "$ref": "#/components/schemas/date-time",
+ "x-stoplight": {
+ "id": "jlta5oi7fu3kf"
+ },
+ "description": "Value used to automatically update dueBy of the project at the Customer Quote Approval step, if this step exists in the project workflow."
+ },
+ "translationEngine": {
+ "$ref": "#/components/schemas/configuration-resource-request"
+ },
+ "fileProcessingConfiguration": {
+ "$ref": "#/components/schemas/configuration-resource-request"
+ },
+ "pricingModel": {
+ "$ref": "#/components/schemas/configuration-resource-request",
+ "description": "Resource configuration properties. Pricing model can only be updated for projects that are not started."
+ },
+ "workflow": {
+ "$ref": "#/components/schemas/configuration-resource-request"
+ },
+ "projectPlan": {
+ "$ref": "#/components/schemas/project-plan-update-request"
+ },
+ "tqaProfile": {
+ "$ref": "#/components/schemas/configuration-resource-request"
+ },
+ "quote": {
+ "$ref": "#/components/schemas/quote-update-request"
+ },
+ "customFields": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/custom-field-request"
+ }
+ },
+ "projectManagers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/project-manager-request"
+ }
+ },
+ "settings": {
+ "$ref": "#/components/schemas/project-settings-request",
+ "x-stoplight": {
+ "id": "xd2b0b8qrxmfl"
+ }
+ }
+ }
+ },
+ "project-template-create-request": {
+ "title": "Project Template Create Request",
+ "type": "object",
+ "description": "Input for Project Template creation.",
+ "required": [
+ "name",
+ "location",
+ "fileProcessingConfiguration"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The project template name.",
+ "minLength": 1,
+ "maxLength": 100
+ },
+ "description": {
+ "type": "string",
+ "description": "The project description.",
+ "maxLength": 1000
+ },
+ "location": {
+ "type": "string",
+ "description": "The folder identifier where the project should be created."
+ },
+ "fileProcessingConfiguration": {
+ "$ref": "#/components/schemas/configuration-resource-request",
+ "x-stoplight": {
+ "id": "uj8d2oyrr72tr"
+ }
+ },
+ "projectManagers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/project-manager-request"
+ }
+ },
+ "scheduleTemplate": {
+ "$ref": "#/components/schemas/configuration-resource-request",
+ "x-stoplight": {
+ "id": "rg3f3u9tenpfl"
+ }
+ },
+ "languageDirections": {
+ "type": "array",
+ "description": "The language directions.\n\nWhen creating a project using a project template that supports multiple source languages, you must supply the `languageDirections`.Note: The values for source and targe language must have the same value as the source and target language from project template.", + "items": { + "$ref": "#/components/schemas/language-direction-request" + } + }, + "customFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-field-request" + } + }, + "translationEngine": { + "$ref": "#/components/schemas/configuration-resource-request", + "x-stoplight": { + "id": "thx33vvuk5gyo" + } + }, + "pricingModel": { + "$ref": "#/components/schemas/configuration-resource-request", + "x-stoplight": { + "id": "qmx22fog888cz" + } + }, + "workflow": { + "$ref": "#/components/schemas/configuration-resource-request", + "x-stoplight": { + "id": "7djywbuahg9ha" + } + }, + "settings": { + "$ref": "#/components/schemas/project-template-settings-request", + "x-stoplight": { + "id": "ygnao3kecn7hc" + } + } + } + }, + "project-template-update-request": { + "title": "Project Template Update Request", + "x-stoplight": { + "id": "udaysucy7sgy4" + }, + "type": "object", + "description": "Input for Project Template creation.", + "properties": { + "name": { + "type": "string", + "description": "The project template name.", + "minLength": 1, + "maxLength": 100 + }, + "description": { + "type": "string", + "description": "The project description.", + "maxLength": 1000 + }, + "fileProcessingConfiguration": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "projectManagers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/project-manager-request" + } + }, + "scheduleTemplate": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "languageDirections": { + "type": "array", + "description": "The language directions.\n\nWhen creating a project using a project template that supports multiple source languages, you must supply the `languageDirections`.
Note: The values for source and targe language must have the same value as the source and target language from project template.", + "items": { + "$ref": "#/components/schemas/language-direction-request" + } + }, + "customFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-field-request" + } + }, + "translationEngine": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "pricingModel": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "workflow": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "settings": { + "$ref": "#/components/schemas/project-template-settings-update-request" + } + } + }, + "project-template-response": { + "title": "Project Template", + "x-stoplight": { + "id": "f513d3d83fd5d" + }, + "type": "object", + "description": "Project Template resource. (Not available for List Projects endpoint)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "description": "The project template identifier." + }, + "name": { + "type": "string", + "description": "
default
The project template name.
",
+ "x-default-field": true
+ },
+ "description": {
+ "type": "string",
+ "description": "The project template description."
+ },
+ "languageDirections": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/language-direction-no-statistics"
+ }
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder-v2"
+ },
+ "translationEngine": {
+ "$ref": "#/components/schemas/translation-engine"
+ },
+ "fileProcessingConfiguration": {
+ "$ref": "#/components/schemas/file-processing-configuration"
+ },
+ "pricingModel": {
+ "$ref": "#/components/schemas/pricing-model"
+ },
+ "workflow": {
+ "$ref": "#/components/schemas/workflow"
+ },
+ "customFields": {
+ "type": "array",
+ "description": "The Custom Fields.",
+ "items": {
+ "$ref": "#/components/schemas/custom-field"
+ }
+ },
+ "forceOnline": {
+ "type": "boolean",
+ "description": "(Deprecated) Moved under settings.general.forceOnline",
+ "deprecated": true
+ },
+ "projectManagers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/project-manager-response"
+ }
+ },
+ "quoteTemplate": {
+ "$ref": "#/components/schemas/project-quote-template-deprecated"
+ },
+ "scheduleTemplate": {
+ "$ref": "#/components/schemas/schedule-template",
+ "x-stoplight": {
+ "id": "anjnnapb4ow78"
+ }
+ },
+ "settings": {
+ "$ref": "#/components/schemas/project-template-settings-response",
+ "x-stoplight": {
+ "id": "s2h6ypp5yywjr"
+ }
+ }
+ }
+ },
+ "project-template-settings-request": {
+ "title": "Project Template Settings",
+ "x-stoplight": {
+ "id": "188a054a839d7"
+ },
+ "type": "object",
+ "description": "Input for Project Template settings.",
+ "properties": {
+ "general": {
+ "$ref": "#/components/schemas/project-template-general-settings-request"
+ },
+ "qualityManagement": {
+ "$ref": "#/components/schemas/project-template-quality-management-settings"
+ }
+ }
+ },
+ "project-template-settings-update-request": {
+ "title": "Project Template Settings",
+ "x-stoplight": {
+ "id": "dn5d77vdz1lvw"
+ },
+ "type": "object",
+ "description": "Input for Project Template settings.",
+ "properties": {
+ "general": {
+ "$ref": "#/components/schemas/project-template-general-settings-update"
+ },
+ "qualityManagement": {
+ "$ref": "#/components/schemas/project-template-quality-management-settings"
+ }
+ }
+ },
+ "project-template-settings-response": {
+ "title": "Project Template Settings",
+ "x-stoplight": {
+ "id": "rfvf2oks12otx"
+ },
+ "type": "object",
+ "description": "Project Template settings. See detailed description of options on the Official Documentation page. \n\r (Not available for List Projects/ProjectTemplates endpoint)",
+ "properties": {
+ "general": {
+ "$ref": "#/components/schemas/project-template-general-settings-response",
+ "x-default-field": true,
+ "description": "default
General settings, are detailed in section 10.a
"
+ },
+ "batchTasks": {
+ "$ref": "#/components/schemas/project-template-batch-tasks-settings"
+ },
+ "verification": {
+ "$ref": "#/components/schemas/project-template-verification-settings"
+ },
+ "qualityManagement": {
+ "$ref": "#/components/schemas/project-template-quality-management-settings-response"
+ },
+ "translationMemorySettings": {
+ "$ref": "#/components/schemas/project-template-translation-memory-settings"
+ }
+ }
+ },
+ "project-template-general-settings-request": {
+ "title": "General settings",
+ "x-stoplight": {
+ "id": "96ba14884fdf8"
+ },
+ "type": "object",
+ "description": "General settings",
+ "properties": {
+ "forceOnline": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "dya48eul3lslu"
+ },
+ "description": "This forces the project to be translated using the Trados Cloud Platform Online Editor exclusively.",
+ "default": false
+ },
+ "quoteTemplate": {
+ "$ref": "#/components/schemas/configuration-resource-request",
+ "x-stoplight": {
+ "id": "0l9y1waovurvh"
+ }
+ },
+ "customerPortalVisibility": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "76vxoxivbrgmb"
+ },
+ "description": "Customer Portal visibility",
+ "default": true
+ },
+ "completionConfiguration": {
+ "$ref": "#/components/schemas/completion-config-request"
+ }
+ }
+ },
+ "project-template-general-settings-update": {
+ "title": "General settings",
+ "x-stoplight": {
+ "id": "qjkldydwydntm"
+ },
+ "type": "object",
+ "description": "General settings",
+ "properties": {
+ "forceOnline": {
+ "type": "boolean",
+ "description": "This forces the project to be translated using the Trados Cloud Platform Online Editor exclusively.",
+ "default": false
+ },
+ "quoteTemplate": {
+ "$ref": "#/components/schemas/configuration-resource-request"
+ },
+ "customerPortalVisibility": {
+ "type": "boolean",
+ "description": "Customer Portal visibility",
+ "default": true
+ },
+ "completionConfiguration": {
+ "$ref": "#/components/schemas/completion-config-request",
+ "x-stoplight": {
+ "id": "zkvabfvamhyoj"
+ }
+ }
+ }
+ },
+ "project-template-general-settings-response": {
+ "title": "General settings",
+ "x-stoplight": {
+ "id": "d6p1yr5skykdb"
+ },
+ "type": "object",
+ "description": "General settings, are detailed in section 10.a",
+ "properties": {
+ "forceOnline": {
+ "type": "boolean",
+ "description": "default
Restrict file downloads.",
+ "x-default-field": true,
+ "default": false
+ },
+ "allowSourceEdit": {
+ "type": "boolean",
+ "description": "
default
Allow editing of source text in segments.",
+ "x-default-field": true,
+ "default": false
+ },
+ "quoteTemplate": {
+ "$ref": "#/components/schemas/project-quote-template",
+ "x-default-field": true,
+ "description": "
default
"
+ },
+ "customerPortalVisibility": {
+ "type": "boolean",
+ "description": "
default
Customer Portal visibility",
+ "x-default-field": true,
+ "default": true
+ },
+ "completionConfiguration": {
+ "$ref": "#/components/schemas/completion-config-request",
+ "x-stoplight": {
+ "id": "z9j2lhijfy67v"
+ },
+ "description": "
default
\r\n"
+ }
+ }
+ },
+ "project-template-batch-tasks-settings": {
+ "title": "Project Template Batch Tasks Settings",
+ "type": "object",
+ "description": "Project Template Batch Tasks Settings",
+ "properties": {
+ "preProcessing": {
+ "$ref": "#/components/schemas/project-template-batch-tasks-preprocessing-settings",
+ "x-default-field": true,
+ "x-stoplight": {
+ "id": "fd9mooc8in0k8"
+ },
+ "description": "
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "nullable": true + } + }, + "required": [ + "taskTemplate", + "scope" + ] + }, + "project-plan-task-assignee-request": { + "title": "Project Plan Task Assignee Request", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "user", + "group", + "vendorOrderTemplate", + "projectCreator" + ] + }, + "id": { + "type": "string", + "description": "The user, group or vendor identifier, depending on the type chosen. It is not required for `projectCreator`." + } + }, + "required": [ + "type" + ] + }, + "project-plan-update-request": { + "title": "Project Plan Update Request", + "type": "object", + "description": "Updates the configurations of the tasks that will be created in the future. \nFor example, you can change the assignee of the \"translation\" task while the project is in the \"preprocessing\" phase.", + "properties": { + "taskConfigurations": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/project-plan-task-configuration-request" + } + } + }, + "required": [ + "taskConfigurations" + ] + }, + "project-plan-task-configuration-request": { + "title": "Project Plan Task Configuration Request", + "type": "object", + "description": "A project plan task configuration request. Used to update a task that will be created in the future.", + "properties": { + "taskTemplate": { + "$ref": "#/components/schemas/object-id-request" + }, + "isSkipped": { + "type": "boolean", + "description": "Specifies if the task will be skipped. \n If you want to skip all the target languages for the given task, set the scope as \"global\"." + }, + "assignees": { + "type": "array", + "description": "Specifies the list of assignees for the future task. \n
When the 'isSkipped' field is set to 'true', an empty list of assignees should be specified.\r\n
Total assignee count is limited. See more at [Assigning users and groups to workflow tasks](https://docs.rws.com/791595/743481/trados-enterprise---accelerate/assigning-users-and-groups-to-workflow-tasks) point 5e.", + "items": { + "$ref": "#/components/schemas/project-plan-task-assignee-request" + } + }, + "scope": { + "$ref": "#/components/schemas/task-configuration-scope-request" + }, + "dueBy": { + "$ref": "#/components/schemas/date-time" + } + }, + "required": [ + "taskTemplate", + "isSkipped", + "assignees", + "scope" + ] + }, + "project-status-history": { + "title": "Project Status History Item", + "type": "object", + "description": "An Item which describes a change in the status of the project.", + "properties": { + "from": { + "type": "string", + "description": "Specifies the project status previous to the change.", + "enum": [ + "none", + "created", + "inProgress", + "completed" + ] + }, + "to": { + "type": "string", + "description": "Specifies the project status post change.", + "enum": [ + "created", + "inProgress", + "completed" + ] + }, + "by": { + "$ref": "#/components/schemas/user" + }, + "timestamp": { + "$ref": "#/components/schemas/date-time", + "x-default-field": true, + "description": "The time and date when the status history was updated.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"" + } + }, + "required": [ + "from", + "to" + ] + }, + "quote": { + "title": "Quote", + "type": "object", + "description": "Project quote.", + "properties": { + "totalAmount": { + "type": "number", + "description": "
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "nullable": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the task was created.
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\" ", + "nullable": true + }, + "applicableOutcomes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/task-outcome" + } + }, + "outcome": { + "type": "string", + "description": "The outcome of the task type. It is retrieved only if the task is completed. It should match one of the legal outcomes in the task type." + }, + "comment": { + "type": "string", + "description": "The comment associated with this task at completion." + }, + "project": { + "$ref": "#/components/schemas/project" + }, + "failedTask": { + "$ref": "#/components/schemas/failed-task" + }, + "completedAt": { + "$ref": "#/components/schemas/date-time", + "description": "The completion timestamp of the task.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"" + } + }, + "required": [ + "id" + ] + }, + "task-error": { + "title": "Task Error", + "type": "object", + "description": "Task Error.", + "properties": { + "name": { + "type": "string", + "description": "The task error name." + }, + "code": { + "type": "string", + "description": "The task error code." + }, + "value": { + "type": "string", + "description": "The task error value." + } + } + }, + "task-assignee": { + "title": "Task Assignee", + "type": "object", + "description": "Task assignee. Based on the \"type\", the following properties can be retrieved: \"user\", \"group\" or \"vendorOrderTemplate\". For \"projectCreator\" and \"projectManager\" no other properties are available.", + "properties": { + "type": { + "type": "string", + "enum": [ + "user", + "group", + "vendorOrderTemplate", + "projectCreator" + ], + "description": "Type \"projectCreator\" - reserved for future use. Should be able to handle it and ignore it if received." + }, + "user": { + "$ref": "#/components/schemas/user", + "description": "
Only required for the `user`, `group`, and `vendorOrderTemplate` types." + }, + "type": { + "type": "string", + "enum": [ + "user", + "group", + "vendorOrderTemplate", + "projectManager", + "projectCreator" + ], + "description": "The assignee type." + } + }, + "required": [ + "type" + ] + }, + "task-assign-request": { + "title": "Task Assign Request", + "type": "object", + "description": "Properties of task assignment.\r\n
Total assignee count is limited. See more at [Maximum number of task assignees](https://docs.rws.com/791595/1137562/trados-enterprise---accelerate/maximum-number-of-task-assignees).", + "properties": { + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/task-assignee-request" + } + } + } + }, + "task-complete-request": { + "title": "Task Complete Request", + "type": "object", + "description": "Properties of task completion.", + "properties": { + "outcome": { + "type": "string", + "description": "The outcome should be one of the valid applicable outcomes of the task. If not specified, the default one will be taken." + }, + "comment": { + "type": "string", + "description": "The comment associated with this task completion.", + "maxLength": 1000 + } + }, + "required": [ + "outcome" + ] + }, + "task-input": { + "title": "Task Input", + "type": "object", + "description": "Task input. Based on the \"type\", the following fields can be retrieved: \"project\", \"sourceFile\", \"targetFile\".", + "properties": { + "type": { + "type": "string", + "description": "The input type.", + "enum": [ + "project", + "sourceFile", + "targetFile", + "languageDirection" + ] + }, + "project": { + "$ref": "#/components/schemas/project", + "description": "
default
Pre-Processing Settings, configure how TMs are applied, are detailed in section 10.b
"
+ },
+ "updateTranslationMemory": {
+ "$ref": "#/components/schemas/update-translation-memory-settings",
+ "x-default-field": true,
+ "x-stoplight": {
+ "id": "mm94ig682wabo"
+ },
+ "description": "default
Configure how TMs are updated throughout the project workflow depending on the status of the segments. Are detailed in section 10.c
"
+ }
+ }
+ },
+ "project-template-verification-settings": {
+ "title": "Project Template Verification Settings",
+ "type": "object",
+ "description": "",
+ "properties": {
+ "tagVerifier": {
+ "$ref": "#/components/schemas/project-template-verification-tag-verifier-settings",
+ "x-default-field": true,
+ "description": "default
Tag Verifier Settings, are detailed in section 10.d
"
+ },
+ "qaChecker": {
+ "$ref": "#/components/schemas/project-template-verification-qa-checker-settings",
+ "x-default-field": true,
+ "description": "default
QA Checker Settings, are detailed in section 10.e
"
+ }
+ }
+ },
+ "project-template-quality-management-settings": {
+ "title": "Quality Managment",
+ "type": "object",
+ "properties": {
+ "tqaProfile": {
+ "$ref": "#/components/schemas/configuration-resource-request",
+ "x-stoplight": {
+ "id": "9n13w0ndmh8tv"
+ }
+ }
+ }
+ },
+ "project-template-quality-management-settings-response": {
+ "title": "Quality Managment",
+ "x-stoplight": {
+ "id": "a5bkdzgg7q3eh"
+ },
+ "type": "object",
+ "properties": {
+ "tqaProfile": {
+ "$ref": "#/components/schemas/tqa-profile",
+ "x-stoplight": {
+ "id": "ln71gs3m3v6lo"
+ }
+ }
+ }
+ },
+ "project-template-translation-memory-settings": {
+ "title": "Translation Memory settings",
+ "x-stoplight": {
+ "id": "f358c4e03ac33"
+ },
+ "type": "object",
+ "description": "Translation Memory settings",
+ "properties": {
+ "penalties": {
+ "$ref": "#/components/schemas/project-template-TM-penalties",
+ "description": "default
"
+ }
+ }
+ },
+ "project-template-batch-tasks-preprocessing-settings": {
+ "title": "Pre-Processing Settings",
+ "x-stoplight": {
+ "id": "3dzxuz1skn1pl"
+ },
+ "type": "object",
+ "description": "Pre-Processing Settings, configure how TMs are applied, are detailed in section 10.b",
+ "properties": {
+ "minimumMatchValue": {
+ "type": "integer",
+ "minimum": 50,
+ "maximum": 100,
+ "default": 70,
+ "description": "default
",
+ "x-default-field": true
+ },
+ "translationOverwriteMode": {
+ "enum": [
+ "keepExisting",
+ "overwriteIfBetter",
+ "overwriteAlways",
+ "overwriteExceptPerfectMatch"
+ ],
+ "description": "default
Options: \r\n- `keepExisting`: no segments are overwritten, existing segments are kept;\r\n- `overwriteIfBetter`: unlocked segments (including confirmed segments) are overwritten, while unlocked PerfectMatch segments and locked segments are not overwritten; \r\n- `overwriteAlways`: PerfectMatch segments (both locked and unlocked) are overwritten, while other locked segments are not overwritten;\r\n- `overwriteExceptPerfectMatch`: unlocked segments (including confirmed segments) and locked segments are overwritten, while unlocked PerfectMatch segments are not overwritten;
",
+ "x-default-field": true,
+ "default": "overwriteIfBetter"
+ },
+ "afterApplyingTranslations": {
+ "type": "array",
+ "x-default-field": true,
+ "description": "default
Default: `confirmExactMatches`, `confirmContextMatches`
",
+ "items": {
+ "enum": [
+ "confirmExactMatches",
+ "confirmContextMatches",
+ "lockExactMatches",
+ "lockContextMatches",
+ "lockGreenSegments",
+ "lockAmberSegments",
+ "lockRedSegments"
+ ],
+ "default": "confirmContextMatches"
+ }
+ },
+ "noMatchFoundAction": {
+ "enum": [
+ "leaveTargetSegmentsEmpty",
+ "copySourceToTarget"
+ ],
+ "description": "default
",
+ "x-default-field": true,
+ "default": "leaveTargetSegmentsEmpty"
+ },
+ "reportCrossFileRepetition": {
+ "type": "boolean",
+ "default": false,
+ "description": "If enabled repetitions are identified and included in analysis reports."
+ },
+ "excludeLockedSegments": {
+ "type": "boolean",
+ "default": false,
+ "description": "If enabled locked segments (content that must not be translated) are excluded from translation. "
+ }
+ }
+ },
+ "project-template-verification-tag-verifier-settings": {
+ "title": "Tag Verifier Settings",
+ "type": "object",
+ "description": "Tag Verifier Settings, are detailed in section 10.d",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "zzdaica4ipzsl"
+ }
+ },
+ "checkAddedTags": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "7jxj0g9hrjxdd"
+ },
+ "x-default-field": true,
+ "default": true,
+ "description": "default
"
+ },
+ "addedTagsSeverity": {
+ "x-stoplight": {
+ "id": "ceijjmhck9qpn"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "error"
+ },
+ "checkDeletedTags": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "rw3qbpbox585c"
+ },
+ "x-default-field": true,
+ "default": true,
+ "description": "default
"
+ },
+ "deletedTagsSeverity": {
+ "x-stoplight": {
+ "id": "v1367u510xuxk"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "error"
+ },
+ "checkTagOrderChanged": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "ug2e4khwq9yjn"
+ },
+ "x-default-field": true,
+ "default": true,
+ "description": "default
"
+ },
+ "tagOrderChangedSeverity": {
+ "x-stoplight": {
+ "id": "61mcttvp5oynd"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "warning"
+ },
+ "checkSpacingAroundTags": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "vje5xtur0mstq"
+ },
+ "x-default-field": true,
+ "default": true,
+ "description": "default
"
+ },
+ "spaceAroundTagsSeverity": {
+ "x-stoplight": {
+ "id": "a8nhawfmukkbc"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "note"
+ },
+ "ignoreFormattingTags": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "ucwul9whydkkk"
+ },
+ "x-default-field": true,
+ "default": true,
+ "description": "default
"
+ },
+ "ignoreLockedSegments": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "votezrhazpcr8"
+ },
+ "x-default-field": true,
+ "default": false,
+ "description": "default
"
+ },
+ "ignoreDifferenceBetweenNormalAndNonBreakingSpace": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "2tutxpylevgp5"
+ },
+ "x-default-field": true,
+ "default": true,
+ "description": "default
"
+ }
+ },
+ "required": [
+ "enabled"
+ ]
+ },
+ "project-template-verification-qa-checker-settings": {
+ "title": "QA checker",
+ "type": "object",
+ "description": "QA Checker Settings, are detailed in section 10.e",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "ht01a321btv9x"
+ },
+ "default": true
+ },
+ "allLanguages": {
+ "$ref": "#/components/schemas/project-template-verification-qa-checker-all-languages",
+ "x-stoplight": {
+ "id": "v2h7hwcxscvdm"
+ },
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "perTargetLanguage": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "doi99m8k1nucn"
+ },
+ "items": {
+ "$ref": "#/components/schemas/project-template-verification-qa-checker-per-target-language",
+ "x-stoplight": {
+ "id": "pt6p63qkx37fh"
+ }
+ }
+ }
+ },
+ "required": [
+ "enabled"
+ ]
+ },
+ "project-template-verification-qa-checker-all-languages": {
+ "title": "All Languages settings",
+ "x-stoplight": {
+ "id": "u7dex87q8i5am"
+ },
+ "type": "object",
+ "properties": {
+ "segmentsVerification": {
+ "$ref": "#/components/schemas/project-template-verification-qa-checker-segments-verification",
+ "x-stoplight": {
+ "id": "gxhqy9p1q87jg"
+ },
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "segmentsToExclude": {
+ "$ref": "#/components/schemas/project-template-verification-qa-checker-segments-to-exclude",
+ "x-stoplight": {
+ "id": "z3drrdagwesm7"
+ },
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "inconsistencies": {
+ "$ref": "#/components/schemas/project-template-verification-qa-checker-inconsistencies",
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "punctuation": {
+ "$ref": "#/components/schemas/project-template-verification-qa-checker-punctuation",
+ "x-stoplight": {
+ "id": "ps49964fkhoes"
+ },
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "numbers": {
+ "$ref": "#/components/schemas/project-template-verification-qa-checker-numbers",
+ "x-stoplight": {
+ "id": "0uo9yg9qgw90j"
+ },
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "wordList": {
+ "$ref": "#/components/schemas/project-template-verification-qa-checker-word-list",
+ "x-stoplight": {
+ "id": "j7c3kcgbk71ct"
+ },
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "regularExpressions": {
+ "$ref": "#/components/schemas/project-template-verification-qa-checker-regular-expressions",
+ "x-stoplight": {
+ "id": "dedwuc8etbbew"
+ },
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "trademarkCheck": {
+ "$ref": "#/components/schemas/project-template-verification-qa-checker-trademark-check",
+ "x-stoplight": {
+ "id": "f5jsh5byu5ncp"
+ },
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "lengthVerification": {
+ "$ref": "#/components/schemas/project-template-verification-qa-checker-length-verification",
+ "x-stoplight": {
+ "id": "e0fx768sgm9t2"
+ },
+ "x-default-field": true,
+ "description": "default
"
+ }
+ }
+ },
+ "project-template-verification-qa-checker-per-target-language": {
+ "title": "Per Language Settings",
+ "x-stoplight": {
+ "id": "huunxvvs0cbps"
+ },
+ "type": "object",
+ "properties": {
+ "targetLanguage": {
+ "x-stoplight": {
+ "id": "k7hb7dlfim7t9"
+ },
+ "$ref": "#/components/schemas/language"
+ },
+ "punctuation": {
+ "$ref": "#/components/schemas/project-template-verification-qa-checker-punctuation",
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "numbers": {
+ "$ref": "#/components/schemas/project-template-verification-qa-checker-numbers",
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "wordList": {
+ "$ref": "#/components/schemas/project-template-verification-qa-checker-word-list",
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "regularExpressions": {
+ "$ref": "#/components/schemas/project-template-verification-qa-checker-regular-expressions",
+ "x-default-field": true,
+ "description": "default
"
+ }
+ },
+ "required": [
+ "targetLanguage"
+ ]
+ },
+ "project-template-verification-qa-checker-segments-verification": {
+ "title": "Segments Verification",
+ "x-stoplight": {
+ "id": "p5v3db4luaxqz"
+ },
+ "type": "object",
+ "properties": {
+ "checkForgottenTranslation": {
+ "type": "boolean",
+ "default": true,
+ "x-stoplight": {
+ "id": "xsjmebx726d3x"
+ },
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "forgottenTranslationSeverity": {
+ "x-stoplight": {
+ "id": "0jd2dz8tdy6br"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "error"
+ },
+ "checkSourceTargetIdentical": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "qmqj04ozi91bk"
+ },
+ "x-default-field": true,
+ "default": true,
+ "description": "default
"
+ },
+ "sourceTargetIdenticalSeverity": {
+ "x-stoplight": {
+ "id": "c907ccbq4vdxn"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "warning"
+ },
+ "identicalSegmentsIgnoreTags": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "g30eue1qg70r7"
+ },
+ "default": false
+ },
+ "identicalSegmentsIgnoreCase": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "ici43l9x3dxk1"
+ },
+ "default": false
+ },
+ "checkTargetLonger": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "n80w5dcs09kxa"
+ },
+ "x-default-field": true,
+ "default": false,
+ "description": "default
"
+ },
+ "longerByValue": {
+ "type": "number",
+ "x-stoplight": {
+ "id": "4j31z4qch04fg"
+ },
+ "x-default-field": true,
+ "default": 50,
+ "description": "default
"
+ },
+ "checkTargetShorter": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "hpzbjbr8t6zhx"
+ },
+ "x-default-field": true,
+ "default": false,
+ "description": "default
"
+ },
+ "shorterByValue": {
+ "type": "number",
+ "x-stoplight": {
+ "id": "6h9vfjna8ialu"
+ },
+ "x-default-field": true,
+ "default": 50,
+ "description": "default
"
+ },
+ "ignoreSegmentsFewerThanCount": {
+ "type": "number",
+ "x-stoplight": {
+ "id": "0y7rzdh9vmpvr"
+ },
+ "x-default-field": true,
+ "default": 2,
+ "description": "default
"
+ },
+ "ignoreSegmentsFewerThanBase": {
+ "x-stoplight": {
+ "id": "17melvff79o5q"
+ },
+ "enum": [
+ "words",
+ "characters"
+ ],
+ "default": "characters",
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "checkForbiddenChars": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "l4ma0z3xj33q3"
+ },
+ "x-default-field": true,
+ "default": false,
+ "description": "default
"
+ },
+ "forbiddenChars": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "wi6dozpt4rqaw"
+ },
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "forbiddenCharsSeverity": {
+ "x-stoplight": {
+ "id": "widdgh98t4w1g"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "error"
+ }
+ }
+ },
+ "project-template-verification-qa-checker-segments-to-exclude": {
+ "title": "Segments to Exclude",
+ "x-stoplight": {
+ "id": "1rb61vur5mzn3"
+ },
+ "type": "object",
+ "properties": {
+ "excludePerfectMatchSegments": {
+ "type": "boolean",
+ "default": true,
+ "x-stoplight": {
+ "id": "lns6fv1v15m9r"
+ },
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "excludeExactMatches": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "hkmg7bvsderss"
+ },
+ "x-default-field": true,
+ "default": false,
+ "description": "default
"
+ },
+ "excludeFuzzyMatches": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "40bzc9xgu79j6"
+ },
+ "x-default-field": true,
+ "default": false,
+ "description": "default
"
+ },
+ "excludeFuzzyMatchesValue": {
+ "type": "number",
+ "x-stoplight": {
+ "id": "6nb9cw19h7j8g"
+ },
+ "x-default-field": true,
+ "default": 99,
+ "description": "default
"
+ },
+ "excludeNewTranslation": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "q9nay4my2ax0d"
+ },
+ "x-default-field": true,
+ "default": false,
+ "description": "default
"
+ },
+ "excludeConfirmedTranslations": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "5qr82fuljzh9c"
+ },
+ "x-default-field": true,
+ "default": false,
+ "description": "default
"
+ },
+ "excludeLockedSegments": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "zxvvu2p3el9vo"
+ },
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "excludeIdentical": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "wt06ljmjtzxx1"
+ },
+ "x-default-field": true,
+ "default": false,
+ "description": "default
"
+ },
+ "elementContextExclusion": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "ihg0auk684zwo"
+ },
+ "x-default-field": true,
+ "default": false,
+ "description": "default
"
+ },
+ "exclusionContextList": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "w8wid64dh2ofd"
+ },
+ "x-default-field": true,
+ "items": {
+ "x-stoplight": {
+ "id": "uold0rq8drd0g"
+ },
+ "type": "string"
+ },
+ "description": "default
"
+ },
+ "reportAllNonExcluded": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "two2plqqt9g76"
+ },
+ "x-default-field": true,
+ "default": false,
+ "description": "default
"
+ },
+ "reportAllNonExcludedSeverity": {
+ "x-stoplight": {
+ "id": "24w5oqpge9vtt"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "note"
+ }
+ }
+ },
+ "project-template-verification-qa-checker-inconsistencies": {
+ "title": "QA Checker Inconsistencies",
+ "x-stoplight": {
+ "id": "iosfg9dirb8hw"
+ },
+ "type": "object",
+ "properties": {
+ "checkInconsistentTranslations": {
+ "type": "boolean",
+ "default": false,
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "checkInconsistentTranslationsSeverity": {
+ "x-stoplight": {
+ "id": "bsouwbxqv95ye"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "warning"
+ },
+ "checkInconsistentTranslationsIgnoreTags": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "3koq6k6fd9l44"
+ },
+ "default": false
+ },
+ "checkInconsistentTranslationsIgnoreCase": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "6cmbn8w6k7fg4"
+ },
+ "default": false
+ },
+ "checkRepeatedWords": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "57vj6px0vfsie"
+ },
+ "x-default-field": true,
+ "default": true,
+ "description": "default
"
+ },
+ "checkRepeatedWordsSeverity": {
+ "x-stoplight": {
+ "id": "72j1swplvu10s"
+ },
+ "enum": [
+ "error",
+ "warning",
+ " Note"
+ ],
+ "default": "warning"
+ },
+ "checkRepeatedWordsIgnoreNumbers": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "h48hxx4si6aoh"
+ },
+ "default": false
+ },
+ "checkRepeatedWordsIgnoreCase": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "0pjpiv5gt6y7k"
+ },
+ "default": false
+ },
+ "checkUneditedSegmentsFuzzy": {
+ "x-stoplight": {
+ "id": "t9fk4h0hrr5co"
+ },
+ "type": "boolean",
+ "x-default-field": true,
+ "default": true,
+ "description": "default
"
+ },
+ "checkUneditedSegmentsFuzzySeverity": {
+ "x-stoplight": {
+ "id": "ry42m8y5j21he"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "warning"
+ },
+ "checkOnlyConfirmedSegments": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "ng703myrxolr9"
+ },
+ "default": false
+ },
+ "checkIfMatchScoresBelow": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "i05vug43v8q0w"
+ },
+ "default": false
+ },
+ "checkIfMatchScoresBelowValue": {
+ "type": "number",
+ "default": 99
+ }
+ }
+ },
+ "project-template-verification-qa-checker-punctuation": {
+ "title": "QA Checker Punctuation",
+ "x-stoplight": {
+ "id": "9sidt6n9cxt5y"
+ },
+ "type": "object",
+ "properties": {
+ "checkIdenticalPunctuation": {
+ "type": "boolean",
+ "default": true,
+ "x-default-field": true,
+ "x-stoplight": {
+ "id": "fvt9f95rf0uen"
+ },
+ "description": "default
"
+ },
+ "checkIdenticalPunctuationSeverity": {
+ "x-stoplight": {
+ "id": "1fcl96sxrs5wx"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "warning"
+ },
+ "checkSpanishPunctuation": {
+ "x-stoplight": {
+ "id": "7fnmgzkao3fxi"
+ },
+ "x-default-field": true,
+ "default": false,
+ "type": "boolean",
+ "description": "default
"
+ },
+ "checkSpanishPunctuationSeverity": {
+ "x-stoplight": {
+ "id": "f0umcr7ywjnsf"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "warning"
+ },
+ "checkUnintentionalSpacesBeforePunctuation": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "4wnyw10rl8k1m"
+ },
+ "x-default-field": true,
+ "default": true,
+ "description": "default
"
+ },
+ "checkUnintentionalSpacesBeforePunctuationSeverity": {
+ "x-stoplight": {
+ "id": "9up0q78jlw73a"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "warning"
+ },
+ "checkUnintentionalSpacesBeforePunctuationValues": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "bukb4vmlo01si"
+ },
+ "default": ":!?;"
+ },
+ "punctuationSpacesFrench": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "n2amwff6y1fru"
+ },
+ "default": false
+ },
+ "checkMultipleSpaces": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "371vnwmqt53uv"
+ },
+ "x-default-field": true,
+ "default": true,
+ "description": "default
"
+ },
+ "checkMultipleSpacesSeverity": {
+ "x-stoplight": {
+ "id": "z1snyx22cm8kp"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "note"
+ },
+ "checkMultipleDots": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "wxxvehvri3o8q"
+ },
+ "x-default-field": true,
+ "default": true,
+ "description": "default
"
+ },
+ "checkMultipleDotsSeverity": {
+ "x-stoplight": {
+ "id": "s3nerdbtbe17i"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "note"
+ },
+ "ignoreThreeDots": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "128751e5f7bb0"
+ },
+ "x-default-field": true,
+ "default": true,
+ "description": "default
"
+ },
+ "checkExtraSpace": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "rczo8oi443l7b"
+ },
+ "x-default-field": true,
+ "default": true,
+ "description": "default
"
+ },
+ "checkExtraSpaceSeverity": {
+ "x-stoplight": {
+ "id": "b9qsayeygu8d5"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "warning"
+ },
+ "checkCapitalizationOfInitials": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "94fhj5alcziax"
+ },
+ "x-default-field": true,
+ "default": false,
+ "description": "default
"
+ },
+ "checkCapitalizationOfInitialsSeverity": {
+ "x-stoplight": {
+ "id": "btsm5s1bzz7aq"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "warning"
+ },
+ "checkConsistencyOfGlobalCapitalization": {
+ "x-stoplight": {
+ "id": "2b9wdh315dahs"
+ },
+ "type": "boolean",
+ "x-default-field": true,
+ "default": false,
+ "description": "default
"
+ },
+ "checkConsistencyOfGlobalCapitalizationSeverity": {
+ "x-stoplight": {
+ "id": "4eohngzh0e2bc"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "warning"
+ },
+ "checkBrackets": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "lw5s7boith817"
+ },
+ "x-default-field": true,
+ "default": true,
+ "description": "default
"
+ },
+ "checkBracketsSeverity": {
+ "x-stoplight": {
+ "id": "f8rpatoa21n08"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "warning"
+ }
+ }
+ },
+ "project-template-verification-qa-checker-numbers": {
+ "title": "QA Checker Numbers",
+ "x-stoplight": {
+ "id": "95nv42e499dwi"
+ },
+ "type": "object",
+ "properties": {
+ "checkNumbers": {
+ "type": "boolean",
+ "default": false,
+ "x-default-field": true,
+ "x-stoplight": {
+ "id": "jmx3msjbemxdr"
+ },
+ "description": "default
"
+ },
+ "checkNumbersSeverity": {
+ "x-stoplight": {
+ "id": "05931rv7v34yd"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "error"
+ },
+ "checkTimes": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "yjnavlbjro7zn"
+ },
+ "x-default-field": true,
+ "default": false,
+ "description": "default
"
+ },
+ "checkTimesSeverity": {
+ "x-stoplight": {
+ "id": "p7a2a445i131t"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "error"
+ },
+ "checkDates": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "yccnoxkca39wp"
+ },
+ "x-default-field": true,
+ "default": false,
+ "description": "default
"
+ },
+ "checkDatesSeverity": {
+ "x-stoplight": {
+ "id": "9e40z6bd9mv8q"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "error"
+ },
+ "checkMeasurements": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "9w2l7x89okahm"
+ },
+ "x-default-field": true,
+ "default": false,
+ "description": "default
"
+ },
+ "checkMeasurementsSeverity": {
+ "x-stoplight": {
+ "id": "5isqhxzz365vq"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "error"
+ }
+ }
+ },
+ "project-template-verification-qa-checker-word-list": {
+ "title": "QA Checker Word list",
+ "x-stoplight": {
+ "id": "jcu8333uzax64"
+ },
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": false,
+ "x-stoplight": {
+ "id": "1i43kmdizt8f9"
+ }
+ },
+ "searchWholeWords": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "mtexp5nafx5d4"
+ },
+ "x-default-field": true,
+ "default": false,
+ "description": "default
"
+ },
+ "ignoreCase": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "lw4spspstngjb"
+ },
+ "x-default-field": true,
+ "default": false,
+ "description": "default
"
+ },
+ "checkWordListSeverity": {
+ "x-stoplight": {
+ "id": "4dxqub35774eb"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "warning"
+ },
+ "wordList": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "rjn2ec0xqsm0k"
+ },
+ "x-default-field": true,
+ "items": {
+ "x-stoplight": {
+ "id": "2rknpju6n8z56"
+ },
+ "type": "object",
+ "properties": {
+ "wrongForm": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "u9yi9ohufpdvp"
+ },
+ "x-default-field": true
+ },
+ "correctForm": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "h4itahton32nl"
+ },
+ "x-default-field": true
+ }
+ }
+ },
+ "description": "default
"
+ }
+ },
+ "required": [
+ "enabled"
+ ]
+ },
+ "project-template-verification-qa-checker-regular-expressions": {
+ "title": "QA Checker Regular Expressions",
+ "x-stoplight": {
+ "id": "xem3u8m9wipd6"
+ },
+ "type": "object",
+ "properties": {
+ "checkRegularExpressions": {
+ "type": "boolean",
+ "default": false,
+ "x-stoplight": {
+ "id": "83h1307cwqhw9"
+ },
+ "description": ""
+ },
+ "regularExpressionSeverity": {
+ "x-stoplight": {
+ "id": "xmi8dmu62uzi8"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "warning"
+ },
+ "regularExpressions": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "6z45r3k1a1b4o"
+ },
+ "x-default-field": true,
+ "items": {
+ "$ref": "#/components/schemas/project-template-verification-qa-checker-regular-expressions-model",
+ "x-stoplight": {
+ "id": "5e6hkwes4mo6a"
+ }
+ },
+ "description": "default
"
+ }
+ },
+ "required": [
+ "checkRegularExpressions"
+ ]
+ },
+ "project-template-verification-qa-checker-regular-expressions-model": {
+ "title": "Regular Expressions Model",
+ "x-stoplight": {
+ "id": "2rx3df3vczsr1"
+ },
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "20v4paozpk91g"
+ },
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "regexSource": {
+ "x-stoplight": {
+ "id": "e9lfc0qm2td5k"
+ },
+ "type": "string",
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "regexTarget": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "k7olv3yojvixm"
+ },
+ "x-default-field": true,
+ "description": "default
"
+ },
+ "ignoreCase": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "21avhvnk4l142"
+ },
+ "x-default-field": true,
+ "default": false,
+ "description": "default
"
+ },
+ "condition": {
+ "x-stoplight": {
+ "id": "nmhpp19inyk2n"
+ },
+ "enum": [
+ "targetAndSource",
+ "targetNotSource",
+ "sourceNotTarget",
+ "sourceOnly",
+ "targetOnly",
+ "differentCount",
+ "groupedTargetAndSource"
+ ],
+ "x-default-field": true,
+ "description": "default
"
+ }
+ }
+ },
+ "project-template-verification-qa-checker-trademark-check": {
+ "title": "QA Checker Trademark check",
+ "x-stoplight": {
+ "id": "l65c655atolg3"
+ },
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "default": true,
+ "x-stoplight": {
+ "id": "hrisnih0vgd4w"
+ }
+ },
+ "trademarkSeverity": {
+ "x-stoplight": {
+ "id": "dfa7w4qetxl2c"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "error"
+ },
+ "trademarkSymbols": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "i0um9xob8izp7"
+ },
+ "x-default-field": true,
+ "items": {
+ "x-stoplight": {
+ "id": "d32mt39hj0fer"
+ },
+ "type": "string"
+ },
+ "default": [
+ "®",
+ "©",
+ "™",
+ "(c)",
+ "(r)",
+ "(tm)"
+ ],
+ "description": "default
"
+ }
+ },
+ "required": [
+ "enabled"
+ ]
+ },
+ "project-template-verification-qa-checker-length-verification": {
+ "title": "QA Checker Length Verification",
+ "x-stoplight": {
+ "id": "ex9iomj4a786f"
+ },
+ "type": "object",
+ "properties": {
+ "checkLengthLimitation": {
+ "type": "boolean",
+ "default": true,
+ "x-default-field": true,
+ "x-stoplight": {
+ "id": "7bxsr6dzipk4m"
+ },
+ "description": "default
"
+ },
+ "checkLengthLimitationSeverity": {
+ "x-stoplight": {
+ "id": "3wlsd7f20hftl"
+ },
+ "enum": [
+ "error",
+ "warning",
+ "note"
+ ],
+ "default": "error"
+ },
+ "targetSegmentsVerificationType": {
+ "x-stoplight": {
+ "id": "147n1oindvqf3"
+ },
+ "x-default-field": true,
+ "enum": [
+ "fileSpecificLimit",
+ "absoluteCharacterCount"
+ ],
+ "default": "fileSpecificLimit",
+ "description": "default
"
+ },
+ "absoluteCharCountValue": {
+ "type": "number",
+ "x-stoplight": {
+ "id": "i88shddbsddjo"
+ },
+ "x-default-field": true,
+ "description": "default
Used in case `targetSegmentsVerificationType = absoluteCharacterCount`
",
+ "default": 50
+ }
+ }
+ },
+ "project-template-TM-penalties": {
+ "title": "Translation Memory Penalties",
+ "type": "object",
+ "description": "Translation Memory Penalties",
+ "properties": {
+ "standardPenalties": {
+ "$ref": "#/components/schemas/project-template-TM-standard-penalties",
+ "description": "default
",
+ "x-default-field": true,
+ "type": "object",
+ "x-stoplight": {
+ "id": "rx66lu3x78mvr"
+ }
+ },
+ "translationUnitStatusPenalties": {
+ "$ref": "#/components/schemas/project-template-TM-translation-unit-status-penalties",
+ "description": "default
",
+ "x-default-field": true,
+ "type": "object",
+ "x-stoplight": {
+ "id": "7g27gag166myh"
+ }
+ }
+ }
+ },
+ "project-template-TM-standard-penalties": {
+ "title": "Translation Memory Standard Penalties",
+ "type": "object",
+ "description": "Translation Memory Standard Penalties",
+ "properties": {
+ "missingFormatting": {
+ "description": "default
",
+ "x-default-field": true,
+ "x-stoplight": {
+ "id": "pdzeu7k11vkc4"
+ },
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 1
+ },
+ "differentFormatting": {
+ "description": "default
",
+ "x-default-field": true,
+ "x-stoplight": {
+ "id": "bspk3rj8xswag"
+ },
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 1
+ },
+ "multipleTranslations": {
+ "description": "default
",
+ "x-default-field": true,
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 1
+ },
+ "autoLocalization": {
+ "description": "default
",
+ "x-default-field": true,
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0
+ },
+ "textReplacement": {
+ "description": "default
",
+ "x-default-field": true,
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0
+ },
+ "alignment": {
+ "description": "default
",
+ "x-default-field": true,
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 1
+ },
+ "characterWidthDifference": {
+ "description": "default
",
+ "x-default-field": true,
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 1
+ }
+ }
+ },
+ "project-template-TM-translation-unit-status-penalties": {
+ "title": "Translation Memory Translation Unit Status Penalties",
+ "type": "object",
+ "description": "Translation Memory Translation Unit Status Penalties",
+ "properties": {
+ "translated": {
+ "description": "default
",
+ "x-default-field": true,
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0
+ },
+ "rejectedTranslation": {
+ "description": "default
",
+ "x-default-field": true,
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0
+ },
+ "approvedTranslation": {
+ "description": "default
",
+ "x-default-field": true,
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0
+ },
+ "rejectedSignOff": {
+ "description": "default
",
+ "x-default-field": true,
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0
+ },
+ "approvedSignOff": {
+ "description": "default
",
+ "x-default-field": true,
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0
+ },
+ "notTranslated": {
+ "description": "default
",
+ "x-default-field": true,
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0
+ },
+ "draft": {
+ "description": "default
",
+ "x-default-field": true,
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0
+ }
+ }
+ },
+ "project-plan": {
+ "title": "Project Plan",
+ "type": "object",
+ "description": "The configurations of the tasks that will be created in the future.\n\nAvailable now directly after project creation, project does not need to be started to be populated. \n\n(Not available for List Projects endpoint)",
+ "properties": {
+ "taskConfigurations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/project-plan-task-configuration"
+ }
+ }
+ }
+ },
+ "project-plan-task-configuration": {
+ "title": "Project Plan Task Configuration",
+ "type": "object",
+ "description": "The configuration of a task that will be created in the future.",
+ "properties": {
+ "taskTemplate": {
+ "$ref": "#/components/schemas/object-id"
+ },
+ "scope": {
+ "$ref": "#/components/schemas/task-configuration-scope"
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/workflow-task-assignee"
+ }
+ },
+ "isSkipped": {
+ "type": "boolean",
+ "description": "default
Specifies if the task will be skipped.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "dueBy": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2022-01-12T12:00:00.000Z",
+ "description": "The due date of the future task. UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "nullable": true + } + }, + "required": [ + "taskTemplate", + "scope" + ] + }, + "project-plan-task-assignee-request": { + "title": "Project Plan Task Assignee Request", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "user", + "group", + "vendorOrderTemplate", + "projectCreator" + ] + }, + "id": { + "type": "string", + "description": "The user, group or vendor identifier, depending on the type chosen. It is not required for `projectCreator`." + } + }, + "required": [ + "type" + ] + }, + "project-plan-update-request": { + "title": "Project Plan Update Request", + "type": "object", + "description": "Updates the configurations of the tasks that will be created in the future. \nFor example, you can change the assignee of the \"translation\" task while the project is in the \"preprocessing\" phase.", + "properties": { + "taskConfigurations": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/project-plan-task-configuration-request" + } + } + }, + "required": [ + "taskConfigurations" + ] + }, + "project-plan-task-configuration-request": { + "title": "Project Plan Task Configuration Request", + "type": "object", + "description": "A project plan task configuration request. Used to update a task that will be created in the future.", + "properties": { + "taskTemplate": { + "$ref": "#/components/schemas/object-id-request" + }, + "isSkipped": { + "type": "boolean", + "description": "Specifies if the task will be skipped. \n If you want to skip all the target languages for the given task, set the scope as \"global\"." + }, + "assignees": { + "type": "array", + "description": "Specifies the list of assignees for the future task. \n
When the 'isSkipped' field is set to 'true', an empty list of assignees should be specified.\r\n
Total assignee count is limited. See more at [Assigning users and groups to workflow tasks](https://docs.rws.com/791595/743481/trados-enterprise---accelerate/assigning-users-and-groups-to-workflow-tasks) point 5e.", + "items": { + "$ref": "#/components/schemas/project-plan-task-assignee-request" + } + }, + "scope": { + "$ref": "#/components/schemas/task-configuration-scope-request" + }, + "dueBy": { + "$ref": "#/components/schemas/date-time" + } + }, + "required": [ + "taskTemplate", + "isSkipped", + "assignees", + "scope" + ] + }, + "project-status-history": { + "title": "Project Status History Item", + "type": "object", + "description": "An Item which describes a change in the status of the project.", + "properties": { + "from": { + "type": "string", + "description": "Specifies the project status previous to the change.", + "enum": [ + "none", + "created", + "inProgress", + "completed" + ] + }, + "to": { + "type": "string", + "description": "Specifies the project status post change.", + "enum": [ + "created", + "inProgress", + "completed" + ] + }, + "by": { + "$ref": "#/components/schemas/user" + }, + "timestamp": { + "$ref": "#/components/schemas/date-time", + "x-default-field": true, + "description": "The time and date when the status history was updated.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"" + } + }, + "required": [ + "from", + "to" + ] + }, + "quote": { + "title": "Quote", + "type": "object", + "description": "Project quote.", + "properties": { + "totalAmount": { + "type": "number", + "description": "
default
Total translation fee.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "currencyCode": {
+ "type": "string",
+ "description": "default
The currency code (ISO 4217).
",
+ "x-default-field": true
+ },
+ "translationCosts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/quote-translation-cost"
+ }
+ },
+ "languageCosts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/quote-language-cost"
+ }
+ },
+ "additionalCosts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/quote-additional-cost"
+ }
+ },
+ "notes": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "n1ohftpten9bv"
+ },
+ "description": "A message associated with the quote."
+ }
+ }
+ },
+ "quote-additional-cost": {
+ "title": "Quote Additional Cost",
+ "type": "object",
+ "description": "Other extra fees not captured by translationCosts and languageCosts.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "default
The name of the additional cost.
"
+ },
+ "count": {
+ "type": "number",
+ "description": "The number of units used to compute the total. Used only for 'volume', 'hourly', 'perPage' and 'percentage' cost types.",
+ "nullable": true
+ },
+ "total": {
+ "type": "number",
+ "description": "default
The computed cost.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "cost": {
+ "type": "number",
+ "description": "The cost of a unit.",
+ "nullable": true
+ },
+ "costType": {
+ "$ref": "#/components/schemas/project-cost-type",
+ "description": "The type of the additional cost."
+ },
+ "volumeUnitType": {
+ "$ref": "#/components/schemas/volume-unit-type",
+ "description": "The unit type of the 'volume' cost, used as a reference for the unit cost."
+ },
+ "costOrder": {
+ "type": "integer",
+ "description": "Indicates the order in which the additional cost is computed.",
+ "nullable": true
+ },
+ "conditionalCostType": {
+ "$ref": "#/components/schemas/conditional-cost-type",
+ "description": "Describes how the cost of type 'conditional' will be added to total cost."
+ },
+ "conditionalCostOperator": {
+ "$ref": "#/components/schemas/conditional-cost-operator",
+ "description": "The operator applied between the 'costVariable' and 'operand'."
+ },
+ "conditionalCostVariable": {
+ "$ref": "#/components/schemas/conditional-cost-variable",
+ "description": "The variable that is evaluated against the 'operand' based on the 'costOperator'."
+ },
+ "conditionalCostThreshold": {
+ "description": "The value that is evaluated against the 'costVariable' based on the 'costOperator'.",
+ "type": "number",
+ "nullable": true
+ },
+ "runningTotal": {
+ "type": "number",
+ "description": "The sum of all the previously computed costs.",
+ "nullable": true
+ },
+ "customUnitName": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "sh8ttf4ncbt4f"
+ },
+ "description": "The name of the custom unit."
+ }
+ }
+ },
+ "quote-additional-cost-request": {
+ "title": "Quote Additional Cost Request",
+ "type": "object",
+ "required": [
+ "name",
+ "count",
+ "cost",
+ "costOrder",
+ "conditionalCostThreshold"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the additional cost."
+ },
+ "count": {
+ "type": "number",
+ "description": "The number of units used to compute the total. Used only for 'volume', 'hourly', 'perPage' and 'percentage' cost types."
+ },
+ "cost": {
+ "type": "number",
+ "description": "The cost of a unit."
+ },
+ "costType": {
+ "$ref": "#/components/schemas/project-cost-type",
+ "description": "The type of the additional cost.",
+ "nullable": true
+ },
+ "volumeUnitType": {
+ "$ref": "#/components/schemas/volume-unit-type",
+ "description": "The unit type of the 'volume' cost, used for counting the units.",
+ "nullable": true
+ },
+ "costOrder": {
+ "type": "integer",
+ "description": "Indicates the order in which the additional cost is computed."
+ },
+ "conditionalCostType": {
+ "$ref": "#/components/schemas/conditional-cost-type",
+ "description": "Describes how the cost of type 'conditional' will be added to total cost.",
+ "nullable": true
+ },
+ "conditionalCostOperator": {
+ "$ref": "#/components/schemas/conditional-cost-operator",
+ "description": "The operator applied between the 'costVariable' and 'operand'.",
+ "nullable": true
+ },
+ "conditionalCostVariable": {
+ "$ref": "#/components/schemas/conditional-cost-variable",
+ "description": "The variable that is evaluated against the 'operand' based on the 'costOperator'.",
+ "nullable": true
+ },
+ "conditionalCostThreshold": {
+ "description": "The value that is evaluated against the 'costVariable' based on the 'costOperator'.",
+ "type": "number"
+ }
+ }
+ },
+ "quote-language-cost": {
+ "title": "Quote Language Cost",
+ "type": "object",
+ "description": "Fees relevant for a specific target language.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "default
The name of the additional cost.
",
+ "x-default-field": true
+ },
+ "count": {
+ "type": "number",
+ "description": "The number of units used to compute the total. Used only for 'volume', 'hourly', 'perPage' and 'percentage' cost types.",
+ "nullable": true
+ },
+ "total": {
+ "type": "number",
+ "description": "default
The computed cost.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "cost": {
+ "type": "number",
+ "description": "The cost of a unit.",
+ "nullable": true
+ },
+ "costType": {
+ "$ref": "#/components/schemas/language-cost-type",
+ "description": "The type of the additional cost."
+ },
+ "volumeUnitType": {
+ "$ref": "#/components/schemas/volume-unit-type",
+ "description": "The unit type of the 'volume' cost, used as a reference for the unit cost."
+ },
+ "targetLanguage": {
+ "$ref": "#/components/schemas/language"
+ },
+ "costOrder": {
+ "type": "integer",
+ "description": "Indicates the order in which the additional cost is computed.",
+ "nullable": true
+ },
+ "conditionalCostType": {
+ "$ref": "#/components/schemas/conditional-cost-type",
+ "description": "The condition type of the conditional cost."
+ },
+ "conditionalCostOperator": {
+ "$ref": "#/components/schemas/conditional-cost-operator",
+ "description": "The operator applied between the 'costVariable' and 'operand'."
+ },
+ "conditionalCostVariable": {
+ "$ref": "#/components/schemas/conditional-cost-variable",
+ "description": "The variable that is evaluated against the 'operand' based on the 'costOperator'."
+ },
+ "conditionalCostThreshold": {
+ "description": "The value that is evaluated against the 'costVariable' based on the 'costOperator'.",
+ "type": "number",
+ "nullable": true
+ },
+ "runningTotal": {
+ "type": "number",
+ "description": "The sum of all the previously computed costs.",
+ "nullable": true
+ },
+ "customUnitName": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "tdfu8mqyo09if"
+ },
+ "description": "The name of the custom unit."
+ }
+ }
+ },
+ "quote-language-cost-request": {
+ "title": "Quote Language Cost Request",
+ "type": "object",
+ "required": [
+ "name",
+ "count",
+ "cost",
+ "costOrder",
+ "conditionalCostThreshold"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the additional cost."
+ },
+ "count": {
+ "type": "number",
+ "description": "The number of units used to compute the total. Used only for 'volume', 'hourly', 'perPage' and 'percentage' cost types."
+ },
+ "cost": {
+ "type": "number",
+ "description": "The cost of a unit."
+ },
+ "costType": {
+ "$ref": "#/components/schemas/language-cost-type",
+ "description": "The type of the additional cost.",
+ "nullable": true
+ },
+ "volumeUnitType": {
+ "$ref": "#/components/schemas/volume-unit-type",
+ "description": "The unit type of the 'volume' cost, used for counting the units.",
+ "nullable": true
+ },
+ "targetLanguage": {
+ "$ref": "#/components/schemas/target-language-request"
+ },
+ "costOrder": {
+ "type": "integer",
+ "description": "Indicates the order in which the additional cost is computed."
+ },
+ "conditionalCostType": {
+ "$ref": "#/components/schemas/conditional-cost-type",
+ "description": "Describes how the cost of type 'conditional' will be added to total cost.",
+ "nullable": true
+ },
+ "conditionalCostOperator": {
+ "$ref": "#/components/schemas/conditional-cost-operator",
+ "description": "The operator applied between the 'costVariable' and 'operand'.",
+ "nullable": true
+ },
+ "conditionalCostVariable": {
+ "$ref": "#/components/schemas/conditional-cost-variable",
+ "description": "The variable that is evaluated against the 'operand' based on the 'costOperator'.",
+ "nullable": true
+ },
+ "conditionalCostThreshold": {
+ "description": "The value that is evaluated against the 'costVariable' based on the 'costOperator'.",
+ "type": "number"
+ }
+ }
+ },
+ "quote-translation-cost": {
+ "title": "Quote Translation Cost",
+ "type": "object",
+ "description": "Fees calculated based on segment status (new, translated, signed off) and previous leverage (100% match and identical context, 100% match, <100%match, cross-file repetitions).",
+ "properties": {
+ "total": {
+ "type": "number",
+ "description": "default
The total cost for the current target language.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "targetLanguage": {
+ "$ref": "#/components/schemas/language"
+ },
+ "exactMatch": {
+ "$ref": "#/components/schemas/translation-cost-item"
+ },
+ "inContextExactMatch": {
+ "$ref": "#/components/schemas/translation-cost-item"
+ },
+ "new": {
+ "$ref": "#/components/schemas/translation-cost-item"
+ },
+ "perfectMatch": {
+ "$ref": "#/components/schemas/translation-cost-item"
+ },
+ "repetitions": {
+ "$ref": "#/components/schemas/translation-cost-item"
+ },
+ "machineTranslation": {
+ "$ref": "#/components/schemas/translation-cost-item"
+ },
+ "fuzzyMatch": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/translation-cost-fuzzy-item"
+ }
+ },
+ "runningTotal": {
+ "type": "number",
+ "description": "default
The sum of all the previously computed costs.
",
+ "nullable": true,
+ "x-default-field": true
+ }
+ }
+ },
+ "quote-update-request": {
+ "title": "Quote Update Request",
+ "type": "object",
+ "properties": {
+ "languageCosts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/quote-language-cost-request"
+ }
+ },
+ "additionalCosts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/quote-additional-cost-request"
+ }
+ },
+ "notes": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "404ggz8hrvbpg"
+ },
+ "description": "A message associated with the quote.",
+ "maxLength": 3000
+ }
+ }
+ },
+ "project-quote-template": {
+ "title": "Project Quote Template",
+ "type": "object",
+ "description": "Project Quote Template resource.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The identifier of the quote template."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the quote template."
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the quote template."
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder-v2"
+ }
+ },
+ "required": [
+ "id"
+ ],
+ "x-stoplight": {
+ "id": "0sp6j7989p1j7"
+ }
+ },
+ "project-quote-template-deprecated": {
+ "title": "Project Quote Template",
+ "x-stoplight": {
+ "id": "cwik0w5o34ix6"
+ },
+ "type": "object",
+ "description": "(Deprecated) moved under settings.general.quoteTemplate",
+ "deprecated": true,
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The identifier of the quote template."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the quote template."
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the quote template."
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder-v2"
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "rate-limit": {
+ "title": "Rate Limit",
+ "type": "object",
+ "description": "Rate Limit entry",
+ "properties": {
+ "policyName": {
+ "type": "string",
+ "description": "Name of the rate limit policy."
+ },
+ "description": {
+ "type": "string",
+ "description": "Describes which endpoints are affected by this limit, and for which time frame."
+ },
+ "limit": {
+ "type": "integer",
+ "description": "The limit in effect for the endpoint and time frame."
+ },
+ "remainingQuota": {
+ "type": "integer",
+ "description": "The remaining quota in effect for the endpoint and time frame."
+ }
+ },
+ "required": [
+ "policyName",
+ "description",
+ "limit",
+ "remainingQuota"
+ ]
+ },
+ "resource-folder-request": {
+ "title": "Resource Folder Request",
+ "type": "object",
+ "description": "Resource folder.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The folder identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the folder."
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "remove-projects-from-group-request": {
+ "title": "Remove Projects From Group Request",
+ "type": "object",
+ "description": "Input for removing projects from group.",
+ "properties": {
+ "projects": {
+ "type": "array",
+ "description": "The projects to be removed from group.",
+ "items": {
+ "$ref": "#/components/schemas/project-group-project-request"
+ }
+ }
+ },
+ "required": [
+ "projects"
+ ]
+ },
+ "schedule-template": {
+ "title": "Schedule Template",
+ "x-stoplight": {
+ "id": "c2a2ilce5ag48"
+ },
+ "type": "object",
+ "description": "Schedule Template resource",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "default
Schedule Template name.
",
+ "x-default-field": true
+ },
+ "description": {
+ "type": "string",
+ "description": "Schedule Template description."
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder-v2"
+ },
+ "configurations": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "w3yw55a536y3m"
+ },
+ "items": {
+ "$ref": "#/components/schemas/schedule-template-configuration",
+ "x-stoplight": {
+ "id": "z1pcd596vxyhe"
+ }
+ }
+ },
+ "projectScheduleConfiguration": {
+ "$ref": "#/components/schemas/schedule-template-project-configuration",
+ "x-stoplight": {
+ "id": "jh0as6p6odfm0"
+ }
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "schedule-template-configuration": {
+ "title": "Schedule Template Configuration",
+ "x-stoplight": {
+ "id": "p8wulrz2rytzj"
+ },
+ "type": "object",
+ "description": "Schedule Template Configuration resource",
+ "properties": {
+ "taskTypeId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "ussbf9yycjf0h"
+ },
+ "description": "The identifier of the human task type. "
+ },
+ "taskTypeName": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "lny75nk7b0g3j"
+ },
+ "description": "The name of the task type."
+ },
+ "schedules": {
+ "x-stoplight": {
+ "id": "iu34k91wl2eql"
+ },
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/schedule-template-configuration-schedules",
+ "x-stoplight": {
+ "id": "j29hssjf8a1nu"
+ }
+ }
+ }
+ },
+ "required": [
+ "taskTypeId"
+ ]
+ },
+ "schedule-template-project-configuration": {
+ "title": "Schedule Template Project Configuration",
+ "x-stoplight": {
+ "id": "ezrw8kwy2cc2x"
+ },
+ "type": "object",
+ "description": "Schedule Template Project Configuration resource",
+ "properties": {
+ "duration": {
+ "type": "integer",
+ "x-stoplight": {
+ "id": "ml3qutq4qy3km"
+ },
+ "description": "default
Expressed in minutes.
",
+ "default": 0,
+ "minimum": 0
+ },
+ "reminder": {
+ "x-stoplight": {
+ "id": "3z5tzoznv1gci"
+ },
+ "description": "default
Expressed in minutes.
",
+ "enum": [
+ 15,
+ 30,
+ 60,
+ 120,
+ 480,
+ 1440,
+ 2880
+ ]
+ }
+ }
+ },
+ "schedule-template-configuration-request": {
+ "title": "Schedule Template Configuration Request",
+ "x-stoplight": {
+ "id": "pzjg39ikgktrd"
+ },
+ "type": "object",
+ "description": "Schedule Template Configuration resource",
+ "properties": {
+ "taskTypeId": {
+ "type": "string",
+ "description": "The identifier of the human task type. "
+ },
+ "schedules": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/schedule-template-configuration-schedules"
+ }
+ }
+ },
+ "required": [
+ "taskTypeId"
+ ]
+ },
+ "schedule-template-configuration-schedules": {
+ "title": "Schedule Template Configuration Schedules",
+ "x-stoplight": {
+ "id": "9kw1yuhfb39q1"
+ },
+ "type": "object",
+ "description": "The Configuration Schedules resource.",
+ "properties": {
+ "scope": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "gn25uzdk9mu85"
+ },
+ "description": "The scope of this configuration schedule. \\\r\nglobal -> schedule of the task \\\r\nsourceLanguage -> schedule of the specific task when the sourceLanguage matches this object's sourceLanguage\\\r\nlanguageDirection -> schedule of the specific task when the languageDirection matches this object's languageDirection",
+ "enum": [
+ "global",
+ "sourceLanguage",
+ "languageDirection"
+ ]
+ },
+ "duration": {
+ "type": "integer",
+ "x-stoplight": {
+ "id": "r20a6jq7s4a99"
+ },
+ "description": "Expressed in minutes.",
+ "minimum": 0
+ },
+ "reminder": {
+ "x-stoplight": {
+ "id": "wa77577h9gchk"
+ },
+ "description": "Expressed in minutes.\r\n\r\n",
+ "enum": [
+ 15,
+ 30,
+ 60,
+ 120,
+ 480,
+ 1440,
+ 2880
+ ]
+ },
+ "sourceLanguage": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "x9sswos4516kw"
+ },
+ "example": " \"en-US\", de-DE\""
+ },
+ "targetLanguage": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "kptfl33vpqdt7"
+ },
+ "example": " \"en-US\", de-DE\""
+ }
+ },
+ "required": [
+ "scope"
+ ]
+ },
+ "schedule-template-update-request": {
+ "title": "Schedule Template Update Request",
+ "x-stoplight": {
+ "id": "eurbufhjxy71a"
+ },
+ "type": "object",
+ "description": "Schedule Template update request model",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Schedule Template name.
",
+ "maxLength": 50
+ },
+ "description": {
+ "type": "string",
+ "description": "Schedule Template description.",
+ "maxLength": 1000
+ },
+ "configurations": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "nzqkfrvaq8mck"
+ },
+ "items": {
+ "$ref": "#/components/schemas/schedule-template-configuration-request",
+ "x-stoplight": {
+ "id": "kw88kaez7l361"
+ }
+ }
+ },
+ "projectScheduleConfiguration": {
+ "$ref": "#/components/schemas/schedule-template-project-configuration",
+ "x-stoplight": {
+ "id": "glzz39c8n1mpo"
+ }
+ }
+ }
+ },
+ "schedule-template-create-request": {
+ "title": "Schedule Template Create Request",
+ "x-stoplight": {
+ "id": "nzunuxlururt7"
+ },
+ "type": "object",
+ "description": "Schedule Template create request model",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Schedule Template name.
",
+ "maxLength": 50
+ },
+ "description": {
+ "type": "string",
+ "description": "Schedule Template description.",
+ "maxLength": 1000
+ },
+ "location": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "j38jg0ywij0e6"
+ },
+ "description": "The folder identifier where the schedule template should be created. "
+ },
+ "configurations": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "eufab0pne7lzd"
+ },
+ "items": {
+ "$ref": "#/components/schemas/schedule-template-configuration-request",
+ "x-stoplight": {
+ "id": "oxk22epaz3rbi"
+ }
+ }
+ },
+ "projectScheduleConfiguration": {
+ "$ref": "#/components/schemas/schedule-template-project-configuration",
+ "x-stoplight": {
+ "id": "rqi0t3ue6dm3m"
+ }
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "simple-language-direction": {
+ "title": "Simple Language Direction",
+ "type": "object",
+ "description": "A basic language direction.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The language direction identifier."
+ },
+ "sourceLanguage": {
+ "$ref": "#/components/schemas/language",
+ "description": "default
The language object.
",
+ "x-default-field": true
+ },
+ "targetLanguage": {
+ "$ref": "#/components/schemas/language",
+ "description": "default
The language object.
",
+ "x-default-field": true
+ }
+ }
+ },
+ "source-file": {
+ "title": "Source File",
+ "type": "object",
+ "description": "Source File.",
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The file name.
",
+ "x-default-field": true
+ },
+ "role": {
+ "$ref": "#/components/schemas/file-role",
+ "description": "default
The file role.
",
+ "x-default-field": true
+ },
+ "language": {
+ "$ref": "#/components/schemas/language"
+ },
+ "versions": {
+ "type": "array",
+ "description": "The source file versions. (Not available for List endpoints).",
+ "items": {
+ "$ref": "#/components/schemas/source-file-version"
+ }
+ },
+ "targetLanguages": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/language"
+ }
+ },
+ "path": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "totalWords": {
+ "type": "integer",
+ "description": "Word count in the source file. \r\n\r\nAvailable only for translatable source files, and only after the workflow task with Task Type `convert` (File Format Conversion) was executed on the source file.\r\n\r\nAvailable only on the List Source Files endpoint."
+ }
+ }
+ },
+ "source-file-request": {
+ "type": "object",
+ "title": "Source File Request",
+ "description": "Source file properties sent as a JSON inside a text part.",
+ "required": [
+ "name",
+ "role",
+ "type",
+ "language"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the source file. For example `Finance_2021_dummy_EN.txt`.\n\n\nThe character limit is calculated together with the `path` length.",
+ "minLength": 1,
+ "maxLength": 255
+ },
+ "role": {
+ "type": "string",
+ "enum": [
+ "translatable",
+ "reference",
+ "unknown"
+ ],
+ "description": "The role of the source file. When set to unknown or translatable, the system will try to detect the file type."
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "native",
+ "bcm",
+ "sdlxliff"
+ ],
+ "description": "The type of the file."
+ },
+ "language": {
+ "$ref": "#/components/schemas/language-request",
+ "description": "The language of the file in code 5 (ex. en-US)"
+ },
+ "targetLanguages": {
+ "type": "array",
+ "description": "A list of target languages in code 5 (ex. en-US)",
+ "items": {
+ "$ref": "#/components/schemas/language-request"
+ }
+ },
+ "path": {
+ "type": "array",
+ "description": "Path represents the hierarchy of the source file inside the project.\n\nFor example `/ZipWithFolders/Finance/2021/Finance_2021_dummy_EN.txt` would be sent as: \n\n```json \n\"path\": [ \n \"ZipWithFolders\", \n \"Finance\", \n \"2021\"\n]\n```\n\nThe character limit is calculated together with the `name` length.",
+ "items": {
+ "type": "string",
+ "minLength": 0,
+ "maxLength": 200
+ }
+ }
+ }
+ },
+ "source-file-rename-request": {
+ "title": "Source File Rename Request",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the source file.\\\nThe name should not contain the extension.\\\nUnsupported characters in the name: `<`, `>`, `:`, `\"`, `/`, `\\`, `|`, `?`, `*`.",
+ "minLength": 1
+ },
+ "updateTargetFilesName": {
+ "type": "boolean",
+ "default": false,
+ "description": "Option for renaming also the target files."
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "source-files-update-request": {
+ "title": "Source Files Update Request",
+ "type": "object",
+ "properties": {
+ "files": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/source-file-update-request"
+ }
+ }
+ },
+ "required": [
+ "files"
+ ]
+ },
+ "source-file-update-request": {
+ "title": "Source File Update Request",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The source file identifier.",
+ "minLength": 1
+ },
+ "name": {
+ "type": "string",
+ "description": "The source file name.\\\nThe name should not contain the extension.\\\nUnsupported characters in the name: `<`, `>`, `:`, `\"`, `/`, `\\`, `|`, `?`, `*`.",
+ "minLength": 1
+ },
+ "updateTargetFilesName": {
+ "type": "boolean",
+ "default": false,
+ "description": "Option for renaming the target files too."
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ]
+ },
+ "source-file-attachment-request": {
+ "title": "Source File Attachment Request",
+ "type": "object",
+ "description": "",
+ "properties": {
+ "sourceFilesAttachment": {
+ "type": "array",
+ "description": "List of Attached Source File properties referencing previously uploaded file",
+ "items": {
+ "$ref": "#/components/schemas/source-file-attachment-request-item"
+ }
+ }
+ }
+ },
+ "source-file-attachment-response": {
+ "title": "Source File Attachment Response",
+ "type": "object",
+ "description": "",
+ "properties": {
+ "sourceFiles": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/source-file"
+ }
+ }
+ }
+ },
+ "source-file-attachment-request-item": {
+ "title": "Source File Attachment Request Item",
+ "type": "object",
+ "description": "Attached Source File properties referencing previously uploaded file",
+ "required": [
+ "name",
+ "role",
+ "fileUrl",
+ "type",
+ "language"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the source file. For example `Finance_2021_dummy_EN.txt`. \n\nThe character limit is calculated together with the `path` length.",
+ "maxLength": 200,
+ "minLength": 1
+ },
+ "role": {
+ "type": "string",
+ "enum": [
+ "translatable",
+ "reference",
+ "unknown"
+ ],
+ "description": "The role of the source file. When set to unknown or translatable, the system will try to detect the file type."
+ },
+ "fileUrl": {
+ "type": "string",
+ "description": "The identifier of the previously uploaded file."
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "native",
+ "bcm",
+ "sdlxliff"
+ ],
+ "description": "The type of the file."
+ },
+ "language": {
+ "$ref": "#/components/schemas/source-language-request"
+ },
+ "targetLanguages": {
+ "type": "array",
+ "description": "A list of target languages in code 5 (ex. en-US)",
+ "items": {
+ "$ref": "#/components/schemas/target-language-request"
+ }
+ },
+ "path": {
+ "type": "array",
+ "description": "Path represents the hierarchy of the source file inside the project.\n\nFor example `/ZipWithFolders/Finance/2021/Finance_2021_dummy_EN.txt` would be sent as: \n\n```json \n\"path\": [ \n \"ZipWithFolders\", \n \"Finance\", \n \"2021\" \n]\n```\n\nThe character limit is calculated together with the `name` length.",
+ "items": {
+ "type": "string",
+ "maxLength": 200,
+ "minLength": 0
+ }
+ }
+ }
+ },
+ "source-file-properties-response": {
+ "title": "Source File Properties Response",
+ "type": "object",
+ "description": "",
+ "properties": {
+ "fileRole": {
+ "type": "string",
+ "description": "The file's role.",
+ "enum": [
+ "translatable",
+ "reference"
+ ]
+ },
+ "fileTypeSettingsId": {
+ "type": "string",
+ "description": "The file type settings identifier."
+ }
+ },
+ "required": [
+ "fileRole",
+ "fileTypeSettingsId"
+ ]
+ },
+ "source-file-properties-update-request": {
+ "title": "Source File Properties Update Request",
+ "type": "object",
+ "description": "",
+ "properties": {
+ "fileRole": {
+ "type": "string",
+ "description": "The file role.",
+ "enum": [
+ "translatable",
+ "reference"
+ ]
+ },
+ "fileTypeSettingsId": {
+ "type": "string",
+ "description": "The file type settings identifier."
+ }
+ }
+ },
+ "source-file-version-properties-create-request": {
+ "title": "Source File Version Properties Create Request",
+ "type": "object",
+ "description": "",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The version type.",
+ "enum": [
+ "bcm",
+ "native"
+ ]
+ },
+ "fileTypeSettingsId": {
+ "type": "string",
+ "description": "The file type settings identifier."
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "source-file-version": {
+ "title": "Source File Version",
+ "type": "object",
+ "description": "Source File Version.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The source file version identifier."
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "native",
+ "bcm"
+ ],
+ "description": "default
The version type.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The file version name. This is a synthetic value, typically constructed from the version number and the originating task name.
",
+ "x-default-field": true
+ },
+ "version": {
+ "type": "integer",
+ "description": "A numeric value, incremented for each new version."
+ },
+ "originatingTaskId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "fsakhiag03gl9"
+ },
+ "description": "The identifier of the task that generated the file."
+ }
+ },
+ "required": [
+ "id",
+ "version"
+ ]
+ },
+ "source-file-version-response": {
+ "title": "Source File Version Response",
+ "type": "object",
+ "description": "",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The source file version identifier."
+ },
+ "type": {
+ "type": "string",
+ "description": "default
The version type.
",
+ "enum": [
+ "native",
+ "bcm"
+ ],
+ "x-default-field": true
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "source-language-request": {
+ "title": "Source Language Request",
+ "type": "object",
+ "properties": {
+ "languageCode": {
+ "type": "string",
+ "description": "The language code."
+ }
+ },
+ "required": [
+ "languageCode"
+ ]
+ },
+ "target-file-version-properties-create-request": {
+ "title": "Target File Version Properties Create Request",
+ "type": "object",
+ "description": "",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The version type.",
+ "enum": [
+ "bcm",
+ "native"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "target-file-version-response": {
+ "title": "Target File Version Response",
+ "type": "object",
+ "description": "",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The target file version identifier."
+ },
+ "type": {
+ "type": "string",
+ "description": "default
The version type.
",
+ "enum": [
+ "native",
+ "bcm"
+ ],
+ "x-default-field": true
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "task": {
+ "title": "Task",
+ "type": "object",
+ "description": "Task.",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string",
+ "description": "default
The task status.
",
+ "enum": [
+ "created",
+ "inProgress",
+ "completed",
+ "failed",
+ "skipped",
+ "canceled"
+ ],
+ "x-default-field": true,
+ "nullable": true
+ },
+ "taskType": {
+ "$ref": "#/components/schemas/task-type"
+ },
+ "input": {
+ "$ref": "#/components/schemas/task-input"
+ },
+ "inputFiles": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/task-input-file"
+ }
+ },
+ "owner": {
+ "$ref": "#/components/schemas/user"
+ },
+ "assignees": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/task-assignee"
+ }
+ },
+ "dueBy": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2022-01-12T12:00:00.000Z",
+ "description": "The task due date. UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "nullable": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the task was created.
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\" ", + "nullable": true + }, + "applicableOutcomes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/task-outcome" + } + }, + "outcome": { + "type": "string", + "description": "The outcome of the task type. It is retrieved only if the task is completed. It should match one of the legal outcomes in the task type." + }, + "comment": { + "type": "string", + "description": "The comment associated with this task at completion." + }, + "project": { + "$ref": "#/components/schemas/project" + }, + "failedTask": { + "$ref": "#/components/schemas/failed-task" + }, + "completedAt": { + "$ref": "#/components/schemas/date-time", + "description": "The completion timestamp of the task.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"" + } + }, + "required": [ + "id" + ] + }, + "task-error": { + "title": "Task Error", + "type": "object", + "description": "Task Error.", + "properties": { + "name": { + "type": "string", + "description": "The task error name." + }, + "code": { + "type": "string", + "description": "The task error code." + }, + "value": { + "type": "string", + "description": "The task error value." + } + } + }, + "task-assignee": { + "title": "Task Assignee", + "type": "object", + "description": "Task assignee. Based on the \"type\", the following properties can be retrieved: \"user\", \"group\" or \"vendorOrderTemplate\". For \"projectCreator\" and \"projectManager\" no other properties are available.", + "properties": { + "type": { + "type": "string", + "enum": [ + "user", + "group", + "vendorOrderTemplate", + "projectCreator" + ], + "description": "Type \"projectCreator\" - reserved for future use. Should be able to handle it and ignore it if received." + }, + "user": { + "$ref": "#/components/schemas/user", + "description": "
default
A user.
",
+ "x-default-field": true
+ },
+ "group": {
+ "$ref": "#/components/schemas/group",
+ "description": "default
A group of users.
",
+ "x-default-field": true
+ },
+ "vendorOrderTemplate": {
+ "$ref": "#/components/schemas/vendor-order-template"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "task-assignee-request": {
+ "title": "Task Assignee Request",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The identifier of the assignee that should correspond to a resource based on the “type” field. Only required for the `user`, `group`, and `vendorOrderTemplate` types." + }, + "type": { + "type": "string", + "enum": [ + "user", + "group", + "vendorOrderTemplate", + "projectManager", + "projectCreator" + ], + "description": "The assignee type." + } + }, + "required": [ + "type" + ] + }, + "task-assign-request": { + "title": "Task Assign Request", + "type": "object", + "description": "Properties of task assignment.\r\n
Total assignee count is limited. See more at [Maximum number of task assignees](https://docs.rws.com/791595/1137562/trados-enterprise---accelerate/maximum-number-of-task-assignees).", + "properties": { + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/task-assignee-request" + } + } + } + }, + "task-complete-request": { + "title": "Task Complete Request", + "type": "object", + "description": "Properties of task completion.", + "properties": { + "outcome": { + "type": "string", + "description": "The outcome should be one of the valid applicable outcomes of the task. If not specified, the default one will be taken." + }, + "comment": { + "type": "string", + "description": "The comment associated with this task completion.", + "maxLength": 1000 + } + }, + "required": [ + "outcome" + ] + }, + "task-input": { + "title": "Task Input", + "type": "object", + "description": "Task input. Based on the \"type\", the following fields can be retrieved: \"project\", \"sourceFile\", \"targetFile\".", + "properties": { + "type": { + "type": "string", + "description": "The input type.", + "enum": [ + "project", + "sourceFile", + "targetFile", + "languageDirection" + ] + }, + "project": { + "$ref": "#/components/schemas/project", + "description": "
default
Project resource
",
+ "x-default-field": true
+ },
+ "sourceFile": {
+ "$ref": "#/components/schemas/source-file",
+ "description": "default
Source file.
",
+ "x-default-field": true
+ },
+ "targetFile": {
+ "$ref": "#/components/schemas/target-file",
+ "description": "default
Target file.
",
+ "x-default-field": true
+ },
+ "languageDirection": {
+ "$ref": "#/components/schemas/language-direction",
+ "description": "default
A language direction.
",
+ "x-default-field": true
+ },
+ "vendorOrder": {
+ "$ref": "#/components/schemas/vendor-order",
+ "description": "default
A vendor order resource.
",
+ "x-default-field": true
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "task-input-file": {
+ "title": "Task Input File",
+ "type": "object",
+ "description": "Task input file. Based on the \"type\", only the \"sourceFile\" or \"targetFile\" can be retrieved.",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "sourceFile",
+ "targetFile"
+ ],
+ "nullable": true,
+ "description": "default
",
+ "x-default-field": true
+ },
+ "sourceFile": {
+ "$ref": "#/components/schemas/source-file",
+ "description": "default
Source file.
",
+ "x-default-field": true
+ },
+ "targetFile": {
+ "$ref": "#/components/schemas/target-file",
+ "description": "default
Target file.
",
+ "x-default-field": true
+ }
+ }
+ },
+ "task-type": {
+ "title": "Task Type",
+ "type": "object",
+ "description": "Task type.",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "key": {
+ "type": "string",
+ "description": "default
Identifier key for the task.
",
+ "x-default-field": true
+ },
+ "name": {
+ "type": "string",
+ "description": "default
",
+ "x-default-field": true
+ },
+ "apiInternalId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "tavwkrljagcmc"
+ },
+ "description": "default
Unique identifier of custom task types. Null for default task types."
+ },
+ "description": {
+ "type": "string"
+ },
+ "automatic": {
+ "type": "boolean",
+ "description": "This indicates whether the task is automatic or human.",
+ "nullable": true
+ },
+ "scope": {
+ "type": "string",
+ "description": "The resource type scope for the task.",
+ "enum": [
+ "file",
+ "targetLanguage",
+ "batch",
+ "vendorOrder",
+ "task"
+ ],
+ "nullable": true
+ },
+ "outcomes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/task-type-outcome"
+ }
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder-v2"
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "task-outcome": {
+ "title": "Task Outcome",
+ "type": "object",
+ "description": "Outcome a task can be completed with. List will be populated after the task is accepted.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "format": "date-time" + }, + "lastModifiedAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the termbase template was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "format": "date-time" + }, + "type": { + "type": "string", + "description": "The type of the termbase template.", + "enum": [ + "system", + "userDefined" + ] + }, + "languages": { + "type": "array", + "description": "The languages of the termbase template.", + "items": { + "$ref": "#/components/schemas/language" + } + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field" + } + } + }, + "required": [ + "id", + "type" + ] + }, + "termbase-template-update-request": { + "title": "Termbase Template Update Request", + "type": "object", + "description": "The termbase template update request.", + "properties": { + "name": { + "type": "string", + "description": "The name of the Termbase template.", + "maxLength": 50, + "minLength": 1 + }, + "description": { + "type": "string", + "description": "The description of the Termbase template.", + "minLength": 0, + "maxLength": 200, + "nullable": true + }, + "copyright": { + "type": "string", + "description": "The copyright of the Termbase template.", + "minLength": 0, + "maxLength": 50, + "nullable": true + }, + "languages": { + "type": "array", + "description": "The languages of the termbase template.", + "items": { + "$ref": "#/components/schemas/language-request" + } + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-update-request" + } + } + } + }, + "termbase-template-create-request": { + "title": "Termbase Template Create Request", + "type": "object", + "description": "The termbase template create request.", + "properties": { + "name": { + "type": "string", + "description": "The name of the termbase template.", + "minLength": 0, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The description of the termbase template.", + "minLength": 0, + "maxLength": 200, + "nullable": true + }, + "copyright": { + "type": "string", + "description": "The copyright of the termbase template.", + "minLength": 0, + "maxLength": 50, + "nullable": true + }, + "location": { + "type": "string", + "description": "The folder identifier where the termbase template should be created. If not mentioned, it will be created in the Root folder. If the user does not have access in Root, the request will fail with forbidden error." + }, + "languages": { + "type": "array", + "description": "The languages of the termbase template.", + "items": { + "$ref": "#/components/schemas/language-request" + } + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-create-request" + } + } + }, + "required": [ + "name" + ] + }, + "termbase-structure": { + "title": "Termbase Structure", + "type": "object", + "description": "The termbase structure.", + "properties": { + "languages": { + "type": "array", + "description": "
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "format": "date-time" + }, + "lastModifiedAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the termbase was last updated. (Not available for List Termbases endpoint)
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "format": "date-time" + } + }, + "required": [ + "id" + ] + }, + "termbase-create-request": { + "title": "Termbase Create Request", + "type": "object", + "description": "Termbase create request.", + "properties": { + "name": { + "type": "string", + "description": "The name of the termbase.", + "minLength": 1, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The description of the termbase.", + "minLength": 0, + "maxLength": 200, + "nullable": true + }, + "copyright": { + "type": "string", + "description": "The copyright of the termbase.", + "minLength": 0, + "maxLength": 50, + "nullable": true + }, + "location": { + "type": "string", + "description": "The folder identifier where the termbase should be created. If not specified, it will be created in the Root folder. If the user does not have access in Root, the request will fail with forbidden error." + }, + "termbaseTemplateId": { + "type": "string", + "description": "The termbase template identifier." + }, + "termbaseStructure": { + "$ref": "#/components/schemas/termbase-structure-create-request" + } + }, + "required": [ + "name" + ] + }, + "termbase-update-request": { + "title": "Termbase Update Request", + "type": "object", + "description": "Termbase update request.", + "properties": { + "name": { + "type": "string", + "description": "The name of the termbase.", + "minLength": 1, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The description of the termbase.", + "minLength": 0, + "maxLength": 200, + "nullable": true + }, + "copyright": { + "type": "string", + "description": "The copyright of the termbase.", + "minLength": 0, + "maxLength": 50, + "nullable": true + }, + "termbaseTemplateId": { + "type": "string", + "description": "The termbase template identifier." + }, + "termbaseStructure": { + "$ref": "#/components/schemas/termbase-structure-update-request" + } + } + }, + "termbase-field-value-link": { + "title": "Termbase Field Value Link", + "type": "object", + "description": "The field value link.", + "properties": { + "type": { + "type": "string", + "enum": [ + "term", + "entry", + "external" + ], + "description": "The type of the link." + }, + "value": { + "type": "string", + "description": "The value of the link." + } + }, + "required": [ + "type", + "value" + ] + }, + "termbase-field-value-link-update-request": { + "title": "Termbase Field Value Link Update Request", + "type": "object", + "description": "The field value link update request.", + "properties": { + "type": { + "type": "string", + "enum": [ + "term", + "entry", + "external" + ], + "description": "The type of the link." + }, + "value": { + "type": "string", + "description": "The value of the link." + } + } + }, + "termbase-field-value-link-create-request": { + "title": "Termbase Field Value Link Create Request", + "type": "object", + "description": "The field value link create request.", + "properties": { + "type": { + "type": "string", + "enum": [ + "term", + "entry", + "external" + ], + "description": "The type of link." + }, + "value": { + "type": "string", + "description": "The value of the link.", + "minLength": 1 + } + }, + "required": [ + "type", + "value" + ] + }, + "termbase-field-value": { + "title": "Termbase Field Value", + "type": "object", + "description": "The termbase field value.", + "properties": { + "id": { + "type": "string", + "description": "The field value identifier." + }, + "name": { + "type": "string", + "description": "The field value name." + }, + "termbaseFieldId": { + "type": "string", + "description": "The termbase field identifier." + }, + "value": { + "type": "string", + "description": "The value of the field." + }, + "fieldValueLinks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-link" + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the termbase field value was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "createdBy": { + "$ref": "#/components/schemas/user" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the termbase field value was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "lastModifiedBy": { + "$ref": "#/components/schemas/user" + } + }, + "required": [ + "id", + "name", + "termbaseFieldId", + "value" + ] + }, + "termbase-field-value-update-request": { + "title": "Termbase Field Value Update request", + "type": "object", + "description": "The termbase field value update request.", + "properties": { + "id": { + "type": "string", + "description": "The field value identifier. Either the `id` or the `name` is mandatory to be provided." + }, + "name": { + "type": "string", + "description": "The field value name. Either the `id` or the `name` is mandatory to be provided." + }, + "termbaseFieldId": { + "type": "string", + "description": "The termbase field value identifier. Must match with the fieldId from the termbase." + }, + "value": { + "type": "string", + "description": "The value of the field.", + "minLength": 1, + "maxLength": 4096 + }, + "fieldValueLinks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-link-update-request" + } + } + }, + "required": [ + "termbaseFieldId", + "value" + ] + }, + "termbase-field-value-create-request": { + "title": "Termbase Field Value Create Request", + "type": "object", + "description": "The termbase field value create request.", + "properties": { + "termbaseFieldId": { + "type": "string", + "description": "The termbase field identifier. It must match the `fieldId` from the termbase." + }, + "value": { + "type": "string", + "description": "The value of the field.", + "minLength": 1, + "maxLength": 4096 + }, + "fieldValueLinks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-link-create-request" + } + } + }, + "required": [ + "termbaseFieldId", + "value" + ] + }, + "termbase-entry-term": { + "title": "Termbase Entry Term", + "type": "object", + "description": "The termbase entry term.", + "required": [ + "id", + "text" + ], + "properties": { + "id": { + "type": "string", + "description": "The term identifier." + }, + "text": { + "type": "string", + "description": "The term text." + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value" + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the term entry was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "createdBy": { + "$ref": "#/components/schemas/user" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the term entry was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "lastModifiedBy": { + "$ref": "#/components/schemas/user" + }, + "systemStatus": { + "$ref": "#/components/schemas/termbase-entry-term-system-status", + "x-stoplight": { + "id": "xx4xvu4isws0c" + } + } + } + }, + "termbase-entry-term-update-request": { + "title": "Termbase Entry Term Update Request", + "type": "object", + "description": "The termbase entry term update request.", + "required": [ + "text" + ], + "properties": { + "id": { + "type": "string", + "description": "The term identifier that will be updated. If not supplied, a new term will be created." + }, + "text": { + "type": "string", + "description": "The term text.", + "minLength": 1, + "maxLength": 1024 + }, + "systemStatus": { + "$ref": "#/components/schemas/termbase-entry-term-system-status-request", + "x-stoplight": { + "id": "lpm4ttzn58ku0" + } + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-update-request" + } + } + } + }, + "termbase-term-create-request": { + "title": "Termbase Entry Term Create Request", + "type": "object", + "description": "The termbase entry term request.", + "required": [ + "text" + ], + "properties": { + "text": { + "type": "string", + "description": "The term text.", + "maxLength": 1024, + "minLength": 1 + }, + "systemStatus": { + "$ref": "#/components/schemas/termbase-entry-term-system-status-request", + "x-stoplight": { + "id": "cvo2q7bu0gkix" + } + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-create-request" + } + } + } + }, + "termbase-entry-language": { + "title": "Termbase Entry Language", + "type": "object", + "description": "The termbase entry language.", + "properties": { + "id": { + "type": "string", + "description": "The termbase language identifier." + }, + "language": { + "$ref": "#/components/schemas/language" + }, + "terms": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-entry-term" + } + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value" + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the language entry was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "createdBy": { + "$ref": "#/components/schemas/user" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the language entry was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "lastModifedBy": { + "$ref": "#/components/schemas/user" + } + }, + "required": [ + "id", + "language" + ] + }, + "termbase-entry-language-update-request": { + "title": "Termbase Entry Language Update Request", + "type": "object", + "description": "The termbase entry language update request.", + "properties": { + "id": { + "type": "string", + "description": "The termbase language identifier." + }, + "language": { + "$ref": "#/components/schemas/language-request" + }, + "terms": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-entry-term-update-request" + } + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-update-request" + } + } + }, + "required": [ + "language", + "terms" + ] + }, + "termbase-entry-language-create-request": { + "title": "Termbase Entry Language Create Request", + "type": "object", + "description": "The termbase entry language create request.", + "properties": { + "language": { + "$ref": "#/components/schemas/language-request" + }, + "terms": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-term-create-request" + } + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-create-request" + } + } + }, + "required": [ + "language", + "terms" + ] + }, + "termbase-entry": { + "title": "Termbase Entry", + "type": "object", + "description": "The termbase entry.", + "properties": { + "id": { + "type": "string", + "description": "The termbase entry identifier." + }, + "humanReadableId": { + "type": "string", + "description": "An identifier that can be provided externally, or generated automatically by the Trados Cloud Platform, used for creating cross-references. You can use it to set its value to be correlated to your system. The format of the generated value is not guaranteed." + }, + "languages": { + "description": "The termbase entry languages.", + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-entry-language" + } + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value" + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the termbase entry was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "createdBy": { + "$ref": "#/components/schemas/user" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the termbase entry was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "lastModifiedBy": { + "$ref": "#/components/schemas/user" + } + }, + "required": [ + "id", + "languages" + ] + }, + "termbase-entry-update-request": { + "title": "Termbase Entry Update Request", + "type": "object", + "description": "The termbase entry update request.", + "properties": { + "humanReadableId": { + "type": "string", + "description": "An identifier that can be provided externally, or generated automatically by the Trados Cloud Platform, used for creating cross-references. You can use it to set its value to be correlated to your system. The format of the generated value is not guaranteed." + }, + "languages": { + "description": "The termbase entry languages.", + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-entry-language-update-request" + } + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-update-request" + } + } + }, + "required": [ + "languages" + ] + }, + "termbase-entry-create-request": { + "title": "Termbase Entry Create Request", + "type": "object", + "description": "The termbase entry create request.", + "properties": { + "humanReadableId": { + "type": "string", + "description": "An identifier that can be provided externally, or generated automatically by the Trados Cloud Platform, used for creating cross-references. You can use it to set its value to be correlated to your system.\nThe format of the generated value is not guaranteed." + }, + "languages": { + "description": "The termbase entry languages.", + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-entry-language-create-request" + } + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-create-request" + } + } + }, + "required": [ + "languages" + ] + }, + "termbase-entry-term-system-status": { + "title": "Termbase Entry Term System Status", + "type": "string", + "nullable": true, + "x-stoplight": { + "id": "k477x1xb11mvw" + }, + "enum": [ + "preferred", + "draft", + "inReview", + "deprecated", + "recommended", + "admitted", + "forbidden", + "rejected", + "superseded" + ] + }, + "termbase-entry-term-system-status-request": { + "title": "Termbase Entry Term System Status", + "type": "string", + "x-stoplight": { + "id": "k477x1xb11mvw" + }, + "enum": [ + "preferred", + "draft", + "inReview", + "deprecated", + "recommended", + "admitted", + "forbidden", + "rejected", + "superseded" + ] + }, + "termbase-export-properties-request": { + "title": "Termbase Export Properties Request", + "type": "object", + "properties": { + "downloadCompressed": { + "type": "boolean", + "description": "Download compressed ( zipped ).", + "default": false + } + } + }, + "termbase-export-response": { + "title": "Termbase Export Response", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The termbase export identifier." + }, + "status": { + "type": "string", + "description": "The status of the export operation.
\n`queued` - The export passed the structural validation and it's waiting to be processed.
\n`processing` - The export is in progress.
\n`done` - The export was successfully processed .
\n`canceled` - The export process was interrupted.
\n`error` - The export was unsuccessful due to an internal error.", + "enum": [ + "queued", + "processing", + "done", + "cancelled", + "error" + ] + }, + "errorMessage": { + "type": "string", + "description": "When status is 'error', contains the error message explaining what went wrong." + }, + "downloadUrl": { + "type": "string", + "description": "The url where the file can be downloaded." + } + }, + "required": [ + "id", + "status" + ] + }, + "termbase-term": { + "title": "Termbase Term Response", + "type": "object", + "description": "The termbase term.", + "properties": { + "id": { + "type": "string", + "description": "The term identifier." + }, + "entryId": { + "type": "string", + "description": "The entry identifier." + }, + "text": { + "type": "string", + "description": "The term text." + } + }, + "required": [ + "id", + "entryId", + "text" + ] + }, + "termbase-import-response": { + "title": "Termbase Import Response", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the import operation." + }, + "status": { + "type": "string", + "description": "The status of the import operation.
\n`queued` - The import passed the structural validation and it's waiting to be processed.
\n`processing` - The import is in progress.
\n`done` - The import was successfully processed and at least an entry changed its structure ( either inserted or modified )
\n`cancelled` - The import process was interrupted.
\n`failed` - The import was unsuccessful. Either one of the import files is not compliant with the TBX structure or no entry changed during the import process.
\n`error` - The import was unsuccessful due to an internal error.", + "enum": [ + "queued", + "processing", + "done", + "cancelled", + "failed", + "error" + ] + } + }, + "required": [ + "id", + "status" + ] + }, + "termbase-poll-import-response": { + "title": "Termbase Poll Import Response", + "type": "object", + "description": "The termbase poll import response.
\nThe import was successfully processed when the status is `done`.", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the import operation." + }, + "status": { + "type": "string", + "description": "The status of the import operation.
\n`queued` - The import passed the structural validation and it's waiting to be processed.
\n`processing` - The import is in progress.
\n`done` - The import was successfully processed and at least an entry changed its structure ( either inserted or modified )
\n`cancelled` - The import process was interrupted.
\n`failed` - The import was unsuccessful. Either one of the import files is not compliant with the TBX structure or no entry changed during the import process.
\n`error` - The import was unsuccessful due to an internal error.", + "enum": [ + "queued", + "processing", + "done", + "cancelled", + "failed", + "error" + ] + } + }, + "required": [ + "id", + "status" + ] + }, + "termbase-import-history-response": { + "title": "Termbase Import History Response", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The termbase import identifier." + }, + "fileName": { + "type": "string", + "description": "
\n`pending` - The import was just created and it's waiting for user input.
\n`queued` - The import passed the structural validation and it's waiting to be processed.
\n`processing` - The import is in progress.
\n`done` - The import was successfully processed and at least an entry changed its structure ( either inserted or modified )
\n`cancelled` - The import process was interrupted.
\n`failed` - The import was unsuccessful. Either one of the import files is not compliant with the TBX structure or no entry changed during the import process.
\n`error` - The import was unsuccessful due to an internal error.", + "enum": [ + "pending", + "queued", + "processing", + "done", + "cancelled", + "failed", + "error" + ] + }, + "createdAt": { + "$ref": "#/components/schemas/date-time" + }, + "elapsedTime": { + "type": "integer", + "description": "The last modified date of the import." + } + }, + "required": [ + "id", + "status" + ] + }, + "termbase-import-request": { + "type": "object", + "title": "Termbase Import Properties", + "description": "Properties required for system status mapping", + "properties": { + "statusMapping": { + "type": "array", + "x-stoplight": { + "id": "jr1v619dgm5k8" + }, + "items": { + "$ref": "#/components/schemas/termbase-system-status-mapping", + "x-stoplight": { + "id": "jjw6bvzbbc0eg" + } + } + } + } + }, + "termbase-system-status-mapping": { + "title": "Termbase System Status Mapping", + "x-stoplight": { + "id": "3o7f2m7gb63yw" + }, + "type": "object", + "description": "A mapping between a termbase term system status and termbase statuses.", + "required": [ + "systemStatusValue", + "statuses" + ], + "properties": { + "systemStatusValue": { + "$ref": "#/components/schemas/termbase-entry-term-system-status-request", + "x-stoplight": { + "id": "kznc76h6wxicr" + } + }, + "statuses": { + "type": "array", + "x-stoplight": { + "id": "3isyr4742q3jg" + }, + "minItems": 1, + "items": { + "x-stoplight": { + "id": "6lvylhb8t3n96" + }, + "type": "string" + } + } + } + }, + "tqa-profile": { + "title": "TQA Profile", + "type": "object", + "description": "As a project manager, you choose a TQA configuration and use it to automatically assess the quality of a translation document.\n\nThe TQA configuration specifies:\n - Categories and subcategories that reviewers will use to classify the translation issues in a document.\n - Severities to define custom metrics you want to use to assess translation quality.\n - Score to measure the importance of each category or subcategory of an issue.\n - Pass/Fail Threshold to define the maximum number of penalty points admitted before failing the translation document.", + "properties": { + "id": { + "type": "string", + "description": "The identifier of the TQA profile." + }, + "name": { + "type": "string", + "description": "
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "createdBy": { + "$ref": "#/components/schemas/user" + }, + "lastRecomputedAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The `DateTime` when the translation memory statistics were last updated.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "lastReIndexedAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The `DateTime` when the translation memory reindexing was performed.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + } + }, + "required": [ + "id" + ] + }, + "translation-memory-fields-update-request": { + "title": "Translation Memory Fields Update Request", + "x-stoplight": { + "id": "lcpur5t4ewvi2" + }, + "type": "object", + "properties": { + "settings": { + "type": "array", + "description": "The configuration settings for Translation Memory Fields.", + "items": { + "$ref": "#/components/schemas/translation-memory-fields-settings-request" + } + } + }, + "required": [ + "settings" + ] + }, + "translation-memory-field-update-type": { + "type": "string", + "title": "Translation Memory Field Update Type", + "x-stoplight": { + "id": "vq3s0tuc4yp5u" + }, + "enum": [ + "dateTime", + "singlePicklist", + "multiplePicklist", + "integer", + "singleString", + "multipleString" + ], + "description": "The data type of the value." + }, + "translation-memory-fields-settings-request": { + "title": "Translation Memory Fields Settings Request", + "type": "object", + "description": "", + "properties": { + "name": { + "type": "string", + "description": "The name of the translation memory field." + }, + "values": { + "type": "array", + "description": "A collection of values.", + "items": { + "type": "string" + } + }, + "type": { + "$ref": "#/components/schemas/translation-memory-field-update-type" + } + }, + "required": [ + "name", + "values", + "type" + ] + }, + "translation-memory-fields-settings": { + "title": "Translation Memory Fields Settings", + "x-stoplight": { + "id": "adnwx8tlwr674" + }, + "type": "object", + "description": "The configuration settings for Translation Memory Fields.", + "properties": { + "name": { + "type": "string", + "description": "The name of the translation memory field." + }, + "values": { + "type": "array", + "description": "A collection of values.", + "items": { + "type": "string" + } + }, + "type": { + "$ref": "#/components/schemas/translation-memory-field-update-type" + } + }, + "required": [ + "name", + "values", + "type" + ] + }, + "translation-memory-base": { + "title": "Translation Memory", + "type": "object", + "description": "", + "properties": { + "id": { + "type": "string", + "description": "The unique translation memory identifier." + }, + "name": { + "type": "string", + "description": "The translation memory name." + }, + "description": { + "type": "string", + "description": "The translation memory description" + }, + "copyright": { + "type": "string" + }, + "location": { + "$ref": "#/components/schemas/folder" + }, + "languageDirections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/translation-memory-language-direction" + } + }, + "languageProcessingRule": { + "$ref": "#/components/schemas/language-processing-rule" + }, + "fieldTemplate": { + "$ref": "#/components/schemas/translation-memory-field-template" + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The `DateTime` when the translation memory was created.", + "nullable": true + }, + "createdBy": { + "$ref": "#/components/schemas/user" + } + }, + "required": [ + "id" + ] + }, + "translation-memory-create-request": { + "title": "Translation Memory Create Request", + "type": "object", + "description": "The model to use when creating a new Translation Memory.", + "properties": { + "name": { + "type": "string", + "maxLength": 151, + "minLength": 1, + "description": "The Translation Memory name." + }, + "description": { + "type": "string", + "maxLength": 1024, + "description": "The Translation Memory description." + }, + "copyright": { + "type": "string", + "maxLength": 1024 + }, + "location": { + "type": "string", + "description": "The folder identifier where the translation memory should be created." + }, + "languageDirections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/language-direction-request" + } + }, + "languageProcessingRuleId": { + "type": "string", + "description": "The Language Processing Rule to be associated with the Translation Memory." + }, + "fieldTemplateId": { + "type": "string", + "description": "A Field Template to be associated with the Translation Memory." + } + }, + "required": [ + "name", + "languageDirections", + "languageProcessingRuleId", + "fieldTemplateId" + ] + }, + "translation-memory-update-request": { + "title": "Translation Memory Update Request", + "type": "object", + "description": "", + "properties": { + "name": { + "type": "string", + "description": "The translation memory name", + "minLength": 1, + "maxLength": 151 + }, + "description": { + "type": "string", + "maxLength": 1024, + "description": "The translation memory description" + }, + "copyright": { + "type": "string", + "maxLength": 1024 + }, + "languageDirections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/language-direction-request" + } + }, + "languageProcessingRuleId": { + "type": "string", + "description": "The language processing rule to be associated with the translation memory." + }, + "fieldTemplateId": { + "type": "string", + "description": "A field template to be associated with the translation memory." + } + } + }, + "translation-memory-language-direction": { + "title": "Translation Memory Language Direction", + "x-stoplight": { + "id": "lxtdb1sy4fdbi" + }, + "type": "object", + "description": "A language direction representation specific to translation memories.", + "properties": { + "languageDirection": { + "$ref": "#/components/schemas/simple-language-direction", + "description": "
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss" + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The last update time of the import operation.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss" + }, + "ownerId": { + "type": "string", + "description": "Owner of the import operation, corresponds with the tenant identifier." + } + }, + "required": [ + "id", + "status" + ] + }, + "translation-memory-import-settings": { + "title": "Translation Memory Import Settings", + "type": "object", + "description": "The properties provided by the client, when the Import Operation was triggered.", + "properties": { + "onlyImportSegmentsWithConfirmationLevels": { + "description": "Only segments with the these confirmation levels were be imported.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "translated", + "approvedTranslation", + "approvedSignOff", + "draft", + "rejectedTranslation", + "rejectedSignOff" + ] + } + }, + "unknownFieldsOption": { + "description": "This option describes how were the translation units handled when there were unknown fields in the request.", + "enum": [ + "skipTranslationUnit", + "ignore", + "addToTranslationMemory", + "failTranslationUnitImport" + ], + "type": "string" + }, + "targetSegmentsDifferOption": { + "description": "This option describes how were the translation units handled when there were differences in target segments.", + "enum": [ + "addNew", + "overwrite", + "leaveUnchanged", + "keepMostRecent" + ], + "type": "string" + }, + "importAsPlainText": { + "description": "(Deprecated) The default value is set for this field, as this property is set internally.", + "type": "boolean", + "deprecated": true + }, + "exportInvalidTranslationUnits": { + "description": "This option describes if the invalid translation units were exported during the original translation memory import operation.", + "type": "boolean" + }, + "triggerRecomputeStatistics": { + "description": "(Deprecated) The default value is set for this field, as this property is set internally.", + "type": "boolean", + "deprecated": true + }, + "fileName": { + "description": "The name of the file attached to the import request.", + "type": "string" + }, + "sourceLanguageCode": { + "description": "The source language code of the import request.", + "type": "string" + }, + "targetLanguageCode": { + "description": "The target language code of the import request.", + "type": "string" + }, + "traceId": { + "description": "(Deprecated) The field will be completly remove in the future. For compatibily, until it will be removed a default value it is set: 0000-0000-0000-0000.", + "type": "string", + "deprecated": true + } + }, + "required": [ + "onlyImportSegmentsWithConfirmationLevels", + "unknownFieldsOption", + "targetSegmentsDifferOption", + "importAsPlainText", + "exportInvalidTranslationUnits", + "triggerRecomputeStatistics", + "fileName", + "sourceLanguageCode", + "targetLanguageCode", + "traceId" + ] + }, + "translation-memory-export-response": { + "title": "Translation Memory Export Response", + "x-stoplight": { + "id": "ol4kmgwlbdr8f" + }, + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The translation memory export identifier." + }, + "status": { + "type": "string", + "description": "(Deprecated) The status of the import operation.\n* `queued` - the import has been queued and is waiting to be processed\n* `inProgress` - the import is being processed\n* `failed` - the import has failed due to internal errors\n* `done` - the import has finished successfully\n* `cancelled` - the import has been interrupted", + "enum": [ + "queued", + "inProgress", + "failed", + "done", + "cancelled" + ], + "deprecated": true + } + }, + "required": [ + "id", + "status" + ] + }, + "translation-memory-poll-export-response": { + "title": "Translation Memory Export Response", + "x-stoplight": { + "id": "h78jfifpf8rpa" + }, + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The translation memory export identifier." + }, + "status": { + "type": "string", + "description": "The translation memory export status.\n* `queued` - the export has been queued to be processed\n* `inProgress` - the export is being processed\n* `failed` - the export has failed due to internal errors\n* `done` - the export has finished successfully\n* `cancelled` - the export has been interrupted", + "enum": [ + "queued", + "inProgress", + "failed", + "done", + "cancelled" + ] + } + }, + "required": [ + "id", + "status" + ] + }, + "translation-memory-export-language-direction": { + "title": "Translation Memory Export Language Direction", + "x-stoplight": { + "id": "sgv1fy31ffmba" + }, + "type": "object", + "description": "", + "properties": { + "sourceLanguage": { + "$ref": "#/components/schemas/source-language-request" + }, + "targetLanguage": { + "$ref": "#/components/schemas/target-language-request" + } + }, + "required": [ + "sourceLanguage", + "targetLanguage" + ] + }, + "translation-memory-export-request": { + "title": "Translation Memory Export Request", + "x-stoplight": { + "id": "ivlpf7ccfd3is" + }, + "description": "", + "type": "object", + "properties": { + "languageDirection": { + "$ref": "#/components/schemas/translation-memory-export-language-direction" + } + }, + "required": [ + "languageDirection" + ] + }, + "translation-service-type": { + "title": "Service Type", + "x-stoplight": { + "id": "qxo8dvfuhtpvn" + }, + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "x-stoplight": { + "id": "y8k58twki2cx2" + }, + "description": "The Service Type identifier." + }, + "name": { + "type": "string", + "x-stoplight": { + "id": "at815peslzdx2" + }, + "description": "
For ex. for \"type\"=\"user\", \"user\" property is available.
For \"projectCreator\" and \"projectManager\" no other property is available.", + "properties": { + "type": { + "type": "string", + "enum": [ + "user", + "group", + "vendorOrderTemplate", + "projectCreator", + "projectManager" + ] + }, + "user": { + "$ref": "#/components/schemas/user", + "description": "
When the 'isSkipped' field is set to 'true', an empty list of assignees should be specified.\r\n
Total assignee count is limited. See more at [Assigning users and groups to workflow tasks](https://docs.rws.com/791595/743481/trados-enterprise---accelerate/assigning-users-and-groups-to-workflow-tasks) point 5e.", + "items": { + "$ref": "#/components/schemas/workflow-task-assignee-request" + } + }, + "scope": { + "$ref": "#/components/schemas/task-configuration-scope-request" + } + }, + "required": [ + "taskTemplate", + "isSkipped", + "assignees", + "scope" + ] + }, + "workflow-task-template": { + "title": "Workflow Task Template", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The workflow task template identifier." + }, + "name": { + "type": "string", + "description": "
- `location`: all the resources located strictly in the folders from the 'location' parameter (default);
- `lineage`: all the resources located in the folders specified in the 'location' parameter, as well as the subfolders;
- `bloodline`: all the resources located in the folders specified in the 'location' parameter, as well as the ancestor folders;
- `genealogy`: the resources located in the folders specified in the 'location' parameter together with subfolders and ancestors.", + "schema": { + "type": "string", + "enum": [ + "location", + "lineage", + "bloodline", + "genealogy" + ] + } + }, + "sort": { + "name": "sort", + "in": "query", + "description": "A comma separated list of fields used to sort the resources in the response. Each field can have a unary negative to imply descending sort order.", + "schema": { + "type": "string" + } + }, + "fields": { + "name": "fields", + "in": "query", + "description": "A comma separated list of fields to include in the response.\n Every value in the list should either consist of a top-level property name (excluding the items envelope for endpoints returning lists) or refer to a property of a top-level property of type object, in the following form: \"toplevelpropertyname.subpropertyname\".\n When this query parameter is omitted, default resource representations are returned (excluding fields marked as optional). The same applies to nested objects when just specifying the top-level property name, without explicitly listing sub-property names. When specifying the fields query parameter, only the specified fields are returned.\n The id property is always returned.", + "schema": { + "type": "string" + } + }, + "customerId": { + "name": "customerId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The customer identifier." + }, + "projectId": { + "name": "projectId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The project identifier." + }, + "taskId": { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The task identifier." + }, + "sourceFileId": { + "name": "sourceFileId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The source file identifier." + }, + "targetFileId": { + "name": "targetFileId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The target file identifier." + }, + "exportId": { + "name": "exportId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The export identifier." + }, + "projectTemplateId": { + "name": "projectTemplateId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The project template identifier." + }, + "fileVersionId": { + "name": "fileVersionId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The file version identifier." + }, + "taskTypeId": { + "name": "taskTypeId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The task type identifier." + }, + "workflowId": { + "name": "workflowId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The workflow identifier." + }, + "fileProcessingConfigurationId": { + "name": "fileProcessingConfigurationId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The file processing configuration identifier." + }, + "translationEngineId": { + "name": "translationEngineId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The translation engine identifier." + }, + "pricingModelId": { + "name": "pricingModelId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The pricing model identifier." + }, + "folderId": { + "name": "folderId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The folder identifier." + }, + "groupId": { + "name": "groupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The group identifier." + }, + "importId": { + "name": "importId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The import identifier." + }, + "fileId": { + "name": "fileId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The file identifier." + }, + "customFieldDefinitionId": { + "name": "customFieldDefinitionId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The custom field definition identifier." + }, + "profileId": { + "name": "profileId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The profile identifier." + }, + "language-id": { + "name": "languageId", + "in": "query", + "description": "The language used for localization.", + "schema": { + "type": "string", + "default": "en" + } + }, + "userId": { + "name": "userId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The user identifier." + }, + "name": { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Filter by name." + }, + "termbaseTemplateId": { + "name": "termbaseTemplateId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The termbase template identifier." + }, + "termbaseId": { + "name": "termbaseId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The termbase identifier." + }, + "translationMemoryId": { + "name": "translationMemoryId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The translation memory identifier." + }, + "entryId": { + "name": "entryId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The termbase entry identifier." + }, + "humanReadableIds": { + "name": "humanReadableIds", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "Can provide a list of humanReadableId from entries to filter by." + } + }, + "headers": { + "X-LC-TraceId": { + "required": true, + "schema": { + "type": "string", + "example": "df680285-adcd-4bda-8f79-0bba4a857287" + }, + "description": "A unique identifier for the request. It should be saved in the logs as it can be used to troubleshoot potential issues. When raising a request for support, it should be provided to help with the investigation." + } + } + } +} diff --git a/articles/LCPublicAPI/api/Public-API.v1.md b/articles/LCPublicAPI/api/Public-API.v1.md new file mode 100644 index 0000000..4af2066 --- /dev/null +++ b/articles/LCPublicAPI/api/Public-API.v1.md @@ -0,0 +1,23 @@ +--- +title: "Public API Documentation" +_disableBreadcrumb: false +_disableAffix: true +_enableSearch: false +_disableToc: false +--- + + + + + + + +Webhooks Documentation
+
+
+
+
+
+
+
+
+
+
+ part is composed of the request URL minus basePath, as defined in the descriptor. must begin with a slash "/". (All paths in Descriptor must start with a slash).
+4. Generate the concatenation |||, where the - represents the value from the header, or calculated. | - is an actual character used for separating the values, and should be included in the final string.
+5. Validating the signature is done by verifying the signature using the public key and generated concatenation using the algorithm from X-LC-Signature-Algo.
+
+## Health Checks
+The health endpoint will be invoked regularly to ensure the health of the Add-On Service. The only expected response is a HTTP code 200, any other code will be considered as a service failure. Any content will be ignored.
+
+## Versioning
+Add-Ons should be designed with versioning in mind. Versioning is applied to the descriptor, allowing changing features in the Add-On without impacting users that might be using an older version of the Add-On.
+
+Things to consider:
+
+- Multiple versions of the Add-On can point to the same endpoints only if the changes are compatible.
+- If there are breaking changes in a new version of the Add-On (changes in the endpoint, changes in the models, changes in behaviour), new endpoints should be created for the new version.
+- Version number is set in the descriptor field "version". It should follow * * Semantic Versioning principles, and should consist of no more then 4 numeric groups separated by dots, ex.: "1.0", "1.3.5".
+
+In order for new changes in the descriptor to be detected, the descriptor must have it's version incremented. Changes in the descriptor will not be automatically detected if the version is the same as the last one.
+
+### Retiring older versions
+When an older version of the Add-On needs to be retired the following steps need to be taken:
+
+While deploying a new version with a new version number in the descriptor, the "minimumVersion" field should also be set to the minimum version that is still supported. It can also be set to the version that is being deployed - meaning that only this version will be supported.
+After deploying and getting the new version Published, a grace period of 30 days will be given to the users to update to the new version. In that period the older versions MUST be supported (the endpoints should be up, the functionality unchanged, etc.)
+After 30 days the old functionality can be decommissioned.
\ No newline at end of file
diff --git a/articles/LCPublicAPI/docs/Export-quote-report.md b/articles/LCPublicAPI/docs/Export-quote-report.md
new file mode 100644
index 0000000..00f9c16
--- /dev/null
+++ b/articles/LCPublicAPI/docs/Export-quote-report.md
@@ -0,0 +1,468 @@
+# Export quote report
+The export quote mechanism has been updated and
+it is now composed of three relevant endpoints.
+The old export quote endpoint is deprecated, you can read about it in this section [`What's new`](https://languagecloud.sdl.com/lc/api-docs/16d216d6237ee-what-s-new#12-august-2022).
+
+The next endpoints would need to be executed in this specific order:
+
+1. To trigger a quote report generation for a given project, make a `POST` request to the [`/projects/{projectId}/quote-report/export`](../api/Public-API.v1-fv.html#/operations/ExportQuoteReport) endpoint. If successful, the response will contain an "Accepted" status, and you can proceed to the next step.
+
+2. To verify the status of the quote report generation, make a `GET` request to the [`/projects/{projectId}/quote-report/export`](../api/Public-API.v1-fv.html#/operations/PollQuoteReportExport) endpoint. As soon as the response body contains a "completed" status, then you can proceed to the next step.
+
+3. To download the generated project quote, make a `GET` request to the [`/projects/{projectId}/quote-report/download`](../api/Public-API.v1-fv.html#/operations/DownloadQuoteReport) endpoint.
+
+
+## Report format
+
+There are two available file formats for exporting the quote:
+- **PDF**
+- **Excel**
+
+By default, the quote report is exported as a `PDF` file. The format of the file can be changed by specifying the `format` query parameter.
+
+## Report language
+
+The report can be localized in one of the following languages, by specifying the `languageId` query parameter:
+- **English - `en`**
+- **German - `de`**
+- **French - `fr`**
+- **French (Canada) - `fr-CA`**
+- **Japanese - `ja`**
+- **Spanish - `es`**
+- **Simplified Chinese - `zh-CN`**
+- **Dutch - `nl`**
+- **Italian - `it`**
+
+The next screenshot illustrates a sample of an exported PDF quote.
+
+
+
+
+
+
+# Update project quote
+To update a quote, make a `PUT` request to the [`/projects/{projectId}`](../api/Public-API.v1-fv.html#/operations/UpdateProject) endpoint, and specify the `quote` field.
+
+## Cost types
+
+Two types of translation costs can be updated using the Trados Cloud Platform API:
+- **Language Costs**
+ - Costs that are applied at language level: *volume, percentage, hourly, per page, conditional*
+- **Project Costs**
+ - Costs that are applied at project level as additional cost: *volume, percentage, hourly, per page, conditional, per file, per target language*
+
+
+## Cost types available at project and language level
+
+> Note: Both language costs and project costs have identical request/response bodies, but for `languageCosts`, the `targetLanguage` field is required.
+
+
+The examples below use the following translation costs:
+
+```json
+...
+{
+ "translationCosts": [{
+ "total": 85.4,
+ "targetLanguage": {
+ "languageCode": "fr-FR",
+ "englishName": "French (France)"
+ },
+ "new": {
+ "count": 854.0,
+ "rate": 0.1,
+ "total": 85.4,
+ "runningTotal": 85.4
+ }
+ }
+ ]
+}
+...
+```
+
+### Volume
+
+This is a fixed per word/character cost.
+
+***Request***:
+```json
+...
+{
+ "name": "Volume Cost",
+ "costOrder": 0,
+ "cost": 0.5,
+ "volumeUnitType": "Words",
+ "costType": "volume"
+ ...
+}
+...
+```
+
+The total cost is calculated as `number of words/characters` * `cost of a unit`:
+
+**`total = count * cost`**
+
+***Response***:
+
+```json
+...
+{
+ "name": "Volume Cost",
+ "count": 854.0,
+ "total": 427.0,
+ "cost": 0.5,
+ "costType": "volume",
+ "volumeUnitType": "words",
+ "costOrder": 0,
+ "runningTotal": 512.4
+ ...
+}
+...
+```
+
+The running total up until this point is equal to `total cost of the current additional cost` + `translation costs`.
+Using the data above, we can get the following running total: + +**`85.4 + 427 = 512.4`** + +### Percentage + +This is a percentage cost calculated against the current cost (current language-level cost or current project-level cost). + +***Request***: + +```json +... +{ + "name": "Percentage Cost", + "costOrder": 1, + "count": -10, + "costType": "percentage" + ... +} +... +``` + +The `total cost of the current additional cost` is calculated using the value from the `count` field as a percentage from the previous `running total`. + +**`total = count% * previousRunningTotal`** + +***Response***: + +```json +... +{ + "name": "Percentage Cost", + "count": -10.0, + "total": -51.24, + "cost": 0.0, + "costType": "percentage", + "costOrder": 1, + "runningTotal": 461.16 + ... +} +... +``` + +Since the previous `running total` is **512.4**, the total cost of the `current additional cost` is calculated as follows: + +**`total = -10% * 512.4 = -51.24`** + +As a result, the new running total becomes: + +**`runningTotal = 512.4 - 51.24 = 461.16`** + +### Hourly + +This is a fixed cost per hour. + +***Request***: + +```json +... +{ + "name": "Hourly Cost", + "costOrder": 2, + "count": 5, + "cost": 1.5, + "costType": "hourly" + ... +} +... +``` + +The total cost is calculated as `number of hours` * `cost of an hour`: + +**`total = count * cost`** + +***Response***: + +```json +... +{ + "name": "Hourly Cost", + "count": 5.0, + "total": 7.5, + "cost": 1.5, + "costType": "hourly", + "costOrder": 2, + "runningTotal": 468.66 + ... +} +... +``` + +**`total = 5 * 1.5 = 7.5`** + +**`runningTotal = 461.16 + 7.5 = 468.66`** + +### Per Page + +This is a fixed cost per page. + +***Request***: + +```json +... +{ + "name": "Per Page Cost", + "costOrder": 3, + "count": 10, + "cost": 0.2, + "costType": "perPage" + ... +} +... +``` + + +The total cost is calculated as `number of pages` * `cost of a page`: + +**`total = count * cost`** + +***Response***: + +```json +... +{ + "name": "Per Page Cost", + "count": 10.0, + "total": 2.0, + "cost": 0.2, + "costType": "perPage", + "costOrder": 3, + "runningTotal": 470.66 + ... +} +... +``` + +**`total = 10 * 0.2 = 2`** + +**``runningTotal = 468.66 + 2 = 470.66``** + +### Conditional + +This is a cost that is applied conditionally, for example: + +***Request***: + +```json +... +{ + "name": "Conditional Cost", + "costOrder": 4, + "conditionalCostVariable": "wordCount", + "conditionalCostOperator": "less", + "conditionalCostThreshold": 1000, + "cost": 100, + "conditionalCostType": "relative", + "costType": "conditional" + ... +} +... +``` + +If `[conditionalCostVariable]` `[conditionalCostOperator]` `[conditionalCostThreshold]`, then add/set `[cost]` `[conditionalCostType]`. + +This formula translates to the following: + +If `wordCount < 1000`, then add `100 relative`. + +***Response***: + +```json +... +{ + "name": "Conditional Cost", + "count": 854.0, + "total": 100.0, + "cost": 100.0, + "costType": "conditional", + "costOrder": 4, + "conditionalCostType": "relative", + "conditionalCostOperator": "less", + "conditionalCostVariable": "wordCount", + "conditionalCostThreshold": 1000.0, + "runningTotal": 570.66 + ... +} +... +``` +Since the word count (`count`) is 854 (in the example above), the condition becomes: + +If `854 < 1000` then add `100 relative`. => `true` + +**`total = cost = 100`** + +**`runningTotal = 470.66 + 100 = 570.66`** + +The total cost depends on the `conditionalCostType` field and on whether the condition evaluates to `true` or `false`. +When the condition evaluates to `false`, the total will be 0, and the running total will not change. + +If `854 > 1000`, then add `100 relative`. => `false` + +**`total = cost = 0`** +**`runningTotal = 470.66`** + + +For the same values as above, and the `conditionalCostType` set to `percentage`, the `total` and `runningTotal` values will change to: + +**`total = 100% * 470.66 = 470.66`** + +**`runningTotal = 470.66 + 470.66 = 941.32`** + +When the `conditionalCostType` is set to `absolute`, the total will be equal to the difference between the `cost` and the `runningtotal`: + +**`total = 100 - 470.66 = -370.66`** + +**`runningTotal = 100`** + +> **Note:** Setting `conditionalCostType` to `absolute` will cancel all the previous costs for the project or the target language. + +## Cost types available ONLY at project level + +### Per Target Language + +This is an additional cost that is calculated based on the number of target languages in the project. + +***Request***: + +```json +... +{ + "name": "Per Target Language", + "costOrder": 5, + "cost": 5, + "costType": "perTargetLanguage" +} +... +``` + +The total cost is calculated as `number of target languages` * `cost of a target language`: + +***Response***: +```json +... +{ + "name": "Per Target Language", + "count": 1.0, + "total": 5.0, + "cost": 5.0, + "costType": "perTargetLanguage", + "costOrder": 5, + "runningTotal": 575.66 +} +... +``` + +Since there is only one target language in the example above, the total cost becomes: +**`total = 1 * 5 = 5`** +**`runningTotal = 570.66 + 5 = 575.66`** + +### Per File + +This is an additional cost that is calculated based on the number of files in the project. + +***Request***: + +```json +... +{ + "name": "Per File", + "costOrder": 6, + "cost": 3, + "costType": "perFile" +} +... +``` + +The total cost is calculated as `number of files` * `cost of a file`: + +***Response***: +```json +... +{ + "name": "Per File", + "count": 2.0, + "total": 6.0, + "cost": 3.0, + "costType": "perFile", + "costOrder": 6, + "runningTotal": 581.66 +} +... +``` +**`total = 2 * 3 = 6`** +**`runningTotal = 575.66 + 6 = 581.66`** + +## Cost order + +The `costOrder` field defines the order in which costs are calculated. + +For example, if there are two additional costs defined in the quote (see below), the percentage cost is calculated based on the running total from the volume cost. + +```json +... +{ + "name": "Volume Cost", + "total": 427.0, + "costType": "volume", + "costOrder": 0, + "runningTotal": 512.4 +... +}, +{ + "name": "Percentage Cost", + "total": -51.24, + "count": -10.0, + "costType": "percentage", + "costOrder": 1, + "runningTotal": 461.16 +... +} +... +``` + +When the `costOrder` field is switched, the `total` percentage cost value will be calculated based on the previous running total, which in this case is the translation cost (**85.4**): +```json +... +{ + "name": "Percentage Cost", + "count": -10.0, + "total": -8.54, + "costType": "percentage", + "costOrder": 0, + "runningTotal": 76.86 +... +}, +{ + "name": "Volume Cost", + "total": 427.0, + "costType": "volume", + "costOrder": 1, + "runningTotal": 503.86 +... +} +... +``` diff --git a/articles/LCPublicAPI/docs/File-formats.md b/articles/LCPublicAPI/docs/File-formats.md new file mode 100644 index 0000000..a7bc483 --- /dev/null +++ b/articles/LCPublicAPI/docs/File-formats.md @@ -0,0 +1,69 @@ +# File formats +A file used in the Trados Cloud Platform API can have one of the three supported formats: native, SDLXLIFF or [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html): + +- Native represents the format of the file that is attached to a project by the user. The project's associated File Type Configuration specifies if the native file extensions can be attached to that project. + +- To download files for translation or review in offline mode, the *.sdlxliff format can be used. SDLXLIFF files have XML format. + +- BCM (Bilingual Content Model) documents are files used for handling content internally. BCM files have JSON content and are stored in .json format. + +## File formats in a workflow +In a workflow, each task has a supported input file type that describes which input file types are allowed for that task. A new file version can be added only if the format of this new version respects the input file type supported by the task. You can check what the supported input file types are for tasks on the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page. + +A few input file types and examples of tasks that support them are listed below: + +- nativeSource: the task handles source file versions in their uploaded native format (e.g.: *FileTypeDetection*, *Engineering*, *FileFormatConversion*) +- bcmSource: the task can process source files in their BCM format (e.g.: *DocumentContentAnalysis*, *CopySourceToTarget*) +- bcmTarget: the task accepts target files in their BCM format (e.g.: *Translation*, *Linguistic Review*, *MachineTranslation*, *TranslationMemoryMatching*, *TranslationMemoryUpdate*, *TargetFileGeneration*) +- nativeTarget: the task handles target files in their native "generated" form (e.g.: *DTP*, *FinalCheck*) +- sdlxliffTarget: the task processes target files in their SDLXLIFF form. Specifically for Import tasks. +- none: the task does not read or modify the content of a file. + +Using the Trados Cloud Platform API, the source and target files in different formats can be viewed, downloaded and added (via import operations), based on the task and its status in the project's workflow. + +### Handling Source Files + +#### Upload Source Files +Source files can be added to a project using the [Add Source File](../api/Public-API.v1-fv.html#/operations/AddSourceFile) endpoint or the [Attach Source Files](../api/Public-API.v1-fv.html#/operations/AddSourceFiles) endpoint (for multiple files). If the file's extension is supported by the File Type Configuration, the project will follow the workflow and a new version of the source file in BCM format will be automatically created in the *File Format Conversion* task. + + +#### Upload Source File Versions +New source file versions can be added in native or BCM format using the [Add Source File Version](../api/Public-API.v1-fv.html#/operations/AddSourceFileVersion) endpoint. You can add source file versions: +* in the *Engineering* task +* in custom tasks created by users having the task type set to *Engineering* +* in extension tasks that handle source files. + +If a project having attached a native source file with an unsupported extension is started, an error task will be generated in the *File Type Detection* task and the workflow is interrupted. + +>Note: For adding a source file version using an extension task, the configuration of the task type must declare the `scope`'s value as "file". + + +#### Download Source File Versions +Any of the source file versions (in native or BCM format) can be downloaded using the [Download Source File Version](../api/Public-API.v1-fv.html#/operations/DownloadSourceFileVersion) endpoint. The *Engineering* task, for instance, is an example of a task where download can be performed. + + + +### Handling Target Files +The *Copy source to target* task converts the native file to a new target file version in BCM format. + +#### Upload Target File Versions +Adding a new version for a target file in native or BCM format can be executed with the [Add Target File Version](../api/Public-API.v1-fv.html#/operations/AddTargetFileVersion) endpoint. + +>Note: For adding a target file version using an extension task, the configuration of the task type must declare the `scope`'s value as "file". + + +#### Download Target File Versions +The BCM and native target file versions can be downloaded by using [Download Target File Version](../api/Public-API.v1-fv.html#/operations/DownloadFileVersion) endpoint, while the project is, for example, in the *Translation* task. + + +#### Export Target File Versions +The BCM target file versions can be exported in native or SDLXLIFF format by calling the [Export Target File Version](../api/Public-API.v1-fv.html#/operations/ExportTargetFileVersion) endpoint. This operation triggers a conversion of the BCM target file version in a native or SDLXLIFF format based on the value of the `format` query parameter used. The endpoint starts an export operation which can be monitored using the [polling endpoint](../api/Public-API.v1-fv.html#/operations/PollTargetFileVersionExport). After the export is done, the files can be downloaded using the [Download Exported Target File Version](../api/Public-API.v1-fv.html#/operations/DownloadExportedTargetFileVersion) endpoint. + +> Note: The export endpoint is dedicated to file versions of BCM format and cannot be used on files in native or SDLXLIFF format. The export operation can only be executed on tasks where the supported output file is a bilingual target file. You can consult the output file types for tasks on the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page from the official RWS Documentation Center. +> +>In order to download file versions of BCM or native type, please use the [Download Target File Version](../api/Public-API.v1-fv.html#/operations/DownloadFileVersion) endpoint. + + +#### Import Target File Versions +Target file versions downloaded in SDLXLIFF format can be processed and afterwards replaced by using [Import Target File Version](../api/Public-API.v1-fv.html#/operations/ImportTargetFileVersion) endpoint. The import operation triggers internally the update of the BCM file associated with the imported SDLXLIFF file. This endpoint should mostly be used for offline work. + diff --git a/articles/LCPublicAPI/docs/Headers-considerations.md b/articles/LCPublicAPI/docs/Headers-considerations.md new file mode 100644 index 0000000..ecaf4ff --- /dev/null +++ b/articles/LCPublicAPI/docs/Headers-considerations.md @@ -0,0 +1,52 @@ +# Headers considerations + +The purpose of this page is to showcase the header types that could capture your interest. + +> Headers must be treated as [case-insensitive](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers). + +The Trados Cloud Platform API response headers can be classified as follows: + +Header type | Example +---------|---------- + Standard | `Content-Type` + Custom | `X-LC-TraceId` + Endpoint specific | `Content-Disposition` + +## Content-Type header + +The `application/octet-stream` content type is used to indicate that a body contains arbitrary binary data. The recommended action for a consumer that receives an +`application/octet-stream` entity is to simply offer to put the data +in a file, read more in the [RFC2046](https://www.rfc-editor.org/rfc/rfc2046#section-4.5.1) space. + +## Content-Disposition header + +For operations expected to return content that can be handled as a file, the `Content-Disposition` header can be sent in the response headers to provide more information about the response payload. The Trados Cloud Platform API will provide this header in certain situations, and its primary goal is to supply a file name for the content being downloaded or exported. +You can read more about the `Content-Disposition` header on the [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition) website or in the [RFC6266](https://www.rfc-editor.org/rfc/rfc6266) space. + +The `Content-Disposition` response header can be usually found on various download API endpoints like [Download Source File Version](../api/Public-API.v1-fv.html#/operations/DownloadSourceFileVersion), [Download Target File Version](../api/Public-API.v1-fv.html#/operations/DownloadFileVersion), [Download Exported Quote Report](../api/Public-API.v1-fv.html#/operations/DownloadQuoteReport) and others. + +> Please note that both `Content-Type` and `Content-Disposition` are **not required** and APIs might not include them in the response. There are no guarantees that an endpoint that used to return a `Content-Type` or `Content-Disposition` header will still do so, under any circumstance. Please treat these headers as **optional** for all APIs. + +### Retrieving the file name + +Here's an example of how the `Content-Type` and the `Content-Disposition` headers look like: +``` +Content-Type: application/octet-stream +Content-Disposition: attachment; filename="Public API Download.pdf"; filename*=UTF-8''Public%20API%20Download.pdf +``` + +The parameters `filename` and `filename*`, to be matched case- +insensitively, provide information on how to construct a filename for +storing the message payload. + +The parameters `filename` and `filename*` differ only in that +`filename*` uses the encoding defined in [RFC5987](https://www.rfc-editor.org/rfc/rfc5987), allowing the use of characters not present in the ISO-8859-1 character set. + +> When both `filename` and `filename*` are present in a single header field value, you **must** pick `filename*` and ignore `filename`. + +If the `Content-Disposition` header is missing or you simply want to have a different file name, you need to provide a name and the file extension. The extension can be usually inferred from the required `Content-Type` header and also from the operation that is invoked. + + +## Deprecation and sunset headers + +These types of headers are used in our endpoint retirement process and are covered broadly in the [Public API Management Process](../docs/Public-API-Management-Process.md#endpoint-retirement-process) page. diff --git a/articles/LCPublicAPI/docs/How-to-multipart.md b/articles/LCPublicAPI/docs/How-to-multipart.md new file mode 100644 index 0000000..34ce72d --- /dev/null +++ b/articles/LCPublicAPI/docs/How-to-multipart.md @@ -0,0 +1,48 @@ +--- +stoplight-id: 1hfz3c15wpkbf +--- + +# Multipart considerations + +This page goes into deeper details for uploading files. Generally you might be interested in this subject when not using the provided SDKs and are implementing your own SDK. This page should help you debug potential problems you might encounter. + +> Our APIs follows standard HTTP/1.1 protocol as described in [RFC2616](https://www.rfc-editor.org/rfc/rfc2616) and subsequent RFCs. This page does not describe any custom HTTP behavior. + +## How to perform POST requests with multipart + +Whenever you make use of endpoints that do file uploads using `multipart/form-data`, some additional details may be required to be sent alongside the file, for example a `properties` part. + +Let's take as an example the [Add Source File Version](../api/Public-API.v1-fv.html#/operations/AddSourceFileVersion) endpoint. The API specifies that the request content is `multipart/form-data` and has a `properties` part that should be serialized as a JSON (this might not be mentioned explicitly in the documentation, but any structures in multiparts should be serialized as JSON). The second property is `file` and though it is of type `string`, that means that the raw content of the file should be sent in that part. + +> The order of parts is important! Please send the parts in the order these are specified in the API contract. + +To confirm that you are sending the correct content, you can intercept the request and view the raw request (this can be done in many ways, with either built in tools if available in your IDE/tooling or even free software). + +A simplified raw HTTP request is presented bellow: + +```http +POST /tasks//source-files//versions HTTP/1.1
+HOST: host.example.com
+Content-Type: multipart/form-data; boundary=--------------------------818668410602542750275539
+
+----------------------------818668410602542750275539
+Content-Disposition: form-data; name="properties"
+Content-Type: application/json
+
+{
+â€â€"type":"native",
+â€â€"fileTypeSettingsId": ""
+}
+----------------------------818668410602542750275539
+Content-Disposition: form-data; name="file"; filename=""
+Content-Type:
+
+
+----------------------------818668410602542750275539--
+
+```
+
+For the file, there is usually the filename that needs to be sent, along with file `Content-type` and finally the content.
+
+
+
diff --git a/articles/LCPublicAPI/docs/How-to-report-an-issue.md b/articles/LCPublicAPI/docs/How-to-report-an-issue.md
new file mode 100644
index 0000000..088d648
--- /dev/null
+++ b/articles/LCPublicAPI/docs/How-to-report-an-issue.md
@@ -0,0 +1,78 @@
+---
+stoplight-id: h5oizt92tuhtg
+---
+
+# How to report an issue
+
+When reporting an issue it is important to include as much information as you can.
+
+## Use this template
+
+Here below is a template that we recommend using when raising a new ticket:
+
+```
+- Endpoint:
+- X-LC-Tenant:
+- X-LC-TraceId:
+- Request URL:
+- Request body:
+- Response status code:
+- Response body:
+- Expected result:
+- Actual result:
+- Description:
+```
+
+You don't have to fill in all the fields, but the more details you provide, the easier it will be to investigate and get to a solution faster. Besides these details you can also add anything that you consider helpful for the investigation.
+
+## Obtaining the details
+
+- Endpoint - identify the endpoint where the issue was observed from the [Trados Cloud Platform API](https://languagecloud.sdl.com/lc/api-docs/9033e3227d21f-rws-language-cloud-api) and paste the link to it.
+- X-LC-Tenant - is the tenant identifier as sent in the request headers. This is required on all endpoints.
+- X-LC-TraceId - is a unique identifier for the request and it can be found in the response headers. It is very useful when investigating the issue, thus it **should always be provided**, if possible.
+- Request URL - the URL in the request as sent from your application (including the domain, endpoint path and any query parameters). If that is not available, at least include the query parameters used to perform the request. Some of the most relevant ones are: `fields`, `top`, `skip`, `location`, `locationStrategy` and others, depending on the case.
+- Request body - the `json` content sent.
+- Response status code - the HTTP status code returned.
+- Response body - the response received. Error responses are also relevant.
+- Expected result - what was the expected outcome.
+- Actual result - what was the actual outcome.
+- Description - a short description about what you are trying to achieve and possible answers to questions like "How did you end up in the current situation?" or "Did you find a workaround?"
+
+## Example
+
+You can simply copy the format from above and fill in the details. For example:
+
+- Endpoint: https://eu.cloud.trados.com/lc/api-docs/025707d21ecc0-create-project
+- X-LC-Tenant:
+- X-LC-TraceId: 90d9147c-6afd-4d19-b0ac-99cac9ece970
+- Request URL: https://api.eu.cloud.trados.com/public-api/v1/projects?fields=dueBy,status,customer.name
+- Request body:
+ ```json
+ {
+ "name": "Invalid projectTemplate",
+ "description": "How to report an issue",
+ "projectTemplate": {
+ "id": "invalid_project_template_id"
+ }
+ }
+ ```
+- Response status code: 404
+- Response body:
+ ```json
+ {
+ "errorCode": "notFound",
+ "message": "Invalid input on create project.",
+ "details": [
+ {
+ "name": "project.template.id",
+ "code": "notFound",
+ "value": "invalid_project_template_id"
+ }
+ ]
+ }
+ ```
+- Expected result: The project is created.
+- Actual result: The project is not created due to `projectTemplate.id` not being found.
+- Description: When attempting to create a new project I get the error mentioned above.
+
+> Check the [Multi-Region](../docs/Multi-region.md) page for regional API details.
\ No newline at end of file
diff --git a/articles/LCPublicAPI/docs/How-to-use-location-and-folders.md b/articles/LCPublicAPI/docs/How-to-use-location-and-folders.md
new file mode 100644
index 0000000..60be9c8
--- /dev/null
+++ b/articles/LCPublicAPI/docs/How-to-use-location-and-folders.md
@@ -0,0 +1,164 @@
+# How to use location and folders
+
+The Trados Cloud Platform API supports [folder-based](https://docs.rws.com/791595/984983/trados-enterprise/how-do-folder-structure-and-inheritance-help-you-get-organized-) access management to all resources. The users have access to resources based on the permissions associated with the group (role) they belong to. For information about creating a user you can check the [Service credentials](../docs/Service-credentials.md) page.
+
+
+### Concepts we use
+
+Detailed information about specific concepts used in inheritance context can be found on the [
+Concepts we use](https://docs.rws.com/791595/984976/trados-enterprise/concepts-we-use) page from the official Trados Cloud Platform Documentation Center.
+
+
+### Setting a location for a user
+
+The folders structure in Trados Cloud Platform API is hierarchical. For more information on how to organize folders and set up a location for a user, visit the [Customers](https://docs.rws.com/791595/707420/trados-enterprise/customers) page.
+
+
+## User rights in folders
+
+Depending on how the account was provisioned, configured and on the groups which the user belongs to, the rights for a user can be more restrictive or permissive.
+
+Users can learn where they were created, the exact folder, and what groups they belong to, by executing a [Get My User](../api/Public-API.v1-fv.html#/operations/GetMyUser) call with the `fields` query parameters set to *"location.name,location.path,groups"*.
+
+For example, let's assume that an account has the following hierarchy of folders (with associated unique identifiers simplified for readability):
+
+- **Root** (60b...fb0)
+ - **Customers** (fea...a0b)
+ - **Customer1** (ed7...623)
+ - **Customer3** (4f0...206)
+ - **Customer4** (e73...4a8)
+ - **Customer2** (48b...5d0)
+ - **Customer5** (bbc...c21)
+ - **Vendors** (a16...29f)
+ - **Vendor1** (b02...281)
+ - **Vendor2** (d46...839)
+
+If a user is created in Customer5 and is assigned to the "Project Managers Customer5" group, performing the above request will receive the following response:
+```json
+{
+ "id": "62b...d56",
+ "location": {
+ "id": "bbc...c21",
+ "name": "Customer5",
+ "path": [
+ {
+ "id": "48b...5d0",
+ "location": "fea...a0b",
+ "name": "Customer2",
+ "hasParent": true
+ },
+ {
+ "id": "fea...a0b",
+ "location": "60b...fb0",
+ "name": "Customers",
+ "hasParent": true
+ },
+ {
+ "id": "60b...fb0",
+ "name": "Root",
+ "hasParent": false
+ }
+ ]
+ },
+ "groups": [
+ {
+ "id": "60b...2be",
+ "name": "Project Managers Customer5"
+ }
+ ]
+}
+```
+In the above example `location.id` describes the exact folder where the resource is situated.
+The array under `location.path` presents a bottom-up hierarchical arrangement of all the parent folders leading up to `Root`, where the array ends, this being signaled by the `"hasParent": false` field.
+
+### Creating resources in folders
+
+The users' access to resources depends on the folder where they were created and on the groups they belong to. Detailed information about what actions can be executed with specific roles can be checked [here](https://docs.rws.com/en-US/trados-enterprise-%26-accelerate-791595/account-structure%2C-folders%2C-inheritance-796862).
+
+When creating a resource, it is strongly recommended to send in the request the `location` field. When `location` is not set, the system will try to create the resource in the higher folder in the hierarchy, the Root folder. It might not have access to that folder and the request will fail with forbidden error.
+
+
+For example:
+
+- If Customer2 tries to create a project with location values set to "48b...5d0":\
+ **Where will the project be created?**
+ - in Customer2 folder
+
+- If Customer2 tries to create a project with no value set for location:\
+ **Where will the project be created?**
+ - In Root folder, if the user has access in Root
+ - If the user does not have access in Root, the request will fail with forbidden error
+
+- If Customer4 tries to create a project with location value set to "e73...4a8":\
+ **Where will the project be created?**
+ - in Customer4 folder
+
+- If Customer4 tries to create a project with no value set for location:\
+ **Where will the project be created?**
+ - In Root folder, if the user has access in Root
+ - If the user does not have access in Root, the request will fail with forbidden error
+
+More examples of accessing resources based on their location are listed on the [Inheritance within the account](https://docs.rws.com/791595/797020/trados-enterprise/inheritance-within-the-account) page.
+
+
+### Retrieve resources using location strategy
+
+List endpoints can have a 'location' query parameter that is used to filter items by location. `Location` is the value of the folder id. Some endpoints accept an array rather than a single location. Additionally, this parameter can be used together with 'locationStrategy' which can have the following values:
+- *location*: all resources located strictly in the folders from the folder parameter (default value for `locationStrategy`) are returned
+- *lineage*: resources located in the folder specified by the folder parameter, as well as any of its subfolders, are returned
+- *bloodline*: resources located in the folder specified by the folder parameter, as well as any of its ancestor folders, are returned
+- *genealogy*: resources located in the folder specified by the folder parameter together with its subfolders and its ancestor folders
+
+The `location` field can be an array of folder identifiers containing multiple identifiers separated by commas. In this case, the `locationStrategy` applies for all of them and the result will contain all resources that fulfill the strategy, but, if a resource is duplicated in response for two, or more location identifiers, it will be returned only once.
+
+For example, let's see how `location` and `locationStrategy` query parameters work on an account that has the hierarchy defined in the earlier example:
+
+- **Root** (60b...fb0) - **Project1**
+ - **Customers** (fea...a0b) - **Project2**
+ - **Customer1** (ed7...623)
+ - **Customer3** (4f0...206) - **Project3**
+ - **Customer4** (e73...4a8)
+ - **Customer2** (48b...5d0)
+ - **Customer5** (bbc...c21) - **Project4**
+ - **Vendors** (a16...29f)
+ - **Vendor1** (b02...281)
+ - **Vendor2** (d46...839)
+
+If the list project endpoint is used with:
+
+- `location` = "fea...a0b" (Customers folder identifier)
+
+ Project2 is listed because the default value for `locationStrategy` is "location". + + +- `locationStrategy` = "lineage" +
+ All projects are listed because sending the `locationStrategy` without `location` does not filter anything. + + +- `location` = "fea...a0b" (Customers folder identifier) AND `locationStrategy` = "location" +
+ Project2 is listed because it is similar with the first case. + + +- `location` = "fea...a0b" (Customers folder identifier) AND `locationStrategy` = "lineage" +
+ Project2, Project3 and Project4 are returned. + + +- `location` = "4f0...206" (Customer3 folder identifier) AND `locationStrategy` = "bloodline" +
+ Project1, Project2 and Project3 are returned. + + +- `location` = "fea...a0b" (Customers folder identifier) AND `locationStrategy` = "genealogy" +
+ Project1, Project2, Project3 and Project4 are returned. + + +- `location` = "fea...a0b,fea...0a0" (Customers and Customer3 folder identifiers) AND `locationStrategy` = "lineage" +
+ Project2, Project3 (only once) and Project4 are returned. + + + diff --git a/articles/LCPublicAPI/docs/Interact-with-tasks.md b/articles/LCPublicAPI/docs/Interact-with-tasks.md new file mode 100644 index 0000000..9d72927 --- /dev/null +++ b/articles/LCPublicAPI/docs/Interact-with-tasks.md @@ -0,0 +1,31 @@ +# Interact with tasks + +Once the project is started, you can interact with tasks in several ways: + +### Find the task identifier + +Make a `GET` request to the [`/tasks/assigned`](../api/Public-API.v1-fv.html#/operations/ListTasksAssignedToMe) endpoint and identify the `id` of the task you want to interact with. + +### Reclaim tasks + +If you make a `PUT` request to the [`/tasks/{taskId}/reclaim`](../api/Public-API.v1-fv.html#/operations/ReclaimTask) endpoint, the owner of task is removed and another user from the assignee's list can accept it. The task is not reassigned automatically. + +### Complete tasks + +To complete a task, make a `PUT` request to the [`/tasks/{taskId}/complete`](../api/Public-API.v1-fv.html#/operations/CompleteTask) endpoint. + +### Assign tasks + +If the tasks is rejected by all its assignees, you can update the list of assignees. Make a `GET` request to the [`/users`](../api/Public-API.v1-fv.html#/operations/ListUsers) or [`/groups`](../api/Public-API.v1-fv.html#/operations/ListGroups) endpoints and remember their identifiers. Then, make a `PUT` request to the [`/tasks/{taskId}/assign`](../api/Public-API.v1-fv.html#/operations/AssignTask) endpoint and provide the identifiers. + +### List all the tasks in a project + +Make a `GET` call to the [`/projects/{projectId}/tasks`](../api/Public-API.v1-fv.html#/operations/ListProjectTasks) endpoint to list all the tasks in a project by projectId. The response returns a total count of the tasks, and several details for each task: `taskId`, the input and outcome per task, the owner and assignees, the creation and due dates. + + +### Upload/Import a target file version + +Make a `POST` call to the [`/projects/{projectId/target-files/{targetFileId}/versions/imports`](../api/Public-API.v1-fv.html#/operations/ImportTargetFileVersion) endpoint to upload (import) a new file version that can be used as part of a task. The response returns the `importId` which you can further use to check the import result by making a `GET` call to the [`/projects/{projectId}/target-files/{targetFileId}/versions/imports/{importId}`](../api/Public-API.v1-fv.html#/operations/PollTargetFileVersionImport) endpoint. The `projectId` can be retrieved by making a `POST` call to the [`/projects`](../api/Public-API.v1-fv.html#/operations/CreateProject) endpoint, while the `targetFileId` can be retrieved by making a `GET` call to the [`/projects/{projectId}/target-files`](../api/Public-API.v1-fv.html#/operations/ListTargetFiles) endpoint. + + + diff --git a/articles/LCPublicAPI/docs/Introduction.md b/articles/LCPublicAPI/docs/Introduction.md new file mode 100644 index 0000000..27d1918 --- /dev/null +++ b/articles/LCPublicAPI/docs/Introduction.md @@ -0,0 +1,29 @@ +# Trados Cloud Platform API + +The Trados Cloud Platform API enables external applications to interact with Trados Cloud Platform. + +## Product Configurations + +This applies to all products that are based on Trados Cloud Platform. Note that, depending on the product and its configuration, certain features may not be available or the rate might be limited through the API. In general, when a certain feature is available in your specific product configuration, the corresponding endpoints will also be available in the API. + +## Features Overview + +At present, the API contains mainly capabilities that enable the creation, management and tracking of cloud translation projects. + +Resources like termbases and translation memories can also be created using the Trados Cloud Platform API. Any other resources, such as pricing models need to be set up beforehand, using the user interface. + +## Types of Integrations + +At the moment the Trados Cloud Platform API can be called by custom (integration) applications on behalf of service users (non-human users). The ability to call the API on behalf of real end users will be supported at a later date. + +## Creating Your First Project + +Follow these steps to create your first project using the API: +### 1. Create a service user, an application and authenticate + +Follow the instructions under the [Service users and custom applications](../docs/Service-users-and-custom-applications.md) and the [Service Credentials](../docs/Service-credentials.md) pages to create a service user and an application, and then authenticate, following the [Authentication](../docs/Authentication.md) page, by using the application's `client_id` and `client_secret`. + +### 2. Create your first project + +See [Create projects](../docs/Create-projects.md) and [Basic project creation flow](../docs/Basic-project-creation-flow.md) for a walk-through of the required steps to create a project. + diff --git a/articles/LCPublicAPI/docs/Known-Issues.md b/articles/LCPublicAPI/docs/Known-Issues.md new file mode 100644 index 0000000..2304413 --- /dev/null +++ b/articles/LCPublicAPI/docs/Known-Issues.md @@ -0,0 +1,13 @@ +# Known issues + +This page lists the known bugs and issues for Trados Cloud Platform API. + +> Note: 5xx status codes might be returned on any endpoint. This means that the server has encountered an unexpected error. If the error persists, use the [How to report an issue](../docs/How-to-report-an-issue.md) guideline to gather the needed information for reporting the issue. + +### Download Exported Quote Report + +The [Download Exported Quote Report](../api/Public-API.v1-fv.html#/operations/DownloadQuoteReport) endpoint is designed to be a one-time operation. After a download attempt, the file is deleted and it's no longer available for download. If the file needs to be downloaded again, the user needs to request a new export of the quote report by using the [Export Quote Report](../api/Public-API.v1-fv.html#/operations/ExportQuoteReport) and [Poll Quote Report Export](../api/Public-API.v1-fv.html#/operations/PollQuoteReportExport) endpoints. + +### Export Quote report +When the export is not using a Quote Template, the response for this call will be empty. + diff --git a/articles/LCPublicAPI/docs/Language-Cloud-APIs-for-Postman.md b/articles/LCPublicAPI/docs/Language-Cloud-APIs-for-Postman.md new file mode 100644 index 0000000..7ba6f9a --- /dev/null +++ b/articles/LCPublicAPI/docs/Language-Cloud-APIs-for-Postman.md @@ -0,0 +1,69 @@ +# Trados Cloud Platform APIs for Postman + +We provide a [Postman](https://www.postman.com/) collection for quick and easy usage of our RESTful APIs. + +## Installation + +You can download the Postman collection from [here](https://github.com/sdl/language-cloud-public-api-postman/blob/develop/postmanCollection.json?raw=true). + +If you make use of multi-region, we also provide the [EU](https://raw.githubusercontent.com/RWS/language-cloud-public-api-postman/refs/heads/develop/Trados%20EU.postman_environment.json?raw=true) and [CA](https://raw.githubusercontent.com/RWS/language-cloud-public-api-postman/refs/heads/develop/Trados%20CA.postman_environment.json?raw=true) Postman Environments. + +There are 3 setup options: +- Copy the collection URL from above and import it into Postman using `Import > Link`. +- Copy the entire file content and import it into Postman using `Import > Raw Text`. +- Save it as a `JSON` file on your computer and import it into Postman using `Import > File`. + + + + + + +## Configuration + +The imported collection is already set up for you to get started as fast as possible. + +We make use of collection level variables and an inherited authentication mechanism. + +For example, authentication is already set up to use the Bearer Token scheme and will use the token value provided by `{{lc-access-token}}` variable. This token is populated with the correct value, each time you `Obtain a client credentials access token`, via the Tests tab. + +One thing you need to do before proceeding is to fill in the `{{lc_tenant}}` variable with your own tenant ID. Prepend the ID with LC- so the final value looks like this `LC-00000000000000000`. + +Don't forget to save the collection! + + + + + + +## Multi-region environments +If you have imported the regional Postman Environments, please note that any environment-level variables (e.g., `baseUrl`) will overwrite collection variables. This means that when you have an environment selected in Postman, the value of `baseUrl` will be the one defined in the environment, not the value defined at the collection level. + + +## Authentication +To start working with the Trados Cloud Platform API, you first need to authenticate. + +You can find the authentication call under the `Authentication (Start Here)` folder. Fill in your `client_id` and `client_secret` and perform the request. + +If the authentication is successful, the token will be extracted automatically from the response and saved to the `{{lc-access-token}}` variable. + + + + + + + +## Usage + +After you have authenticated successfully, you can start interacting with the Trados Cloud Platform API. + +For example, we can get information about a project by using the **GetProject** request from the **Project** folder. + +Simply fill in your `projectId` and click SEND. Optionally, you can supply values to the `fields` parameter to receive only data that is of interest. + + + + +> IMPORTANT: make sure you are not sending any query parameters with default Postman values. If you are sending any parameters, make sure you are sending valid data or else you will get an API Error. + + + diff --git a/articles/LCPublicAPI/docs/Language-codes.md b/articles/LCPublicAPI/docs/Language-codes.md new file mode 100644 index 0000000..5c73090 --- /dev/null +++ b/articles/LCPublicAPI/docs/Language-codes.md @@ -0,0 +1,13 @@ +# Language Codes + +When getting a response that contains language codes, the case of the language code is not guaranteed and should be treated as case insensitive. + +For example the Trados Cloud Platform API can return the same language code but with different casing on different endpoints: + +- en-US +- en-us +- EN-US + +All 3 variants are equivalent. + +When making a request to the Trados Cloud Platform API, you should still ensure the correct casing of language codes, to avoid any unexpected situations. \ No newline at end of file diff --git a/articles/LCPublicAPI/docs/Multi-region.md b/articles/LCPublicAPI/docs/Multi-region.md new file mode 100644 index 0000000..4977dd5 --- /dev/null +++ b/articles/LCPublicAPI/docs/Multi-region.md @@ -0,0 +1,23 @@ +--- +stoplight-id: nfdrob1smwn00 +--- + +# Multi-region + +Trados Cloud Platform operates in multiple regions, and it's essential to know how to use the Public API correctly for each region. + +Each region has a unique Public API host, and all requests must be specific to that region. If you try to access accounts or data not available in a region, you will encounter errors. + +## Legacy integrations + +The domains for the Trados Cloud Platform API have been updated. If you are using the old domain `lc-api.sdl.com` in a legacy integration, please consider the following options: +- Use the new endpoints to discover the correct Public API host for your desired region. +- If you are only integrating with the EU region (legacy), update the host to: `api.eu.cloud.trados.com` + +## Supporting multi-region + +This information is especially relevant if you are building multi-tenant integrations. + +The provided .NET and Java SDKs already support multiple regions. For details on using these SDKs, refer to their documentation. + +> If you're building your own client, avoid hard-coding Trados Cloud Platform API hosts, as new regions may be added in the future, requiring updates to hard-coded hosts. You can discover all available regions and their corresponding Public API hosts using the [List Regions](../api/Global-Public-API.v1-fv.html#/operations/ListRegions) endpoint from the new Global Public API, which is accessible on a new global host `api.cloud.trados.com`. diff --git a/articles/LCPublicAPI/docs/Public-API-Management-Process.md b/articles/LCPublicAPI/docs/Public-API-Management-Process.md new file mode 100644 index 0000000..5d3c92b --- /dev/null +++ b/articles/LCPublicAPI/docs/Public-API-Management-Process.md @@ -0,0 +1,61 @@ +# Trados Cloud Platform API Management Process + + +## Overview +By using continuous delivery, our team regularly updates the Trados Cloud Platform API with new functionality, bug fixes and performance improvements. + +Find below the defined process (lifecycle policy) we use that enables us to maintain a set of stable APIs. + +Every release is announced on the [What's new](../docs/Whats-New.md) page in our API Docs. + +## What is a breaking change? +- Changing the type of a field +- Modifying a field name +- Marking an existing field as required with no default value +- Introducing a new validation +- Enforcing validations +- Removing or renaming enum values +- Removing fields from response + +## What isn't a breaking change? +- Adding new endpoints +- Adding optional request fields +- Adding new fields in responses +- Adding new field as required with default value +- Changing of error messages description +- Adding enum values + +## Endpoint retirement process +Retirement of an endpoint will happen in two phases: deprecation and sunset. + +Deprecation will be marked accordingly with IETF's [deprecation http-response-header-field](https://datatracker.ietf.org/doc/draft-dalal-deprecation-header/) with: +- a date in the future: representing the date, when the endpoint will be marked as deprecated +- a date in the past: representing the date, when the endpoint was marked as deprecated +- true: simply signal to the clients, that the endpoint is deprecated + +The deprecation period is six months. + +Sunset marks the point in time where the endpoint will not return the expected response. The endpoint will still be functional until sunset. + +Together with the deprecation header, a new sunset-header will be introduced to mark the date of the sunset. + +## How will we communicate an eventual breaking change or endpoint retirement? +An eventual breaking change or an endpoint retirement will be announced: +- on the [What's new](../docs/Whats-New.md) page in our API Docs +- on the [What's deprecated](../docs/Whats-deprecated.md) page in our API Docs +- on the developers [GitHub](https://developers.rws.com/languagecloud-api-docs/index.html) page +- on a new blog post in the [Language Developers Blog](https://community.rws.com/developers-more/developers/language-developers/b/language-developers-blog) and [Trados Blog](https://community.rws.com/product-groups/trados-portfolio/trados-live/b/blog) + +Any breaking change will be announced six months in advance. + + +> #### Info +> +> We may introduce breaking changes for critical bugs or security vulnerabilities. + +## What is our process for testing changes before releasing them to the Trados Cloud Platform API? +All changes undergo comprehensive testing and validation, following our deployment chronology in both non-customer and customer facing environments. + +As part of development, unit and contract tests are built as appropriate and undergo in-depth code review before being merged into master. + +As part of testing, once the changes are merged, they are tested according to our testing strategy, where testing scope and test coverage are identified. A test plan for the changes is created and quality assurance engineers decide upon manual and automation testing percentage to ensure the feature is implemented according to the specifications. On top of this we make sure regressions are not introduced by running the automated tests we have in place, as part of the release pipeline. Before new code is deployed to an environment (either customer or non-customer facing), all smoke tests must pass. diff --git a/articles/LCPublicAPI/docs/Service-credentials.md b/articles/LCPublicAPI/docs/Service-credentials.md new file mode 100644 index 0000000..75e7290 --- /dev/null +++ b/articles/LCPublicAPI/docs/Service-credentials.md @@ -0,0 +1,43 @@ +# Service Credentials + +Before service users can authenticate with the Trados Cloud Platform API, they need to get their client credentials from a Trados Cloud Platform administrator. Service users can then use their client credentials to authenticate with the API via an Auth0 access token. + +## Step 1: Trados Cloud Platform administrators add service users to the Trados Cloud Platform account. + +1. Log in to the Trados UI as a human **Administrator** user type or contact the administrator to perform the operations in this section. +2. Go to the **Users** view and select the **Service Users** sub-tab. +3. Select **New Service User** and enter the following information: + - **Name** – Enter a unique name for your service user. + - **Location** – Select a location (the **Root** folder or any of its children) for your service user. A location is a folder in your account hierarchy where resources are stored and managed. + - **Groups** – Select one or more groups (from the same **Location** as the one selected above) where you want to include your service user. Each group corresponds to a predefined role, and each predefined role has a set of permissions. Resource access is influenced by the role you choose. + - (Optional) **Description** – Enter any other relevant details. +4. Select **Create**. + +## Step 2: Trados Cloud Platform administrators add additional notification options for service users + +1. Log in to the Trados UI as a human **Administrator** user type or contact the administrator to perform the operations in this section. +2. Go to the **Users** view and select the **Service Users** sub-tab. +3. Select the service user to be edited +4. **Additional users to notify** - Add existing users to be notified of actions via email. +4. Select **Save**. + +## Step 3: Trados Cloud Platform administrators create a custom application, assign the service user to it, and retrieve the client credentials from within this application. + +1. Log in to the Trados UI as a human **Administrator** user type or contact the administrator to perform the operations in this section. +2. Expand the account menu on the top right-hand corner and select **Integrations**. +3. Select the **Applications** sub-tab. +4. Select **New Application** and enter the following information: + - **Name** – Enter a unique name for your custom application. + - (Optional) **URL** – Enter your custom application URL. + - (Optional) **Description** – Enter any other relevant details. + - **Service User** – Select a service user from the dropdown menu. +5. Select **Add**. +6. Back in the **Applications** sub-tab, select the check box corresponding to your application. +7. Select **Edit**. +8. On the **Overall Information** page you can change any of the following, if necessary: name, URL, description. +9. On the **Webhooks** page you can: + - Enter a default callback URL for your application Webhooks (all Webhooks defined in Trados Cloud Platform). + - Enter a value for **Webhook URL** (this is your Webhook endpoint URL which you expose and which Trados Cloud Platform calls), select one or more event types, and hit Enter. You can create a separate webhook for every event you are interested in or combine notifications for multiple event types to one webhook. If you delete your application, all its associated webhooks are also deleted. +10. Finally, from the **API Access** page you can retrieve your **Client ID** and **Client Secret**. + +> Although you have the option to change the **Service User** later on, it is not recommended. Due to the caching layers, changes from one **Service User** to another can take between 10 to 20 minutes to fully take effect. During this period, calls made with this **Application**'s credentials may randomly use either the new or the old **Service User.** If you can't stop your services to wait for the cache to expire, it's recommended to create a new **Application** with the new **Service User** and delete the old one. \ No newline at end of file diff --git a/articles/LCPublicAPI/docs/Service-users-and-custom-applications.md b/articles/LCPublicAPI/docs/Service-users-and-custom-applications.md new file mode 100644 index 0000000..2a1b398 --- /dev/null +++ b/articles/LCPublicAPI/docs/Service-users-and-custom-applications.md @@ -0,0 +1,20 @@ +# Service users and custom applications + +Service users are special users created when developing custom applications that integrate with the Trados Cloud Platform API. + +Service users: +- Are non-human users +- Don’t have login credentials +- Can only access Trados Cloud Platform via the Trados Cloud Platform API + +### Who can create service users? + +Service users are managed by administrators within a Trados Cloud Platform account. Administrators add service users to one or more groups. Once service users become part of a group, they automatically get a role, namely the group role which is associated with a predefined set of permissions. Service users access resources based on the permissions associated with the group (role) they belong to. + +### How are service users assigned to custom applications? + +When Trados Cloud Platform administrators create a custom application from the Trados UI, they assign one service user per application. + +### How does the authentication process of service users work? + +Whenever a third-party client authenticates with the application credentials, calls against the Trados Cloud Platform API will assume the identity of the service user within the platform for the purpose of authorizing access to data. diff --git a/articles/LCPublicAPI/docs/Track-projects.md b/articles/LCPublicAPI/docs/Track-projects.md new file mode 100644 index 0000000..0d36e1c --- /dev/null +++ b/articles/LCPublicAPI/docs/Track-projects.md @@ -0,0 +1,6 @@ +# Track projects + +After you create a project, you can track it by making a `GET` request to the [`/projects/{projectId}`](../api/Public-API.v1-fv.html#/operations/GetProject) endpoint to obtain information such as: creation date, due date, status, and resources used. + +When requesting a list of projects, you can filter out projects that have a file download restriction by sending the `excludeOnline` query parameter. + diff --git a/articles/LCPublicAPI/docs/Update-project-quote.md b/articles/LCPublicAPI/docs/Update-project-quote.md new file mode 100644 index 0000000..93983e6 --- /dev/null +++ b/articles/LCPublicAPI/docs/Update-project-quote.md @@ -0,0 +1,426 @@ +# Update project quote +To update a quote, make a `PUT` request to the [`/projects/{projectId}`](../api/Public-API.v1-fv.html#/operations/UpdateProject) end point, and specify the `quote` field. + +## Cost types + +There are two types of translation costs that can be updated using the Trados Cloud Platform API: +- **Language Costs** + - Costs that are applied at language level: *volume, percentage, hourly, per page, conditional* +- **Project Costs** + - Costs that are applied at project level as additional cost: *volume, percentage, hourly, per page, conditional, per file, per target language* + + +## Cost types available at project and language level + +> Note: Both language costs and project costs have identical request/response bodies, but for `languageCosts`, the `targetLanguage` field is required. + + +The examples below use the following translation costs: + +```json +... +{ + "translationCosts": [{ + "total": 85.4, + "targetLanguage": { + "languageCode": "fr-FR", + "englishName": "French (France)" + }, + "new": { + "count": 854.0, + "rate": 0.1, + "total": 85.4, + "runningTotal": 85.4 + } + } + ] +} +... +``` + +### Volume + +This is a fixed per word/character cost. + +***Request***: +```json +... +{ + "name": "Volume Cost", + "costOrder": 0, + "cost": 0.5, + "volumeUnitType": "Words", + "costType": "volume" + ... +} +... +``` + +The total cost is calculated as `number of words/characters` * `cost of a unit`: + +**`total = count * cost`** + +***Response***: + +```json +... +{ + "name": "Volume Cost", + "count": 854.0, + "total": 427.0, + "cost": 0.5, + "costType": "volume", + "volumeUnitType": "words", + "costOrder": 0, + "runningTotal": 512.4 + ... +} +... +``` + +The running total up until this point is equal to `total cost of the current additional cost` + `translation costs`.
+Using the data above, we can get the following running total: + +**`85.4 + 427 = 512.4`** + +### Percentage + +This is a percentage cost calculated against the current cost (current language-level cost or current project-level cost). + +***Request***: + +```json +... +{ + "name": "Percentage Cost", + "costOrder": 1, + "count": -10, + "costType": "percentage" + ... +} +... +``` + +The `total cost of the current additional cost` is calculated using the value from the `count` field as a percentage from the previous `running total`. + +**`total = count% * previousRunningTotal`** + +***Response***: + +```json +... +{ + "name": "Percentage Cost", + "count": -10.0, + "total": -51.24, + "cost": 0.0, + "costType": "percentage", + "costOrder": 1, + "runningTotal": 461.16 + ... +} +... +``` + +Since the previous `running total` is **512.4**, the total cost of the `current additional cost` is calculated as follows: + +**`total = -10% * 512.4 = -51.24`** + +As a result, the new running total becomes: + +**`runningTotal = 512.4 - 51.24 = 461.16`** + +### Hourly + +This is a fixed cost per hour. + +***Request***: + +```json +... +{ + "name": "Hourly Cost", + "costOrder": 2, + "count": 5, + "cost": 1.5, + "costType": "hourly" + ... +} +... +``` + +The total cost is calculated as `number of hours` * `cost of an hour`: + +**`total = count * cost`** + +***Response***: + +```json +... +{ + "name": "Hourly Cost", + "count": 5.0, + "total": 7.5, + "cost": 1.5, + "costType": "hourly", + "costOrder": 2, + "runningTotal": 468.66 + ... +} +... +``` + +**`total = 5 * 1.5 = 7.5`** + +**`runningTotal = 461.16 + 7.5 = 468.66`** + +### Per Page + +This is a fixed cost per page. + +***Request***: + +```json +... +{ + "name": "Per Page Cost", + "costOrder": 3, + "count": 10, + "cost": 0.2, + "costType": "perPage" + ... +} +... +``` + + +The total cost is calculated as `number of pages` * `cost of a page`: + +**`total = count * cost`** + +***Response***: + +```json +... +{ + "name": "Per Page Cost", + "count": 10.0, + "total": 2.0, + "cost": 0.2, + "costType": "perPage", + "costOrder": 3, + "runningTotal": 470.66 + ... +} +... +``` + +**`total = 10 * 0.2 = 2`** + +**``runningTotal = 468.66 + 2 = 470.66``** + +### Conditional + +This is a cost that is applied conditionally, for example: + +***Request***: + +```json +... +{ + "name": "Conditional Cost", + "costOrder": 4, + "conditionalCostVariable": "wordCount", + "conditionalCostOperator": "less", + "conditionalCostThreshold": 1000, + "cost": 100, + "conditionalCostType": "relative", + "costType": "conditional" + ... +} +... +``` + +If `[conditionalCostVariable]` `[conditionalCostOperator]` `[conditionalCostThreshold]`, then add/set `[cost]` `[conditionalCostType]`. + +This formula translates to the following: + +If `wordCount < 1000`, then add `100 relative`. + +***Response***: + +```json +... +{ + "name": "Conditional Cost", + "count": 854.0, + "total": 100.0, + "cost": 100.0, + "costType": "conditional", + "costOrder": 4, + "conditionalCostType": "relative", + "conditionalCostOperator": "less", + "conditionalCostVariable": "wordCount", + "conditionalCostThreshold": 1000.0, + "runningTotal": 570.66 + ... +} +... +``` +Since the word count (`count`) is 854 (in the example above), the condition becomes: + +If `854 < 1000` then add `100 relative`. => `true` + +**`total = cost = 100`** + +**`runningTotal = 470.66 + 100 = 570.66`** + +The total cost depends on the `conditionalCostType` field and on whether the condition evaluates to `true` or `false`. +When the condition evaluates to `false`, the total will be 0, and the running total will not change. + +If `854 > 1000`, then add `100 relative`. => `false` + +**`total = cost = 0`** +**`runningTotal = 470.66`** + + +For the same values as above, and the `conditionalCostType` set to `percentage`, the `total` and `runningTotal` values will change to: + +**`total = 100% * 470.66 = 470.66`** + +**`runningTotal = 470.66 + 470.66 = 941.32`** + +When the `conditionalCostType` is set to `absolute`, the total will be equal to the difference between the `cost` and the `runningtotal`: + +**`total = 100 - 470.66 = -370.66`** + +**`runningTotal = 100`** + +> **Note:** Setting `conditionalCostType` to `absolute` will cancel all the previous costs for the project or target language. + +## Cost types available ONLY at project level + +### Per Target Language + +This is an additional cost that is calculated based on the number of target languages in the project. + +***Request***: + +```json +... +{ + "name": "Per Target Language", + "costOrder": 5, + "cost": 5, + "costType": "perTargetLanguage" +} +... +``` + +The total cost is calculated as `number of target languages` * `cost of a target language`: + +***Response***: +```json +... +{ + "name": "Per Target Language", + "count": 1.0, + "total": 5.0, + "cost": 5.0, + "costType": "perTargetLanguage", + "costOrder": 5, + "runningTotal": 575.66 +} +... +``` + +Since there is only one target language in the example above, the total cost becomes: +**`total = 1 * 5 = 5`** +**`runningTotal = 570.66 + 5 = 575.66`** + +### Per File + +This is an additional cost that is calculated based on the number of files in the project. + +***Request***: + +```json +... +{ + "name": "Per File", + "costOrder": 6, + "cost": 3, + "costType": "perFile" +} +... +``` + +The total cost is calculated as `number of files` * `cost of a file`: + +***Response***: +```json +... +{ + "name": "Per File", + "count": 2.0, + "total": 6.0, + "cost": 3.0, + "costType": "perFile", + "costOrder": 6, + "runningTotal": 581.66 +} +... +``` +**`total = 2 * 3 = 6`** +**`runningTotal = 575.66 + 6 = 581.66`** + +## Cost order + +The `costOrder` field defines the order in which costs are calculated. + +For example, if there are two additional costs defined in the quote (see below), the percentage cost is calculated based on the running total from the volume cost. + +```json +... +{ + "name": "Volume Cost", + "total": 427.0, + "costType": "volume", + "costOrder": 0, + "runningTotal": 512.4 +... +}, +{ + "name": "Percentage Cost", + "total": -51.24, + "count": -10.0, + "costType": "percentage", + "costOrder": 1, + "runningTotal": 461.16 +... +} +... +``` + +When the `costOrder` field is switched, the `total` percentage cost value will be calculated based on the previous running total, which in this case is the translation cost (**85.4**): +```json +... +{ + "name": "Percentage Cost", + "count": -10.0, + "total": -8.54, + "costType": "percentage", + "costOrder": 0, + "runningTotal": 76.86 +... +}, +{ + "name": "Volume Cost", + "total": 427.0, + "costType": "volume", + "costOrder": 1, + "runningTotal": 503.86 +... +} +... +``` diff --git a/articles/LCPublicAPI/docs/Updating-data-with-PUT.md b/articles/LCPublicAPI/docs/Updating-data-with-PUT.md new file mode 100644 index 0000000..6918108 --- /dev/null +++ b/articles/LCPublicAPI/docs/Updating-data-with-PUT.md @@ -0,0 +1,18 @@ +# Updating data with PUT + +All update endpoints follow the rules listed in [JSON Merge Patch Semantics](https://tools.ietf.org/html/rfc7386). + +### Pay special attention when updating array fields + +The update overrides the entire array, not just the elements that are sent. See the following example: + +| ORIGINAL | PATCH | RESULT | +|:--- | :--- | :--- | +|`{"a" :[{"b": "c"}]}`| `{"a" :[1]}` | `{"a" :[1]}`| + + +If you don't send the "b" element from array "a", the element "b" will be removed from result after the update operation. + +If you send a new array element `[1]`, this element will be added into the result. + +Updating an existing array element requires that you send the original array with a new value for the desired element. \ No newline at end of file diff --git a/articles/LCPublicAPI/docs/Use-fields-in-your-requests.md b/articles/LCPublicAPI/docs/Use-fields-in-your-requests.md new file mode 100644 index 0000000..c0951e4 --- /dev/null +++ b/articles/LCPublicAPI/docs/Use-fields-in-your-requests.md @@ -0,0 +1,54 @@ +# Use fields in your requests + +All the endpoints that return a resource representation allow the `fields` query parameter. Fields are used to specify the property values you want returned for your entities. + +When you make a call using the `fields` query parameter, make sure that you: +- Separate the fields by commas. +- Query by `properties` and/or `subproperties`. Write `subproperties` in the following format: `propertyname.subpropertyname`. +- Familiarize yourself with the elements that get returned: + - The fields marked as “**required**” are always returned. + - If fields are not customized for a given level and the requested field is non null then the default fields will be returned. + - If fields are customized for a given level and the requested field is non null, the fields you requested will be returned. + - The rules above are applied at nested level as well. + +Let’s look at an example to understand how the `fields` parameter can be used. +We will perform a `GET` request to the [`/projects/projectId`](../api/Public-API.v1-fv.html#/operations/GetProject) endpoint and we will consider that in our example the `projectId`= 101. + +#### 1. Fields consist of properties and subproperties. Here are some examples: +- `Properties`: `id`; `name`; `customer`; `createdBy` and so on +- `Subproperties`: `customer.name`; `customer.keyContact`; `customer.Location`; `createdBy.email` and so on + +#### 2. You can make calls in several ways: +- No field customization + +Request: `GET/projects/101` + +Response: the project **identifier**, the project **name**, the project **language directions** + + + + +* Field customization (no nesting) + +Request: `GET/projects/101?fields=customer` + +Response: the project **identifier**; the customer **identifier**; the customer **name**; the customer’s **key contact**; the customer **location** + + + + +* Field customization (nesting) + +Request: `GET/projects/101?fields=customer.keyContact,customer.name` + +Response: the project **identifier**; the customer **name**; the customer’s **key contact** + + + + diff --git a/articles/LCPublicAPI/docs/Use-paging-and-sorting-for-lists.md b/articles/LCPublicAPI/docs/Use-paging-and-sorting-for-lists.md new file mode 100644 index 0000000..4ed1872 --- /dev/null +++ b/articles/LCPublicAPI/docs/Use-paging-and-sorting-for-lists.md @@ -0,0 +1,26 @@ +# Use paging and sorting for lists + +When the outcome of a `GET` call is a list of items (item properties and total count), you can control the number of results displayed on a page as well as sort the results. + +To control the number of results displayed on a page, do the following: + +- To retrieve the full size of an entity, make a `GET` call to its corresponding endpoint. + +For example, make a `GET` call to the [`/projects`](../api/Public-API.v1-fv.html#/operations/ListProjects) endpoint. The result consists in a list of all the projects (and their details) as well as a project count. The project count field returns the same value even if you further apply the `top` or `skip` query parameters. + +- To display only the first 10, 20, 30 (and so on) results in your list, use the `top` query parameter. + +For example, for the [`/projects`](../api/Public-API.v1-fv.html#/operations/ListProjects) endpoint, your query may look like this if you are interested in the first 10 projects: `/projects?top=10` + +- To get to a particular set of retrieved results in your list, use the `skip` query parameter. + +For example, for the [`/projects`](../api/Public-API.v1-fv.html#/operations/ListProjects) endpoint, if you want to skip the first 100 results, your query will look like this: `/projects?skip=100`. + +- To sort your list by certain properties, use the `sort` query parameter. + +The default sorting strategy is ascending. Add unary operators for ascending (+) and descending (-) sorting. If you do not add any operator, the default ascending strategy kicks in. + +For example, if you want to sort results by due date (-) and name (+), your query will look like this: `/projects?sort=-dueBy,name`. + +Note that sorting can be performed only on first-level fields (not nested fields), for naturally comparable types like strings, numbers, and dates. + diff --git a/articles/LCPublicAPI/docs/Whats-New.md b/articles/LCPublicAPI/docs/Whats-New.md new file mode 100644 index 0000000..8f7da76 --- /dev/null +++ b/articles/LCPublicAPI/docs/Whats-New.md @@ -0,0 +1,383 @@ +# What's new + + + +## 10 September 2025 +- With this release we deliver [Lookup](../api/Public-API.v1-fv.html#/operations/TranslationsLookup), [Concordance](../api/Public-API.v1-fv.html#/operations/TranslationsConcordanceSearch), [Add](../api/Public-API.v1-fv.html#/operations/TranslationsAdd) and [Update](../api/Public-API.v1-fv.html#/operations/TranslationsUpdate) translation units to a translation memory. See [this](./translations/Translations.md) page for more details. +- You can now [obtain](../api/Public-API.v1-fv.html#/operations/GetTranslationEngine) and [update](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) the resources sequence information for a Translation Engine. +- A new project event `PROJECT.STARTED` has been added. See [this](./webhooks/Webhooks-payload.md) page for more details. + + +## 18 August 2025 + +- The new, modernized Trados Cloud Platform SDK for Java is now available. See the upgrade guide [here](../docs/api-clients/java/Java-Client-Upgrade-Guide.md). + +## 12 August 2025 + +- You can now get word count and cost estimation analysis of files without the need to create a project. The functionality is accessible via the [Request File Analysis](../api/Public-API.v1-fv.html#/operations/RequestFileAnalysis) and [Poll File Analysis](../api/Public-API.v1-fv.html#/operations/PollFileAnalysis) endpoints. +- As previously announced, the `languageProcessingRuleId` parameter is now mandatory for [Update Translation Engine](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) endpoint. +- We fixed various bugs. + +## 15 July 2025 +- You can now add the `systemStatus` property on termbase entries. See [Update Termbase Entry](../api/Public-API.v1-fv.html#/operations/UpdateTermbaseEntry). +- We've improved the documentation around zip files on [Add Source File](../api/Public-API.v1-fv.html#/operations/AddSourceFile) and [Attach Source File](../api/Public-API.v1-fv.html#/operations/AddSourceFiles) endpoints. +- As a reminder, we want to let our users know that the field `languageProcessingRuleId` under [Update Translation Engine](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) endpoint will be mandatory. +- [Import Termbase](../api/Public-API.v1-fv.html#/operations/ImportTermbase) and [Poll Termbase Import](../api/Public-API.v1-fv.html#/operations/PollTermbaseImport) endpoints will return `pending` instead of `queued` for the status. This change is scheduled to take effect no sooner than six months from now. + +## 8 May 2025 +- You can now download the target files associated with a project in a ZIP format. This functionality is accessible through three endpoints: [Export](../api/Public-API.v1-fv.html#/operations/ExportProjectFiles), [Poll](../api/Public-API.v1-fv.html#/operations/ExportProjectFilesStatus), and [Download](../api/Public-API.v1-fv.html#/operations/DownloadFile). +- With this release we deliver the [Create](../api/Public-API.v1-fv.html#/operations/CreatePricingModel), [Update](../api/Public-API.v1-fv.html#/operations/UpdatePricingModel) and [Delete](../api/Public-API.v1-fv.html#/operations/DeletePricingModel) pricing model endpoints. Together with these, several changes were required to correct the pricing model response: + - `name` : changed from required to default. + - `additionalCosts.volumeUnitType` changed from required to non required. + - `additionalCosts.conditionalCostType` changed from required to non required. + - `additionalCosts.costOperator` changed from required to non required. + - `additionalCosts.costVariable` changed from required to non required. + - `additionalCosts.operand` changed from required to non required. + - `perTargetLanguage` and `perFile` cost types have been removed from `languageCosts` to clean up the structure. + +- We have expanded the cost types by introducing two new values: **adhoc** and **adhoc volume**. +- Import and Export TM endpoints are now subject to API limits. For more details, please refer to [this page](../docs/API-rate-limits.md). +- We updated the [Java Client samples](../docs/api-clients/java/Java-Samples.md) to reflect the usage of the latest version. +- We fixed various bugs. + +## 1 April 2025 +- As part of the Connected AI feature, we have added the following updates and new endpoints: + - We have introduced a new endpoint for listing [Large Language Models](../api/Public-API.v1-fv.html#/operations/ListLlmConfigurations) (LLMs). + - We have added the functionality to [update your translation engines](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) with the new LLM resource type. +- We have added the source word count to the [List Source Files](../api/Public-API.v1-fv.html#/operations/ListSourceFiles) endpoint. +- We fixed various bugs. + + +## 10 March 2025 + +- We've introduced the concept of [Batched Webhooks](../docs/webhooks/Batched-webhooks.md). +- We've updated the models for [Import Translation Memory](../api/Public-API.v1-fv.html#/operations/ImportTranslationMemory), [Export Translation Memory](../api/Public-API.v1-fv.html#/operations/ExportTranslationMemory) and [Get Translation Memory Import History](../api/Public-API.v1-fv.html#/operations/GetTMImportHistory). + - As part of this, the existing `status` field is now marked as deprecated in the response model of [Import Translation Memory](../api/Public-API.v1-fv.html#/operations/ImportTranslationMemory) and [Export Translation Memory](../api/Public-API.v1-fv.html#/operations/ExportTranslationMemory). + - Additionally, the fields `importAsPlainText` and `triggerRecomputeStatistics` are marked as deprecated in the request model of [Import Translation Memory](../api/Public-API.v1-fv.html#/operations/ImportTranslationMemory) and in the response model of [Get Translation Memory Import History](../api/Public-API.v1-fv.html#/operations/GetTMImportHistory), alongside the `traceId` field. + - Their decommissioning is scheduled at a minimum of six months from now. + + +## 10 December 2024 +- You can now associate existing users with a service user to notify them of actions via email, using Trados UI. More details [here](../docs/Service-credentials.md#step-2-trados-cloud-platform-administrators-add-additional-notification-options-for-service-users). +- We have officially rebranded from RWS Language Cloud API to Trados Cloud Platform API. All references to our previous brand name will now reflect our new identity, Trados. +- Provided [Postman Environments](../docs/Language-Cloud-APIs-for-Postman.md) for multi-region. + +## 18 November 2024 +- As part of our multi-region support, we have added global endpoints to facilitate the discovery of available regions and hosts. For more details, see the [Multi-region](../docs/Multi-region.md) page. +- We have updated the documentation on how to use the new SDK with multi-region features. +- Additionally, we made various minor contract corrections. +- As a reminder, we want to let our users know that the field `languageProcessingRuleId` under [Update Translation Engine](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) endpoint will become mandatory. + +## 6 November 2024 +- We are planning to transition the hosting of our API from **lc-api.sdl.com** to **api.eu.cloud.trados.com** on November 9th: + + - **lc-api.sdl.com** for API and integrations will remain active. + + - Existing integrations will continue to work as before. We do recommend planning to change the URL when possible. + + - For new integrations, we recommend using the new URL to avoid additional work in the future. + +- You now have the ability to add notes to customer quotes. + + - We have updated the deprecated types for the `language` and `targetLanguages` fields in the [Add Source File Request](../api/Public-API.v1-fv.html#/schemas/source-file-request) model, which now reference [Language Request](../api/Public-API.v1-fv.html#/schemas/language-request) model. In the updated API contract, these fields have been changed from simple strings to structured objects containing a `languageCode` property, enhancing clarity and consistency in language handling. + + > We will provide backwards compatibility until May 2025. However, starting with this release, SDKs will be updated to use the new types. Please ensure your integration is updated to use the new [Language Request](../api/Public-API.v1-fv.html#/schemas/language-request) model. + +- We fixed various bugs. +## 11 September 2024 + +- With this release we deliver the [PerfectMatch](https://docs.rws.com/791595/1155478/trados-enterprise---accelerate/perfectmatch-general-information) functionality. You can apply PerfectMatch either at the start of a project or midway through the translation process. These capabilities are accessible via the [PerfectMatch Mapping](../api/Public-API.v1-fv.html#/operations/CreatePerfectMatchMapping) menu. +- We've improved filtering for projects lists. See the [List Projects](../api/Public-API.v1-fv.html#/operations/ListProjects) endpoint. +- A recent update has been made to the [Webhooks Setup](../docs/webhooks/Webhooks-setup.md) page, informing the customers that the order of webhook event deliveries cannot be guaranteed. Please take this into consideration using the `timestamp` field to determine the event generation time. +- You can now set due dates for tasks during project creation. +- We fixed various bugs. + + +## 28 August 2024 +- We have introduced a new option which allows users to switch to a different pricing model at the Customer Quote Review task using the dedicated endpoint [Update Project Pricing Model](../api/Public-API.v1-fv.html#/operations/UpdateProjectPricingModel). +- You now have the ability to view the locking color options for MTQE segments by utilizing the [Get Project Template](../api/Public-API.v1-fv.html#/operations/GetProjectTemplate) endpoint. +- The parameter `termbaseStructure.fields.type` in the [Get Termbase](../api/Public-API.v1-fv.html#/operations/GetTermbase) endpoint is no longer marked as mandatory. +- We fixed various bugs. + +## 1 July 2024 +- We updated the folder/resource locations to the new format, which now includes the [path](../api/Public-API.v1-fv.html#/schemas/folder). +- We fixed various bugs. + +## 9 May 2024 + +- You can configure the number of days after which projects are given the Completed or Archived status automatically using the `completionConfiguration` option under the following endpoints: [Create](../api/Public-API.v1-fv.html#/operations/CreateProject) and [Update](../api/Public-API.v1-fv.html#/operations/UpdateProject) Project, [Create](../api/Public-API.v1-fv.html#/operations/CreateProjectTemplate) and [Update](../api/Public-API.v1-fv.html#/operations/UpdateProjectTemplate) Project Template. +- The field `languageProcessingRuleId` under [Update Translation Engine](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) endpoint will become mandatory. The enforcement is scheduled at a minimum of six months from now. +- As a reminder, we want to let our users know that we updated the folder/resource locations to the new format, which now includes the [path](../api/Public-API.v1-fv.html#/schemas/folder-v2). The old fields are marked as deprecated and their decommissioning is planned for near future. Please ensure you update the implementation if you are using fields that are marked as deprecated. +- We fixed various bugs. + +## 8 April 2024 + +- We extended the information available on the webhooks setup page, [Circuit Breaker](../docs/webhooks/Webhooks-setup.md#circuit-breaker) section. +- We removed the `languageId` allowed values for the [Export Quote Report](../api/Public-API.v1-fv.html#/operations/ExportQuoteReport) endpoint. +- As a reminder, we want to let our users know that we updated the folder/resource locations to the new format, which now includes the [path](../api/Public-API.v1-fv.html#/schemas/folder-v2). The old fields are marked as deprecated and their decommissioning is planned for near future. Please ensure you update the implementation if you are using fields that are marked as deprecated. +- We fixed various bugs. + +## 27 February 2024 + +- With this release we deliver the [Update](../api/Public-API.v1-fv.html#/operations/UpdateProjectTemplate) and [Delete Project Template](../api/Public-API.v1-fv.html#/operations/DeleteProjectTemplate) endpoints. Subsequent iterations with new implementations will follow, ensuring continuous enhancement for project template update. +- We published a new page about [multipart considerations](../docs/How-to-multipart.md) +- We fixed various bugs. + +## 13 December 2023 + +- With this release we deliver the [Create Project Template](../api/Public-API.v1-fv.html#/operations/CreateProjectTemplate) endpoint. Subsequent iterations with new implementations will follow, ensuring continuous enhancement for project template creation. +- We enhanced the response model for the [Get Project Template](../api/Public-API.v1-fv.html#/operations/GetProjectTemplate) endpoint, which now includes settings for verification and batch tasks. The existing `forceOnline` and `quoteTemplate` fields from root level are now marked as deprecated, as they have been moved to the `settings` section. Their decommissioning is scheduled at a minimum of six months from now. +- Webhooks will stop trying to send on urls that cause timeouts, retrying later. Read more [here](../docs/webhooks/Webhooks-setup.md#circuit-breaker). +- We fixed various bugs. + +## 16 November 2023 +- We introduced the `applicableOutcomes` field under the [get task](../api/Public-API.v1-fv.html#/operations/GetTask) endpoint to be used when completing the tasks. +- You can now change the folder visibility when updating a customer. +- We fixed various bugs. + +## 17 October 2023 +- This release delivers more integrations for the customer resource type. You can now [create](../api/Public-API.v1-fv.html#/operations/CreateCustomer), [update](../api/Public-API.v1-fv.html#/operations/UpdateCustomer) and [delete](../api/Public-API.v1-fv.html#/operations/DeleteCustomer) customers. +- We enhanced the response model for [pricing](../api/Public-API.v1-fv.html#/operations/ListPricingModels) endpoints. +- As previously announced, we made the `dueBy`, the `location` and the `languageDirections` fields mandatory for [creating a project](../api/Public-API.v1-fv.html#/operations/CreateProject). +- We added `deliveredBy` as a new field for the [update project](../api/Public-API.v1-fv.html#/operations/UpdateProject) capabilities. +- We extended the information available on the [webhooks setup](../docs/webhooks/Webhooks-setup.md) page. +- We fixed various bugs. + +## 06 September 2023 +- With this release we deliver the [create](../api/Public-API.v1-fv.html#/operations/CreateScheduleTemplate), [read](../api/Public-API.v1-fv.html#/operations/GetScheduleTemplate), [update](../api/Public-API.v1-fv.html#/operations/UpdateScheduleTemplate) and [delete](../api/Public-API.v1-fv.html#/operations/DeleteScheduleTemplate) endpoints of the new schedule template resource. You will find the endpoints under the [schedule templates](../api/Public-API.v1-fv.html#/operations/ListScheduleTemplates) menu. You can also retrieve the schedule template attached to a [project](../api/Public-API.v1-fv.html#/operations/GetProject) or to a [project template](../api/Public-API.v1-fv.html#/operations/GetProjectTemplate) using the relevant fields. +- Additionally, the [create project](../api/Public-API.v1-fv.html#/operations/CreateProject) now supports the schedule template resource, either individually or from the project template. +- We added the `apiInternalId` to [task type](../api/Public-API.v1-fv.html#/schemas/task-type) and [workflow task template](../api/Public-API.v1-fv.html#/schemas/workflow-task-template) to easily identify custom tasks. +- We fixed various bugs. + +## 17 August 2023 +- We updated the folder/resource locations to the new format, which now includes the [path](../api/Public-API.v1-fv.html#/schemas/folder-v2). The old fields are marked as deprecated and their decommissioning is scheduled at a minimum of six months from now. Please ensure you update the implementation if you are using fields that are marked as deprecated. +- Enhanced [project configuration](../api/Public-API.v1-fv.html#/operations/UpdateProjectConfiguration) now includes new choices for updating translation memory settings. +- We fixed various bugs. +- As a reminder, we want to let our users know that validations related to the following fields used at project creation: `dueBy`, `location` and `languageDirections` will become **required** in near future. + +## 02 August 2023 +- With this release we provide a new endpoint to allow integrators to update only one [custom field](../api/Public-API.v1-fv.html#/operations/UpdateCustomField) of a project +- We extended the information available on the [webhooks](../docs/webhooks/Webhooks-payload.md) page +- You can now update a translation engine as a stand alone resource or one that is linked to a live project. Read this [page](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) for more details. +- We fixed various bugs. + +## 15 June 2023 +- We extended the information provided for both [source](../api/Public-API.v1-fv.html#/operations/ListSourceFileVersions) and [target](../api/Public-API.v1-fv.html#/operations/ListTargetFileVersions) files in a task with the `name`, the `version` and `originatingTaskId` details +- We made available a new [rate-limits](../api/Public-API.v1-fv.html#/operations/ListRateLimits) endpoint and a new header which includes the relevant policy name, namely, the `X-RateLimit-Policy` header. Read the [API-rate-limits](../docs/API-rate-limits.md) page for more details. +- We improved descriptions for the `default` and `required` fields [here](../docs/Use-fields-in-your-requests.md). +- We updated the JAVA samples to reflect changes in the SDK. +- We fixed various bugs. + + +## 19 May 2023 +- We replaced the `friendlyId` on all Project Group endpoints with `shortId` and we've exposed it on all Project endpoints too. +- As a security enhancement, we will restrict some characters in naming projects and project files. The unsupported characters are: `<`, `>`, `:`, `"`, `/`, `\`, `|`, `?`, `*`. +- In 6 months we will introduce the following breaking change: on the [Export Quote Report](../api/Public-API.v1-fv.html#/operations/ExportQuoteReport) endpoint, if the quote is not generated using a Quote Template, the response will be an empty object. +- We will enforce validations related to the following fields at project creation: `dueBy`, `location` and `languageDirections`. These fields will become **required** in 3 months. +- As a reminder, we want to let our users know that for security issues or bugs we may introduce breaking changes at any time. + + + +## 20 April 2023 +- With this release we enforce validations listed in the documentation for the Create and Update Project endpoints. This impacts the SDKs, so please update your integration accordingly. +- We extended the [webhooks](../docs/Webhooks.md) functionality to support error tasks +- We introduced the `customFields` field for project webhooks, and the `dueBy` field for task webhooks +- We added the `name` of the `customFields` under the response for the Get Project endpoint +- We fixed various bugs. + +## 21 March 2023 +- We extended the list of [webhooks](../docs/Webhooks.md) available for tasks, projects, project files, project templates and enabled the first webhook for project group +- We fixed several bugs. + +## 03 March 2023 +- We introduced fields displaying the project status history and the `completedAt` date for a task. +- We exposed the project creator as a sorting option on list projects. +- We fixed several bugs +- We want to remind our users we will enforce validations listed in the documentation for the Create and Update Project endpoints. + +## 15 February 2023 +- We enabled support for the Trados Enterprise Quote Template functionality +- We introduced the `projectManagers` field to enable the selection of individuals or of users groups at [project creation](../api/Public-API.v1-fv.html#/operations/CreateProject). +- We removed unnecessary outcome values for the [Task Completed Request](../api/Public-API.v1-fv.html#/schemas/task-complete-request) model on the [Complete Task](../api/Public-API.v1-fv.html#/operations/CompleteTask) operation. This impacts the SDKs, so update your integration accordingly. +- You can now specify the `projectCreator` as an assignee type for a task when [updating a project](../api/Public-API.v1-fv.html#/operations/UpdateProject). +- We will enforce validations related to the following fields at project creation: `dueBy`, `location` and `languageDirections`. These fields will become **required** in 6 months. + + +## 11 January 2023 + +- You can now [create](../api/Public-API.v1-fv.html#/operations/CreateProjectGroup), [read](../api/Public-API.v1-fv.html#/operations/GetProjectGroup), [update](../api/Public-API.v1-fv.html#/operations/UpdateProjectGroup) and [delete](../api/Public-API.v1-fv.html#/operations/DeleteProjectGroup) Project Groups +- We've improved filtering for projects lists, namely by status and by creation date +- We've introduced fields displaying more details for error tasks +- We fixed various bugs + + +## 22 November 2022 +- To enable support for the Trados Enterprise multi-source resources functionality, we're introducing an important breaking change: when creating workflows with multi-source languages from the TE UI, please use the new `languageDirection` scope value. As the new feature may limit previously working functionality, inconsistencies within applications or certain products may appear. For integrations that are impacted, please contact their developers to update the integrations. +- We've made 3 new endpoints available for [TM export](../api/Public-API.v1-fv.html#/operations/ExportTranslationMemory) +- We removed the old 10 MB size limitations for files, termbases and translation memories. We now support [these values](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) for files and [these values](https://docs.rws.com/791595/741139/trados-enterprise---accelerate/importing-tm-content) for importing translation memory content. +- Users can now retrieve task comments. +- We've added the [TM Import history](../api/Public-API.v1-fv.html#/operations/GetTMImportHistory) endpoint. +- We are postponing the breaking change in the `LanguageDirectionRequest` model, previously announced for November, and consequently the model can be used until the end of 2022. +- 4 new endpoints are subject to [API limits](https://languagecloud.sdl.com/lc/api-docs/d2266fabaa1bf-api-rate-limits#project-files-rate-limits) +- We fixed various bugs. + +## 28 October 2022 +- You can [import translation memories](../docs/translation-memory/Translation-memory-import-export.md) using the [import](../api/Public-API.v1-fv.html#/operations/ImportTranslationMemory) and [poll](../api/Public-API.v1-fv.html#/operations/PollTMImport) endpoints. Note that the maximum size for an imported translation memory is 10 MB. +- We added traceability fields for terminology entries: createdAt, createdBy, lastModifiedAt, lastModifiedBy +- We added recommendations for [HTTP headers](../docs/Headers-considerations.md) +- We updated the recommendations for [Authentication](../docs/Authentication.md) and the [API rate limits](../docs/API-rate-limits.md) with token values and other details +- We fixed various bugs + +## 15 September 2022 +- We introduced a new [Export Quote Report](../docs/Export-quote-report.md) mechanism and deprecated the older endpoint +- We updated the constrains for the 'name' and 'description' fields for the [Create Project](../api/Public-API.v1-fv.html#/operations/CreateProject) and [Update Project](../api/Public-API.v1-fv.html#/operations/UpdateProject) endpoints that will be enforced starting December 2022 +- We introduced a new page for the currently [Known issues](../docs/Known-Issues.md) +- We fixed various bugs + + +## 22 August 2022 +- You can now read [language processing rules](../api/Public-API.v1-fv.html#/operations/ListLanguageProcessingRules) and [translation memory field templates](../api/Public-API.v1-fv.html#/operations/ListFieldTemplates) +- You can now [create](../api/Public-API.v1-fv.html#/operations/CreateTranslationMemory), [read](../api/Public-API.v1-fv.html#/operations/GetTranslationMemory), [update](../api/Public-API.v1-fv.html#/operations/UpdateTranslationMemory), [delete](../api/Public-API.v1-fv.html#/operations/DeleteTranslationMemory) and [copy](../api/Public-API.v1-fv.html#/operations/CopyTranslationMemory) translation memories + +## 12 August 2022 +- Retiring of the Export Quote endpoint will happen in 6 months. You can read more about it [here](../docs/Public-API-Management-Process.md#endpoint-retirement-process). +- We now support the Export Quote Report functionality with 3 new endpoints: [Poll Quote Export Report](../api/Public-API.v1-fv.html#/operations/PollQuoteReportExport), [Export Quote](../api/Public-API.v1-fv.html#/operations/ExportQuoteReport) and [Download Exported Quote](../api/Public-API.v1-fv.html#/operations/DownloadQuoteReport). +- You can now upload [source](../api/Public-API.v1-fv.html#/operations/AddSourceFileVersion) and [target](../api/Public-API.v1-fv.html#/operations/AddTargetFileVersion) file versions +- We published a new page about [File formats](../docs/File-formats.md) +- We fixed various bugs + +## 28 July 2022 +- We published a new page about [How to use location and folders](../docs/How-to-use-location-and-folders.md) +- We published a new page about [How to report an API issue](../docs/How-to-report-an-issue.md) +- We fixed various bugs + +## 19 July 2022 + +- You can now update [source](../api/Public-API.v1-fv.html#/operations/UpdateSourceFile) and [target](../api/Public-API.v1-fv.html#/operations/UpdateTargetFile) file names +- We fixed various bugs + +## 28 June 2022 + +- You can now [read](../api/Public-API.v1-fv.html#/operations/GetProjectConfiguration) and [update](../api/Public-API.v1-fv.html#/operations/UpdateProjectConfiguration) translation memory settings for a project's configuration +- We updated the user guide page for [using fields](../docs/Use-fields-in-your-requests.md) with new animated gifs +- We fixed various bugs + + +## 07 June 2022 +- We have increased the API limits, you can find the new limits on [this page](../docs/API-rate-limits.md). +- Deprecation of the language direction code will happen in 6 months. You can read more about it [here](../docs/Whats-deprecated.md). +- Enforce validations related to the length of the *name* and *description* fields and the accepted input values for the Create and Update Project endpoints will be delivered in 6 months. + +## 24 May 2022 +- To address potentially infected files, we've updated our API contracts to support In-Product Antivirus scanning + +## 04 May 2022 +- You can now upload a .zip archive using [this](../api/Public-API.v1-fv.html#/operations/UploadZipFile) endpoint and then [poll](../api/Public-API.v1-fv.html#/operations/PollUploadZipFile) for the extracted files. After extraction, you can upload multiple source files to a project using a [single call](../api/Public-API.v1-fv.html#/operations/AddSourceFiles). The maximum size for an imported .zip file is 10 MB. +- Our Java SDK client is now available in **public beta**. [Here](../docs/api-clients/java/Java-Client.md) are more details on how to start integrating it into your solution +- We published the API limits [here](../docs/API-rate-limits.md) +- We updated the Custom fields [page](../docs/Custom-Fields.md) with useful gifs +- We fixed various bugs + +**We update the .NET and Java client versions with each API release.** + +## 11 March 2022 +- You can now export a termbase and a termbase template in Trados Enterprise using the Trados Cloud Platform API +- We fixed various bugs + +## 22 February 2022 +- You can now convert an xdt file into a termbase structure using [this](../api/Public-API.v1-fv.html#/operations/ConvertTermbaseTemplate) dedicated endpoint +- When updating a termbase entry you will have to provide either the name or the identifier for the `termbaseFieldValues` +- We fixed various bugs + +## 2 February 2022 +- You can now import a termbase in Trados Enterprise using the Trados Cloud Platform API. The supported extensions are `xml` and `tbx`. The maximum size for an imported termbase is 10 MB. +- Our .NET SDK client is now available in **public beta**. [Here](../docs/api-clients/net/NET-Client.md) are more details on how to start integrating it into your solution. +- We updated the [basic project creation](../docs/Basic-project-creation-flow.md) page with useful gifs and added a small Postman collection to help you get started quickly +- We fixed various bugs + + +## 15 December 2021 +- You can now create, read, update and delete terminology termbases, termbase templates and termbase entries +- We fixed various bugs + +## 18 November 2021 +- You can now update the configurations of future tasks using the `projectPlan` field, in the [`update project`](../api/Public-API.v1-fv.html#/operations/UpdateProject) endpoint +- Fixed various bugs + +## 20 October 2021 +- Basic project creation flow added +- Fixed various bugs + +## 04 October 2021 +- Added multiple date formats +- Added pagination for [`List File Processing Configurations`](../api/Public-API.v1-fv.html#/operations/ListFileProcessingConfigurations) endpoint +- Fixed various bugs + +## 08 September 2021 +- Added support for downloading quote files +- Enum values updated to follow camelCase convention +- Updated documentation for projectTemplate in create project request +- Renamed customProperty to customFields in error responses +- Improved documentation for [Reclaim Task](../docs/Interact-with-tasks.md) +- Updated documentation for [Quotes](../docs/Export-quote-report.md) + +## 26 August 2021 +- Added support to restrict file downloads +- When creating/updating projects using a project template which has mandatory custom fields, you must supply those custom fields +- Fixed various bugs + +**We will remove deprecated fields from the [`ErrorResponse`](../api/Public-API.v1-fv.html#/schemas/error-response) model in an upcoming release. Please ensure you are not using fields marked as deprecated!** + +## 29 July 2021 +- Added endpoints for custom field definitions. +- Added support for custom fields on projects and project templates. +- The `translationEngine`, `fileProcessingConfiguration`, `workflow` fields are now required on the [`/projects`](../api/Public-API.v1-fv.html#/operations/CreateProject) endpoint. +- The `isSkipped` field is now marked as required on the [`/workflow/updateworkflow`](../api/Public-API.v1-fv.html#/operations/UpdateWorkflow) endpoint. +- Added new assignee type `projectCreator` when retrieving workflows. +- Improved contract documentation on TQA endpoints. +- Fixed various bugs. + +## 08 June 2021 +* For endpoints that return multiple items, the `top` query parameter has a default value of `100` and a maximum value of `100`; `skip` has a default value of `0`. +* The `Authorization` and `X-LC-Tenant` headers are now required for all endpoints. +* Improved the returned error structure. +* Fixed various issues with incorrect contract. +* Added new conditional cost fields (`costOrder`, `conditionalCostType`, `conditionalCostOperator`, `conditionalCostVariable`, `conditionalCostThreshold`) when working with project quotes. +* Added currency types for quote model. + +## 17 May 2021 +A Postman Collection is now available for integrators. Check out [this](../docs/Language-Cloud-APIs-for-Postman.md) page for details. + +## 10 February 2021 + +* **Target File** > **Download File Version** endpoint + +When you make a `GET` request to the [`/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/download`](../api/Public-API.v1-fv.html#/operations/DownloadFileVersion) endpoint, you can now perform a direct download of the native file as well as of the `BCM` file version. + +* **Target File** > **Export Target File Version** endpoint + +When you make a `POST` request to the [`/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/exports`](../api/Public-API.v1-fv.html#/operations/ExportTargetFileVersion) endpoint, you now have a query parameter where you can specify whether the file version export should be a native file or an `sdlxliff` file. The default value is `native`. + +## 28 January 2021 + +* **Project** > **List Project’s Tasks** endpoint + +When you make a `GET` request to the [`/projects/{projectId}/tasks`](../api/Public-API.v1-fv.html#/operations/ListProjectTasks) endpoint, you can now retrieve the available project tasks and their details. + + +* **Retrieving tasks** + +Retrieving tasks provides the following new additional details: + +- the Vendor Order Quote information +- the translation status for each task: the type of matches, the number of segments, the number of words/characters. + +* **Specifying target languages for source files** + +When adding source files to a project, you can specify their target languages via the `targetLanguages` and `path` elements. + + + + +â‚Ť^. .^₎⟆ + diff --git a/articles/LCPublicAPI/docs/Whats-deprecated.md b/articles/LCPublicAPI/docs/Whats-deprecated.md new file mode 100644 index 0000000..22584fe --- /dev/null +++ b/articles/LCPublicAPI/docs/Whats-deprecated.md @@ -0,0 +1,33 @@ +# What's Deprecated + + +## 1 July 2024 +We have removed the old fields in the folder/resource structure and are no longer available. Use the [path](../api/Public-API.v1-fv.html#/schemas/folder-v2) field going forward. + +## 13 December 2023 +- The `Export Quote` endpoint has been removed. +- In the Get Project Template model we deprecated: + - `forceOnline` field from root level and we added `forceOnline` to the settings → general + - `quoteTemplate` field from root level and we added `quoteTemplate` to the settings → general + They will only be available for use until July 2024. + +## 17 August 2023 + +We updated the folder/resource locations to the new format, which now includes the [path](../api/Public-API.v1-fv.html#/schemas/folder-v2). The old fields are marked as deprecated and their decommissioning is scheduled at a minimum of six months from now. + +## 12 August 2022 +In the `Quote` code, we deprecated the `Export Quote` endpoint. It will only be available for use until December 2022. + + +## 7 June 2022 + +In the `LanguageDirectionRequest` model we deprecated: +- the `sourceLanguageCode` field and introduced `sourceLanguage` as an object containing the `languageCode` field; +- the `targetLanguageCode` field and introduced `targetLanguage` as an object containing the `languageCode` field. + +They will no longer be available to use starting with November 2022. + +## 8 September 2021 + +We removed deprecated fields from the ErrorResponse model. + diff --git a/articles/LCPublicAPI/docs/api-clients/java/Java-Client-Upgrade-Guide.md b/articles/LCPublicAPI/docs/api-clients/java/Java-Client-Upgrade-Guide.md new file mode 100644 index 0000000..e0c2359 --- /dev/null +++ b/articles/LCPublicAPI/docs/api-clients/java/Java-Client-Upgrade-Guide.md @@ -0,0 +1,169 @@ +--- +stoplight-id: b309fcde3938d +--- + + +# Trados Cloud Platform SDK - Migration Guide v25.x.x + +## Executive Summary + +The Trados Cloud Platform API SDK has transitioned from a "fat JAR" to a "light JAR" architecture, delivering faster downloads, improved dependency management, and better build performance. For most users, migration requires only a version update in your build configuration. + + +**What Changed:** +1. **Modernized Dependencies:** JUnit 4 → 5, Apache HttpClient 4 → 5, Commons Lang 2→3 +2. **OpenAPI Generator:** Version 6.5.0 → 7.14.0 with enhanced nullability annotations +3. **Enhanced Features:** New `LCContext.executeInScope()` methods for improved tenant/trace context management +4. **Updated Tooling:** Latest versions of Jackson, Feign, and other core libraries + +## Step-by-Step Migration Guide + +### For Standard API Usage (Most Users): + +If you're using the generated SDK classes like `ProjectApi`, `SourceFileApi`, etc., migration is straightforward: + +1. Update SDK version to 25.x.x in your build configuration. +2. Run your build command to verify everything works. +3. Review and update your code for compatibility with the new OpenAPI Generator output (see the section [OpenAPI Generator & Generated Code Changes](#openapi-generator--generated-code-changes) below for details). +4. Your API calls should work as before, but review and resolve any compilation issues related to the above changes. + +```java +// Your existing code continues to work +ProjectApi projectApi = languageCloudClientProvider.getProjectClient(); +Project project = projectApi.createProject(projectCreateRequest, queryParams); +``` +## Troubleshooting + +**Most Common Issue**: Build fails after version update +**Solution**: Run `mvn dependency:tree` to check for dependency conflicts + +**Issue**: `ClassNotFoundException: feign.Client` +**Solution**: Verify Feign dependencies: `mvn dependency:tree | grep feign` + +**Issue**: `NoClassDefFoundError` for HTTP client classes +**Solution**: Update imports from `org.apache.http` to `org.apache.hc.core5.http` + +**Issue**: Commons Lang methods not found +**Solution**: Update imports from `org.apache.commons.lang` to `org.apache.commons.lang3` + +## Success Validation + +**For Standard Users:** +1. Clean build: `mvn clean install` succeeds +2. API functionality works as before +3. Faster builds and smaller downloads + +**For Advanced Users:** +- Run `mvn dependency:tree` - no conflicts shown +- Test application startup and core functionality + +### Advanced Scenarios + +
+ com.rws.lt.lc.public-api
+ lc-public-api-sdk
+ 24.0.9
+
+```
+> Make sure to always reference the latest available version. Check the [Maven Central Repository](https://search.maven.org/artifact/com.rws.lt.lc.public-api/lc-public-api-sdk) for more info.
+
+
+## Usage
+We will use the project creation flow as an example to show how the API clients can be used.
+
+API clients can be initialized individually based on the endpoints you need to target.
+If authorization was provided when instantiating the client, it's not required again when calling its methods.
+
+Trados Cloud Platform operates in multiple regions; ensure you select the correct region for your integration.
+*See the [Multi Region](../../../docs/Multi-Region.md) page for more details.*
+
+The default region for `LanguageCloudClientProvider` is `eu`, but you can override it.
+For example, to use Project features, instantiate a Project client like this:
+
+```java
+
+// define credentials
+ServiceCredentials serviceCredentials = new ServiceCredentials("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET", "YOUR_TENANT_ID");
+
+// instantiate the LanguageCloudClientProvider
+LanguageCloudClientProvider languageCloudClientProvider = LanguageCloudClientProvider.builder()
+ .withRegionCode("ca") // default is "eu"
+ .withServiceCredentials(serviceCredentials)
+ .build();
+
+// instantiate the client
+ProjectApi projectApi = languageCloudClientProvider.getProjectClient();
+```
+
+#### 1. Create a new project:
+
+```java
+ProjectCreateRequest projectCreateRequest = new ProjectCreateRequest();
+projectCreateRequest.setName("YOUR_PROJECT_NAME");
+projectCreateRequest.setDueBy(DateTime.parse("2025-01-01T00:00:00.000Z"));
+projectCreateRequest.setProjectTemplate(new ObjectIdRequest().id("YOUR_PROJECT_TEMPLATE_ID"));
+
+// Set the `fields` query parameter so the response is populated with `projectPlan.taskConfigurations`
+ProjectApi.CreateProjectQueryParams queryParams = new ProjectApi.CreateProjectQueryParams();
+queryParams.fields("projectPlan.taskConfigurations");
+Project projectCreateResponse = projectApi.createProject(projectCreateRequest, queryParams);
+```
+
+#### 2. Attach a source file to the project:
+
+Projects that do not contain source files cannot be started.
+
+```java
+SourceFileApi sourceFileApi = languageCloudClientProvider.getSourceFileClient();
+
+SourceFileRequest properties = new SourceFileRequest();
+properties.setLanguage(new LanguageRequest("en-US"));
+properties.setName("YOUR_TEXT_SOURCE_FILE");
+properties.setRole(SourceFileRequest.RoleEnum.TRANSLATABLE);
+properties.setType(SourceFileRequest.TypeEnum.NATIVE);
+File file = new File("YOUR_TEXT_SOURCE_FILE_PATH");
+
+SourceFile sourceFile = sourceFileApi.addSourceFile("YOUR_PROJECT_ID", properties, file);
+```
+
+#### 3. Start the project:
+```java
+projectApi.startProject("YOUR_PROJECT_ID");
+```
+
+#### 4. Get the project details:
+```java
+Project project = projectApi.getProject("YOUR_PROJECT_ID", "status,quote.totalAmount");
+```
diff --git a/articles/LCPublicAPI/docs/api-clients/java/Java-Samples.md b/articles/LCPublicAPI/docs/api-clients/java/Java-Samples.md
new file mode 100644
index 0000000..f1af7f6
--- /dev/null
+++ b/articles/LCPublicAPI/docs/api-clients/java/Java-Samples.md
@@ -0,0 +1,280 @@
+# Trados Cloud Platform SDK Samples for Java
+
+## Console Application Sample
+
+The console application sample is available for download on [GitHub](https://github.com/RWS/language-cloud-public-api-samples/tree/main/Java/PublicApi.Sample.Console.Java).
+
+The sample contains three examples of how to instantiate and work with an API client provided by the Trados Cloud Platform SDK. You can either use the supplied provider or handle the authentication yourself:
+
+#### 1. Instantiating a client using service credentials
+
+You can instantiate a client using the provided `LanguageCloudClientProvider.builder()` pattern.
+
+This method requires you to provide a `ServiceCredentials` object containing your `clientID`, `clientSecret`, and `tenant`. *See the [Authentication](../../../docs/Authentication.md) page for more details.*
+
+```java
+import com.rws.lt.lc.publicapi.sdk.api.GroupApi;
+import com.rws.lt.lc.publicapi.sdk.auth.ServiceCredentials;
+import com.rws.lt.lc.publicapi.sdk.client.LanguageCloudClientProvider;
+import com.rws.lt.lc.publicapi.sdk.model.Group;
+import com.rws.lt.lc.publicapi.sdk.model.ListGroupsResponse;
+
+import java.util.stream.Collectors;
+...
+
+//instantiate the credentials
+ServiceCredentials serviceCredentials = new ServiceCredentials("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET", "YOUR_TENANT_ID");
+
+// instantiate the LanguageCloudClientProvider
+LanguageCloudClientProvider languageCloudClientProvider = LanguageCloudClientProvider
+ .builder()
+ .withRegion("eu") // optional (default is "eu")
+ .withServiceCredentials(serviceCredentials)
+ .build();
+
+// instantiate the client
+GroupApi groupApi = languageCloudClientProvider.getGroupClient();
+
+// use the client
+ListGroupsResponse groupsResponse = groupApi.listGroups(new GroupApi.ListGroupsQueryParams());
+System.out.println("Groups:");
+System.out.println(
+ groupsResponse.getItems().stream()
+ .map(Group::getName)
+ .collect(Collectors.joining("\n")));
+```
+
+*\*Using this method, a unique TraceID will be generated for each request.*
+
+
+
+> #### Info
+>
+> Make sure you always keep your credentials safe.
+
+
+#### 2. Instantiating a client using context scoping
+
+This method allows you to make API calls with multiple different service credentials using the same client instance.
+
+We provide an `LCContext` which exposes scoping options. You can use this to scope your API calls in different contexts. The sample contains an example with two different service credentials:
+
+```java
+import com.rws.lt.lc.publicapi.sdk.api.UserApi;
+import com.rws.lt.lc.publicapi.sdk.auth.ServiceCredentials;
+import com.rws.lt.lc.publicapi.sdk.client.LanguageCloudClientProvider;
+import com.rws.lt.lc.publicapi.sdk.context.ContextKeys;
+import com.rws.lt.lc.publicapi.sdk.context.LCContext;
+import com.rws.lt.lc.publicapi.sdk.model.ListUsersResponse;
+import com.rws.lt.lc.publicapi.sdk.model.User;
+
+import java.util.stream.Collectors;
+...
+
+// define credentials for your first user
+ServiceCredentials credentials_1 = new ServiceCredentials("YOUR_CLIENT_ID_1", "YOUR_CLIENT_SECRET_1", "YOUR_TENANT_ID_1");
+
+// define credentials for your second user
+ServiceCredentials credentials_2 = new ServiceCredentials("YOUR_CLIENT_ID_2", "YOUR_CLIENT_SECRET_2", "YOUR_TENANT_ID_2");
+
+// instantiate the LanguageCloudClientProvider
+LanguageCloudClientProvider languageCloudClientProvider_contextAuth = LanguageCloudClientProvider
+ .builder()
+ .withRegion("eu") // optional (default is "eu")
+ .build();
+
+// instantiate the client without credentials
+UserApi userApi = languageCloudClientProvider_contextAuth.getUserClient();
+
+
+Runnable listUsersExecutable = () -> {
+ ListUsersResponse usersResponse = userApi.listUsers(new UserApi.ListUsersQueryParams());
+ System.out.println(LCContext.getFromLCContext(ContextKeys.TRACE_ID_KEY) + " >> Users for tenant " + LCContext.getFromLCContext(ContextKeys.TENANT_ID_KEY) + " are:");
+ System.out.println(usersResponse.getItems().stream().map(User::getId).collect(Collectors.joining("\n")));
+};
+
+// create a context scope and execute inside with tenant 1
+LCContext.executeInScope(listUsersExecutable, serviceCredentials1, "trace-id-1");
+
+System.out.println("--------------------------------------------------");
+// create a context scope and execute inside with tenant 2
+LCContext.executeInScope(listUsersExecutable, serviceCredentials2, "trace-id-2");
+```
+
+#### 3. Instantiating a client with App service credentials
+
+This method allows you to make an API call from an App for different tenants using the same client instance. See more at [Extensibility Docs](https://eu.cloud.trados.com/lc/extensibility-docs/937a747af31a0-concepts#apps).
+
+
+We provide an `LCContext` which exposes scoping options. You can use this to scope your API calls in different contexts. The sample contains an example with an App installed in multiple tenants:
+
+```java
+import com.rws.lt.lc.publicapi.sdk.api.UserApi;
+import com.rws.lt.lc.publicapi.sdk.auth.ServiceCredentials;
+import com.rws.lt.lc.publicapi.sdk.client.LanguageCloudClientProvider;
+import com.rws.lt.lc.publicapi.sdk.context.ContextKeys;
+import com.rws.lt.lc.publicapi.sdk.context.LCContext;
+import com.rws.lt.lc.publicapi.sdk.model.ListUsersResponse;
+import com.rws.lt.lc.publicapi.sdk.model.User;
+
+import java.util.stream.Collectors;
+...
+
+//instantiate the credentials
+ServiceCredentials serviceCredentials = new ServiceCredentials("YOUR_CLIENT_ID_1", "YOUR_CLIENT_SECRET_1");
+
+// instantiate the LanguageCloudClientProvider
+LanguageCloudClientProvider languageCloudClientProvider_contextAuth = LanguageCloudClientProvider
+ .builder()
+ .withRegion("eu") // optional (default is "eu")
+ .withServiceCredentials(serviceCredentials)
+ .build();
+
+// instantiate the client without credentials
+UserApi userApi = languageCloudClientProvider_contextAuth.getUserClient();
+
+
+Runnable listUsersExecutable = () -> {
+ ListUsersResponse usersResponse = userApi.listUsers(new UserApi.ListUsersQueryParams());
+ System.out.println(LCContext.getFromLCContext(ContextKeys.TRACE_ID_KEY) + " >> Users for tenant " + LCContext.getFromLCContext(ContextKeys.TENANT_ID_KEY) + " are:");
+ System.out.println(usersResponse.getItems().stream().map(User::getId).collect(Collectors.joining("\n")));
+};
+
+// create a context scope and execute inside with tenant 1
+LCContext.executeInScope(listUsersExecutable, TENANT_VALUE_1, "trace-id-1");
+
+System.out.println("--------------------------------------------------");
+// create a context scope and execute inside with tenant 2
+LCContext.executeInScope(listUsersExecutable, TENANT_VALUE_2, "trace-id-2");
+
+```
+#### 4. Instantiating a client using custom authentication
+
+If you want complete control over client authentication, you can provide a `CustomServiceAuthenticationHandler`:
+
+```java
+import com.rws.lt.lc.publicapi.sdk.api.ProjectApi;
+import com.rws.lt.lc.publicapi.sdk.auth.AuthenticationService;
+import com.rws.lt.lc.publicapi.sdk.auth.CustomServiceAuthenticationHandler;
+import com.rws.lt.lc.publicapi.sdk.auth.ServiceCredentials;
+import com.rws.lt.lc.publicapi.sdk.client.LanguageCloudClientProvider;
+import com.rws.lt.lc.publicapi.sdk.model.ListProjectsResponse;
+
+import java.util.List;
+import java.util.UUID;
+...
+
+AuthenticationService authenticationService = AuthenticationService.getInstance();
+
+CustomServiceAuthenticationHandler customServiceAuthenticationHandler = new CustomServiceAuthenticationHandler(authenticationService) {
+ @Override
+ public ServiceCredentials getServiceCredentials() {
+ return new ServiceCredentials(CLIENT_ID, CLIENT_SECRET);
+ }
+
+ @Override
+ public String getTraceId() {
+ return UUID.randomUUID().toString();
+ }
+
+ @Override
+ public String getTenantId() {
+ return TENANT_VALUE;
+ }
+};
+
+LanguageCloudClientProvider languageCloudCustomClientProvider = LanguageCloudClientProvider
+ .builder()
+ .withRegion("eu") // optional (default is "eu")
+ .withRequestInterceptors(List.of(customServiceAuthenticationHandler))
+ .build();
+
+// instantiate the client
+ProjectApi projectApi = languageCloudCustomClientProvider.getProjectClient();
+
+// use the client
+ListProjectsResponse projectsResponse = projectApi.listProjects(new ProjectApi.ListProjectsQueryParams());
+System.out.println("Projects:");
+System.out.println(projectsResponse.getItems());
+```
+
+
+ +## Web API Sample +The web API sample is available for download on [GitHub](https://github.com/RWS/language-cloud-public-api-samples/tree/main/Java/PublicApi.Sample.Web.Java). + +The sample contains two examples of how to instantiate and work with an API client provided by the Trados Cloud Platform SDK for Java: + +- *If you want to use the provided authentication mechanism, create a custom handler that inherits from `CustomServiceAuthenticationHandler`.* + +In our example, we created the `CustomAuthenticationHandler` class, which inherits from `CustomServiceAuthenticationHandler`. The `CustomServiceAuthenticationHandler` class already provides an authentication mechanism. + +We have overridden the `getServiceCredentials`, `getTraceId`, and `getTenantId` methods and provided our implementations, as these will be called by `CustomAuthenticationHandler`: + +```java +// Provide your implementation. A possible example can be: +@Override +public ServiceCredentials getServiceCredentials() { + return repository.getServiceCredentialsById(getCurrentUser().getUserId()); +} + +// serviceCredentials may or may not be bound to a tenant +@Override +public String getTenantId() { + return repository.getServiceCredentialsById(getCurrentUser().getUserId()).getTenantId(); + // or + // return repository.getTenantForUserId(getCurrentUser().getUserId()); +} + +@Override +public String getTraceId() { + return UUID.randomUUID().toString(); +} + +private User getCurrentUser() { + Authentication authentication = SecurityContextHolder.getContext().getAuthentication(); + return (User) authentication.getPrincipal(); +} +``` + +We registered an instance of `LanguageCloudClientProvider` as a bean in the `ConfigClass` class and created beans for all exposed API clients: +```java +// the LanguageCloudClientProvider instance +@Bean +public LanguageCloudClientProvider getPublicApiClient(CustomAuthenticationHandler customAuthenticationHandler) { + return LanguageCloudClientProvider.builder() + .withRegion("eu") // optional (default is "eu") + .withRequestInterceptors(List.of(customAuthenticationHandler)).build(); +} + +//the AccountApi bean +@Bean +public AccountApi getAccountApi(LanguageCloudClientProvider languageCloudClientProvider) { + return languageCloudClientProvider.getAccountClient(); +} +``` + +We can then use the registered client in the controller (or any other class resolved through Dependency Injection): + +```java +@RestController +public class AccountController extends ResponseEntityExceptionHandler { + + @Autowired + private AccountApi accountApi; + + @GetMapping("/getAccounts/{userId}") + public List listAccounts(@PathVariable("userId") int userId) {
+ User user = new User(userId);
+ Authentication authentication = new UsernamePasswordAuthenticationToken(user, null);
+ SecurityContext sc = SecurityContextHolder.getContext();
+ sc.setAuthentication(authentication);
+
+ ListMyAccountsResponse listMyAccountsResponse = accountApi.listMyAccounts();
+
+ return listMyAccountsResponse.getItems();
+ }
+}
+```
+
+
diff --git a/articles/LCPublicAPI/docs/api-clients/net/NET-Client.md b/articles/LCPublicAPI/docs/api-clients/net/NET-Client.md
new file mode 100644
index 0000000..7c8a51d
--- /dev/null
+++ b/articles/LCPublicAPI/docs/api-clients/net/NET-Client.md
@@ -0,0 +1,180 @@
+# .NET Client
+
+.NET Client is a collection of API clients structured in accordance with the API documentation, meaning each section will have its own client.
+
+It is built on .NET Standard 2.0. For compatibility information, see the [Microsoft implementation support page](https://docs.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0#net-implementation-support).
+
+
+> The .NET Client library is auto-generated from the current API contracts, so any updates to the contract will reflect as changes in the SDK client. Minor version increases do not guarantee backwards compatibility.
+
+## Installation
+
+You can add the .NET Client library to your project from [Rws.LanguageCloud.Sdk NuGet](https://www.nuget.org/packages/Rws.LanguageCloud.Sdk).
+
+## Usage
+
+We will take the project creation flow as an example to show how the API clients can be used.
+
+#### 1. Add the `using` statement:
+
+```csharp
+using Rws.LanguageCloud.Sdk;
+```
+#### 2. Get a new Project client:
+
+First step is to get an instance of `LanguageCloudClientProvider`. The constructor has 2 optional parameters `region` and `baseUrl`. When using the constructor with no parameters, the provider will be instantiated for the `eu` region. Any clients created by this instance will be calling on the EU region. If you need to specify a different region, instantiate it with the `region` specified. Region is specified by it's code, ex: `eu`, `ca`, etc,
+
+The second optional parameter `baseUrl` is used if you want to test the client with a mock server.
+
+You can request a new API client from the `LanguageCloudClientProvider` instance. There are 3 methods exposed for each client:
+
+ - ```csharp
+ GetProjectClient (ServiceCredentials credentials, params DelegatingHandler[] handlers)
+ This method accepts a `ServiceCredentials` object which will be used to perform authentication using an implicit authentication handler. Custom handlers are also accepted.
+
+ - ```csharp
+ GetProjectClientNoAuth (params DelegatingHandler[] handlers)
+ This method accepts custom handlers and does not perform any authentication implicitly. You must handle authentication in a custom handler when using this method.
+
+ - ```csharp
+ GetProjectClient (params DelegatingHandler[] handlers)`
+ This method accepts custom handlers and can be used to authenticate using scoping/context.
+
+
+> On each call to GetProjectClient or GetProjectClientNoAuth a new instance is created. That means a new HttpClient for each one. You should avoid having more than one instance - and should share that using Dependency Injection or other mechanisms.
+
+In this example we will use the credentials options to get a new Project Client and we won't supply any additional handlers:
+
+```csharp
+
+ // define credentials
+ServiceCredentials credentials = new ServiceCredentials("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET", "YOUR_TENANT_ID");
+
+// instantiate the provider
+var clientProvider = new LanguageCloudClientProvider("eu");
+
+// instantiate the client
+var projectClient = clientProvider.GetProjectClient(credentials);
+```
+
+Since each client exposes its available operations according to the API documentation, you can find the GetProject operation in the Project client.
+
+#### 3. Create a new project:
+
+```csharp
+var projectCreateRequest = new ProjectCreateRequest
+{
+ Name = "YOUR_PROJECT_NAME",
+ DueBy = DateTime.Now.AddDays(7),
+ ProjectTemplate = new ObjectIdRequest
+ {
+ Id = "YOUR_PROJECT_TEMPLATE_ID"
+ }
+};
+
+var projectCreateResponse = await projectClient.CreateProjectAsync(projectCreateRequest);
+```
+
+
+#### 4. Attach a source file to the project via the SourceFiles client:
+
+Projects that do not contain source files cannot be started.
+
+First, `GET` the SourceFiles client:
+
+```csharp
+ // define credentials
+ServiceCredentials credentials = new ServiceCredentials("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET", "YOUR_TENANT_ID");
+
+// instantiate the provider
+var clientProvider = new LanguageCloudClientProvider("eu");
+
+// instantiate the client
+var sourceFileClient = clientProvider.GetSourceFileClient(credentials);
+```
+Then, attach a source file to the project:
+
+```csharp
+using (FileStream SourceStream = File.Open("YOUR_TEXT_SOURCE_FILE", FileMode.Open))
+{
+ FileParameter file = new FileParameter(SourceStream, "YOUR_TEXT_SOURCE_FILE", "text/plain");
+
+ SourceFileRequest properties = new SourceFileRequest
+ {
+ Name = "YOUR_TEXT_SOURCE_FILE",
+ Role = SourceFileRequestRole.Translatable,
+ Type = SourceFileRequestType.Native,
+ Language = "en-US",
+ };
+
+ await sourceFileClient.AddSourceFileAsync("YOUR_PROJECT_ID", properties ,file);
+}
+```
+
+#### 5. Start the project:
+
+```csharp
+await projectClient.StartProjectAsync("YOUR_PROJECT_ID");
+```
+
+#### 6. `GET` the project details using the Project client:
+```csharp
+var myProject = await projectClient.GetProjectAsync("YOUR_PROJECT_ID");
+```
+
+#### 7. (Optional) Supply the `fields` parameter and retrieve specific data about the project:
+
+```csharp
+var myProject = await projectClient.GetProjectAsync("YOUR_PROJECT_ID", "status,quote.totalAmount");
+```
+
+
+## Error handling
+The SDK may throw the following exceptions:
+
+Exception Type | Exception description
+---------|----------
+**ModelDeserializationException** | Response could not be deserialized
+**ApiUnauthorizedException** | The user could not be identified
+**ApiPermissionException** | The user does not have permission to access this resource
+**ApiForbiddenException** | The user does not have access to the resource
+**ApiErrorException** | Something went wrong when performing the action
+**ApiConnectionException** | Something went wrong when connecting to the server
+**[TaskCanceledException](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.taskcanceledexception?view=netstandard-2.0)** | A timeout occurred. This exception is provided by Microsoft in System.Threading.Tasks namespace.
+
+All these exceptions inherit from `ApiClientException` and provide an `ApiErrorResponse` object which contains details about the error that occurred.
+You may use this object in combination with the ErrorCode class to perform exception handling:
+
+```csharp
+try
+{
+ // your API Client interaction code
+}
+catch (ApiForbiddenException e)
+{
+ // handle exception...
+}
+catch (ApiUnauthorizedException e)
+{
+ // handle exception...
+}
+// we can limit what specific API Errors we want to handle:
+catch (ApiErrorException e) where (e.ApiError.ErrorCode == ErrorCodes.MaxSize)
+{
+ // One of the fields in your call, has value higher then allowed
+ // We get the summary message:
+ string summary = e.ApiError.Message;
+
+ // Next we can get the list of fields that failed validation:
+ foreach (var detail in e.ApiError.Details)
+ {
+ // TODO
+ }
+}
+```
+Additionally, the `ApiErrorResponse.Details` object contains specific error data that may be useful.
+
+
+### Error Codes
+
+The `ErrorCodes` static class provides a series of constant strings suitable to be used for error code validation. Please check the Rest API documentation for specific codes any endpoint may return and what that value means in the specific context.
diff --git a/articles/LCPublicAPI/docs/api-clients/net/Net-Samples.md b/articles/LCPublicAPI/docs/api-clients/net/Net-Samples.md
new file mode 100644
index 0000000..92cd0cf
--- /dev/null
+++ b/articles/LCPublicAPI/docs/api-clients/net/Net-Samples.md
@@ -0,0 +1,232 @@
+# Trados Cloud Platform SDK Samples for .NET
+
+This document is designed to help developers get started with the Trados Cloud Platform SDK in .NET applications. You'll find practical sample code and clear guidance for instantiating API clients using credentials, context scoping, or custom handlers. The examples also show how to integrate the SDK into ASP.NET Web API projects, including tips for dependency injection and custom authentication. Use these samples to quickly implement Trados Cloud Platform features in your console or web API projects.
+
+Here is some guidance to help you decide which sample to follow:
+
+- If your application targets a single tenant, the quickest way to get started is the [Instantiating a client using credentials (single tenant)](#instantiating-a-client-using-credentials-single-tenant) sample.
+- For background processes that must handle multiple tenants, see the [Instantiating a client using context scoping](#instantiating-a-client-using-context-scoping) sample.
+- If you're building a multi-tenant web application and need Dependency Injection that depends on the current user, start with the [Web API Dependency Injection Sample](#web-api-dependency-injection-sample).
+- If you require a custom authentication flow, the SDK supports supplying your own handler — see [Instantiating a client using a custom handler](#instantiating-a-client-using-a-custom-handler).
+
+## Console Application Sample
+
+The console application sample is available for download on [GitHub](https://github.com/RWS/language-cloud-public-api-samples/tree/main/.Net/PublicApi.Sample.Console).
+
+It contains three examples of how to instantiate and work with an API client provided by the Trados Cloud Platform SDK. You can either use the supplied provider, or handle the client instantiation on your own:
+
+### Instantiating a client using credentials (single tenant)
+
+You can instantiate a client using the supplied `LanguageCloudClientProvider` class. This method requires you to provide a `ServiceCredentials` object, which contains your `clientID`, `clientSecret` and the `tenant`. *See the [Authentication](../../../docs/Authentication.md) page for more details.*
+
+```csharp
+using Rws.LanguageCloud.Sdk;
+
+...
+
+// define credentials
+ServiceCredentials credentials = new ServiceCredentials("client-id", "client-secret", "tenant");
+
+// instantiate the provider
+var clientProvider = new LanguageCloudClientProvider("eu");
+
+// Instantiate the client
+var projectClient = clientProvider.GetProjectClient(credentials);
+
+// use the client
+var projectsResponse = await projectClient.ListProjectsAsync();
+```
+
+*Using this method, a unique TraceId will be generated for each request.*
+
+
+
+> #### Info
+>
+> Make sure you always keep your credentials safe.
+
+### Instantiating a client using context scoping
+
+This method lets you make API calls as two different users using the same client instance.
+
+We provide an `ApiClientContext` which exposes scoping options. You can use it to scope API calls for different users; the sample shows an example with two users:
+
+```csharp
+using Rws.LanguageCloud.Sdk;
+using Sdl.ApiClientSdk.Core;
+...
+
+// define credentials for your first user
+ServiceCredentials credentials_1 = new ServiceCredentials("client-id-1", "client-secret-1", "tenant-1");
+
+// define credentials for your second user
+ServiceCredentials credentials_2 = new ServiceCredentials("client-id-2", "client-secret-2", "tenant-2");
+
+// instantiate the provider
+var clientProvider = new LanguageCloudClientProvider("eu");
+
+// instantiate the client without credentials
+var projectClient = clientProvider.GetProjectClient();
+
+// create a context scope and use the client. You can also provide your own traceId
+using (ApiClientContext.BeginScope(new LCContext(credentials_1, "trace-id-1")))
+{
+ // the client will use the credentials_1 and "trace-id-1" defined in the scope
+ var projectsResponse = await projectClient.ListProjectsAsync();
+}
+
+// create a context scope and use the client. You can also provide your own traceId
+using (ApiClientContext.BeginScope(new LCContext(credentials_2, "trace-id-2")))
+{
+ // the client will use the credentials_2 and "trace-id-2" defined in the scope
+ var projectsResponse = await projectClient.ListProjectsAsync();
+}
+```
+
+### Instantiating a client using a custom handler
+
+If you would like to control the authentication process, you should use the method which does not perform any authentication implicitly. You can provide your own authentication implementation via a custom handler:
+
+```csharp
+// define credentials
+ServiceCredentials credentials = new ServiceCredentials("client-id", "client-secret", "tenant");
+
+// get an authentication handler
+ServiceAuthenticationHandler handler = new ServiceAuthenticationHandler(credentials);
+
+// instantiate the provider
+var clientProvider = new LanguageCloudClientProvider("eu");
+
+// get a client with the custom handler
+var client = clientProvider.GetProjectClientNoAuth(handler);
+
+// use the client
+var projectsResponse = await projectClient.ListProjectsAsync();
+
+```
+
+## Web API Dependency Injection Sample
+
+The web API sample is available for download on [GitHub](https://github.com/RWS/language-cloud-public-api-samples/tree/main/.Net/PublicApi.WebApiSample).
+
+It contains an example of how to instantiate and work with an API client provided by the Trados Cloud Platform SDK for ASP .Net.
+
+> If you want to use the provided authentication mechanism, a custom handler can be created, which must inherit from `LCCustomAuthenticationHandler`.
+
+> If you want to handle authentication and tracing on you own, you could implement your own `DelegatingHandler`.
+
+In our example, we've created the `LcHandler` class, which inherits from `LCCustomAuthenticationHandler`. The `LCCustomAuthenticationHandler` class already provides an authentication mechanism. We've overridden the `GetServiceCredentials` and `GetTraceId` methods and provided our own implementations; these will be called by `LCCustomAuthenticationHandler`:
+
+```csharp
+// Provide your own implementation. A possible example:
+protected override ServiceCredentials GetServiceCredentials()
+{
+ int accountId = int.Parse(context.HttpContext.User.Claims.Single(x => x.Type.Equals("aid")).Value);
+ ServiceCredentials credentials = repository.GetServiceCredentialsById(accountId);
+
+ return credentials;
+}
+
+...
+
+// Provide your own implementation. A possible example:
+protected override string GetTraceId()
+{
+ return DateTimeOffset.UtcNow.ToString();
+}
+```
+
+We'll need a bit of custom magic to make sure dependency injection works correctly for multi-region. We'll create a custom Factory to provide our clients. An example implementation would be a factory class to provide a per region factory. We'll make sure to have all instances initialized only once, to avoid problems:
+
+```csharp
+
+ class RegionClientContainerFactory
+ {
+ private readonly LanguageCloudClientProvider _languageCloudClientProvider;
+ private readonly IServiceProvider _serviceProvider;
+
+ private IAccountClient _accountClient;
+
+
+ public RegionClientContainerFactory(string region, IServiceProvider serviceProvider)
+ {
+ _languageCloudClientProvider = new LanguageCloudClientProvider(region);
+ _serviceProvider = serviceProvider;
+ }
+
+ public IAccountClient AccountClient {
+ get
+ {
+ // get custom authentication handler
+ LcHandler handler = _serviceProvider.GetRequiredService();
+
+ // ensure account client is instantiated only once
+ return _accountClient ??= _languageCloudClientProvider.GetAccountClient(handler);
+ }
+ }
+ }
+
+ class LanguageCloudClientFactory
+ {
+ private object _lock = new object();
+ private IServiceProvider _serviceProvider;
+
+ ConcurrentDictionary _regionClientContainerFactories = new ConcurrentDictionary();
+
+ LanguageCloudClientFactory(IServiceProvider serviceProvider)
+ {
+ _serviceProvider = serviceProvider;
+ }
+
+ public RegionClientContainerFactory Region(string region)
+ {
+ if (!_regionClientContainerFactories.TryGetValue(region, out RegionClientContainerFactory regionClientContainerFactory))
+ {
+ lock (_lock)
+ {
+ if (!_regionClientContainerFactories.TryGetValue(region, out regionClientContainerFactory))
+ {
+ regionClientContainerFactory = new RegionClientContainerFactory(region, _serviceProvider);
+ _regionClientContainerFactories.TryAdd(region, regionClientContainerFactory);
+ }
+ }
+ }
+
+ return regionClientContainerFactory;
+ }
+ }
+
+```
+
+We register our handler `LcHandler` as a transient service and a Factory class with factory, in the `Startup` class:
+
+```csharp
+// Handlers should be registered as transient
+services.AddTransient();
+
+// Register the LanguageCloudClientFactory as a singleton. Resolve the handler from the provider when needed.
+services.AddSingleton(provider => new LanguageCloudClientFactory(provider.GetRequiredService()));
+```
+
+We can then use the registered client in the controller (or any other class resolved through Dependency Injection):
+
+```csharp
+public class LanguageCloudApiSampleController : ControllerBase
+{
+ LanguageCloudClientFactory _factory;
+
+ // inject the client via constructor
+ public LanguageCloudApiSampleController(LanguageCloudClientFactory clientFactory)
+ {
+ this._factory = clientFactory;
+ }
+
+ ...
+
+ // make an API call using a client and the user identity from HttpContext
+ var accountClient = _factory.Region("eu").AccountClient;
+ var accounts = await accountClient.ListMyAccountsAsync();
+
+ ...
+}
+```
diff --git a/articles/LCPublicAPI/docs/termbase/Termbase-entries.md b/articles/LCPublicAPI/docs/termbase/Termbase-entries.md
new file mode 100644
index 0000000..7f40137
--- /dev/null
+++ b/articles/LCPublicAPI/docs/termbase/Termbase-entries.md
@@ -0,0 +1,286 @@
+# Termbase entries
+
+
+## Creating a termbase entry
+
+A termbase entry can be created by making a `POST` request to the [`/termbases/{termbaseId}/entries`](../../api/Public-API.v1-fv.html#/operations/CreateTermbaseEntry) endpoint.
+
+Request example for an entry using language code `en`: `POST /termbases/61b70c0775ed5f14d8190fab/entries`
+```json
+{
+ "humanReadableId": "LC000000000000000000000001",
+ "languages": [
+ {
+ "language": {
+ "languageCode": "en"
+ },
+ "terms": [
+ {
+ "text": "Simple Entry"
+ }
+ ]
+ }
+ ]
+}
+```
+
+The `humanReadableId` is optional and can be any value. If it's not specified it will be autogenerated. The autogenerated value is not guaranteed to adhere to any specific format.
+
+### Creating a termbase entry with cross-references
+
+A termbase entry can contain cross-references. These references can have the following types: `entry`, `term` or `external`, representing the associated element type. For the `external` type you can use as value external URLs.
+For the `entry` type, the `entryId` needed can be retrieved by pressing the `Copy Entry ID` button on the user interface for the entry that should be referred.
+
+ See below an example of how to add a cross-reference of 'entry' type in the user interface:
+
+
+
+
+Equivalent cross-references can be created via API by using `fieldValueLinks` objects. In the next example, `value` is an HTML snippet, where the identifier provided in the value `LC61b7264d877e04258abc7da8` (note that it appears twice in the snippet) is the value from the `humanReadableId` field. This is the same for the UI example, as the "Copy Entry ID" button copies the `humanReadableId`, for the entry, into clipboard.
+
+Request example: `POST /termbases/61b70c0775ed5f14d8190fab/entries`
+```json
+{
+ "humanReadableId": "LC000000000000000000000001",
+ "languages": [
+ {
+ "language": {
+ "languageCode": "en"
+ },
+ "terms": [
+ {
+ "text": "New Simple entry",
+ "termbaseFieldValues": [
+ {
+ "termbaseFieldId": "61b71de9877e04258abc7d9f",
+ "value": "This is an new entry reference<\/a>",
+ "fieldValueLinks": [
+ {
+ "type": "entry",
+ "value": "This is a new entry reference"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ ]
+}
+```
+
+> Note: The `termbaseFieldId` should match the field `id` from the termbase.
+
+Response example:
+```json
+{
+ "id": "61b73e4475ed5f14d81ae5e7",
+ "languages": [
+ {
+ "id": "61b73e4475ed5f14d81ae5e8",
+ "language": {
+ "languageCode": "en",
+ "englishName": "English"
+ }
+ }
+ ]
+}
+```
+
+Postman example:
+
+
+
+
+
+
+## Updating a termbase entry
+
+A termbase entry can be updated by making a `PUT` request to the [`/termbases/{termbaseId}/entries/{entryId}`](../../api/Public-API.v1-fv.html#/operations/UpdateTermbaseEntry) endpoint.
+
+The update action changes the entire structure of an entry, it doesn't only update the terms specified in the request body. The terms that are not specified, are deleted. If some terms should not be updated, their structure must be send in the request as it currently is.
+
+The cross-references between terms can be updated using `fieldValueLinks` objects. Postman example:
+
+
+
+
+Request example: `PUT /termbases/61b70c0775ed5f14d8190fab/entries/61b73e4475ed5f14d81ae5e7`
+```json
+{
+ "humanReadableId": "LC000000000000000000000002",
+ "languages": [
+ {
+ "id": "61b73e4475ed5f14d81ae5e8",
+ "language": {
+ "languageCode": "en"
+ },
+ "terms": [
+ {
+ "id": "61b73e4475ed5f14d81ae5e9",
+ "text": "Simple Entry Updated",
+ "termbaseFieldValues": [
+ {
+ "id": "61b73e4475ed5f14d81ae5ea",
+ "termbaseFieldId": "61b71de9877e04258abc7d9f",
+ "value": "This is an updated entry reference<\/a>",
+ "fieldValueLinks": [
+ {
+ "type": "entry",
+ "value": "This is an updated entry reference"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ ]
+}
+```
+
+
+## Retrieving a termbase entry
+
+A termbase entry can be retrieved by making a `GET` request to the [`/termbases/{termbaseId}/entries/{entryId}`](../../api/Public-API.v1-fv.html#/operations/GetTermbaseEntry) endpoint. Postman example:
+
+
+
+
+Request example: `GET /termbases/61b70c0775ed5f14d8190fab/entries/61b73e4475ed5f14d81ae5e7?fields=humanReadableId,languages.terms,languages.terms.termbaseFieldValues`
+
+Response example:
+```json
+{
+ "id": "61b73e4475ed5f14d81ae5e7",
+ "humanReadableId": "LC000000000000000000000002",
+ "languages": [
+ {
+ "id": "61b73e4475ed5f14d81ae5e8",
+ "language": {
+ "languageCode": "en",
+ "englishName": "English"
+ },
+ "terms": [
+ {
+ "id": "61b73e4475ed5f14d81ae5e9",
+ "text": "Simple Entry Updated",
+ "termbaseFieldValues": [
+ {
+ "id": "61b73e4475ed5f14d81ae5ea",
+ "name": "Term level field",
+ "termbaseFieldId": "61b71de9877e04258abc7d9f",
+ "value": "This is an updated entry reference"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+}
+```
+
+
+## Retrieving the list of termbase entries
+
+You can retrieve the list of termbase entries by making a `GET` request to the [`/termbases/{termbaseId}/entries`](../../api/Public-API.v1-fv.html#/operations/ListTermbaseEntries) endpoint.
+
+Request example: `GET /termbases/61b70c0775ed5f14d8190fab/entries?fields=humanReadableId,languages.terms,languages.terms.termbaseFieldValues`
+
+Response example:
+```json
+{
+ "items": [
+ {
+ "id": "61b725aa75ed5f14d8190fea",
+ "humanReadableId": "LC61b725aa75ed5f14d8190fee",
+ "languages": [
+ {
+ "id": "61b725aa75ed5f14d8190feb",
+ "language": {
+ "languageCode": "en",
+ "englishName": "English"
+ },
+ "terms": [
+ {
+ "id": "61b725aa75ed5f14d8190fed",
+ "text": "Simple entry",
+ "termbaseFieldValues": [
+ {
+ "id": "61b733ee75ed5f14d81a8602",
+ "name": "Term level field",
+ "termbaseFieldId": "61b71de9877e04258abc7d9f",
+ "value": "This is an entry reference"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "61b7264d877e04258abc7da5",
+ "humanReadableId": "LC61b7264d877e04258abc7da8",
+ "languages": [
+ {
+ "id": "61b7264d877e04258abc7da6",
+ "language": {
+ "languageCode": "en",
+ "englishName": "English"
+ },
+ "terms": [
+ {
+ "id": "61b7264d877e04258abc7da7",
+ "text": "Entry reference",
+ "termbaseFieldValues": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "id": "61b73e4475ed5f14d81ae5e7",
+ "humanReadableId": "LC000000000000000000000002",
+ "languages": [
+ {
+ "id": "61b73e4475ed5f14d81ae5e8",
+ "language": {
+ "languageCode": "en",
+ "englishName": "English"
+ },
+ "terms": [
+ {
+ "id": "61b73e4475ed5f14d81ae5e9",
+ "text": "Simple Entry Updated",
+ "termbaseFieldValues": [
+ {
+ "id": "61b73e4475ed5f14d81ae5ea",
+ "name": "Term level field",
+ "termbaseFieldId": "61b71de9877e04258abc7d9f",
+ "value": "This is an updated entry reference"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "itemCount": 3
+}
+```
+
+
+## Deleting a termbase entry
+
+A termbase entry can be deleted by making a `DELETE` request to the [`/termbases/{termbaseId}/entries/{entryId}`](../../api/Public-API.v1-fv.html#/operations/DeleteTermbaseEntry) endpoint.
+
+Request example: `DELETE /termbases/61b70c0775ed5f14d8190fab/entries/61b73e4475ed5f14d81ae5e7`
+
+
+## Deleting all termbase entries
+
+All termbase entries can be deleted by making a `DELETE` request to the [`/termbases/{termbaseId}/entries`](../../api/Public-API.v1-fv.html#/operations/DeleteTermbaseEntries) endpoint.
+
+Request example: `DELETE /termbases/61b70c0775ed5f14d8190fab/entries`
+
diff --git a/articles/LCPublicAPI/docs/termbase/Termbase-import-export.md b/articles/LCPublicAPI/docs/termbase/Termbase-import-export.md
new file mode 100644
index 0000000..d324065
--- /dev/null
+++ b/articles/LCPublicAPI/docs/termbase/Termbase-import-export.md
@@ -0,0 +1,66 @@
+# Termbase import and export
+
+
+## Importing a termbase
+
+The following termbase formats are supported: `tbx` and `xml`.
+
+> Before importing a termbase, make sure you already created one using the [Create Termbase](../../api/Public-API.v1-fv.html#/operations/CreateTermbase) endpoint. Only empty termbases support importing content.
+
+To import a `tbx` or an `xml` termbase, perform a `POST` request to the [Import Termbase](../../api/Public-API.v1-fv.html#/operations/ImportTermbase) endpoint and provide the `termbaseId` and the termbase file. Optionally, you can specify two import settings via query parameters:
+
+1. `duplicateEntriesStrategy` - It determines how the duplicate entries will be handled and it can have one of the following values:
+
+ - `ignore` The content of the current entry with the same identifier will be kept and the new entry will be ignored.
+
+ - `merge` The content of the current entry with the same identifier will be merged into the imported entry. If the identifier is not provided, the content will be merged by text.
+
+ - `override` The content of the current entry with the same identifier will be replaced by the imported entry.
+
+> If `duplicateEntriesStrategy` is not sent, the default behavior will be `override`.
+
+
+2. `strictImport` - It specifies if the entries are imported only into the exact language that matches your imported file and it can have one of the following values:
+
+ - `true` The import will only occur if the language in your import file matches exactly a language in your termbase.
+
+ - `false` The import will occur even if there are non-matching languages, by trying to match them to a relevant main language or language variant, if available.
+
+> If `strictImport` is not sent, the default behavior will be `true`.
+
+If the import is successful, you will get back an `importId` and the import `status`.
+
+
+
+
+
+
+## Polling a termbase import
+Some imports may take longer, depending on the size of the termbase.
+
+To check if the import finished, you can perform a `GET` request to the [Poll Termbase Import](../../api/Public-API.v1-fv.html#/operations/PollTermbaseImport) endpoint and supply the `importId` and the `termbaseId`. The import is complete when the status is `done`.
+
+
+
+## Exporting a termbase
+The following termbase formats are supported: `tbx` and `xml`.
+
+To export a `tbx` or an `xml` termbase, perform a `POST` request to the [Export Termbase](../../api/Public-API.v1-fv.html#/operations/ExportTermbase) endpoint and provide the `termbaseId`.
+Optionally, you can specify in body, one of the two allowed formats. If none is specified, the default format will be `tbx`. Also, in the body, it can be specified if the download should be compressed (zipped) or not. By default, this property is set to `false`.
+
+If the export is successful, you will get back an `exportId`, the export `status` and the `downloadUrl` for this. If the export did not succeed, the response will contain an `errorMessage`.
+
+
+
+
+
+## Polling a termbase export
+Some exports may take longer, depending on the size of the termbase.
+
+To check if the export finished, you can perform a `GET` request to the [Poll Termbase Export](../../api/Public-API.v1-fv.html#/operations/PollExportTermbase) endpoint and supply the `exportId` and the `termbaseId`. The export is complete when the status is `done`.
+
+
+
+## Downloading a termbase export
+If an export is completed (the status received at the polling is `done`), it can be downloaded by performing a `GET` request to the [Download Exported Termbase](../../api/Public-API.v1-fv.html#/operations/DownloadExportedTermbase) endpoint. Supply as path parameters the `exportId` and the `termbaseId` and the response will contain the exported termbase file.
+
diff --git a/articles/LCPublicAPI/docs/termbase/Termbase-templates.md b/articles/LCPublicAPI/docs/termbase/Termbase-templates.md
new file mode 100644
index 0000000..05d4441
--- /dev/null
+++ b/articles/LCPublicAPI/docs/termbase/Termbase-templates.md
@@ -0,0 +1,178 @@
+# Termbase templates
+
+
+## Creating a termbase template
+
+A termbase template can be created by making a `POST` request to the [`/termbase-templates`](../../api/Public-API.v1-fv.html#/operations/CreateTermbaseTemplate) endpoint.
+
+> Note: If the `location` is not specified, the template will be created in the root folder.
+
+> Note: When `dataType` is `picklist`, the `pickListValues` array must be filled in or the `allowCustomValues` must be set to true.
+
+Postman example:
+
+
+
+
+Request example: `POST /termbase-templates`
+
+``` json
+{
+ "name": "Simple Termbase template",
+ "description": "A simple termbase template.",
+ "location": "5ebcd778b3d9411141eeff7a",
+ "copyright": "RWS",
+ "languages": [{
+ "languageCode": "en-US"
+ }
+ ],
+ "fields": [{
+ "name": "Entry level field",
+ "description": "A simple entry level field description.",
+ "level": "entry",
+ "dataType": "text",
+ "allowMultiple": true,
+ "isMandatory": false
+ }, {
+ "name": "Language level field",
+ "description": "A simple language level field description.",
+ "level": "language",
+ "dataType": "boolean",
+ "allowMultiple": false,
+ "isMandatory": true
+ }, {
+ "name": "Term level field",
+ "description": "A simple term level field description.",
+ "level": "term",
+ "dataType": "picklist",
+ "pickListValues": [
+ "Option 1",
+ "Option 2",
+ "Option 3"
+ ],
+ "allowCustomValues": false,
+ "allowMultiple": false,
+ "isMandatory": false
+ }
+ ]
+}
+
+```
+
+Response example:
+```json
+{
+ "id": "6156bbc7a638696c7686db7f",
+ "name": "Simple Termbase template",
+ "location": {
+ "id": "5ebcd778b3d9411141eeff7a",
+ "name": "RWS"
+ },
+ "type": "userDefined"
+}
+```
+
+
+## Updating a termbase template
+
+A termbase template can be updated by making a `PUT` request to the [`/termbase-templates/{termbaseTemplateId}`](../../api/Public-API.v1-fv.html#/operations/UpdateTermbaseTemplate) endpoint. Postman example:
+
+
+
+
+Request example: `PUT /termbase-templates/6156bbc7a638696c7686db7f`
+```json
+{
+ "name": "[UPDATED] Simple Termbase template",
+ "description": "A simple termbase template.",
+ "copyright": "RWS",
+ "languages": [{
+ "languageCode": "en-US"
+ }
+ ],
+ "fields": [{
+ "name": "[UPDATED] Entry level field",
+ "description": "A simple entry level field description.",
+ "level": "entry",
+ "dataType": "double",
+ "allowMultiple": true,
+ "isMandatory": false
+ }
+ ]
+}
+```
+
+
+## Retrieving a termbase template
+
+A termbase template can be retrieved by making a `GET` request to the [`/termbase-templates/{termbaseTemplateId}`](../../api/Public-API.v1-fv.html#/operations/GetTermbaseTemplate) endpoint.
+
+Request example: `GET /termbase-templates/6156bbc7a638696c7686db7f?fields=name,location,description,languages,fields`
+
+Response example:
+```json
+{
+ "id": "615ae37ac736b8373d19a717",
+ "name": "[UPDATED] Simple Termbase template",
+ "description": "A simple termbase template.",
+ "location": {
+ "id": "5ebcd778b3d9411141eeff7a",
+ "name": "RWS"
+ },
+ "type": "userDefined",
+ "languages": [{
+ "languageCode": "en-US",
+ "englishName": "English (United States)"
+ }
+ ],
+ "fields": [{
+ "id": "615af63ca638696c7687d7fa",
+ "name": "[UPDATED] Entry level field",
+ "type": "userDefined",
+ "level": "entry",
+ "dataType": "double"
+ }
+ ]
+}
+
+```
+
+
+## Retrieving termbase templates
+
+You can retrieve the list of termbase templates by making a `GET` request to the [`/termbase-templates`](../../api/Public-API.v1-fv.html#/operations/ListTermbaseTemplates) endpoint.
+
+Request example: `GET /termbase-templates?fields=name,description`
+
+Response example:
+```json
+{
+ "items": [{
+ "id": "541823689b976a6a9de11dfe",
+ "name": "Basic",
+ "description": "description",
+ "type": "system"
+ }, {
+ "id": "541823689b976a6a9de11dff",
+ "name": "Advanced",
+ "description": "description",
+ "type": "system"
+ }, {
+ "id": "615ae37ac736b8373d19a717",
+ "name": "[UPDATED] Simple Termbase template",
+ "description": "A simple termbase template.",
+ "type": "userDefined"
+ }
+ ],
+ "itemCount": 3
+}
+```
+
+
+## Deleting termbase templates
+
+A termbase template can be deleted by making a `DELETE` request to the [`/termbase-templates/{termbaseTemplateId}`](../../api/Public-API.v1-fv.html#/operations/DeleteTermbaseTemplate) endpoint.
+
+> Note: You can only delete the `userDefined` termbases.
+
+Request example: `DELETE /termbase-templates/6156bbc7a638696c7686db7f`
diff --git a/articles/LCPublicAPI/docs/termbase/Termbase.md b/articles/LCPublicAPI/docs/termbase/Termbase.md
new file mode 100644
index 0000000..9544536
--- /dev/null
+++ b/articles/LCPublicAPI/docs/termbase/Termbase.md
@@ -0,0 +1,185 @@
+# Termbases
+
+
+## Creating a termbase
+
+A termbase can be created by making a `POST` request to the [`/termbases`](../../api/Public-API.v1-fv.html#/operations/CreateTermbase) endpoint.
+
+You can create a termbase based on an existing termbase template by providing the `termbaseTemplateId`. This will create the termbase using the structure described by the template. For details about termbase templates, see [`Termbase Template`](../../docs/termbase/Termbase-templates.md). Postman example:
+
+
+
+
+
+Request example: `POST /termbases`
+```json
+{
+ "name": "Simple Termbase",
+ "description": "A simple termbase",
+ "copyright": "RWS",
+ "location" : "60b0a03152a974047fd46fb0"
+ "termbaseTemplateId": "your-termbase-template-id"
+}
+```
+
+If, however, you wish to provide your own custom termbase structure, you can do so by supplying it via the `termbaseStructure` object in the request body. Postman example:
+
+
+
+
+Request example: `POST /termbases`
+```json
+{
+ "name": "Simple Termbase",
+ "description": "A simple termbase",
+ "copyright": "RWS",
+ "location" : "60b0a03152a974047fd46fb0"
+ "termbaseStructure": {
+ "languages": [
+ {
+ "languageCode": "en-US"
+ }
+ ],
+ "fields": [
+ {
+ "name": "Entry level field",
+ "description": "A simple entry level field description.",
+ "level": "entry",
+ "allowCustomValues": true,
+ "allowMultiple": true,
+ "isMandatory": false
+ "dataType": "picklist",
+ "pickListValues": [
+ "picklist-value-1",
+ "picklist-value-2",
+ "picklist-value-3"
+ ]
+ }
+ ]
+ }
+}
+```
+
+
+Response example:
+```json
+{
+ "id": "6171694efb696c53e5ad726e",
+ "name": "Simple Termbase",
+ "location": {
+ "id": "60b0a03152a974047fd46fb0",
+ "name": "RWS"
+ }
+}
+```
+> Note: If both the `termbaseTemplateId` and the `termbaseStructure` are added in the request, the `termbaseStructure` takes precedence. In other words, the `termbaseTemplateId` is ignored.
+
+
+## Updating a termbase
+> You can update the fields for a termbase only if the termbase you want to update was not created using a termbase template or if it does not already have fields defined.
+
+A termbase can be updated by making a `PUT` request to the [`/termbases/{termbaseId}`](../../api/Public-API.v1-fv.html#/operations/UpdateTermbase) endpoint and providing the `termbaseTemplateId`.
+
+Request example: `PUT /termbases/616d0efa7a11677d6085b0be`
+```json
+{
+ "name": "[UPDATED] Simple Termbase",
+ "description": "A simple termbase",
+ "copyright": "[UPDATED] RWS",
+ "termbaseTemplateId" : "your-termbase-template-id"
+}
+```
+
+If, however, you wish to provide your own custom termbase structure, you can do so by supplying it via the `termbaseStructure` object in the request body. Postman example:
+
+
+
+
+Request example: `PUT /termbases/616d0efa7a11677d6085b0be`
+```json
+{
+ "name": "[UPDATED] Simple Termbase",
+ "description": "A simple termbase",
+ "copyright": "[UPDATED] RWS",
+ "termbaseStructure": {
+ "languages": [
+ {
+ "languageCode": "en-US"
+ }
+ ],
+ "fields": [
+ {
+ "id": "616d0efa7a12676d603b71ad",
+ "name": "[UPDATED] Entry level field",
+ "description": "A simple entry level field description.",
+ "level": "entry",
+ "dataType": "text",
+ "allowMultiple": true,
+ "isMandatory": false
+ }
+ ]
+ }
+}
+```
+> Note: If both the `termbaseTemplateId` and the `termbaseStructure` are added in the request, the `termbaseStructure` takes precedence. In other words, the `termbaseTemplateId` is ignored.
+
+> Note: If you perform an update using a termbase field without an `id`, the field will be added to the termbase.
+
+## Retrieving a termbase
+
+A termbase can be retrieved by making a `GET` request to the [`/termbases/{termbaseId}`](../../api/Public-API.v1-fv.html#/operations/GetTermbase) endpoint.
+
+Request example: `GET /termbases/616d0efa7a11677d6085b0be`
+
+Response example:
+```json
+{
+ "id": "616d28597a11677d60862233",
+ "name": "[UPDATED] Simple Termbase",
+ "copyright": "[UPDATED] RWS",
+ "location": {
+ "id": "60b0a03152a974047fd46fb0",
+ "name": "RWS"
+ }
+}
+```
+
+
+## Retrieving the list of termbases
+
+You can retrieve the list of termbases by making a `GET` request to the [`/termbases`](../../api/Public-API.v1-fv.html#/operations/ListTermbase) endpoint.
+
+Request example: `GET /termbases`
+
+Response example:
+```json
+{
+ "items": [
+ {
+ "id": "616d28597a11677d60862233",
+ "name": "[UPDATED] Simple Termbase",
+ "location": {
+ "id": "60b0a03152a974047fd46fb0",
+ "name": "RWS"
+ }
+ },
+ {
+ "id": "616d0efa7a11677d6085b0be",
+ "name": "New Termbase",
+ "location": {
+ "id": "60b0a03152a974047fd46fb0",
+ "name": "RWS"
+ }
+ }
+ ],
+ "itemCount": 2
+}
+```
+
+> Note: Some properties are not available for this endpoint: `numberOfEntries`, `status`, `createdAt` and `lastModifiedAt`.
+
+## Deleting termbases
+
+A termbase can be deleted by making a `DELETE` request to the [`/termbases/{termbaseId}`](../../api/Public-API.v1-fv.html#/operations/DeleteTermbase) endpoint.
+
+Request example: `DELETE /termbases/616d0efa7a11677d6085b0be`
diff --git a/articles/LCPublicAPI/docs/translation-memory/Translation-memory-import-export.md b/articles/LCPublicAPI/docs/translation-memory/Translation-memory-import-export.md
new file mode 100644
index 0000000..afca740
--- /dev/null
+++ b/articles/LCPublicAPI/docs/translation-memory/Translation-memory-import-export.md
@@ -0,0 +1,77 @@
+# Translation Memory import and export
+
+## Concepts
+
+
+Concept | Explanation |
+---------|----------|
+ Translation Unit | A pair made of source and target segments |
+ Fields | The `fields` contain metadata about the translation unit. |
+
+## Importing a translation memory
+
+The translation memory that you want to import must have one of the following formats: `tmx`, `sdltm`, `zip`, `tmx.gz` or `sdlxliff`.
+
+> Before the import action, make sure you have already created a translation memory using the [Create Translation Memory](../../api/Public-API.v1-fv.html#/operations/CreateTranslationMemory) endpoint.
+
+To import a translation memory, perform a `POST` request to the [Import Translation Memory](../../api/Public-API.v1-fv.html#/operations/ImportTranslationMemory) endpoint and provide these details: `translationMemoryId`, the translation memory file and a couple of properties.
+
+
+> Pay special attention to the order of `properties` and `file`. It must be exactly as described in the contract (properties first).
+
+If you are not sure what properties to include, here's a short description for each of them:
+1. `sourceLanguageCode` and `targetLanguageCode` - These fields represent the language direction of your import. Make sure to provide both of them as they are required fields.
+2. `importAsPlainText` - When true, the translation units will be imported as plain text, excluding any text markup.
+3. `exportInvalidTranslationUnits` - When true, all the translation units that failed to import are saved in a `tmx` file.
+4. `triggerRecomputeStatistics` - When true, will recompute the fuzzy index statistics once the import is done.
+5. `targetSegmentsDifferOption` - Option to specify how to handle translation units in the Translation Memory, if the target segments differ.
+ - `addNew` - Add a new translation unit and leave the original translation unit with the same source untouched.
+ - `overwrite` - Overwrite all the existing translation units where the source segment matches with the new content.
+ - `leaveUnchanged` - Do not change the existing translation units with the same source segment and ignore the new translation unit.
+ - `keepMostRecent` - Delete all the existing translation units with matching source segments and retain only the most recent translation unit
+6. `unknownFieldsOption` - Option to specify how to handle translation units and unknown fields in the Translation Memory.
+ - `addToTranslationMemory` - The translation unit is processed and the unknown user-defined fields are automatically added to the setup.
+ - `skipTranslationUnit` - The translation units containing unknown user-defined fields are skipped.
+ - `ignore` - The translation unit is processed and the unknown user-defined fields are ignored (not added to the setup).
+ - `failTranslationUnitImport` - If any translation unit contains an unknown user-defined field an error is thrown.
+7. `onlyImportSegmentsWithConfirmationLevels` - Only segments with the specified confirmation levels will be imported.
+ - `translated` - The segment has been fully translated, but not yet reviewed.
+ - `approvedTranslation` - The translation has been reviewed and approved, but not signed-off.
+ - `approvedSignOff` - The translation has been approved and signed-off.
+ - `draft` - The target segment may have been changed, but it's not yet considered fully translated.
+ - `rejectedTranslation` - The translation has been reviewed and rejected.
+ - `rejectedSignOff` - The translation was rejected in the sign-off process.
+
+Note that only the `sourceLanguageCode` and `targetLanguageCode` fields are **required**, the others already have default values, so you don't have to set them.
+
+If the import is successful, you will get back the import `id` and the `status`(normally `queued`).
+
+For more details about translation memory imports you can also check out the [Importing TM content](https://docs.rws.com/791595/741139/trados-enterprise/importing-tm-content) page.
+
+
+
+
+## Polling a translation memory import
+Some imports may take longer, depending on the size of the Translation Memory.
+
+To check if the import finished, you can perform a `GET` request to the [Poll Translation Memory Import](../../api/Public-API.v1-fv.html#/operations/PollTMImport) endpoint and supply the `importId` and the `translationMemoryId`. The import is complete when the status is `done`.
+
+
+## Exporting a translation memory
+
+To export a translation memory, perform a `POST` request to the [Export Translation Memory](../../api/Public-API.v1-fv.html#/operations/ExportTranslationMemory) endpoint and provide the `translationMemoryId` and a valid `languageDirection` of your translation memory.
+
+If the export is successful, you will get back an `exportId` and the export `status`. If the export did not succeed, the response will contain an error message.
+
+
+
+## Polling a translation memory export
+
+Some exports may take longer, depending on the size of the Translation Memory.
+
+To check if the export finished, you can perform a `GET` request to the [Poll Translation Memory Export](../../api/Public-API.v1-fv.html#/operations/PollTranslationMemoryExport) endpoint and supply the `exportId`. The export is complete when the status is `done`.
+
+## Downloading a translation memory export
+
+If an export is completed successfully (the status received at the polling is `done`), it can be downloaded by performing a `GET` request to the [Download Exported Translation Memory](../../api/Public-API.v1-fv.html#/operations/DownloadExportedTranslationMemory) endpoint. Just supply as `path` parameter the `exportId` and the response will contain the exported translation memory file in `tmx.gz` format.
+
diff --git a/articles/LCPublicAPI/docs/translations/Translations.md b/articles/LCPublicAPI/docs/translations/Translations.md
new file mode 100644
index 0000000..30e3e12
--- /dev/null
+++ b/articles/LCPublicAPI/docs/translations/Translations.md
@@ -0,0 +1,313 @@
+# Translation API
+
+The Translation API provides endpoints for performing translation operations using translation engines. These endpoints allow you to lookup translations, perform concordance searches, and manage translation units within your translation memories.
+
+## Overview
+
+The Translation API enables you to:
+- **Lookup translations** for text or BCM fragments using translation memories and machine translation
+- **Perform concordance searches** to find similar segments within translation memories
+- **Add new translation units** to translation memories
+- **Update existing translation units** in translation memories
+
+All translation operations require a translation engine that defines which translation memories, machine translation engines, and termbases to use for the translation process.
+
+
+> The BCM fragment format is used for input and output as JSON string, meaning that you will need to serialize and deserialize the BCM fragments when sending requests or processing responses. For .NET you can use the `Sdl.Core.Bcm.API` [nuget package](https://www.nuget.org/packages/Sdl.Core.Bcm.API).
+
+## Endpoints
+
+### Translation Lookup
+
+[`POST /translations/lookup`](../../api/Public-API.v1-fv.html#/operations/TranslationsLookup)
+
+Translates a phrase in plain text or a BCM fragment containing a single segment. The translated content will be returned as a [BCM fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html) or [term](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Skeleton.Term.html).
+
+**Use cases:**
+- Get translation suggestions for a source segment
+- Retrieve matches from translation memories
+- Get machine translation proposals
+- Access termbase entries for specific terms
+
+**Key features:**
+- Supports both plain text and BCM fragment input
+- Returns translations from multiple resource types (TM, MT, TB)
+- Configurable match thresholds and penalties
+
+**Request body example:**
+```json
+{
+ "input": {
+ "content": "Hello world",
+ "contentType": "text"
+ },
+ "languageDirection": {
+ "sourceLanguage": {
+ "languageCode": "en-US"
+ },
+ "targetLanguage": {
+ "languageCode": "fr-FR"
+ }
+ },
+ "definition": {
+ "translationEngineId": "your-translation-engine-id"
+ },
+ "settings": {
+ "translationMemory": {
+ "minimumMatchValue": 70,
+ "penalties": {
+ "standardPenalties": {
+ "missingFormatting": 1,
+ "differentFormatting": 1
+ }
+ }
+ }
+ }
+}
+```
+
+
+> The `translationProposal` field in the response can be either a BCM fragment or a term. You can rely on the `responseType` field to determine the content type and deserialize it accordingly.
+
+### Concordance Search
+
+[`POST /translations/concordance`](../../api/Public-API.v1-fv.html#/operations/TranslationsConcordanceSearch)
+
+Performs a concordance search for a given text within the translation memories linked to the specified translation engine. This helps you find segments that contain specific words or phrases.
+
+**Use cases:**
+- Research how certain phrases have been translated previously
+- Quality assurance and consistency checking
+- Translation memory analysis
+
+**Key features:**
+- Search within source or target segments
+- Support for exact and fuzzy matching
+- Configurable search parameters and penalties
+- Returns matching segments with context
+
+
+> The Translation Memory penalty defined in the Translation Engine will be automatically included in the translation score.
+
+**Request body example:**
+```json
+{
+ "input": {
+ "content": "user interface"
+ },
+ "languageDirection": {
+ "sourceLanguage": {
+ "languageCode": "en-US"
+ },
+ "targetLanguage": {
+ "languageCode": "fr-FR"
+ }
+ },
+ "definition": {
+ "translationEngineId": "your-translation-engine-id"
+ },
+ "targetOnly": false,
+ "settings": {
+ "translationMemory": {
+ "minimumMatchValue": 80
+ }
+ }
+}
+```
+
+### Translation Unit Management
+
+#### Update Translation Unit
+
+[`PUT /translations/translation-unit`](../../api/Public-API.v1-fv.html#/operations/TranslationsUpdate)
+
+Updates an existing translation unit in the translation memories. The system identifies matching translation units based on the `originalTranslationHash` provided in the BCM fragment.
+
+
+> After each update the `targetContent.translationOrigin.originalTranslationHash` is updated. The new values are returned in the response on the `translationHash` field.
+> Subsequent updates can be performed by updating the `targetContent.translationOrigin.originalTranslationHash` in the BCM fragment with the new `translationHash`, otherwise the system will add a new translation unit instead of updating the existing one.
+
+
+> Changing any fields in the `sourceContent` of a BCM fragment will result in a new translation unit being added instead of updating the existing one.
+
+**Use cases:**
+- Correct existing translations
+- Update translation metadata
+- Modify translation unit fields
+- Maintain translation memory quality
+
+**Key features:**
+- Smart matching of existing translation units
+- Preserve or update translation metadata
+- Configurable update behavior
+- Support for custom fields
+
+**Request body example for both add and update:**
+```json
+{
+ "input": {
+ "content": "BCM fragment"
+ },
+ "definition": {
+ "translationEngineId": "your-translation-engine-id"
+ },
+ "settings": {
+ "fields": [
+ {
+ "name": "field-name",
+ "values": [ "field-value" ]
+ }
+ ]
+ }
+}
+```
+
+#### Add Translation Unit
+
+[`POST /translations/translation-unit`](../../api/Public-API.v1-fv.html#/operations/TranslationsAdd)
+
+Adds a new translation unit to the translation memories.
+
+**Use cases:**
+- Add new translations units whose existence in the translation memory is unknown
+- If, however, the translation unit with the same source already exists, it will be updated based on the `ifTargetSegmentsDiffer` field
+- Populate translation memories with approved content
+
+**Key features:**
+- Automatic duplicate handling
+- Field template support for metadata
+- Configurable behavior for existing translations
+- BCM fragment support for rich content
+
+## BCM Fragments
+
+Many Translation API endpoints work with BCM (Binary Content Model) fragments. BCM is RWS's content model that preserves formatting, tags, and metadata within translation content.
+
+**BCM advantages:**
+- Preserves inline formatting and tags
+- Maintains content structure during translation
+- Supports complex document elements
+- Enables accurate translation memory matching
+
+For more information about BCM fragments, see the [BCM documentation](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html).
+
+Example of a BCM fragment:
+```json
+{
+ "sourceLanguageCode": "en-US",
+ "targetLanguageCode": "fr-FR",
+ "sourceContent": {
+ "id": "166fbfdd-8e0a-46aa-97bf-7b2b62014e5f",
+ "segmentNumber": "1",
+ "confirmationLevel": "Translated",
+ "type": "segment",
+ "children": [
+ {
+ "id": "c0cff9db-46e4-493d-b578-25e78d578ea7",
+ "placeholderTagDefinitionId": 1,
+ "tagNumber": "50",
+ "type": "placeholderTag",
+ "metadata": {
+ "SDL:IsSoftBreak": "True",
+ "SpecialCharacterPlaceholder": "‌",
+ "frameworkOriginalTagId": "50",
+ "SDL:IsWordStop": "False"
+ }
+ },
+ {
+ "id": "4b5cbfc4-53b1-462c-86a4-dbc061b5f266",
+ "text": "This is a sample text",
+ "type": "text"
+ }
+ ]
+ },
+ "targetContent": {
+ "id": "166fbfdd-8e0a-46aa-97bf-7b2b62014e5f",
+ "segmentNumber": "1",
+ "confirmationLevel": "Translated",
+ "translationOrigin": {
+ "originType": "tm",
+ "originSystem": "Example TM",
+ "matchPercent": 92,
+ "textContextMatchLevel": "None",
+ "originalTranslationHash": "-377851791",
+ "createdBy": "some-user-id",
+ "createdOn": "2023-09-25T14:24:04.000Z",
+ "modifiedBy": "some-user-id",
+ "modifiedOn": "2025-02-12T09:25:57.000Z",
+ "metadata": {
+ "used_on": "04/01/2025 13:56:28",
+ "used_by": "some-user-id",
+ "use_count": "8"
+ }
+ },
+ "type": "segment",
+ "metadata": {
+ "Contexts": [
+ {
+ "Context1": 0,
+ "Context2": 0,
+ "Segment1": null,
+ "Segment2": null,
+ "LeftSource": 0,
+ "LeftTarget": 0
+ }
+ ]
+ },
+ "children": [
+ {
+ "id": "6143602c-5548-43d0-a2fc-1a5a7f2aeb35",
+ "text": "Ceci est un exemple de texte",
+ "type": "text"
+ }
+ ]
+ }
+}
+```
+
+## Translation Memory Penalties
+
+The Translation API supports various penalty types to fine-tune translation matching:
+
+### Standard Penalties
+- **Missing Formatting**: Penalty for matches missing formatting tags
+- **Different Formatting**: Penalty for matches with different formatting
+- **Multiple Translations**: Penalty for segments with multiple translation options
+
+### Translation Unit Status Penalties
+- **Translated**: Penalty for translated but not reviewed segments
+- **Approved Translation**: Penalty for approved translations
+- **Rejected Translation**: Penalty for rejected translations
+
+Learn more about [Translation Memory penalties](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/trados-tm-penalties-1159224) and [Translation Unit status penalties](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/editing-project-tm-and-verification-settings-800732).
+
+## Best Practices
+
+### Performance Optimization
+- Set appropriate minimum match values to reduce processing time
+- Use reasonable penalty values to balance quality and performance
+
+### Quality Management
+- Configure penalties based on your quality requirements
+- Regularly update translation units to maintain accuracy
+
+### Translation Memory Maintenance
+- Add high-quality translations to build reliable TMs
+- Update outdated translations to keep content current
+- Use appropriate field templates for metadata management
+
+## Related APIs
+
+- **[Translation Memory API](../translation-memory/Translation-memory-import-export.md)**: Bulk import/export of translation memories
+- **[Translation Engine API](../../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine)**: Manage translation engine configurations
+- **[Termbase API](../termbase/Termbase.md)**: Manage terminology resources
+
+## Examples and Use Cases
+
+### Building a Translation Workflow
+
+1. **Setup**: Configure translation engine with TMs, MT, and termbases
+2. **Lookup**: Use `/translations/lookup` for translation suggestions
+3. **Research**: Use `/translations/concordance` for plain text research
+4. **Quality**: Add/update translation units with the updated BCM fragments retrieved from the previous requests to improve TM quality
+5. **Maintenance**: Regular TM updates and quality checks
diff --git a/articles/LCPublicAPI/docs/webhooks/Batched-webhooks.md b/articles/LCPublicAPI/docs/webhooks/Batched-webhooks.md
new file mode 100644
index 0000000..0a970f2
--- /dev/null
+++ b/articles/LCPublicAPI/docs/webhooks/Batched-webhooks.md
@@ -0,0 +1,56 @@
+# Batched Webhooks
+
+Webhooks can be batched to reduce the number of HTTP requests. Batched webhooks are sent as a single HTTP request to the configured webhook URL.
+The request body follows the [Webhook Batch](../../api/Webhooks.v1-fv.html#/schemas/webhook-batch) structure and contains a set of [Trados Cloud Platform events](../../api/Webhooks.v1-fv.html#/schemas/webhook).
+
+## Considerations for Consuming Batched Webhooks
+
+* Create the webhook endpoint to handle batched webhooks. The endpoint must be capable of processing multiple events in a single request.
+* The same [webhook authenticity](Webhooks-setup.md#webhook-authenticity) rules apply to both batched and single webhooks.
+* The same **success/failure** rules for webhook notifications apply, as described in [notification responses](Webhooks-setup.md#return-notification-responses).
+ * **Note:** A notification delivery is considered successful if the application responds with a 2xx status code within 20 seconds (compared to 3 seconds for individual webhooks).
+* The **retry policies** and **circuit breaker** mechanisms for webhook notifications are the same as those described in [notification responses](Webhooks-setup.md#return-notification-responses).
+* The same **headers** are included in batched webhooks as in single webhooks, as outlined in the [reference](Webhooks-setup.md#reference).
+
+## Example Request for a Batched Webhook
+
+```json
+{
+ "itemCount": 42,
+ "items": [
+ {
+ "eventId": "EVENT_ID",
+ "eventType": "PROJECT.CREATED",
+ "version": "1.0",
+ "timestamp": "TIMESTAMP",
+ "accountId": "ACCOUNT_ID",
+ "data": { ... }
+ },
+ {
+ "eventId": "EVENT_ID",
+ "eventType": "PROJECT.TASK.CREATED",
+ "version": "1.0",
+ "timestamp": "TIMESTAMP",
+ "accountId": "ACCOUNT_ID",
+ "data": { ... }
+ },
+ ...
+ ]
+}
+```
+
+## Batch Size and Frequency
+
+Batched webhooks are sent when either the maximum batch size is reached or a predefined time interval elapses.
+The current configuration for the Trados Cloud Platform is:
+
+* The maximum batch size is 100 events.
+* The maximum time interval is 1 second.
+
+> **Note:** These values are subject to change without prior notice to enhance system efficiency and ensure platform stability.
+
+## Key Considerations for Efficient Batching
+
+* Ensure that a single URL is set for receiving batched webhooks in the Trados Cloud Platform.
+* Create a single webhook under [Webhooks Setup](Webhooks-setup.md#subscribe-to-webhook-events) that subscribes to multiple event types.
+
diff --git a/articles/LCPublicAPI/docs/webhooks/Webhooks-payload.md b/articles/LCPublicAPI/docs/webhooks/Webhooks-payload.md
new file mode 100644
index 0000000..946bec3
--- /dev/null
+++ b/articles/LCPublicAPI/docs/webhooks/Webhooks-payload.md
@@ -0,0 +1,77 @@
+# Webhooks payload
+
+**The request body** has the same standard JSON format for all [Trados Cloud Platform events](../../api/Webhooks.v1-fv.html#/schemas/webhook).
+
+An example of request for a `PROJECT_CREATED` event:
+
+```json
+{
+ "eventId": "EVENT_ID",
+ "eventType": "PROJECT.CREATED",
+ "version": "1.0",
+ "timestamp": "TIMESTAMP",
+ "accountId": "ACCOUNT_ID",
+ "data": {
+ "id": "DATA_ID",
+ "name": "PROJECT_NAME",
+ "description": "PROJECT_DESCRIPTION",
+ "customFields": [
+ {
+ "id": "CUSTOM_FIELD_ID1",
+ "key": "CUSTOM_FIELD_KEY1",
+ "value": "CUSTOM_FIELD_VALUE1"
+ },
+ {
+ "id": "CUSTOM_FIELD_ID2",
+ "key": "CUSTOM_FIELD_KEY2",
+ "value": "CUSTOM_FIELD_VALUE2"
+ }
+ ]
+ }
+}
+```
+
+> Note: Depending on the event type, the `data` field will contain a different object, representing the Data Payload Object as mentioned in the next example. This will include different details relevant to that event type, please check the table below.
+
+This is the envelope that is common to all events, and only the < Data Payload Object part > is specific and depending on the event type.
+
+```json
+{
+ "eventId": "EVENT_ID",
+ "eventType": "PROJECT.CREATED",
+ "version": "1.0",
+ "timestamp": "TIMESTAMP",
+ "accountId": "ACCOUNT_ID",
+ "data": {
+ < Data Payload Object part >
+ }
+}
+```
+
+ +| Event | Data payload object model | Trigger operations in Trados Cloud Platform API | Trigger operations in Trados UI | +|---|---|---|---| +| `PROJECT.TASK.ACCEPTED` | [`task-event`](../../api/Webhooks.v1-fv.html#/schemas/task-event) | Accept task
Accept error task | Accept task
Accept error task | +| `PROJECT.TASK.CREATED` | [`task-event`](../../api/Webhooks.v1-fv.html#/schemas/task-event) | Generate task | Generate task | +| `PROJECT.TASK.COMPLETED` | [`task-event`](../../api/Webhooks.v1-fv.html#/schemas/task-event) | Complete task | Complete task | +| `PROJECT.TASK.UPDATED` | [`task-event`](../../api/Webhooks.v1-fv.html#/schemas/task-event) | Generate task
Accept task
Reject task
Release task
Assign task
Reassign task
Complete task | Generate task
Accept task
Reject task
Release task
Assign task
Reassign task
Complete task | +| `PROJECT.TASK.DELETED` | [`task-event`](../../api/Webhooks.v1-fv.html#/schemas/task-event) | Delete project and its tasks | Delete project and its tasks | +| `PROJECT.CREATED` | [`project-event`](../../api/Webhooks.v1-fv.html#/schemas/project-event) | Create project | Create project | +| `PROJECT.STARTED` | [`project-event`](../../api/Webhooks.v1-fv.html#/schemas/project-event) | Start project | Start project | +| `PROJECT.UPDATED` | [`project-event`](../../api/Webhooks.v1-fv.html#/schemas/project-event) | Start project (This event will also be emitted in addition to `PROJECT.STARTED`)
Update project by changing any field
Complete project
Cancel source file
Complete target file | Start project (This event will also be emitted in addition to `PROJECT.STARTED`)
Update project by changing the `Project Information`, `Configuration` or `Custom Fields` fields in the `Settings` tab
Complete project
Set project back in progress
Cancel project
Complete target file | +| `PROJECT.DELETED` | [`project-event`](../../api/Webhooks.v1-fv.html#/schemas/project-event) | Delete project | Delete project | +| `PROJECT.TEMPLATE.CREATED` | [`project-template-event`](../api/Webhooks.v1-fv.html#/schemas/project-template-event) | | Create project template | +| `PROJECT.TEMPLATE.UPDATED` | [`project-template-event`](../../api/Webhooks.v1-fv.html#/schemas/project-template-event) | | Create project template
Update project template | +| `PROJECT.TEMPLATE.DELETED` | [`project-template-event`](../../api/Webhooks.v1-fv.html#/schemas/project-template-event) | | Delete project template | +| `PROJECT.SOURCE.FILE.CREATED` | [`source-file-event`](../api/Webhooks.v1-fv.html#/schemas/source-file-event) | Add source file to project
Attach source files to project | Add reference file to project
Add translatable file to project | +| `PROJECT.SOURCE.FILE.UPDATED` | [`source-file-event`](../../api/Webhooks.v1-fv.html#/schemas/source-file-event) | Update source file by changing the `name` field
Add source file version
The project reaches the `File Type Detection` task
The project reaches the `File Format Conversion` task | Update source file by changing the `fileType` or `fileRole` fields
Add source file version via `Replace file` action
Delete source file version
Cancel source file
The project reaches the `File Type Detection` task
The project reaches the `File Format Conversion` task | +| `PROJECT.SOURCE.FILE.DELETED` | [`source-file-event`](../../api/Webhooks.v1-fv.html#/schemas/source-file-event) |Delete project and its tasks | Delete project and its tasks | +| `PROJECT.TARGET.FILE.CREATED` | [`target-file-event`](../../api/Webhooks.v1-fv.html#/schemas/target-file-event) | The project reaches the `File Format Conversion` task | The project reaches the `File Format Conversion` task | +| `PROJECT.TARGET.FILE.UPDATED` | [`target-file-event`](../../api/Webhooks.v1-fv.html#/schemas/target-file-event) | Update source file by changing the `name` field
Add target file version
Import target file version
The project reaches the `File Format Conversion` task
The project reaches the `Copy Source to Target` task
The project reaches the `Machine Translation` task
The project reaches the `Bilingual Engineering` task
The project reaches the `Translation` task
The project reaches the `Linguistic Review` task
The project reaches the `Customer Review` task
The project reaches the `Implement Customer Review` task
The project reaches the `Target File Generation` task | Add target file version via `Upload SDLXLIFF` action
Replace target file
Delete target file version
Cancel target file
The project reaches the `File Format Conversion` task
The project reaches the `Copy Source to Target` task
The project reaches the `Machine Translation` task
The project reaches the `Bilingual Engineering` task
The project reaches the `Translation` task
The project reaches the `Linguistic Review` task
The project reaches the `Customer Review` task
The project reaches the `Implement Customer Review` task
The project reaches the `Target File Generation` task | +| `PROJECT.TARGET.FILE.DELETED` | [`target-file-event`](../../api/Webhooks.v1-fv.html#/schemas/target-file-event) | Delete project and its tasks | Delete project and its tasks | +| `PROJECT.GROUP.PROJECT.MEMBERSHIP.CHANGE` | [`project-group-event`](../../api/Webhooks.v1-fv.html#/schemas/project-group-event) | Add project to project group
Remove project from project group | Add project to project group
Remove project from project group | +| `PROJECT.ERROR.TASK.CREATED` | [`error-task-event`](../../api/Webhooks.v1-fv.html#/schemas/error-task-event) | Generate error task | Generate error task | +| `PROJECT.ERROR.TASK.COMPLETED` | [`error-task-event`](../../api/Webhooks.v1-fv.html#/schemas/error-task-event) | Complete error task | Complete error task | +| `PROJECT.ERROR.TASK.ACCEPTED` | [`error-task-event`](../../api/Webhooks.v1-fv.html#/schemas/error-task-event) | Accept error task | Accept error task | + + diff --git a/articles/LCPublicAPI/docs/webhooks/Webhooks-setup.md b/articles/LCPublicAPI/docs/webhooks/Webhooks-setup.md new file mode 100644 index 0000000..e38f01e --- /dev/null +++ b/articles/LCPublicAPI/docs/webhooks/Webhooks-setup.md @@ -0,0 +1,200 @@ +--- +stoplight-id: eg4ja9nrs9wtk +--- + +# Webhooks Setup + +A webhook is a web callback by which Trados Cloud Platform notifies an external application when a specific event occurs in a specific account in Trados Cloud Platform. You can subscribe to events by registering webhooks from within the Trados UI. + +> When integrating with our webhook service, please be aware that we cannot guarantee the order of webhook event deliveries. This means that notifications may arrive out of sequence, and consumers should not rely on receiving messages in a specific order. Instead, make use of the `timestamp` field to determine the event generation time. + +## Subscribe to Webhook events + +You subscribe to Webhook events from the Trados UI by creating a Trados Cloud Platform custom application. + +Several prerequisites must be met so that you can configure the right webhooks for the right customer, namely: + +1. Create a Service User in the correct customer folder. +2. Create an application based on the Service User created above. This means that the application is saved in the same customer folder as the Service User. +3. Use the application to configure the webhooks for your customer. + +Here are the detailed steps: + +1. Log in to the Trados UI as a human Administrator user. +2. Expand the account menu on the top right-hand corner and select **Integrations**. +3. Select the **Applications** sub-tab. +4. Select **New Application** and enter the following information: + - **Name** – Enter a unique name for your custom application. + - (Optional) **URL** – Enter your custom application URL. + - **Service User** – Select a service user from the dropdown list. To understand how service users are added in Trados Cloud Platform, check step 1 in the [Authenticate](../../docs/Service-credentials.md) topic. +5. Select **Add**. +6. Back in the **Applications** sub-tab, select the check box corresponding to your application. +7. Select **Edit**. +8. On the **Overall Information** page change any of the following, if necessary: name, URL, description. +9. On the **API Access** page you can find your **Client ID** and **Client Secret**. +10. On the **Webhooks** page: + - Enter a default callback URL for your application Webhooks (all Webhooks defined in Trados Cloud Platform). + - Enter a value for **Webhook URL** (this is your Webhook endpoint URL which you expose and which Trados Cloud Platform calls), select one or more event types, and hit Enter. You can create a separate webhook for every event you are interested in or combine notifications for multiple event types to one webhook. If you delete your application, all its associated webhooks are also deleted. +11. Select **Save**. + +A webhook is triggered for all the projects located in the same folder as the selected service user. + +> Similar to other resource types, webhooks are governed by inheritance, the propagation rule giving users visibility and work access with resources in the [account hierarchy](https://docs.rws.com/791595/797020/trados-enterprise---accelerate/inheritance-within-the-account).
+> Please be aware that the webhooks will be delivered only for the users having the READ permission on the resource triggering the webhook. + +For example, given there is a folder structure: + +- Root + - Customer1 + - Customer2 + - Customer3 + +Let's say that: +- the `Group1` has the location `Customer1` +- the `Group2` has the location `Customer2` +- the `Group3` has the location `Customer3` + +Let's presume that: +- the service user `S1`, with the webhook `WB1`, is in the group `Group1` +- the service user `S2`, with the webhook `WB2`, is in the group `Group2` +- the service user `S3`, with the webhook `WB3`, is in the group `Group3` + +The followings are true: +1. if you create a project in `Customer1`: + - the webhook event is sent to `WB1`; + +2. if you create a project in `Customer2`: + - the webhook event is sent to `WB1` url and `WB2` url; + +3. if you create a project in `Customer3`: + - the webhook event is sent to `WB1` url and `WB3` url. + + + +Remember that each time events occur, Trados Cloud Platform will call your server on a `POST` request, on the URL you configured in the Trados Cloud Platform application, and the request body will emulate the [Webhook](../../api/Webhooks.v1-fv.html#/schemas/webhook) object format. + +## Validate the Webhook notifications + +In terms of security, you must ensure that Trados Cloud Platform is the system which sent the event. For this, webhook requests must be verified in terms of authenticity, integrity, and confidentiality. + +### Webhook authenticity + +The webhook `POST` request sent by Trados Cloud Platform will include a digital signature which concatenates the following information: `transmissionTime|applicationId|webhookId|crc32 `. For more information on request headers, check the *Reference* section at the end. The [crc32](https://en.wikipedia.org/wiki/Cyclic_redundancy_check) component is a checksum for the HTTP request body. + +The signature is decrypted using your Public Key. You can get the Public Key as follows: + +1. Log in to the Trados UI as a human Administrator user. +2. Expand the account menu on the top right-hand corner and select **Integrations**. +3. Select the **Applications** sub-tab. +4. Open your application and go to the **Webhooks** tab. Copy the value from the **Secret Key** field. This is the Public Key which validates and decrypts the signature sent by the header. + +The validation process mimics the generation sequence, where the recipient system use its Public Key to verify the received signature using the same concatenation: `transmissionTime|applicationId|webhookId|crc32 `. + +**Here is a Java sample:** + +``` +//retrieve transmissionTime, applicationId, webhookId, signatureAlg & signature from request headers* + +// event = request message body +//generate crc32 from the request body + +CRC32 checkSum = new CRC32(); +checksum.update(event.getBytes(UTF_8)); +long crc32Val = checksum.getValue(); + +//build the message +String message = transmissionTime + “|” + applicationId + “|” + webhookId + “|” + crc32Val; + +//build PublicKey +byte[] bytes = org.springframework.security.crypto.codec.Base64.decode(publicKeyAsString.getBytes()); +X509EncodeKeySpec ks = new X509EncodeKeySpec(bytes); +KeyFactory kf = KeyFactory.getInstance(“RSA”); +PublicKey publicKey = kf.generatePublic(ks); + +//verify signature + +Signature publicSignature = Signature.getInstance(signatureAlg); +publicSignature.initVerify(publicKey); +publicSignature.update(message.getBytes(UTF_8)); +byte[] signatureBytes = Base64.getDecoder().decode(signature); + +publicSignature.verify(signatureBytes); +``` + +A valid message implies that the message was sent by Trados Cloud Platform. + +### Webhook integrity + +The fact that the signature is created based on payload content ensures that the message is not altered ([CRC32](https://en.wikipedia.org/wiki/Cyclic_redundancy_check)). + +### Webhook confidentiality + +To ensure that the message cannot be read by 3rd-parties, Trados Cloud Platform Webhooks only accept the HTTPS communication protocol specified in the webhook URLs you provide. + +## Return notification responses + +### Success notifications + +A notification delivery is considered successful when applications respond with a 2xx status code within 3 seconds. + +> It is recommended that applications perform little processing when receiving events and, for instance, that they make use of a queuing mechanism to perform further processing asynchronously after having acknowledged the event notification request. + +Trados Cloud Platform does not inspect the HTTP response body. + +### Failure notifications + +Notifications will fail in the following scenarios: +- Response time: the response status code is `2xx`, but the response is received after 3 seconds +- Response status code: + - `3xx`: Trados Cloud Platform does not follow redirects + - `4xx` + - `5xx` + +### Retry policies + +Trados Cloud Platform will try its best to redeliver the notification. Retries will include specific headers with information about the retry: +- `X-LC-Retry-Num`: header indicating the retry number (1, 2 or 3) +- `X-LC-Retry-Reason`: header indicating why the retry is sent + +Trados Cloud Platform will try to delivery the notification up to 8 times using an exponential back-off strategy (namely, it will delay the next delivery attempt exponentially with the number of retries already made). + +Retry No.| Interval (relative to last retry)/ Minutes| Interval (relative to original attempt)/ Minutes| +---- |---- |---- | +1 |5 |5 | +2 |10 |15 | +3 |30 |45 | +4 |120 (2h) |165 | +5 |360 (6h) |525 | +6 |600 (10h) |1125 | +7 |960 (16h) |2085 | +8 |1440 (24h) |3525 | + +### Circuit Breaker + +To protect the platform and ensure problems from one tenant do not affect other tenants, we have a circuit breaker that will stop sending webhook on URLs that do not respond within the allowed time (mentioned in **Failure** notifications section). The actual HTTP response code is not relevant since the connection is closed before the response is received. + +The circuit breaker is triggered when 3 calls to a URL fail within a short time window. The circuit breaker is opened for an hour only for that URL, not for the tenant. During that hour, any webhooks sent to that URL are scheduled for the next retry. + +> Frequent timeouts may compromise the performance of our delivery system.
+> We may need to remove your webhook from our database without advance notice if it is negatively impacting the platform.
+> This action is reserved for cases of major incidents and is necessary to prevent potential issues that can arise from repeated delivery attempts. +## Reference + +**The request headers** are: + +* `X-LC-Signature`: Contains the message digital signature (see section on *Webhook authenticity* above). + +* `X-LC-Signature-Algo`: Contains the algorithm used for signing the message. Possible values: "*SHA256withRSA*". + +* `X-LC-Retry-Num`: Contains the retry attempt counter. Initial value is 0, which will be increased with each attempt at redelivering the webhook message. + +* `X-LC-Retry-Reason`: Contains a textual description of the previous error, which resulted in the current attempt to redeliver the webhook message. + +* `X-LC-Transmission-Time`: Contains the date/time when the webhook message was delivered, in ISO 8601 date time format. + +* `X-LC-Application`: Unique identifier of the Trados Cloud Platform application, which is the recipient of the webhook message. Every webhook has an application associated in Trados Cloud Platform, which can be found in the Trados UI, in the account dropdown menu from the top right corner, under the **Applications** tab, in **Integrations**. The configured webhooks for an application are listed on the **Webhooks** tab of the respective application. + +* `X-LC-Webhook`: Unique identifier of the webhook defined for the LC application which is the recipient of the webhook message. It can be ignored because it is not exposed in the Trados UI. + +* `X-LC-Region`: Region of the account of the user, which is the recipient of the webhook message. + diff --git a/articles/LCPublicAPI/toc.yml b/articles/LCPublicAPI/toc.yml new file mode 100644 index 0000000..606b1f4 --- /dev/null +++ b/articles/LCPublicAPI/toc.yml @@ -0,0 +1,119 @@ +- name: Introduction + href: docs/Introduction.md + +- name: Public API Management Process + href: docs/Public-API-Management-Process.md + +- name: What's new + href: docs/Whats-New.md + +- name: What's deprecated + href: docs/Whats-deprecated.md + +- name: How to report an issue + href: docs/How-to-report-an-issue.md + +- name: Known issues + href: docs/Known-Issues.md + +- name: Getting started + items: + - name: Multi-region + href: docs/Multi-region.md + - name: API rate limits + href: docs/API-rate-limits.md + - name: Use fields in your requests + href: docs/Use-fields-in-your-requests.md + - name: Use paging and sorting for lists + href: docs/Use-paging-and-sorting-for-lists.md + - name: Updating data with PUT + href: docs/Updating-data-with-PUT.md + - name: Language codes + href: docs/Language-codes.md + - name: How to use location and folders + href: docs/How-to-use-location-and-folders.md + - name: File formats + href: docs/File-formats.md + - name: Headers considerations + href: docs/Headers-considerations.md + - name: Multipart considerations + href: docs/How-to-multipart.md + +- name: Authentication + items: + - name: Service users and custom applications + href: docs/Service-users-and-custom-applications.md + - name: Service credentials + href: docs/Service-credentials.md + - name: Authentication + href: docs/Authentication.md + +- name: Projects + items: + - name: Basic project creation flow + href: docs/Basic-project-creation-flow.md + - name: Create projects + href: docs/Create-projects.md + - name: Track projects + href: docs/Track-projects.md + - name: Interact with tasks + href: docs/Interact-with-tasks.md + +- name: Termbases + items: + - name: Termbases + href: docs/termbase/Termbase.md + - name: Termbase templates + href: docs/termbase/Termbase-templates.md + - name: Termbase entries + href: docs/termbase/Termbase-entries.md + - name: Termbase import and export + href: docs/termbase/Termbase-import-export.md + +- name: Translation Memories + items: + - name: Translation Memory import and export + href: docs/translation-memory/Translation-memory-import-export.md + +- name: Translations + items: + - name: Translation Memory import and export + href: docs/translations/Translations.md + +- name: Custom fields + href: docs/Custom-Fields.md + +- name: Export quote report + href: docs/Export-quote-report.md + +- name: Webhooks + items: + - name: Webhooks Setup + href: docs/webhooks/Webhooks-setup.md + - name: Webhooks Payload + href: docs/webhooks/Webhooks-payload.md + - name: Batched Webhooks + href: docs/webhooks/Batched-webhooks.md + +- name: Trados Cloud Platform APIs for Postman + href: docs/Language-Cloud-APIs-for-Postman.md + +- name: API Clients + items: + - name: .NET Client + href: docs/api-clients/net/NET-Client.md + - name: .NET Samples + href: docs/api-clients/net/Net-Samples.md + - name: Java Client + href: docs/api-clients/java/Java-Client.md + - name: Java Samples + href: docs/api-clients/java/Java-Samples.md + +- name: APIs + items: + - name: Public API + href: api/Public-API.v1.md + - name: Global Public API + href: api/Global-Public-API.v1.md + - name: Webhooks + href: api/Webhooks.v1.md \ No newline at end of file diff --git a/index.md b/index.md index f976e32..60d6816 100644 --- a/index.md +++ b/index.md @@ -7,17 +7,19 @@ Var:ProductName is the platform on which RWS host a number of products. You're i - Trados Studio (cloud capabilities) - Trados Go -## Integrating with Var:ProductName products -To create an integration with any of the products listed above, you'll need to use the Public API. You can find the documentation for the API [here](https://languagecloud.sdl.com/lc/api-docs). Note that the API is updated regularly so make sure that you check out the [What's new](https://languagecloud.sdl.com/lc/api-docs/whats-new) section to find out information on recently added features. To enable RWS to extend and improve the API, and to support the latest features in the products, sometimes it's necessary to remove or change functionality. For that, you'll need to check the [What's deprecated](https://languagecloud.sdl.com/lc/api-docs/whats-deprecated) page where RWS will post advance notice of any API endpoints that will be removed or change in the future. Don't worry though because RWS will try and give six months notice of any breaking changes. +## Integrating with products
+To create an integration with any of the products listed above, you'll need to use the Public API. You can find the documentation for the API [here](articles/LCPublicAPI/docs/Introduction.md). Note that the API is updated regularly so make sure that you check out the [What's new](articles/LCPublicAPI/docs/Whats-New.md) section to find out information on recently added features. To enable RWS to extend and improve the API, and to support the latest features in the products, sometimes it's necessary to remove or change functionality. For that, you'll need to check the [What's deprecated](articles/LCPublicAPI/docs/Whats-Deprecated.md) page where RWS will post advance notice of any API endpoints that will be removed or change in the future. Don't worry though because RWS will try and give six months notice of any breaking changes.
+Click [here](articles/LCPublicAPI/docs/Introduction.md) to find out more.
-## Extending Var:ProductName products
-Var:ProductName products can be extended in a number of ways. For example, you may want to create an add-on to support a machine translation engine or you may want to create a custom workflow task. RWS provides an extensibility framework for the Var:ProductName suite of products. To get more information on what's required and how you can do this, visit the [Var:ProductName extensibility documentation](https://languagecloud.sdl.com/lc/extensibility-docs) pages.
+## Extending products
+ products can be extended in a number of ways. For example, you may want to create an add-on to support a machine translation engine or you may want to create a custom workflow task. RWS provides an extensibility framework for the suite of products. To get more information on what's required and how you can do this, visit the [ extensibility documentation](articles/Extensibility/) pages.
+Click [here](articles/Extensibility/docs/Whats-New.md) to find out more.
## Interacting with files
-Translatable content in Var:ProductName is held in a format called **Bilingual Content Model**, or **BCM** for short. You can find **BCM** reference documentation and samples on this site. Click [here](articles/bcm/BCM.NET_client_API.md) to find out more.
+Translatable content in is held in a format called **Bilingual Content Model**, or **BCM** for short. You can find **BCM** reference documentation and samples on this site. Click [here](articles/BCM/BCM.NET_client_API.md) to find out more.
## Reporting API issues ##
-If you want to report an issue with the API, you can find information on how to do this here - [How to report an issue](https://languagecloud.sdl.com/lc/api-docs/how-to-report-an-issue)
+If you want to report an issue with the API, you can find information on how to do this here - [How to report an issue](articles/LCPublicAPI/docs/how-to-report-an-issue.md)
## Trados Cloud API and Customer Portal API
-Please be aware that Trados Cloud offers two different APIs. First is the modern Trados Cloud API described on this page. Then there is the second API that is the [Mantra API](https://languagecloud.sdl.com/cp/api). Trados Cloud API is the recommended option for new integrations as it is more modern and much effort is put into its continuous evolution along with Trados Enterprise. Please take care not to confuse the two of them as they are not interchangeable.
+Please be aware that Trados Cloud offers two different APIs. First is the modern Trados Cloud API described on this page. Then there is the second API that is the Mantra API. Trados Cloud API is the recommended option for new integrations as it is more modern and much effort is put into its continuous evolution along with Trados Enterprise. Please take care not to confuse the two of them as they are not interchangeable.
diff --git a/toc.yml b/toc.yml
index a5961ff..91593ef 100644
--- a/toc.yml
+++ b/toc.yml
@@ -1,10 +1,10 @@
- name: Trados Cloud
href: index.md
- name: API
- href: https://languagecloud.sdl.com/lc/api-docs
+ href: articles/LCPublicAPI/
- name: Extensibility
- href: https://languagecloud.sdl.com/lc/extensibility-docs
+ href: articles/Extensibility/
- name: BCM
- href: articles/bcm/BCM.NET_client_API.md
+ href: articles/BCM/BCM.NET_client_API.md
- name: Developer License
href: developer_license.md
default
Outcome to be used with complete endpoint.",
+ "x-default-field": true
+ },
+ "description": {
+ "type": "string",
+ "description": "A human-friendly form of the outcome."
+ },
+ "default": {
+ "type": "boolean",
+ "description": "default
Specifies if the outcome is the default one for the task.",
+ "x-default-field": true
+ }
+ }
+ },
+ "task-type-outcome": {
+ "title": "Task Type Outcome",
+ "type": "object",
+ "description": "The task type outcome.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "default
",
+ "x-default-field": true
+ },
+ "description": {
+ "type": "string"
+ },
+ "default": {
+ "type": "boolean",
+ "nullable": true,
+ "description": "default
",
+ "x-default-field": true
+ }
+ }
+ },
+ "task-configuration-scope": {
+ "title": "Workflow Task Configuration Scope",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The applicability impact of the workflow configuration:\n- global: used for global tasks which are not associated to a target language\n- sourceLanguage: changes affect only the task associated to the source language specified in **sourceLanguage** field\n- targetLanguage: changes affect only the task associated to the target language specified in **targetLanguage** field\n- languageDirection: changes affect only the task associated to the language direction specified in **languageDirection** field",
+ "enum": [
+ "global",
+ "sourceLanguage",
+ "targetLanguage",
+ "languageDirection"
+ ]
+ },
+ "sourceLanguage": {
+ "$ref": "#/components/schemas/language"
+ },
+ "targetLanguage": {
+ "$ref": "#/components/schemas/language"
+ },
+ "languageDirection": {
+ "$ref": "#/components/schemas/language-direction-item"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "task-configuration-scope-request": {
+ "title": "Workflow Task Configuration Scope Request",
+ "type": "object",
+ "description": "",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The applicability impact of the workflow configuration:\n- global: used for global tasks, that are not associated to a target language \n- sourceLanguage: changes affect only the task associated to the source language specified in `sourceLanguage` field. For using this type, must include the `sourceLanguage` field.\n- targetLanguage: changes affect only the task associated to the target language specified in `targetLanguage` field. For using this type, must include the `targetLanguage` field.\n- languageDirection: changes affect only the task associated to the language direction specified in `languageDirection` field. For using this type, must include the `languageDirection` field.",
+ "enum": [
+ "global",
+ "sourceLanguage",
+ "targetLanguage",
+ "languageDirection"
+ ]
+ },
+ "sourceLanguage": {
+ "$ref": "#/components/schemas/source-language-request"
+ },
+ "targetLanguage": {
+ "$ref": "#/components/schemas/target-language-request"
+ },
+ "languageDirection": {
+ "$ref": "#/components/schemas/language-direction-item"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "target-file": {
+ "title": "Target File",
+ "type": "object",
+ "description": "Target File.",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The target file name.
",
+ "x-default-field": true
+ },
+ "languageDirection": {
+ "$ref": "#/components/schemas/language-direction",
+ "description": "default
A basic language direction.
",
+ "x-default-field": true
+ },
+ "sourceFile": {
+ "$ref": "#/components/schemas/source-file"
+ },
+ "latestVersion": {
+ "$ref": "#/components/schemas/target-file-latest-version"
+ },
+ "analysisStatistics": {
+ "$ref": "#/components/schemas/analysis-statistics"
+ },
+ "status": {
+ "type": "string",
+ "description": "Shows if the file is still being processed (inProgress) or if it has been fully processed (finished) by the workflow. A target file is automatically marked as finished by the workflow engine, once there are no more tasks to be performed on it.",
+ "enum": [
+ "inProgress",
+ "finished",
+ "canceled"
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "target-file-rename-request": {
+ "title": "Target File Rename Request",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the target file.\\\nThe name should not contain the extension.\\\nUnsupported characters in the name: `<`, `>`, `:`, `\"`, `/`, `\\`, `|`, `?`, `*`.",
+ "minLength": 1
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "target-files-update-request": {
+ "title": "Target Files Update Request",
+ "type": "object",
+ "properties": {
+ "files": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/target-file-update-request"
+ }
+ }
+ },
+ "required": [
+ "files"
+ ]
+ },
+ "target-file-update-request": {
+ "title": "Target File Update Request",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The target file identifier.",
+ "minLength": 1
+ },
+ "name": {
+ "type": "string",
+ "description": "The target file name.\\\nThe name should not contain the extension.\\\nUnsupported characters in the name: `<`, `>`, `:`, `\"`, `/`, `\\`, `|`, `?`, `*`.",
+ "minLength": 1
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ]
+ },
+ "target-file-version": {
+ "title": "Target File Version",
+ "type": "object",
+ "description": "Target File Version.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The target file version identifier."
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "native",
+ "bcm"
+ ],
+ "description": "default
The version type.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The file version name. This is a synthetic value, typically constructed from the version number and the originating task name.
",
+ "x-default-field": true
+ },
+ "version": {
+ "type": "integer",
+ "description": "A numeric value, incremented for each new version."
+ },
+ "originatingTaskId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "yxst0hpphv0tq"
+ },
+ "description": "The identifier of the task that generated the file."
+ }
+ },
+ "required": [
+ "id",
+ "version"
+ ]
+ },
+ "target-file-latest-version": {
+ "title": "Target File Latest Version",
+ "x-stoplight": {
+ "id": "0zlvlegfodgta"
+ },
+ "type": "object",
+ "description": "Target File Latest Version.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The target file version identifier."
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "native",
+ "bcm"
+ ],
+ "description": "default
The version type.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "version": {
+ "type": "integer",
+ "description": "A numeric value, incremented for each new version."
+ }
+ },
+ "required": [
+ "id",
+ "version"
+ ]
+ },
+ "target-language-request": {
+ "title": "Target Language Request",
+ "type": "object",
+ "properties": {
+ "languageCode": {
+ "type": "string",
+ "description": "The language code."
+ }
+ },
+ "required": [
+ "languageCode"
+ ],
+ "description": ""
+ },
+ "termbase-template": {
+ "title": "Termbase Template",
+ "type": "object",
+ "description": "The termbase template.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The identifier of the termbase template."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The name of the termbase template.
",
+ "x-default-field": true
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the termbase template.",
+ "nullable": true
+ },
+ "copyright": {
+ "type": "string",
+ "description": "The copyright of the termbase template.",
+ "nullable": true
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder-v2",
+ "description": "default
The resource folder.
",
+ "x-default-field": true
+ },
+ "createdAt": {
+ "type": "string",
+ "example": "2022-01-12T12:00:00.000Z",
+ "description": "The date and time when the termbase template was created. UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "format": "date-time" + }, + "lastModifiedAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the termbase template was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "format": "date-time" + }, + "type": { + "type": "string", + "description": "The type of the termbase template.", + "enum": [ + "system", + "userDefined" + ] + }, + "languages": { + "type": "array", + "description": "The languages of the termbase template.", + "items": { + "$ref": "#/components/schemas/language" + } + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field" + } + } + }, + "required": [ + "id", + "type" + ] + }, + "termbase-template-update-request": { + "title": "Termbase Template Update Request", + "type": "object", + "description": "The termbase template update request.", + "properties": { + "name": { + "type": "string", + "description": "The name of the Termbase template.", + "maxLength": 50, + "minLength": 1 + }, + "description": { + "type": "string", + "description": "The description of the Termbase template.", + "minLength": 0, + "maxLength": 200, + "nullable": true + }, + "copyright": { + "type": "string", + "description": "The copyright of the Termbase template.", + "minLength": 0, + "maxLength": 50, + "nullable": true + }, + "languages": { + "type": "array", + "description": "The languages of the termbase template.", + "items": { + "$ref": "#/components/schemas/language-request" + } + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-update-request" + } + } + } + }, + "termbase-template-create-request": { + "title": "Termbase Template Create Request", + "type": "object", + "description": "The termbase template create request.", + "properties": { + "name": { + "type": "string", + "description": "The name of the termbase template.", + "minLength": 0, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The description of the termbase template.", + "minLength": 0, + "maxLength": 200, + "nullable": true + }, + "copyright": { + "type": "string", + "description": "The copyright of the termbase template.", + "minLength": 0, + "maxLength": 50, + "nullable": true + }, + "location": { + "type": "string", + "description": "The folder identifier where the termbase template should be created. If not mentioned, it will be created in the Root folder. If the user does not have access in Root, the request will fail with forbidden error." + }, + "languages": { + "type": "array", + "description": "The languages of the termbase template.", + "items": { + "$ref": "#/components/schemas/language-request" + } + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-create-request" + } + } + }, + "required": [ + "name" + ] + }, + "termbase-structure": { + "title": "Termbase Structure", + "type": "object", + "description": "The termbase structure.", + "properties": { + "languages": { + "type": "array", + "description": "
default
The languages of the termbase.
",
+ "items": {
+ "$ref": "#/components/schemas/language"
+ },
+ "x-default-field": true
+ },
+ "fields": {
+ "type": "array",
+ "description": "default
The termbase fields. (Not available for List Termbases endpoint).
",
+ "items": {
+ "$ref": "#/components/schemas/termbase-field"
+ },
+ "x-default-field": true
+ }
+ }
+ },
+ "termbase-structure-create-request": {
+ "title": "Termbase Structure Create Request",
+ "type": "object",
+ "description": "The termbase structure create request.",
+ "properties": {
+ "languages": {
+ "type": "array",
+ "description": "The languages of the termbase. If not supplied, the termbase will be created using the languages from the specified template. Otherwise it will override the languages from the template.",
+ "items": {
+ "$ref": "#/components/schemas/language-request"
+ }
+ },
+ "fields": {
+ "type": "array",
+ "description": "Describes the field structure. If not supplied, the termbase will be created using the fields from the specified template. Otherwise it will override the fields from the template.",
+ "items": {
+ "$ref": "#/components/schemas/termbase-field-create-request"
+ }
+ }
+ }
+ },
+ "termbase-structure-update-request": {
+ "title": "Termbase Structure Update Request",
+ "type": "object",
+ "description": "The termbase structure update request.",
+ "properties": {
+ "languages": {
+ "type": "array",
+ "description": "The languages of the termbase. If not supplied, the termbase will be updated using the languages from the specified template. Otherwise it will override the languages from the template.",
+ "items": {
+ "$ref": "#/components/schemas/language-request"
+ }
+ },
+ "fields": {
+ "type": "array",
+ "description": "Describes the field structure. If not supplied, the termbase will be updated using the fields from the specified template. Otherwise it will override the fields from the template.",
+ "items": {
+ "$ref": "#/components/schemas/termbase-field-update-request"
+ }
+ }
+ }
+ },
+ "termbase-field": {
+ "title": "Termbase Field",
+ "type": "object",
+ "description": "The termbase field.",
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The identifier of the termbase field."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The name of the termbase field.
",
+ "x-default-field": true
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the termbase field",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of the termbase field - system or userDefined.",
+ "enum": [
+ "system",
+ "userDefined"
+ ]
+ },
+ "level": {
+ "type": "string",
+ "enum": [
+ "entry",
+ "language",
+ "term"
+ ],
+ "description": "default
The level of which this field applies.
",
+ "x-default-field": true
+ },
+ "dataType": {
+ "type": "string",
+ "enum": [
+ "text",
+ "double",
+ "date",
+ "picklist",
+ "boolean"
+ ],
+ "description": "default
The data type of the field.
",
+ "x-default-field": true
+ },
+ "pickListValues": {
+ "type": "array",
+ "uniqueItems": false,
+ "description": "The pick list options. Only if dataType is \"picklist\".",
+ "items": {
+ "type": "string"
+ }
+ },
+ "allowCustomValues": {
+ "type": "boolean",
+ "description": "Specifies if the field allows custom values."
+ },
+ "allowMultiple": {
+ "type": "boolean",
+ "description": "Specifies if the field can be used multiple times."
+ },
+ "isMandatory": {
+ "type": "boolean",
+ "description": "Specifies if the field is mandatory."
+ }
+ }
+ },
+ "termbase-field-update-request": {
+ "title": "Termbase Field Update Request",
+ "type": "object",
+ "description": "The termbase field update request.\n\nIf dataType is `picklist` and pickListValues array is empty `allowCustomValues` must be true.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The identifier of the termbase field to updated. If missing will add a new field."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the termbase field. Must be unique.",
+ "minLength": 1,
+ "maxLength": 50
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the termbase field.",
+ "minLength": 1,
+ "maxLength": 200,
+ "nullable": true
+ },
+ "level": {
+ "type": "string",
+ "enum": [
+ "entry",
+ "language",
+ "term"
+ ],
+ "description": "The level of which this field applies."
+ },
+ "dataType": {
+ "type": "string",
+ "enum": [
+ "text",
+ "double",
+ "date",
+ "picklist",
+ "boolean"
+ ],
+ "description": "The data type of the field."
+ },
+ "pickListValues": {
+ "type": "array",
+ "uniqueItems": true,
+ "description": "The pick list options. Only if dataType is \"picklist\".",
+ "items": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 1000
+ }
+ },
+ "allowCustomValues": {
+ "type": "boolean",
+ "description": "Specifies if the field allows custom values. Must be true if pickListValues is empty.",
+ "default": false
+ },
+ "allowMultiple": {
+ "type": "boolean",
+ "description": "Specifies if the field can be used multiple times.",
+ "default": true
+ },
+ "isMandatory": {
+ "type": "boolean",
+ "description": "Specifies if the field is mandatory.",
+ "default": false
+ }
+ },
+ "required": [
+ "name",
+ "level",
+ "dataType"
+ ]
+ },
+ "termbase-field-create-request": {
+ "title": "Termbase Field Create Request",
+ "type": "object",
+ "description": "The termbase field request.\n\nIf dataType is `picklist` and pickListValues array is empty `allowCustomValues` must be true.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the termbase field. Must be unique.",
+ "minLength": 1,
+ "maxLength": 50
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the termbase field.",
+ "minLength": 1,
+ "maxLength": 200,
+ "nullable": true
+ },
+ "level": {
+ "type": "string",
+ "enum": [
+ "entry",
+ "language",
+ "term"
+ ],
+ "description": "The level of which this field applies."
+ },
+ "dataType": {
+ "type": "string",
+ "enum": [
+ "text",
+ "double",
+ "date",
+ "picklist",
+ "boolean"
+ ],
+ "description": "The data type of the field."
+ },
+ "pickListValues": {
+ "type": "array",
+ "uniqueItems": true,
+ "description": "The pick list values. Only if dataType is \"picklist\". Values must be unique.",
+ "items": {
+ "type": "string",
+ "minLength": 1,
+ "maxLength": 1000
+ }
+ },
+ "allowCustomValues": {
+ "type": "boolean",
+ "description": "Specifies if the field allows custom values. Must be true if pickListValues is empty.",
+ "default": false
+ },
+ "allowMultiple": {
+ "type": "boolean",
+ "description": "Specifies if the field can be used multiple times.",
+ "default": true
+ },
+ "isMandatory": {
+ "type": "boolean",
+ "description": "Specifies if the field is mandatory.",
+ "default": false
+ }
+ },
+ "required": [
+ "name",
+ "level",
+ "dataType"
+ ]
+ },
+ "termbase": {
+ "title": "Termbase",
+ "type": "object",
+ "description": "The termbase.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The identifier of the termbase."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The name of the termbase.
",
+ "x-default-field": true
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the termbase.",
+ "nullable": true
+ },
+ "copyright": {
+ "type": "string",
+ "description": "The copyright of the termbase.",
+ "nullable": true
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder-v2",
+ "description": "default
The resource folder.
",
+ "x-default-field": true
+ },
+ "termbaseStructure": {
+ "$ref": "#/components/schemas/termbase-structure"
+ },
+ "numberOfEntries": {
+ "type": "number",
+ "description": "The number of entries included in the termbase. (Not available for List Termbases endpoint)"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "ready",
+ "processingContent",
+ "exportingContent",
+ "deletingContent"
+ ],
+ "description": "The status of the termbase. (Not available for List Termbases endpoint)"
+ },
+ "createdAt": {
+ "type": "string",
+ "example": "2022-01-12T12:00:00.000Z",
+ "description": "The date and time when the termbase was created. (Not available for List Termbases endpoint) UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "format": "date-time" + }, + "lastModifiedAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the termbase was last updated. (Not available for List Termbases endpoint)
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "format": "date-time" + } + }, + "required": [ + "id" + ] + }, + "termbase-create-request": { + "title": "Termbase Create Request", + "type": "object", + "description": "Termbase create request.", + "properties": { + "name": { + "type": "string", + "description": "The name of the termbase.", + "minLength": 1, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The description of the termbase.", + "minLength": 0, + "maxLength": 200, + "nullable": true + }, + "copyright": { + "type": "string", + "description": "The copyright of the termbase.", + "minLength": 0, + "maxLength": 50, + "nullable": true + }, + "location": { + "type": "string", + "description": "The folder identifier where the termbase should be created. If not specified, it will be created in the Root folder. If the user does not have access in Root, the request will fail with forbidden error." + }, + "termbaseTemplateId": { + "type": "string", + "description": "The termbase template identifier." + }, + "termbaseStructure": { + "$ref": "#/components/schemas/termbase-structure-create-request" + } + }, + "required": [ + "name" + ] + }, + "termbase-update-request": { + "title": "Termbase Update Request", + "type": "object", + "description": "Termbase update request.", + "properties": { + "name": { + "type": "string", + "description": "The name of the termbase.", + "minLength": 1, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The description of the termbase.", + "minLength": 0, + "maxLength": 200, + "nullable": true + }, + "copyright": { + "type": "string", + "description": "The copyright of the termbase.", + "minLength": 0, + "maxLength": 50, + "nullable": true + }, + "termbaseTemplateId": { + "type": "string", + "description": "The termbase template identifier." + }, + "termbaseStructure": { + "$ref": "#/components/schemas/termbase-structure-update-request" + } + } + }, + "termbase-field-value-link": { + "title": "Termbase Field Value Link", + "type": "object", + "description": "The field value link.", + "properties": { + "type": { + "type": "string", + "enum": [ + "term", + "entry", + "external" + ], + "description": "The type of the link." + }, + "value": { + "type": "string", + "description": "The value of the link." + } + }, + "required": [ + "type", + "value" + ] + }, + "termbase-field-value-link-update-request": { + "title": "Termbase Field Value Link Update Request", + "type": "object", + "description": "The field value link update request.", + "properties": { + "type": { + "type": "string", + "enum": [ + "term", + "entry", + "external" + ], + "description": "The type of the link." + }, + "value": { + "type": "string", + "description": "The value of the link." + } + } + }, + "termbase-field-value-link-create-request": { + "title": "Termbase Field Value Link Create Request", + "type": "object", + "description": "The field value link create request.", + "properties": { + "type": { + "type": "string", + "enum": [ + "term", + "entry", + "external" + ], + "description": "The type of link." + }, + "value": { + "type": "string", + "description": "The value of the link.", + "minLength": 1 + } + }, + "required": [ + "type", + "value" + ] + }, + "termbase-field-value": { + "title": "Termbase Field Value", + "type": "object", + "description": "The termbase field value.", + "properties": { + "id": { + "type": "string", + "description": "The field value identifier." + }, + "name": { + "type": "string", + "description": "The field value name." + }, + "termbaseFieldId": { + "type": "string", + "description": "The termbase field identifier." + }, + "value": { + "type": "string", + "description": "The value of the field." + }, + "fieldValueLinks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-link" + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the termbase field value was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "createdBy": { + "$ref": "#/components/schemas/user" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the termbase field value was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "lastModifiedBy": { + "$ref": "#/components/schemas/user" + } + }, + "required": [ + "id", + "name", + "termbaseFieldId", + "value" + ] + }, + "termbase-field-value-update-request": { + "title": "Termbase Field Value Update request", + "type": "object", + "description": "The termbase field value update request.", + "properties": { + "id": { + "type": "string", + "description": "The field value identifier. Either the `id` or the `name` is mandatory to be provided." + }, + "name": { + "type": "string", + "description": "The field value name. Either the `id` or the `name` is mandatory to be provided." + }, + "termbaseFieldId": { + "type": "string", + "description": "The termbase field value identifier. Must match with the fieldId from the termbase." + }, + "value": { + "type": "string", + "description": "The value of the field.", + "minLength": 1, + "maxLength": 4096 + }, + "fieldValueLinks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-link-update-request" + } + } + }, + "required": [ + "termbaseFieldId", + "value" + ] + }, + "termbase-field-value-create-request": { + "title": "Termbase Field Value Create Request", + "type": "object", + "description": "The termbase field value create request.", + "properties": { + "termbaseFieldId": { + "type": "string", + "description": "The termbase field identifier. It must match the `fieldId` from the termbase." + }, + "value": { + "type": "string", + "description": "The value of the field.", + "minLength": 1, + "maxLength": 4096 + }, + "fieldValueLinks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-link-create-request" + } + } + }, + "required": [ + "termbaseFieldId", + "value" + ] + }, + "termbase-entry-term": { + "title": "Termbase Entry Term", + "type": "object", + "description": "The termbase entry term.", + "required": [ + "id", + "text" + ], + "properties": { + "id": { + "type": "string", + "description": "The term identifier." + }, + "text": { + "type": "string", + "description": "The term text." + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value" + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the term entry was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "createdBy": { + "$ref": "#/components/schemas/user" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the term entry was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "lastModifiedBy": { + "$ref": "#/components/schemas/user" + }, + "systemStatus": { + "$ref": "#/components/schemas/termbase-entry-term-system-status", + "x-stoplight": { + "id": "xx4xvu4isws0c" + } + } + } + }, + "termbase-entry-term-update-request": { + "title": "Termbase Entry Term Update Request", + "type": "object", + "description": "The termbase entry term update request.", + "required": [ + "text" + ], + "properties": { + "id": { + "type": "string", + "description": "The term identifier that will be updated. If not supplied, a new term will be created." + }, + "text": { + "type": "string", + "description": "The term text.", + "minLength": 1, + "maxLength": 1024 + }, + "systemStatus": { + "$ref": "#/components/schemas/termbase-entry-term-system-status-request", + "x-stoplight": { + "id": "lpm4ttzn58ku0" + } + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-update-request" + } + } + } + }, + "termbase-term-create-request": { + "title": "Termbase Entry Term Create Request", + "type": "object", + "description": "The termbase entry term request.", + "required": [ + "text" + ], + "properties": { + "text": { + "type": "string", + "description": "The term text.", + "maxLength": 1024, + "minLength": 1 + }, + "systemStatus": { + "$ref": "#/components/schemas/termbase-entry-term-system-status-request", + "x-stoplight": { + "id": "cvo2q7bu0gkix" + } + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-create-request" + } + } + } + }, + "termbase-entry-language": { + "title": "Termbase Entry Language", + "type": "object", + "description": "The termbase entry language.", + "properties": { + "id": { + "type": "string", + "description": "The termbase language identifier." + }, + "language": { + "$ref": "#/components/schemas/language" + }, + "terms": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-entry-term" + } + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value" + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the language entry was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "createdBy": { + "$ref": "#/components/schemas/user" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the language entry was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "lastModifedBy": { + "$ref": "#/components/schemas/user" + } + }, + "required": [ + "id", + "language" + ] + }, + "termbase-entry-language-update-request": { + "title": "Termbase Entry Language Update Request", + "type": "object", + "description": "The termbase entry language update request.", + "properties": { + "id": { + "type": "string", + "description": "The termbase language identifier." + }, + "language": { + "$ref": "#/components/schemas/language-request" + }, + "terms": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-entry-term-update-request" + } + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-update-request" + } + } + }, + "required": [ + "language", + "terms" + ] + }, + "termbase-entry-language-create-request": { + "title": "Termbase Entry Language Create Request", + "type": "object", + "description": "The termbase entry language create request.", + "properties": { + "language": { + "$ref": "#/components/schemas/language-request" + }, + "terms": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-term-create-request" + } + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-create-request" + } + } + }, + "required": [ + "language", + "terms" + ] + }, + "termbase-entry": { + "title": "Termbase Entry", + "type": "object", + "description": "The termbase entry.", + "properties": { + "id": { + "type": "string", + "description": "The termbase entry identifier." + }, + "humanReadableId": { + "type": "string", + "description": "An identifier that can be provided externally, or generated automatically by the Trados Cloud Platform, used for creating cross-references. You can use it to set its value to be correlated to your system. The format of the generated value is not guaranteed." + }, + "languages": { + "description": "The termbase entry languages.", + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-entry-language" + } + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value" + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the termbase entry was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "createdBy": { + "$ref": "#/components/schemas/user" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the termbase entry was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "lastModifiedBy": { + "$ref": "#/components/schemas/user" + } + }, + "required": [ + "id", + "languages" + ] + }, + "termbase-entry-update-request": { + "title": "Termbase Entry Update Request", + "type": "object", + "description": "The termbase entry update request.", + "properties": { + "humanReadableId": { + "type": "string", + "description": "An identifier that can be provided externally, or generated automatically by the Trados Cloud Platform, used for creating cross-references. You can use it to set its value to be correlated to your system. The format of the generated value is not guaranteed." + }, + "languages": { + "description": "The termbase entry languages.", + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-entry-language-update-request" + } + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-update-request" + } + } + }, + "required": [ + "languages" + ] + }, + "termbase-entry-create-request": { + "title": "Termbase Entry Create Request", + "type": "object", + "description": "The termbase entry create request.", + "properties": { + "humanReadableId": { + "type": "string", + "description": "An identifier that can be provided externally, or generated automatically by the Trados Cloud Platform, used for creating cross-references. You can use it to set its value to be correlated to your system.\nThe format of the generated value is not guaranteed." + }, + "languages": { + "description": "The termbase entry languages.", + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-entry-language-create-request" + } + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-create-request" + } + } + }, + "required": [ + "languages" + ] + }, + "termbase-entry-term-system-status": { + "title": "Termbase Entry Term System Status", + "type": "string", + "nullable": true, + "x-stoplight": { + "id": "k477x1xb11mvw" + }, + "enum": [ + "preferred", + "draft", + "inReview", + "deprecated", + "recommended", + "admitted", + "forbidden", + "rejected", + "superseded" + ] + }, + "termbase-entry-term-system-status-request": { + "title": "Termbase Entry Term System Status", + "type": "string", + "x-stoplight": { + "id": "k477x1xb11mvw" + }, + "enum": [ + "preferred", + "draft", + "inReview", + "deprecated", + "recommended", + "admitted", + "forbidden", + "rejected", + "superseded" + ] + }, + "termbase-export-properties-request": { + "title": "Termbase Export Properties Request", + "type": "object", + "properties": { + "downloadCompressed": { + "type": "boolean", + "description": "Download compressed ( zipped ).", + "default": false + } + } + }, + "termbase-export-response": { + "title": "Termbase Export Response", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The termbase export identifier." + }, + "status": { + "type": "string", + "description": "The status of the export operation.
\n`queued` - The export passed the structural validation and it's waiting to be processed.
\n`processing` - The export is in progress.
\n`done` - The export was successfully processed .
\n`canceled` - The export process was interrupted.
\n`error` - The export was unsuccessful due to an internal error.", + "enum": [ + "queued", + "processing", + "done", + "cancelled", + "error" + ] + }, + "errorMessage": { + "type": "string", + "description": "When status is 'error', contains the error message explaining what went wrong." + }, + "downloadUrl": { + "type": "string", + "description": "The url where the file can be downloaded." + } + }, + "required": [ + "id", + "status" + ] + }, + "termbase-term": { + "title": "Termbase Term Response", + "type": "object", + "description": "The termbase term.", + "properties": { + "id": { + "type": "string", + "description": "The term identifier." + }, + "entryId": { + "type": "string", + "description": "The entry identifier." + }, + "text": { + "type": "string", + "description": "The term text." + } + }, + "required": [ + "id", + "entryId", + "text" + ] + }, + "termbase-import-response": { + "title": "Termbase Import Response", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the import operation." + }, + "status": { + "type": "string", + "description": "The status of the import operation.
\n`queued` - The import passed the structural validation and it's waiting to be processed.
\n`processing` - The import is in progress.
\n`done` - The import was successfully processed and at least an entry changed its structure ( either inserted or modified )
\n`cancelled` - The import process was interrupted.
\n`failed` - The import was unsuccessful. Either one of the import files is not compliant with the TBX structure or no entry changed during the import process.
\n`error` - The import was unsuccessful due to an internal error.", + "enum": [ + "queued", + "processing", + "done", + "cancelled", + "failed", + "error" + ] + } + }, + "required": [ + "id", + "status" + ] + }, + "termbase-poll-import-response": { + "title": "Termbase Poll Import Response", + "type": "object", + "description": "The termbase poll import response.
\nThe import was successfully processed when the status is `done`.", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the import operation." + }, + "status": { + "type": "string", + "description": "The status of the import operation.
\n`queued` - The import passed the structural validation and it's waiting to be processed.
\n`processing` - The import is in progress.
\n`done` - The import was successfully processed and at least an entry changed its structure ( either inserted or modified )
\n`cancelled` - The import process was interrupted.
\n`failed` - The import was unsuccessful. Either one of the import files is not compliant with the TBX structure or no entry changed during the import process.
\n`error` - The import was unsuccessful due to an internal error.", + "enum": [ + "queued", + "processing", + "done", + "cancelled", + "failed", + "error" + ] + } + }, + "required": [ + "id", + "status" + ] + }, + "termbase-import-history-response": { + "title": "Termbase Import History Response", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The termbase import identifier." + }, + "fileName": { + "type": "string", + "description": "
default
The file name of the imported file.
",
+ "x-default-field": true
+ },
+ "fileSize": {
+ "type": "integer",
+ "description": "The file size of the imported file.",
+ "format": "int64"
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of the import operation.\n`pending` - The import was just created and it's waiting for user input.
\n`queued` - The import passed the structural validation and it's waiting to be processed.
\n`processing` - The import is in progress.
\n`done` - The import was successfully processed and at least an entry changed its structure ( either inserted or modified )
\n`cancelled` - The import process was interrupted.
\n`failed` - The import was unsuccessful. Either one of the import files is not compliant with the TBX structure or no entry changed during the import process.
\n`error` - The import was unsuccessful due to an internal error.", + "enum": [ + "pending", + "queued", + "processing", + "done", + "cancelled", + "failed", + "error" + ] + }, + "createdAt": { + "$ref": "#/components/schemas/date-time" + }, + "elapsedTime": { + "type": "integer", + "description": "The last modified date of the import." + } + }, + "required": [ + "id", + "status" + ] + }, + "termbase-import-request": { + "type": "object", + "title": "Termbase Import Properties", + "description": "Properties required for system status mapping", + "properties": { + "statusMapping": { + "type": "array", + "x-stoplight": { + "id": "jr1v619dgm5k8" + }, + "items": { + "$ref": "#/components/schemas/termbase-system-status-mapping", + "x-stoplight": { + "id": "jjw6bvzbbc0eg" + } + } + } + } + }, + "termbase-system-status-mapping": { + "title": "Termbase System Status Mapping", + "x-stoplight": { + "id": "3o7f2m7gb63yw" + }, + "type": "object", + "description": "A mapping between a termbase term system status and termbase statuses.", + "required": [ + "systemStatusValue", + "statuses" + ], + "properties": { + "systemStatusValue": { + "$ref": "#/components/schemas/termbase-entry-term-system-status-request", + "x-stoplight": { + "id": "kznc76h6wxicr" + } + }, + "statuses": { + "type": "array", + "x-stoplight": { + "id": "3isyr4742q3jg" + }, + "minItems": 1, + "items": { + "x-stoplight": { + "id": "6lvylhb8t3n96" + }, + "type": "string" + } + } + } + }, + "tqa-profile": { + "title": "TQA Profile", + "type": "object", + "description": "As a project manager, you choose a TQA configuration and use it to automatically assess the quality of a translation document.\n\nThe TQA configuration specifies:\n - Categories and subcategories that reviewers will use to classify the translation issues in a document.\n - Severities to define custom metrics you want to use to assess translation quality.\n - Score to measure the importance of each category or subcategory of an issue.\n - Pass/Fail Threshold to define the maximum number of penalty points admitted before failing the translation document.", + "properties": { + "id": { + "type": "string", + "description": "The identifier of the TQA profile." + }, + "name": { + "type": "string", + "description": "
default
The name of the TQA Profile.
",
+ "x-default-field": true
+ },
+ "description": {
+ "type": "string",
+ "description": "default
The TQA Profile description.
",
+ "x-default-field": true
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder-v2"
+ },
+ "passFailThreshold": {
+ "$ref": "#/components/schemas/tqa-profile-passFailThreshold",
+ "description": "default
Pass/Fail Threshold is used to define the maximum number of penalty points admitted before failing the translation document.
",
+ "x-default-field": true
+ },
+ "categories": {
+ "type": "array",
+ "description": "Categories and subcategories are assessment options that reviewers can use to classify any translation-related issue that they find in a file.",
+ "items": {
+ "$ref": "#/components/schemas/tqa-profile-category"
+ }
+ },
+ "severities": {
+ "type": "array",
+ "description": "Severities are custom metrics that reviewers can use to measure the importance of any translation-related issues that they find in a file.",
+ "items": {
+ "$ref": "#/components/schemas/tqa-profile-severity"
+ }
+ },
+ "scores": {
+ "type": "array",
+ "description": "The TQA scoring indicates whether translations pass or fail the acceptance threshold.",
+ "items": {
+ "$ref": "#/components/schemas/tqa-profile-score"
+ }
+ },
+ "path": {
+ "type": "array",
+ "deprecated": true,
+ "items": {
+ "$ref": "#/components/schemas/folder"
+ }
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "tqa-profile-category": {
+ "title": "TQA Profile Category",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The category identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The category name.
",
+ "x-default-field": true
+ },
+ "description": {
+ "type": "string",
+ "description": "The category description."
+ },
+ "abbreviation": {
+ "type": "string",
+ "description": "The category abbreviation."
+ }
+ }
+ },
+ "tqa-profile-severity": {
+ "title": "TQA Profile Severity",
+ "type": "object",
+ "description": "Severities are custom metrics that reviewers can use to measure the importance of any translation-related issues that they find in a file.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The severity identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The severity name.
",
+ "x-default-field": true
+ },
+ "type": {
+ "type": "string",
+ "description": "The severity type."
+ }
+ }
+ },
+ "tqa-profile-passFailThreshold": {
+ "title": "TQA Profile PassFailThreshold",
+ "type": "object",
+ "description": "Pass/Fail Threshold is used to define the maximum number of penalty points admitted before failing the translation document.",
+ "properties": {
+ "points": {
+ "type": "integer",
+ "description": "default
The penalty points.
",
+ "x-default-field": true
+ },
+ "quantity": {
+ "type": "integer",
+ "description": "default
The quantity against which the points are measured.
",
+ "x-default-field": true
+ },
+ "scope": {
+ "type": "string",
+ "description": "default
Words or characters.
",
+ "x-default-field": true
+ }
+ }
+ },
+ "tqa-profile-score": {
+ "title": "TQA Profile Score",
+ "type": "object",
+ "description": "The TQA scoring indicates whether translations pass or fail the acceptance threshold.",
+ "properties": {
+ "category": {
+ "$ref": "#/components/schemas/tqa-profile-category",
+ "description": "default
The TQA category.
",
+ "x-default-field": true
+ },
+ "severity": {
+ "$ref": "#/components/schemas/tqa-profile-severity",
+ "description": "default
Severities are custom metrics that reviewers can use to measure the importance of any translation-related issues that they find in a file.
",
+ "x-default-field": true
+ },
+ "penalty": {
+ "type": "integer",
+ "description": "default
The associated penalty for this score's category and severity.
",
+ "x-default-field": true
+ }
+ }
+ },
+ "translation-search-request": {
+ "title": "Translation Search Request",
+ "x-stoplight": {
+ "id": "pfa7dyujl86lv"
+ },
+ "type": "object",
+ "required": [
+ "input",
+ "languageDirection",
+ "definition"
+ ],
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/translation-lookup-input-request",
+ "x-stoplight": {
+ "id": "gj1t64z5swfgk"
+ }
+ },
+ "languageDirection": {
+ "$ref": "#/components/schemas/language-direction-general-request",
+ "x-stoplight": {
+ "id": "h62z5gy3c4otv"
+ }
+ },
+ "definition": {
+ "$ref": "#/components/schemas/translation-definition",
+ "x-stoplight": {
+ "id": "f9rodrj2q7z6e"
+ }
+ },
+ "settings": {
+ "$ref": "#/components/schemas/translation-search-settings",
+ "x-stoplight": {
+ "id": "vkle6tvpl4amf"
+ }
+ }
+ }
+ },
+ "translation-search-response": {
+ "title": "Translation Search Response",
+ "x-stoplight": {
+ "id": "6zhfxtway5o0e"
+ },
+ "type": "object",
+ "required": [
+ "translations"
+ ],
+ "properties": {
+ "translations": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "ags6uqvpedq4l"
+ },
+ "description": "Translations from different resource origins such as `TM`. The origin information is found in the BCM fragment.",
+ "items": {
+ "$ref": "#/components/schemas/translation",
+ "x-stoplight": {
+ "id": "5px5mphkbp2rr"
+ }
+ }
+ },
+ "appliedResourcesStatus": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "3v56u017sssw8"
+ },
+ "items": {
+ "$ref": "#/components/schemas/translation-applied-resource-status",
+ "x-stoplight": {
+ "id": "gexmk4z2gsbyb"
+ }
+ }
+ }
+ }
+ },
+ "translation-concordance-search-response": {
+ "title": "Translation Concordance Search Response",
+ "x-stoplight": {
+ "id": "6zhfxtway5o0e"
+ },
+ "type": "object",
+ "required": [
+ "translations"
+ ],
+ "properties": {
+ "translations": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "ags6uqvpedq4l"
+ },
+ "description": "Translations from different resource origins such as `TM`. The origin information is found in the BCM fragment. Only the top 5 matches are displayed",
+ "items": {
+ "$ref": "#/components/schemas/translation-concordance",
+ "x-stoplight": {
+ "id": "5px5mphkbp2rr"
+ }
+ }
+ },
+ "appliedResourcesStatus": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "3v56u017sssw8"
+ },
+ "items": {
+ "$ref": "#/components/schemas/translation-concordance-search-applied-resource-status",
+ "x-stoplight": {
+ "id": "gexmk4z2gsbyb"
+ }
+ }
+ }
+ }
+ },
+ "translation-unit-add-update-response": {
+ "title": "Translation Unit Response",
+ "type": "object",
+ "required": [
+ "success"
+ ],
+ "properties": {
+ "success": {
+ "type": "boolean",
+ "description": "A flag indicating whether the overall operation was successful executed"
+ },
+ "insights": {
+ "type": "array",
+ "description": "default
The operation insights.
",
+ "x-default-field": true,
+ "items": {
+ "$ref": "#/components/schemas/translation-unit-insight-model"
+ }
+ },
+ "errorInsights": {
+ "type": "array",
+ "description": "default
The operation error insights.
",
+ "x-default-field": true,
+ "items": {
+ "$ref": "#/components/schemas/translation-error-detail-response"
+ }
+ }
+ }
+ },
+ "translation-unit-insight-model": {
+ "title": "Translation Unit Insight Model",
+ "type": "object",
+ "description": "Detailed insight information about the processed translation unit.",
+ "required": [
+ "resourceId",
+ "translationHash",
+ "action"
+ ],
+ "properties": {
+ "resourceId": {
+ "type": "string",
+ "description": "The translation memory identifier."
+ },
+ "translationHash": {
+ "type": "string",
+ "description": "The translation unit hash code."
+ },
+ "action": {
+ "type": "string",
+ "description": "The action performed",
+ "enum": [
+ "discard",
+ "add",
+ "merge",
+ "overwrite",
+ "error",
+ "delete"
+ ]
+ }
+ }
+ },
+ "translation-unit-resource-type": {
+ "title": "Translation Unit Resource Type",
+ "type": "string",
+ "description": "Enumeration of available translation unit resource types.",
+ "enum": [
+ "TM"
+ ]
+ },
+ "translation-applied-resource-status": {
+ "title": "Translation Applied Resource Status",
+ "x-stoplight": {
+ "id": "l8qfj2wt8ex3q"
+ },
+ "type": "object",
+ "properties": {
+ "resourceId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "ijitw3244ojkf"
+ },
+ "description": "default
The resource identifier."
+ },
+ "resourceType": {
+ "$ref": "#/components/schemas/translation-resource-type",
+ "x-stoplight": {
+ "id": "3y8wplo4peutt"
+ },
+ "description": "default
The type of resource applied."
+ },
+ "status": {
+ "x-stoplight": {
+ "id": "vacv71ru214af"
+ },
+ "type": "string",
+ "enum": [
+ "successful",
+ "unsuccessful"
+ ],
+ "description": "default
The status of the applied resource."
+ },
+ "message": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "wj0qjf9jfalmv"
+ },
+ "description": "A message describing the applied resource."
+ },
+ "translationErrors": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "o91qwrova4eay"
+ },
+ "description": "Details of possible errors.",
+ "items": {
+ "$ref": "#/components/schemas/translation-error-detail-response",
+ "x-stoplight": {
+ "id": "rllzog6wfm1te"
+ }
+ }
+ }
+ }
+ },
+ "translation-concordance-search-applied-resource-status": {
+ "title": "Translation Concordance Search Applied Resource Status",
+ "x-stoplight": {
+ "id": "l8qfj2wt8ex3q"
+ },
+ "type": "object",
+ "properties": {
+ "resourceId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "ijitw3244ojkf"
+ },
+ "description": "default
The resource identifier."
+ },
+ "resourceType": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "3y8wplo4peutt"
+ },
+ "description": "default
The type of resource applied.",
+ "enum": [
+ "TM"
+ ]
+ },
+ "status": {
+ "x-stoplight": {
+ "id": "vacv71ru214af"
+ },
+ "type": "string",
+ "enum": [
+ "successful",
+ "unsuccessful"
+ ],
+ "description": "default
The status of the applied resource."
+ },
+ "message": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "wj0qjf9jfalmv"
+ },
+ "description": "A message describing the applied resource."
+ },
+ "translationErrors": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "o91qwrova4eay"
+ },
+ "description": "Details of possible errors.",
+ "items": {
+ "$ref": "#/components/schemas/translation-error-detail-response",
+ "x-stoplight": {
+ "id": "rllzog6wfm1te"
+ }
+ }
+ }
+ }
+ },
+ "translation-definition": {
+ "title": "Translation Definition",
+ "x-stoplight": {
+ "id": "1ajyhlvlclubb"
+ },
+ "type": "object",
+ "required": [
+ "translationEngineId"
+ ],
+ "properties": {
+ "translationEngineId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "546wr95sonkhe"
+ },
+ "description": "The translation engine identifier."
+ }
+ }
+ },
+ "translation-concordance-search-definition": {
+ "title": "Translation Concordance Search Definition",
+ "x-stoplight": {
+ "id": "1ajyhlvlclubb"
+ },
+ "type": "object",
+ "required": [
+ "translationEngineId"
+ ],
+ "properties": {
+ "translationEngineId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "546wr95sonkhe"
+ },
+ "description": "The translation engine identifier."
+ }
+ }
+ },
+ "translation-resource": {
+ "title": "Translation Resource",
+ "x-stoplight": {
+ "id": "vrs494q2buzhy"
+ },
+ "type": "object",
+ "required": [
+ "resourceId",
+ "type"
+ ],
+ "properties": {
+ "resourceId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "1wr6q3uu0ow0s"
+ },
+ "description": "The resource identifier."
+ },
+ "type": {
+ "$ref": "#/components/schemas/translation-resource-type",
+ "x-stoplight": {
+ "id": "mn8n0t9bwutha"
+ }
+ }
+ }
+ },
+ "translation-resource-type": {
+ "title": "Translation Resource Type",
+ "type": "string",
+ "x-stoplight": {
+ "id": "zr6udmd1g99q4"
+ },
+ "description": "The translation resource type",
+ "enum": [
+ "TM",
+ "MT",
+ "TB"
+ ]
+ },
+ "translation-concordance-resource-type": {
+ "title": "Translation Resource Type",
+ "type": "string",
+ "x-stoplight": {
+ "id": "zr6udmd1g99q4"
+ },
+ "description": "The translation resource type",
+ "enum": [
+ "TM"
+ ]
+ },
+ "translation": {
+ "title": "Translation",
+ "x-stoplight": {
+ "id": "a0g18gy80z5p1"
+ },
+ "type": "object",
+ "required": [
+ "translationProposal",
+ "resourceType"
+ ],
+ "properties": {
+ "translationProposal": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "siqg2y0t0s38m"
+ },
+ "description": "The translation content serialized as JSON. BCM fragment for `TM` and `MT`. BCM term for `TB`."
+ },
+ "resourceType": {
+ "$ref": "#/components/schemas/translation-resource-type",
+ "x-stoplight": {
+ "id": "gkon15o12wfc8"
+ }
+ },
+ "sourceLocation": {
+ "$ref": "#/components/schemas/translation-source-locations",
+ "description": "The source location is only available for `TB`."
+ }
+ }
+ },
+ "translation-concordance": {
+ "title": "Translation",
+ "x-stoplight": {
+ "id": "a0g18gy80z5p1"
+ },
+ "type": "object",
+ "required": [
+ "translationProposal",
+ "resourceType"
+ ],
+ "properties": {
+ "translationProposal": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "siqg2y0t0s38m"
+ },
+ "description": "The translation content serialized as JSON. BCM fragment for `TM`."
+ },
+ "resourceType": {
+ "$ref": "#/components/schemas/translation-concordance-resource-type",
+ "x-stoplight": {
+ "id": "gkon15o12wfc8"
+ }
+ }
+ }
+ },
+ "translation-source-locations": {
+ "title": "sourceLocations",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/translation-source-location"
+ }
+ },
+ "translation-source-location": {
+ "title": "sourceLocation",
+ "type": "object",
+ "properties": {
+ "start": {
+ "type": "integer"
+ },
+ "length": {
+ "type": "integer"
+ }
+ }
+ },
+ "translation-concordance-search-request": {
+ "title": "Translation Concordance Search Request",
+ "x-stoplight": {
+ "id": "mu51b39komenk"
+ },
+ "type": "object",
+ "required": [
+ "input",
+ "languageDirection",
+ "definition"
+ ],
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/translation-concordance-input-request",
+ "x-stoplight": {
+ "id": "15af4h5jkfyvj"
+ }
+ },
+ "languageDirection": {
+ "$ref": "#/components/schemas/language-direction-general-request",
+ "x-stoplight": {
+ "id": "o84ns9q1ulxkz"
+ }
+ },
+ "definition": {
+ "$ref": "#/components/schemas/translation-concordance-search-definition",
+ "x-stoplight": {
+ "id": "d6yrwalewio7h"
+ }
+ },
+ "targetOnly": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "ffjvv0xao6ykz"
+ },
+ "default": false,
+ "description": "Indicates whether the search should be performed only in the target segments."
+ },
+ "settings": {
+ "$ref": "#/components/schemas/concordance-search-settings",
+ "x-stoplight": {
+ "id": "49cht6969uysn"
+ }
+ }
+ }
+ },
+ "translation-add-request": {
+ "title": "Translation Add Request",
+ "x-stoplight": {
+ "id": "44r5oq5khi1fs"
+ },
+ "type": "object",
+ "required": [
+ "input",
+ "definition"
+ ],
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/translation-tu-update-input-request",
+ "x-stoplight": {
+ "id": "4an4r6b9854aq"
+ }
+ },
+ "definition": {
+ "$ref": "#/components/schemas/translation-update-definition",
+ "x-stoplight": {
+ "id": "rv8rlalk5d2a7"
+ }
+ },
+ "settings": {
+ "$ref": "#/components/schemas/translation-add-settings",
+ "x-stoplight": {
+ "id": "uy8l353n2uh3g"
+ }
+ }
+ }
+ },
+ "translation-update-request": {
+ "title": "Translation Update Request",
+ "x-stoplight": {
+ "id": "44r5oq5khi1fs"
+ },
+ "type": "object",
+ "required": [
+ "input",
+ "definition"
+ ],
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/translation-tu-update-input-request",
+ "x-stoplight": {
+ "id": "4an4r6b9854aq"
+ }
+ },
+ "definition": {
+ "$ref": "#/components/schemas/translation-update-definition",
+ "x-stoplight": {
+ "id": "rv8rlalk5d2a7"
+ }
+ },
+ "settings": {
+ "$ref": "#/components/schemas/translation-update-settings",
+ "x-stoplight": {
+ "id": "uy8l353n2uh3g"
+ }
+ }
+ }
+ },
+ "translation-add-settings": {
+ "title": "Translation Add Settings",
+ "x-stoplight": {
+ "id": "4rfs3hgmqnjnl"
+ },
+ "type": "object",
+ "properties": {
+ "fields": {
+ "x-stoplight": {
+ "id": "q2x1e7tqb6bjj"
+ },
+ "type": "array",
+ "description": "The Translation Unit fields to update. They are defined in the Field Template associated to your Translation Memory.",
+ "items": {
+ "$ref": "#/components/schemas/translation-update-field",
+ "x-stoplight": {
+ "id": "zrkulmef1pa37"
+ }
+ }
+ },
+ "ifTargetSegmentsDiffer": {
+ "x-stoplight": {
+ "id": "9kr4dv5q5yko5"
+ },
+ "type": "string",
+ "enum": [
+ "addNew",
+ "overwrite",
+ "leaveUnchanged",
+ "keepMostRecent",
+ "merge"
+ ],
+ "description": "Update behavior when the translation unit already exists but target differs."
+ }
+ }
+ },
+ "translation-update-settings": {
+ "title": "Translation Update Settings",
+ "x-stoplight": {
+ "id": "4rfs3hgmqnjnl"
+ },
+ "type": "object",
+ "properties": {
+ "fields": {
+ "x-stoplight": {
+ "id": "q2x1e7tqb6bjj"
+ },
+ "type": "array",
+ "description": "The Translation Unit fields to update. They are defined in the Field Template associated to your Translation Memory.",
+ "items": {
+ "$ref": "#/components/schemas/translation-update-field",
+ "x-stoplight": {
+ "id": "zrkulmef1pa37"
+ }
+ }
+ }
+ }
+ },
+ "translation-update-resource": {
+ "title": "Translation Update Resource",
+ "x-stoplight": {
+ "id": "kk5sxng7r7rcv"
+ },
+ "type": "object",
+ "required": [
+ "resourceId",
+ "type"
+ ],
+ "properties": {
+ "resourceId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "ht1329zmz3hgp"
+ },
+ "description": "The resource identifier."
+ },
+ "type": {
+ "x-stoplight": {
+ "id": "dmov4sqorfrf3"
+ },
+ "type": "string",
+ "enum": [
+ "TM"
+ ],
+ "description": "The translation resource type."
+ }
+ }
+ },
+ "translation-cost-item": {
+ "title": "Translation Cost Item",
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number",
+ "description": "default
The total number of units.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "rate": {
+ "type": "number",
+ "description": "default
The cost of a unit.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "total": {
+ "type": "number",
+ "description": "default
The total cost for the current item.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "runningTotal": {
+ "type": "number",
+ "description": "default
The sum of all the previously computed costs.
",
+ "nullable": true,
+ "x-default-field": true
+ }
+ }
+ },
+ "translation-cost-fuzzy-item": {
+ "title": "Translation Cost Fuzzy Item",
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number",
+ "description": "default
The total number of units.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "rate": {
+ "type": "number",
+ "description": "default
The cost of a unit.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "total": {
+ "type": "number",
+ "description": "default
The total cost for the current item.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "runningTotal": {
+ "type": "number",
+ "description": "default
The sum of all the previously computed costs.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "fuzzyCategory": {
+ "$ref": "#/components/schemas/fuzzy-category",
+ "description": "default
Fuzzy category range.
",
+ "x-default-field": true
+ }
+ }
+ },
+ "translation-engine": {
+ "title": "Translation Engine",
+ "type": "object",
+ "description": "Translation Engine resource. (Not available for List Projects endpoint)",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The translation engine identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The translation engine name.
",
+ "x-default-field": true
+ },
+ "description": {
+ "type": "string"
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder-v2"
+ },
+ "definition": {
+ "$ref": "#/components/schemas/translation-engine-definition"
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "translation-engine-update-request": {
+ "title": "Translation Engine Update Request",
+ "x-stoplight": {
+ "id": "qjks6cvd5ej43"
+ },
+ "type": "object",
+ "description": "Translation Engine resource update request",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "default
The translation engine name.
",
+ "x-default-field": true,
+ "minLength": 1,
+ "maxLength": 50
+ },
+ "description": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "h2kzvu2xlq1dh"
+ },
+ "maxLength": 1000
+ },
+ "definition": {
+ "$ref": "#/components/schemas/translation-engine-definition",
+ "x-stoplight": {
+ "id": "gesu0kld6jyxg"
+ }
+ }
+ }
+ },
+ "translation-engine-definition": {
+ "title": "Translation Engine Definition",
+ "x-stoplight": {
+ "id": "yb3ai5ltnbu49"
+ },
+ "type": "object",
+ "description": "The definition of a translation engine.",
+ "required": [
+ "languageProcessingRuleId"
+ ],
+ "properties": {
+ "languageProcessingRuleId": {
+ "type": "string"
+ },
+ "languagePairDefinitions": {
+ "type": [
+ "array"
+ ],
+ "x-stoplight": {
+ "id": "891hvyzbxnaqm"
+ },
+ "items": {
+ "$ref": "#/components/schemas/translation-engine-definition-language-pair",
+ "x-stoplight": {
+ "id": "nbfh6uvky8c4o"
+ }
+ }
+ },
+ "sequence": {
+ "$ref": "#/components/schemas/remote-translation-engine-sequence"
+ }
+ }
+ },
+ "remote-translation-engine-sequence": {
+ "title": "Translation Engine Sequence",
+ "description": "Lists of IDs for Translation Memories, Termbases, Machine Translations and Large Language Models, in order of their use",
+ "properties": {
+ "tm":{
+ "type": "array",
+ "description": "Translation Memories",
+ "items": {
+ "type": "string"
+ }
+ },
+ "tb":{
+ "type": "array",
+ "description": "Termbases",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mt":{
+ "type": "array",
+ "description": "Machine Translations",
+ "items":{
+ "type": "string"
+ }
+ },
+ "llm":{
+ "type": "array",
+ "description": "Large Language Models",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "translation-engine-definition-language-pair": {
+ "title": "Language Pair Definition",
+ "x-stoplight": {
+ "id": "isibhifp9qrao"
+ },
+ "type": "object",
+ "properties": {
+ "languagePair": {
+ "$ref": "#/components/schemas/language-pair",
+ "x-stoplight": {
+ "id": "ixoi0dqka8bkw"
+ }
+ },
+ "resources": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "foi4rdwsrevkj"
+ },
+ "items": {
+ "$ref": "#/components/schemas/language-pair-resource",
+ "x-stoplight": {
+ "id": "d2b4btupa9mu1"
+ }
+ }
+ }
+ },
+ "required": [
+ "languagePair",
+ "resources"
+ ]
+ },
+ "translation-memory-field": {
+ "title": "Translation Memory Field",
+ "type": "object",
+ "description": "The unique identifier of the field.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The unique identifier of the field."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The name of the field.
",
+ "x-default-field": true
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "unknown",
+ "singleString",
+ "multipleString",
+ "dateTime",
+ "singlePicklist",
+ "multiplePicklist",
+ "integer"
+ ],
+ "description": "The data type of the field."
+ },
+ "values": {
+ "type": "array",
+ "description": "A collection of values for this field.",
+ "items": {
+ "$ref": "#/components/schemas/translation-memory-field-value"
+ }
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "translation-memory-fields": {
+ "title": "Translation Memory Fields",
+ "type": "object",
+ "properties": {
+ "settings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/translation-memory-fields-settings"
+ },
+ "description": "default
",
+ "x-default-field": true
+ }
+ }
+ },
+ "translation-memory-field-template": {
+ "title": "Translation Memory Field Template",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The unique identifier of the translation memory field template."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The name of the field template.
",
+ "x-default-field": true
+ },
+ "description": {
+ "type": "string",
+ "description": "The field template description."
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder-v2"
+ },
+ "fieldDefinitions": {
+ "type": "array",
+ "description": "A collection of translation memory fields.",
+ "items": {
+ "$ref": "#/components/schemas/translation-memory-field"
+ }
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "translation-memory-field-value": {
+ "title": "Translation Memory Field Value",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The unique identifier associated with this value."
+ },
+ "value": {
+ "type": "string",
+ "description": "A translation memory field value."
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "translation-memory": {
+ "title": "Translation Memory",
+ "type": "object",
+ "description": "",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique identifier of the translation memory."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The translation memory name.
",
+ "x-default-field": true
+ },
+ "description": {
+ "type": "string",
+ "description": "The translation memory description."
+ },
+ "copyright": {
+ "type": "string"
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder"
+ },
+ "languageDirections": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/translation-memory-language-direction"
+ },
+ "description": "default
A collection of language directions
",
+ "x-default-field": true
+ },
+ "languageProcessingRule": {
+ "$ref": "#/components/schemas/language-processing-rule"
+ },
+ "fieldTemplate": {
+ "$ref": "#/components/schemas/translation-memory-field-template"
+ },
+ "createdAt": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2022-01-12T12:00:00.000Z",
+ "description": "The `DateTime` when the translation memory was created. UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "createdBy": { + "$ref": "#/components/schemas/user" + }, + "lastRecomputedAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The `DateTime` when the translation memory statistics were last updated.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "lastReIndexedAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The `DateTime` when the translation memory reindexing was performed.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + } + }, + "required": [ + "id" + ] + }, + "translation-memory-fields-update-request": { + "title": "Translation Memory Fields Update Request", + "x-stoplight": { + "id": "lcpur5t4ewvi2" + }, + "type": "object", + "properties": { + "settings": { + "type": "array", + "description": "The configuration settings for Translation Memory Fields.", + "items": { + "$ref": "#/components/schemas/translation-memory-fields-settings-request" + } + } + }, + "required": [ + "settings" + ] + }, + "translation-memory-field-update-type": { + "type": "string", + "title": "Translation Memory Field Update Type", + "x-stoplight": { + "id": "vq3s0tuc4yp5u" + }, + "enum": [ + "dateTime", + "singlePicklist", + "multiplePicklist", + "integer", + "singleString", + "multipleString" + ], + "description": "The data type of the value." + }, + "translation-memory-fields-settings-request": { + "title": "Translation Memory Fields Settings Request", + "type": "object", + "description": "", + "properties": { + "name": { + "type": "string", + "description": "The name of the translation memory field." + }, + "values": { + "type": "array", + "description": "A collection of values.", + "items": { + "type": "string" + } + }, + "type": { + "$ref": "#/components/schemas/translation-memory-field-update-type" + } + }, + "required": [ + "name", + "values", + "type" + ] + }, + "translation-memory-fields-settings": { + "title": "Translation Memory Fields Settings", + "x-stoplight": { + "id": "adnwx8tlwr674" + }, + "type": "object", + "description": "The configuration settings for Translation Memory Fields.", + "properties": { + "name": { + "type": "string", + "description": "The name of the translation memory field." + }, + "values": { + "type": "array", + "description": "A collection of values.", + "items": { + "type": "string" + } + }, + "type": { + "$ref": "#/components/schemas/translation-memory-field-update-type" + } + }, + "required": [ + "name", + "values", + "type" + ] + }, + "translation-memory-base": { + "title": "Translation Memory", + "type": "object", + "description": "", + "properties": { + "id": { + "type": "string", + "description": "The unique translation memory identifier." + }, + "name": { + "type": "string", + "description": "The translation memory name." + }, + "description": { + "type": "string", + "description": "The translation memory description" + }, + "copyright": { + "type": "string" + }, + "location": { + "$ref": "#/components/schemas/folder" + }, + "languageDirections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/translation-memory-language-direction" + } + }, + "languageProcessingRule": { + "$ref": "#/components/schemas/language-processing-rule" + }, + "fieldTemplate": { + "$ref": "#/components/schemas/translation-memory-field-template" + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The `DateTime` when the translation memory was created.", + "nullable": true + }, + "createdBy": { + "$ref": "#/components/schemas/user" + } + }, + "required": [ + "id" + ] + }, + "translation-memory-create-request": { + "title": "Translation Memory Create Request", + "type": "object", + "description": "The model to use when creating a new Translation Memory.", + "properties": { + "name": { + "type": "string", + "maxLength": 151, + "minLength": 1, + "description": "The Translation Memory name." + }, + "description": { + "type": "string", + "maxLength": 1024, + "description": "The Translation Memory description." + }, + "copyright": { + "type": "string", + "maxLength": 1024 + }, + "location": { + "type": "string", + "description": "The folder identifier where the translation memory should be created." + }, + "languageDirections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/language-direction-request" + } + }, + "languageProcessingRuleId": { + "type": "string", + "description": "The Language Processing Rule to be associated with the Translation Memory." + }, + "fieldTemplateId": { + "type": "string", + "description": "A Field Template to be associated with the Translation Memory." + } + }, + "required": [ + "name", + "languageDirections", + "languageProcessingRuleId", + "fieldTemplateId" + ] + }, + "translation-memory-update-request": { + "title": "Translation Memory Update Request", + "type": "object", + "description": "", + "properties": { + "name": { + "type": "string", + "description": "The translation memory name", + "minLength": 1, + "maxLength": 151 + }, + "description": { + "type": "string", + "maxLength": 1024, + "description": "The translation memory description" + }, + "copyright": { + "type": "string", + "maxLength": 1024 + }, + "languageDirections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/language-direction-request" + } + }, + "languageProcessingRuleId": { + "type": "string", + "description": "The language processing rule to be associated with the translation memory." + }, + "fieldTemplateId": { + "type": "string", + "description": "A field template to be associated with the translation memory." + } + } + }, + "translation-memory-language-direction": { + "title": "Translation Memory Language Direction", + "x-stoplight": { + "id": "lxtdb1sy4fdbi" + }, + "type": "object", + "description": "A language direction representation specific to translation memories.", + "properties": { + "languageDirection": { + "$ref": "#/components/schemas/simple-language-direction", + "description": "
default
A basic language direction.
",
+ "x-default-field": true
+ },
+ "translationUnits": {
+ "type": "integer",
+ "description": "The number of translation units for this language pair. Sum up all language pairs to get the total for the translation memory.",
+ "nullable": true
+ },
+ "unalignedTranslationUnits": {
+ "type": "integer",
+ "description": "The number of translation units that are unaligned for this language pair. Sum up all language pairs to get the total for the translation memory.",
+ "nullable": true
+ }
+ }
+ },
+ "translation-memory-import-request": {
+ "title": "Translation Memory Import Properties",
+ "type": "object",
+ "description": "Translation Memory Import properties sent as a JSON inside a text part.",
+ "properties": {
+ "sourceLanguageCode": {
+ "type": "string",
+ "description": "The code of the source language of the translation memory."
+ },
+ "targetLanguageCode": {
+ "type": "string",
+ "description": "The code of the target language of the translation memory."
+ },
+ "importAsPlainText": {
+ "description": "(Deprecated) The default value is set for this field, as this property is set internally.",
+ "type": "boolean",
+ "deprecated": true
+ },
+ "exportInvalidTranslationUnits": {
+ "type": "boolean",
+ "default": true
+ },
+ "triggerRecomputeStatistics": {
+ "description": "(Deprecated) The default value is set for this field, as this property is set internally.",
+ "type": "boolean",
+ "deprecated": true
+ },
+ "targetSegmentsDifferOption": {
+ "type": "string",
+ "description": "Option to specify how to handle translation units in the Translation Memory, if target segments differ.",
+ "enum": [
+ "addNew",
+ "overwrite",
+ "leaveUnchanged",
+ "keepMostRecent"
+ ],
+ "default": "addNew"
+ },
+ "unknownFieldsOption": {
+ "type": "string",
+ "description": "Option to specify how to handle translation units and unknown fields in the Translation Memory.",
+ "enum": [
+ "skipTranslationUnit",
+ "ignore",
+ "addToTranslationMemory",
+ "failTranslationUnitImport"
+ ],
+ "default": "addToTranslationMemory"
+ },
+ "onlyImportSegmentsWithConfirmationLevels": {
+ "description": "Only segments with the these confirmation levels will be imported. Default if the field is not set or null: [translated, approvedSignOff, approvedTranslation]. Empty array will be treated as not specified.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "translated",
+ "approvedTranslation",
+ "approvedSignOff",
+ "draft",
+ "rejectedTranslation",
+ "rejectedSignOff"
+ ]
+ }
+ }
+ },
+ "required": [
+ "sourceLanguageCode",
+ "targetLanguageCode"
+ ]
+ },
+ "translation-memory-import-response": {
+ "title": "Translation Memory Import Response",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The unique identifier of the import operation."
+ },
+ "status": {
+ "type": "string",
+ "description": "(Deprecated) The status of the import operation.\n* `queued` - the import has been queued and is waiting to be processed\n* `inProgress` - the import is being processed\n* `failed` - the import has failed due to internal errors\n* `done` - the import has finished successfully\n* `cancelled` - the import has been interrupted",
+ "enum": [
+ "queued",
+ "inProgress",
+ "failed",
+ "done",
+ "cancelled"
+ ],
+ "deprecated": true
+ }
+ },
+ "required": [
+ "id",
+ "status"
+ ]
+ },
+ "translation-memory-import-poll-response": {
+ "title": "Translation Memory Import Response",
+ "x-stoplight": {
+ "id": "f31ba8725474f"
+ },
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The unique identifier of the import operation."
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of the import operation.\n* `queued` - the import has been queued and is waiting to be processed\n* `inProgress` - the import is being processed\n* `failed` - the import has failed due to internal errors\n* `done` - the import has finished successfully\n* `cancelled` - the import has been interrupted",
+ "enum": [
+ "queued",
+ "inProgress",
+ "failed",
+ "done",
+ "cancelled"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "status"
+ ]
+ },
+ "translation-memory-import-history-response": {
+ "title": "Translation Memory Import History Response",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The unique identifier of the import operation."
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of the import operation.\n* `queued` - the import has been queued\n* `inPorgress` - the import is being processed\n* `failed` - the import has failed\n* `done` - the import has finished successfully\n* `cancelled` - the import has been cancelled",
+ "enum": [
+ "queued",
+ "inProgress",
+ "failed",
+ "done",
+ "cancelled"
+ ]
+ },
+ "displayName": {
+ "type": "string",
+ "description": "The assigned name of the import operation."
+ },
+ "settings": {
+ "$ref": "#/components/schemas/translation-memory-import-settings"
+ },
+ "createdAt": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2022-01-12T12:00:00.000Z",
+ "description": "The creation date of the import operation. UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss" + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The last update time of the import operation.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss" + }, + "ownerId": { + "type": "string", + "description": "Owner of the import operation, corresponds with the tenant identifier." + } + }, + "required": [ + "id", + "status" + ] + }, + "translation-memory-import-settings": { + "title": "Translation Memory Import Settings", + "type": "object", + "description": "The properties provided by the client, when the Import Operation was triggered.", + "properties": { + "onlyImportSegmentsWithConfirmationLevels": { + "description": "Only segments with the these confirmation levels were be imported.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "translated", + "approvedTranslation", + "approvedSignOff", + "draft", + "rejectedTranslation", + "rejectedSignOff" + ] + } + }, + "unknownFieldsOption": { + "description": "This option describes how were the translation units handled when there were unknown fields in the request.", + "enum": [ + "skipTranslationUnit", + "ignore", + "addToTranslationMemory", + "failTranslationUnitImport" + ], + "type": "string" + }, + "targetSegmentsDifferOption": { + "description": "This option describes how were the translation units handled when there were differences in target segments.", + "enum": [ + "addNew", + "overwrite", + "leaveUnchanged", + "keepMostRecent" + ], + "type": "string" + }, + "importAsPlainText": { + "description": "(Deprecated) The default value is set for this field, as this property is set internally.", + "type": "boolean", + "deprecated": true + }, + "exportInvalidTranslationUnits": { + "description": "This option describes if the invalid translation units were exported during the original translation memory import operation.", + "type": "boolean" + }, + "triggerRecomputeStatistics": { + "description": "(Deprecated) The default value is set for this field, as this property is set internally.", + "type": "boolean", + "deprecated": true + }, + "fileName": { + "description": "The name of the file attached to the import request.", + "type": "string" + }, + "sourceLanguageCode": { + "description": "The source language code of the import request.", + "type": "string" + }, + "targetLanguageCode": { + "description": "The target language code of the import request.", + "type": "string" + }, + "traceId": { + "description": "(Deprecated) The field will be completly remove in the future. For compatibily, until it will be removed a default value it is set: 0000-0000-0000-0000.", + "type": "string", + "deprecated": true + } + }, + "required": [ + "onlyImportSegmentsWithConfirmationLevels", + "unknownFieldsOption", + "targetSegmentsDifferOption", + "importAsPlainText", + "exportInvalidTranslationUnits", + "triggerRecomputeStatistics", + "fileName", + "sourceLanguageCode", + "targetLanguageCode", + "traceId" + ] + }, + "translation-memory-export-response": { + "title": "Translation Memory Export Response", + "x-stoplight": { + "id": "ol4kmgwlbdr8f" + }, + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The translation memory export identifier." + }, + "status": { + "type": "string", + "description": "(Deprecated) The status of the import operation.\n* `queued` - the import has been queued and is waiting to be processed\n* `inProgress` - the import is being processed\n* `failed` - the import has failed due to internal errors\n* `done` - the import has finished successfully\n* `cancelled` - the import has been interrupted", + "enum": [ + "queued", + "inProgress", + "failed", + "done", + "cancelled" + ], + "deprecated": true + } + }, + "required": [ + "id", + "status" + ] + }, + "translation-memory-poll-export-response": { + "title": "Translation Memory Export Response", + "x-stoplight": { + "id": "h78jfifpf8rpa" + }, + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The translation memory export identifier." + }, + "status": { + "type": "string", + "description": "The translation memory export status.\n* `queued` - the export has been queued to be processed\n* `inProgress` - the export is being processed\n* `failed` - the export has failed due to internal errors\n* `done` - the export has finished successfully\n* `cancelled` - the export has been interrupted", + "enum": [ + "queued", + "inProgress", + "failed", + "done", + "cancelled" + ] + } + }, + "required": [ + "id", + "status" + ] + }, + "translation-memory-export-language-direction": { + "title": "Translation Memory Export Language Direction", + "x-stoplight": { + "id": "sgv1fy31ffmba" + }, + "type": "object", + "description": "", + "properties": { + "sourceLanguage": { + "$ref": "#/components/schemas/source-language-request" + }, + "targetLanguage": { + "$ref": "#/components/schemas/target-language-request" + } + }, + "required": [ + "sourceLanguage", + "targetLanguage" + ] + }, + "translation-memory-export-request": { + "title": "Translation Memory Export Request", + "x-stoplight": { + "id": "ivlpf7ccfd3is" + }, + "description": "", + "type": "object", + "properties": { + "languageDirection": { + "$ref": "#/components/schemas/translation-memory-export-language-direction" + } + }, + "required": [ + "languageDirection" + ] + }, + "translation-service-type": { + "title": "Service Type", + "x-stoplight": { + "id": "qxo8dvfuhtpvn" + }, + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "x-stoplight": { + "id": "y8k58twki2cx2" + }, + "description": "The Service Type identifier." + }, + "name": { + "type": "string", + "x-stoplight": { + "id": "at815peslzdx2" + }, + "description": "
default
The Service Type name.
"
+ }
+ }
+ },
+ "update-translation-memory": {
+ "title": "Update Translation Memory",
+ "x-stoplight": {
+ "id": "7imfj2yp6ndh4"
+ },
+ "type": "object",
+ "properties": {
+ "settings": {
+ "$ref": "#/components/schemas/update-translation-memory-settings",
+ "description": "The configuration settings for Update Translation Memory\r\n.",
+ "x-default-field": true
+ }
+ },
+ "required": [
+ "settings"
+ ]
+ },
+ "update-translation-memory-settings": {
+ "title": "Update Translation Memory Settings",
+ "x-stoplight": {
+ "id": "ns9gqapkdazxv"
+ },
+ "type": "object",
+ "properties": {
+ "segmentsConfirmationLevels": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "1sf7j3cudjzag"
+ },
+ "items": {
+ "x-stoplight": {
+ "id": "7tg40rat3gilo"
+ },
+ "type": "string",
+ "enum": [
+ "approvedTranslation",
+ "approvedSignOff",
+ "draft",
+ "notTranslated",
+ "translated",
+ "rejectedTranslation",
+ "rejectedSignOff"
+ ]
+ },
+ "description": "Default values are: \n\r [`translated`, `approvedTranslation`, `approvedSignOff`]."
+ },
+ "targetSegmentsDifferOption": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "2ndpsnxl5k5qq"
+ },
+ "enum": [
+ "addNew",
+ "overwrite",
+ "keepMostRecent",
+ "leaveUnchanged",
+ "merge"
+ ],
+ "description": "Options:\r\n- `merge`: replace (update) only the TU (from which a match was retrieved for the edited TU) with the latest available translation AND keep the other duplicates as they are. Use this option to have multiple translations for the same source together with Multiple Translation Penalty = 0.\r\n- `addNew`: add translations as new TUs to the TM. Specify the status of the TUs (which will be added) under Segment status. This means that the existing TUs in the TM are not overwritten.\r\n- `overwriteExisting`: delete all TUs (which have the same source, all TU duplicates) and keep only the last added TU (the latest available translation). Use this option to prevent inconsistent translations.\r\n- `leaveUnchanged`: keep the existing TUs and do not add any new ones.\r\n- `keepMostRecent`: replace (update) only the most recent TU (from which a match was retrieved for the edited TU) with the latest available translation AND delete all other duplicates.\r\n",
+ "default": "merge"
+ }
+ },
+ "required": [
+ "segmentsConfirmationLevels",
+ "targetSegmentsDifferOption"
+ ]
+ },
+ "user": {
+ "title": "User",
+ "type": "object",
+ "description": "User in the account.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "User account identifier."
+ },
+ "email": {
+ "type": "string",
+ "description": "default
The user's email address. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
",
+ "x-default-field": true
+ },
+ "firstName": {
+ "type": "string",
+ "description": "default
The user's first name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
",
+ "x-default-field": true
+ },
+ "lastName": {
+ "type": "string",
+ "description": "default
The user's last name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
",
+ "x-default-field": true
+ },
+ "anonymized": {
+ "type": "boolean",
+ "description": "default
This shows if the authenticated entity has access to read the details of the user or not. If true, then the 'anonymizedUserName' should be retrieved.
",
+ "nullable": true,
+ "x-default-field": true
+ },
+ "anonymizedUserName": {
+ "type": "string",
+ "description": "default
Retrieved if the authenticated entity does not have access to read the User.
",
+ "x-default-field": true
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder-v2"
+ },
+ "groups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/group"
+ }
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "user-request": {
+ "title": "User Request",
+ "type": "object",
+ "description": "User in the account.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The user identifier."
+ },
+ "email": {
+ "type": "string",
+ "description": "User’s email. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read."
+ },
+ "firstName": {
+ "type": "string",
+ "description": "User’s first name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read."
+ },
+ "lastName": {
+ "type": "string",
+ "description": "User’s last name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read."
+ },
+ "location": {
+ "$ref": "#/components/schemas/resource-folder-request"
+ },
+ "groups": {
+ "type": "array",
+ "description": "The groups.",
+ "items": {
+ "$ref": "#/components/schemas/group-request"
+ }
+ },
+ "anonymized": {
+ "type": "boolean",
+ "description": "Shows if the authenticated entity has access to read the details of the user or not. If true then the ‘anonymizedUserName’ should be retrieved.",
+ "nullable": true
+ },
+ "anonymizedUserName": {
+ "type": "string",
+ "description": "Retrieved if the authenticated entity does not have access to read the User."
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "vendor-order": {
+ "title": "Vendor Order",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "quote": {
+ "$ref": "#/components/schemas/quote"
+ }
+ },
+ "required": [
+ "id"
+ ],
+ "description": "A vendor order resource."
+ },
+ "vendor-order-template-request": {
+ "title": "Vendor Order Template Request",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "vendor-order-template": {
+ "title": "Vendor Order Template",
+ "description": "The vendor order template.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "volume-unit-type": {
+ "title": "Volume Unit Type",
+ "x-stoplight": {
+ "id": "xo217uws14jb2"
+ },
+ "enum": [
+ "words",
+ "characters",
+ "custom"
+ ]
+ },
+ "workflow": {
+ "title": "Workflow",
+ "type": "object",
+ "description": "The steps a project goes through. (Not available for List Projects endpoint)",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The workflow identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The workflow name.
",
+ "x-default-field": true
+ },
+ "description": {
+ "type": "string",
+ "description": "The workflow description."
+ },
+ "location": {
+ "$ref": "#/components/schemas/folder"
+ },
+ "workflowTemplate": {
+ "$ref": "#/components/schemas/workflow-template"
+ },
+ "taskConfigurations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/workflow-task-configuration"
+ }
+ },
+ "languageDirections": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/language-direction-no-statistics"
+ }
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "workflow-task-assignee": {
+ "title": "Workflow Task Assignee",
+ "type": "object",
+ "description": "Task assignee. Based on the \"type\", further details can be retrieved. For ex. for \"type\"=\"user\", \"user\" property is available.
For \"projectCreator\" and \"projectManager\" no other property is available.", + "properties": { + "type": { + "type": "string", + "enum": [ + "user", + "group", + "vendorOrderTemplate", + "projectCreator", + "projectManager" + ] + }, + "user": { + "$ref": "#/components/schemas/user", + "description": "
default
User in the account
",
+ "x-default-field": true
+ },
+ "group": {
+ "$ref": "#/components/schemas/group",
+ "description": "default
Group of users.
",
+ "x-default-field": true
+ },
+ "vendorOrderTemplate": {
+ "$ref": "#/components/schemas/vendor-order-template",
+ "description": "default
A vendor oder template.
",
+ "x-default-field": true
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "workflow-task-assignee-request": {
+ "title": "Workflow Task Assignee Request",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "user",
+ "group",
+ "vendorOrderTemplate",
+ "projectCreator",
+ "projectManager"
+ ]
+ },
+ "user": {
+ "$ref": "#/components/schemas/user-request"
+ },
+ "group": {
+ "$ref": "#/components/schemas/group-request"
+ },
+ "vendorOrderTemplate": {
+ "$ref": "#/components/schemas/vendor-order-template-request"
+ }
+ },
+ "required": [
+ "type"
+ ]
+ },
+ "workflow-task-configuration": {
+ "title": "Workflow Task Configuration",
+ "type": "object",
+ "description": "Properties of a workflow task.",
+ "properties": {
+ "scope": {
+ "$ref": "#/components/schemas/task-configuration-scope"
+ },
+ "assignees": {
+ "$ref": "#/components/schemas/workflow-task-assignee"
+ },
+ "isSkipped": {
+ "type": "boolean",
+ "nullable": true,
+ "description": "default
",
+ "x-default-field": true
+ },
+ "taskTemplate": {
+ "$ref": "#/components/schemas/workflow-task-template"
+ }
+ },
+ "required": [
+ "scope",
+ "taskTemplate"
+ ]
+ },
+ "workflow-phase": {
+ "title": "Workflow Phase",
+ "type": "object",
+ "description": "A set of workflow steps which work together towards a localization outcome.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The phase identfier."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The phase name.
",
+ "x-default-field": true
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "workflow-task-configuration-request": {
+ "title": "Workflow Task Configuration Request",
+ "type": "object",
+ "description": "A task configuration request.",
+ "properties": {
+ "taskTemplate": {
+ "$ref": "#/components/schemas/object-id"
+ },
+ "isSkipped": {
+ "type": "boolean"
+ },
+ "assignees": {
+ "type": "array",
+ "description": "Specifies the list of assignees for the task template. \nWhen the 'isSkipped' field is set to 'true', an empty list of assignees should be specified.\r\n
Total assignee count is limited. See more at [Assigning users and groups to workflow tasks](https://docs.rws.com/791595/743481/trados-enterprise---accelerate/assigning-users-and-groups-to-workflow-tasks) point 5e.", + "items": { + "$ref": "#/components/schemas/workflow-task-assignee-request" + } + }, + "scope": { + "$ref": "#/components/schemas/task-configuration-scope-request" + } + }, + "required": [ + "taskTemplate", + "isSkipped", + "assignees", + "scope" + ] + }, + "workflow-task-template": { + "title": "Workflow Task Template", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The workflow task template identifier." + }, + "name": { + "type": "string", + "description": "
default
The workflow task template name.
",
+ "x-default-field": true
+ },
+ "apiInternalId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "dd6vytpa9vo41"
+ },
+ "description": "default
Unique identifier of workflow task templates\r\n
"
+ },
+ "description": {
+ "type": "string"
+ },
+ "canSkip": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "requiresAssignment": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "taskType": {
+ "$ref": "#/components/schemas/task-type"
+ },
+ "phase": {
+ "$ref": "#/components/schemas/workflow-phase"
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "workflow-template": {
+ "title": "Workflow Template",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The workflow template identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "default
The workflow template name.
",
+ "x-default-field": true
+ },
+ "description": {
+ "type": "string",
+ "description": "The workflow template description."
+ },
+ "taskTemplates": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/workflow-task-template"
+ }
+ },
+ "phases": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/workflow-phase"
+ }
+ },
+ "transitions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/workflow-template-transition"
+ }
+ }
+ },
+ "required": [
+ "id"
+ ]
+ },
+ "workflow-template-transition": {
+ "title": "Workflow Template Transition",
+ "type": "object",
+ "properties": {
+ "from": {
+ "$ref": "#/components/schemas/workflow-template-transition-node",
+ "description": "default
",
+ "x-default-field": true
+ },
+ "to": {
+ "$ref": "#/components/schemas/workflow-template-transition-node",
+ "description": "default
",
+ "x-default-field": true
+ },
+ "condition": {
+ "$ref": "#/components/schemas/workflow-template-transition-condition"
+ }
+ }
+ },
+ "workflow-template-transition-condition": {
+ "title": "Workflow Template Transition Condition",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "outcome",
+ "expression"
+ ],
+ "nullable": true,
+ "description": "default
",
+ "x-default-field": true
+ },
+ "value": {
+ "type": "string",
+ "description": "default
",
+ "x-default-field": true
+ }
+ }
+ },
+ "workflow-template-transition-node": {
+ "title": "Workflow Template Transition Node",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "taskTemplate",
+ "start",
+ "end"
+ ],
+ "description": "default
",
+ "x-default-field": true
+ },
+ "taskTemplate": {
+ "$ref": "#/components/schemas/workflow-task-template",
+ "description": "default
",
+ "x-default-field": true
+ }
+ }
+ },
+ "workflow-update-request": {
+ "title": "Workflow Update Request",
+ "type": "object",
+ "description": "A model to update a workflow.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The workflow name."
+ },
+ "description": {
+ "type": "string",
+ "description": "The workflow description."
+ },
+ "taskConfigurations": {
+ "type": "array",
+ "description": "The task configurations.",
+ "items": {
+ "$ref": "#/components/schemas/workflow-task-configuration-request"
+ }
+ }
+ }
+ },
+ "well-known-jwks-response": {
+ "title": "Well Known Keys Response",
+ "x-stoplight": {
+ "id": "1owp0jo4rmrg7"
+ },
+ "type": "object",
+ "properties": {
+ "keys": {
+ "$ref": "#/components/schemas/list-jwks",
+ "x-stoplight": {
+ "id": "dbkidlpmb0wk4"
+ },
+ "description": "The list of public keys."
+ }
+ }
+ },
+ "translation-update-definition": {
+ "title": "Translation Update Definition",
+ "x-stoplight": {
+ "id": "9qqwmpya8mbgb"
+ },
+ "type": "object",
+ "required": [
+ "translationEngineId"
+ ],
+ "properties": {
+ "translationEngineId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "57wk8minjka59"
+ },
+ "description": "The translation engine id. The translation engine must have a `TM` resource."
+ }
+ }
+ },
+ "translation-update-field": {
+ "title": "Translation Update Field",
+ "x-stoplight": {
+ "id": "ivfrnlswg3n8o"
+ },
+ "type": "object",
+ "required": [
+ "name",
+ "values"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "w0z5ip16a75jo"
+ },
+ "description": "Field name"
+ },
+ "values": {
+ "type": "array",
+ "x-stoplight": {
+ "id": "jzd3s8buqkhyh"
+ },
+ "description": "Field values",
+ "items": {
+ "x-stoplight": {
+ "id": "vxkufz4upb8e0"
+ },
+ "type": "string"
+ }
+ }
+ },
+ "description": ""
+ },
+ "translation-search-settings": {
+ "title": "Translation Search Settings",
+ "x-stoplight": {
+ "id": "k6reff6ihojws"
+ },
+ "type": "object",
+ "properties": {
+ "translationMemory": {
+ "$ref": "#/components/schemas/translation-search-settings-tm",
+ "x-stoplight": {
+ "id": "6d8m3xqn7kla8"
+ }
+ }
+ }
+ },
+ "concordance-search-settings": {
+ "title": "Concordance Search Settings",
+ "x-stoplight": {
+ "id": "k6reff6ihojws"
+ },
+ "type": "object",
+ "properties": {
+ "translationMemory": {
+ "$ref": "#/components/schemas/concordance-search-settings-tm",
+ "x-stoplight": {
+ "id": "6d8m3xqn7kla8"
+ }
+ }
+ }
+ },
+ "translation-search-settings-tm": {
+ "title": "Translation Memory Search Settings",
+ "x-stoplight": {
+ "id": "7b6bn72a6ldvj"
+ },
+ "type": "object",
+ "properties": {
+ "minimumMatchValue": {
+ "type": "integer",
+ "x-stoplight": {
+ "id": "br24y2myv21e0"
+ },
+ "description": "This is the degree of match that must exist between a source document segment and a translation memory segment in order for the segment translation to be offered as a match. The default is 70%, but you can set a value between 30% and 100%.\r\n\r\nThe selected value is inclusive, meaning that matches with your exact selected value are also included in translation results.",
+ "minimum": 30,
+ "maximum": 100,
+ "default": 70
+ },
+ "penalties": {
+ "$ref": "#/components/schemas/translation-search-TM-penalties",
+ "x-stoplight": {
+ "id": "fkru1d5bfhm2w"
+ }
+ }
+ }
+ },
+ "concordance-search-settings-tm": {
+ "title": "Translation Memory Concordance Search Settings",
+ "x-stoplight": {
+ "id": "7b6bn72a6ldvj"
+ },
+ "type": "object",
+ "properties": {
+ "minimumMatchValue": {
+ "type": "integer",
+ "x-stoplight": {
+ "id": "br24y2myv21e0"
+ },
+ "description": "This is the degree of match that must exist between a source document segment and a translation memory segment in order for the segment translation to be offered as a match. The default is 70%, but you can set a value between 30% and 100%.\r\n\r\nThe selected value is inclusive, meaning that matches with your exact selected value are also included in translation results.",
+ "minimum": 30,
+ "maximum": 100,
+ "default": 70
+ },
+ "penalties": {
+ "$ref": "#/components/schemas/concordance-search-TM-penalties",
+ "x-stoplight": {
+ "id": "fkru1d5bfhm2w"
+ }
+ }
+ }
+ },
+ "translation-search-standard-penalties": {
+ "title": "Translation Memory Standard Penalties",
+ "x-stoplight": {
+ "id": "9c3abb6urgvqh"
+ },
+ "type": "object",
+ "properties": {
+ "missingFormatting": {
+ "type": "integer",
+ "x-stoplight": {
+ "id": "g8mtup7862xdn"
+ },
+ "minimum": 0,
+ "maximum": 20,
+ "default": 1
+ },
+ "differentFormatting": {
+ "type": "integer",
+ "x-stoplight": {
+ "id": "pao1qvu6sbjc9"
+ },
+ "default": 1,
+ "minimum": 0,
+ "maximum": 20
+ },
+ "multipleTranslations": {
+ "type": "integer",
+ "x-stoplight": {
+ "id": "y9awj7oyd87ye"
+ },
+ "default": 1,
+ "minimum": 0,
+ "maximum": 20
+ },
+ "autoLocalization": {
+ "type": "integer",
+ "x-stoplight": {
+ "id": "y85nv8a0u4ptr"
+ },
+ "default": 0,
+ "minimum": 0,
+ "maximum": 20
+ },
+ "textReplacement": {
+ "type": "integer",
+ "x-stoplight": {
+ "id": "t7hvtgxzazgy0"
+ },
+ "default": 0,
+ "minimum": 0,
+ "maximum": 20
+ },
+ "alignment": {
+ "type": "integer",
+ "x-stoplight": {
+ "id": "ipk0iaseeokla"
+ },
+ "default": 1,
+ "minimum": 0,
+ "maximum": 20
+ },
+ "characterWidthDifference": {
+ "type": "integer",
+ "default": 1,
+ "minimum": 0,
+ "maximum": 20
+ }
+ },
+ "description": ""
+ },
+ "translation-search-unit-status-penalties": {
+ "title": "Translation Unit Status Penalties",
+ "x-stoplight": {
+ "id": "x6ufijbtx0mff"
+ },
+ "type": "object",
+ "description": "The penalties to apply depending on the status of the translation unit.",
+ "properties": {
+ "translated": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0,
+ "x-stoplight": {
+ "id": "c2kh1fiux8bl7"
+ }
+ },
+ "translationRejected": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0,
+ "x-stoplight": {
+ "id": "o3ezy93r7i26i"
+ }
+ },
+ "translationApproved": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0,
+ "x-stoplight": {
+ "id": "9380xqwtvbrsl"
+ }
+ },
+ "signOffRejected": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0,
+ "x-stoplight": {
+ "id": "ahddzpafpv7mv"
+ }
+ },
+ "signOff": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0,
+ "x-stoplight": {
+ "id": "yijp1eutihsi4"
+ }
+ },
+ "notTranslated": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0,
+ "x-stoplight": {
+ "id": "ezuj0yylywjk7"
+ }
+ },
+ "draft": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0,
+ "x-stoplight": {
+ "id": "aibykf8ozjqmt"
+ }
+ }
+ }
+ },
+ "translation-concordance-search-standard-penalties": {
+ "title": "Translation Memory Concordance Standard Penalties",
+ "x-stoplight": {
+ "id": "9c3abb6urgvqh"
+ },
+ "type": "object",
+ "properties": {
+ "alignment": {
+ "type": "integer",
+ "x-stoplight": {
+ "id": "ipk0iaseeokla"
+ },
+ "default": 1,
+ "minimum": 0,
+ "maximum": 20
+ },
+ "characterWidthDifference": {
+ "type": "integer",
+ "default": 1,
+ "minimum": 0,
+ "maximum": 20
+ }
+ },
+ "description": ""
+ },
+ "translation-concordance-search-unit-status-penalties": {
+ "title": "Translation Unit Status Concordance Penalties",
+ "x-stoplight": {
+ "id": "x6ufijbtx0mff"
+ },
+ "type": "object",
+ "description": "The penalties to apply depending on the status of the translation unit.",
+ "properties": {
+ "translated": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0,
+ "x-stoplight": {
+ "id": "c2kh1fiux8bl7"
+ }
+ },
+ "translationRejected": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0,
+ "x-stoplight": {
+ "id": "o3ezy93r7i26i"
+ }
+ },
+ "translationApproved": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0,
+ "x-stoplight": {
+ "id": "9380xqwtvbrsl"
+ }
+ },
+ "signOffRejected": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0,
+ "x-stoplight": {
+ "id": "ahddzpafpv7mv"
+ }
+ },
+ "signOff": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0,
+ "x-stoplight": {
+ "id": "yijp1eutihsi4"
+ }
+ },
+ "notTranslated": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0,
+ "x-stoplight": {
+ "id": "ezuj0yylywjk7"
+ }
+ },
+ "draft": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 20,
+ "default": 0,
+ "x-stoplight": {
+ "id": "aibykf8ozjqmt"
+ }
+ }
+ }
+ },
+ "translation-search-TM-penalties": {
+ "title": "Translation TM Penalties",
+ "x-stoplight": {
+ "id": "6kx5w2gbj2696"
+ },
+ "type": "object",
+ "properties": {
+ "standardPenalties": {
+ "$ref": "#/components/schemas/translation-search-standard-penalties",
+ "x-stoplight": {
+ "id": "q58i9rha03e0z"
+ }
+ },
+ "translationUnitStatusPenalties": {
+ "$ref": "#/components/schemas/translation-search-unit-status-penalties",
+ "x-stoplight": {
+ "id": "8pzly4obx7tiz"
+ }
+ }
+ }
+ },
+ "concordance-search-TM-penalties": {
+ "title": "Concordance Search TM Penalties",
+ "x-stoplight": {
+ "id": "6kx5w2gbj2696"
+ },
+ "type": "object",
+ "properties": {
+ "standardPenalties": {
+ "$ref": "#/components/schemas/translation-concordance-search-standard-penalties",
+ "x-stoplight": {
+ "id": "q58i9rha03e0z"
+ }
+ },
+ "translationUnitStatusPenalties": {
+ "$ref": "#/components/schemas/translation-concordance-search-unit-status-penalties",
+ "x-stoplight": {
+ "id": "8pzly4obx7tiz"
+ }
+ }
+ }
+ },
+ "translation-concordance-search-resource": {
+ "title": "Translation Concordance Search Resource",
+ "x-stoplight": {
+ "id": "20ixo2ym2xerq"
+ },
+ "type": "object",
+ "required": [
+ "resourceId",
+ "type"
+ ],
+ "properties": {
+ "resourceId": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "9rewrlat7xg1p"
+ },
+ "description": "The resource identifier."
+ },
+ "type": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "ablx3ujgx5zyg"
+ },
+ "enum": [
+ "TM"
+ ],
+ "description": "The resource type."
+ }
+ }
+ },
+ "language-direction-general-request": {
+ "title": "Language Direction General Request",
+ "x-stoplight": {
+ "id": "0pezqwl74njpv"
+ },
+ "type": "object",
+ "description": "The language directions model used for creating or updating a resource.",
+ "properties": {
+ "sourceLanguage": {
+ "$ref": "#/components/schemas/source-language-request",
+ "x-stoplight": {
+ "id": "ik01rev5dxdym"
+ }
+ },
+ "targetLanguage": {
+ "$ref": "#/components/schemas/target-language-request",
+ "x-stoplight": {
+ "id": "72zo0gp14dpdp"
+ }
+ }
+ }
+ },
+ "translation-lookup-input-request": {
+ "title": "Translation Lookup Input Request",
+ "x-stoplight": {
+ "id": "k91lzmo3d80y4"
+ },
+ "type": "object",
+ "description": "The translation input.",
+ "required": [
+ "content",
+ "contentType"
+ ],
+ "properties": {
+ "content": {
+ "type": [
+ "string"
+ ],
+ "x-stoplight": {
+ "id": "d90k7nxt66cq9"
+ },
+ "description": "A plain text phrase or a BCM fragment with a single segment serialized as JSON string."
+ },
+ "contentType": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "7lkm3ehfoeipb"
+ },
+ "enum": [
+ "text",
+ "bcmFragment"
+ ],
+ "description": "The content type."
+ }
+ }
+ },
+ "translation-concordance-input-request": {
+ "title": "Translation Concordance Input Request",
+ "x-stoplight": {
+ "id": "gzgvhcqrx5qjh"
+ },
+ "type": "object",
+ "required": [
+ "content"
+ ],
+ "properties": {
+ "content": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "8t10luex044ia"
+ },
+ "description": "Text to search for."
+ }
+ }
+ },
+ "translation-tu-update-input-request": {
+ "title": "Translation TU Input Request",
+ "x-stoplight": {
+ "id": "wstvyd816xr0e"
+ },
+ "type": "object",
+ "required": [
+ "content"
+ ],
+ "properties": {
+ "content": {
+ "type": "string",
+ "x-stoplight": {
+ "id": "srf6ctoqfhljn"
+ },
+ "description": "The Translation Unit update content as a BCM fragment serialized in JSON string."
+ }
+ }
+ },
+ "zip-file-export-request": {
+ "title": "Export Project Files Request",
+ "type": "object",
+ "properties": {
+ "referenceFiles": {
+ "$ref": "#/components/schemas/zip-file-export-reference-files-request"
+ },
+ "targetFiles": {
+ "$ref": "#/components/schemas/zip-file-export-target-files-request"
+ }
+ }
+ },
+ "zip-file-export-reference-files-request": {
+ "title": "Export Project Reference Files Request",
+ "type": "object",
+ "description": "Reference files associated with the project.",
+ "properties": {
+ "include": {
+ "type": "boolean",
+ "description": "Add reference files to the export package.",
+ "default": true
+ }
+ }
+ },
+ "zip-file-export-target-files-request": {
+ "title": "Export Project Target Files Request",
+ "type": "object",
+ "description": "Target files associated with the project.",
+ "properties": {
+ "includeVersions": {
+ "type": "string",
+ "enum": [
+ "currentVersion",
+ "none",
+ "nativeVersion"
+ ],
+ "description": "Include target files with these versions into the export.",
+ "default": "currentVersion",
+ "x-stoplight": {
+ "id": "7s4voozws4tse"
+ }
+ },
+ "targetLanguages": {
+ "type": "array",
+ "description": "Include target files for the specified languages (e.g., 'en-US', 'de-DE'). Only one target language is supported when `downloadFlat` is set to `true`.",
+ "items": {
+ "x-stoplight": {
+ "id": "3pr8zsp16si53"
+ },
+ "type": "string"
+ }
+ },
+ "downloadFlat": {
+ "type": "boolean",
+ "x-stoplight": {
+ "id": "ebjydtoffk5xl"
+ },
+ "description": "If this flag is set to `true`, folder structure will reflect exactly the file paths. If the flag is set to `false`, a ZIP folder will be generated with a structure similar to the one provided by Trados.",
+ "default": false
+ }
+ }
+ },
+ "zip-file-export-response": {
+ "title": "Project Files export poll response",
+ "type": "object",
+ "required": [
+ "exportId",
+ "state"
+ ],
+ "properties": {
+ "exportId": {
+ "type": "string",
+ "description": "The identifier of the export operation"
+ },
+ "state": {
+ "description": "The status of the export",
+ "default": "created",
+ "enum": [
+ "created",
+ "processing",
+ "done",
+ "error"
+ ]
+ }
+ }
+ }
+ },
+ "parameters": {
+ "export-format": {
+ "name": "format",
+ "in": "query",
+ "schema": {
+ "type": "string",
+ "default": "native",
+ "enum": [
+ "native",
+ "sdlxliff"
+ ]
+ },
+ "description": "The file format."
+ },
+ "quote-report-format": {
+ "name": "format",
+ "in": "query",
+ "schema": {
+ "type": "string",
+ "default": "pdf",
+ "enum": [
+ "pdf",
+ "excel"
+ ]
+ },
+ "description": "The file format of the quote report."
+ },
+ "X-LC-Tenant": {
+ "name": "X-LC-Tenant",
+ "in": "header",
+ "description": "The identifier of the account where the request is executed.",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ "Authorization": {
+ "name": "Authorization",
+ "in": "header",
+ "description": "The bearer access token provided by Auth0.",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ "top": {
+ "name": "top",
+ "in": "query",
+ "description": "The number of items to include inside the page.",
+ "schema": {
+ "maximum": 100,
+ "minimum": 1,
+ "type": "integer",
+ "default": 100
+ }
+ },
+ "skip": {
+ "name": "skip",
+ "in": "query",
+ "description": "The number of items that are skipped to reach the desired page.",
+ "schema": {
+ "type": "integer",
+ "minimum": 0,
+ "default": 0
+ }
+ },
+ "location": {
+ "name": "location",
+ "in": "query",
+ "description": "The identifiers of the resource folders. You can control the behavior by using the 'locationStrategy'. ",
+ "style": "form",
+ "explode": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "location-strategy": {
+ "name": "locationStrategy",
+ "in": "query",
+ "description": "Options: - `location`: all the resources located strictly in the folders from the 'location' parameter (default);
- `lineage`: all the resources located in the folders specified in the 'location' parameter, as well as the subfolders;
- `bloodline`: all the resources located in the folders specified in the 'location' parameter, as well as the ancestor folders;
- `genealogy`: the resources located in the folders specified in the 'location' parameter together with subfolders and ancestors.", + "schema": { + "type": "string", + "enum": [ + "location", + "lineage", + "bloodline", + "genealogy" + ] + } + }, + "sort": { + "name": "sort", + "in": "query", + "description": "A comma separated list of fields used to sort the resources in the response. Each field can have a unary negative to imply descending sort order.", + "schema": { + "type": "string" + } + }, + "fields": { + "name": "fields", + "in": "query", + "description": "A comma separated list of fields to include in the response.\n Every value in the list should either consist of a top-level property name (excluding the items envelope for endpoints returning lists) or refer to a property of a top-level property of type object, in the following form: \"toplevelpropertyname.subpropertyname\".\n When this query parameter is omitted, default resource representations are returned (excluding fields marked as optional). The same applies to nested objects when just specifying the top-level property name, without explicitly listing sub-property names. When specifying the fields query parameter, only the specified fields are returned.\n The id property is always returned.", + "schema": { + "type": "string" + } + }, + "customerId": { + "name": "customerId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The customer identifier." + }, + "projectId": { + "name": "projectId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The project identifier." + }, + "taskId": { + "name": "taskId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The task identifier." + }, + "sourceFileId": { + "name": "sourceFileId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The source file identifier." + }, + "targetFileId": { + "name": "targetFileId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The target file identifier." + }, + "exportId": { + "name": "exportId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The export identifier." + }, + "projectTemplateId": { + "name": "projectTemplateId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The project template identifier." + }, + "fileVersionId": { + "name": "fileVersionId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The file version identifier." + }, + "taskTypeId": { + "name": "taskTypeId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The task type identifier." + }, + "workflowId": { + "name": "workflowId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The workflow identifier." + }, + "fileProcessingConfigurationId": { + "name": "fileProcessingConfigurationId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The file processing configuration identifier." + }, + "translationEngineId": { + "name": "translationEngineId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The translation engine identifier." + }, + "pricingModelId": { + "name": "pricingModelId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The pricing model identifier." + }, + "folderId": { + "name": "folderId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The folder identifier." + }, + "groupId": { + "name": "groupId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The group identifier." + }, + "importId": { + "name": "importId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The import identifier." + }, + "fileId": { + "name": "fileId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The file identifier." + }, + "customFieldDefinitionId": { + "name": "customFieldDefinitionId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The custom field definition identifier." + }, + "profileId": { + "name": "profileId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The profile identifier." + }, + "language-id": { + "name": "languageId", + "in": "query", + "description": "The language used for localization.", + "schema": { + "type": "string", + "default": "en" + } + }, + "userId": { + "name": "userId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The user identifier." + }, + "name": { + "name": "name", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Filter by name." + }, + "termbaseTemplateId": { + "name": "termbaseTemplateId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The termbase template identifier." + }, + "termbaseId": { + "name": "termbaseId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The termbase identifier." + }, + "translationMemoryId": { + "name": "translationMemoryId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The translation memory identifier." + }, + "entryId": { + "name": "entryId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The termbase entry identifier." + }, + "humanReadableIds": { + "name": "humanReadableIds", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "Can provide a list of humanReadableId from entries to filter by." + } + }, + "headers": { + "X-LC-TraceId": { + "required": true, + "schema": { + "type": "string", + "example": "df680285-adcd-4bda-8f79-0bba4a857287" + }, + "description": "A unique identifier for the request. It should be saved in the logs as it can be used to troubleshoot potential issues. When raising a request for support, it should be provided to help with the investigation." + } + } + } +} diff --git a/articles/LCPublicAPI/api/Public-API.v1.md b/articles/LCPublicAPI/api/Public-API.v1.md new file mode 100644 index 0000000..4af2066 --- /dev/null +++ b/articles/LCPublicAPI/api/Public-API.v1.md @@ -0,0 +1,23 @@ +--- +title: "Public API Documentation" +_disableBreadcrumb: false +_disableAffix: true +_enableSearch: false +_disableToc: false +--- + + + + + + + +
+Using the data above, we can get the following running total: + +**`85.4 + 427 = 512.4`** + +### Percentage + +This is a percentage cost calculated against the current cost (current language-level cost or current project-level cost). + +***Request***: + +```json +... +{ + "name": "Percentage Cost", + "costOrder": 1, + "count": -10, + "costType": "percentage" + ... +} +... +``` + +The `total cost of the current additional cost` is calculated using the value from the `count` field as a percentage from the previous `running total`. + +**`total = count% * previousRunningTotal`** + +***Response***: + +```json +... +{ + "name": "Percentage Cost", + "count": -10.0, + "total": -51.24, + "cost": 0.0, + "costType": "percentage", + "costOrder": 1, + "runningTotal": 461.16 + ... +} +... +``` + +Since the previous `running total` is **512.4**, the total cost of the `current additional cost` is calculated as follows: + +**`total = -10% * 512.4 = -51.24`** + +As a result, the new running total becomes: + +**`runningTotal = 512.4 - 51.24 = 461.16`** + +### Hourly + +This is a fixed cost per hour. + +***Request***: + +```json +... +{ + "name": "Hourly Cost", + "costOrder": 2, + "count": 5, + "cost": 1.5, + "costType": "hourly" + ... +} +... +``` + +The total cost is calculated as `number of hours` * `cost of an hour`: + +**`total = count * cost`** + +***Response***: + +```json +... +{ + "name": "Hourly Cost", + "count": 5.0, + "total": 7.5, + "cost": 1.5, + "costType": "hourly", + "costOrder": 2, + "runningTotal": 468.66 + ... +} +... +``` + +**`total = 5 * 1.5 = 7.5`** + +**`runningTotal = 461.16 + 7.5 = 468.66`** + +### Per Page + +This is a fixed cost per page. + +***Request***: + +```json +... +{ + "name": "Per Page Cost", + "costOrder": 3, + "count": 10, + "cost": 0.2, + "costType": "perPage" + ... +} +... +``` + + +The total cost is calculated as `number of pages` * `cost of a page`: + +**`total = count * cost`** + +***Response***: + +```json +... +{ + "name": "Per Page Cost", + "count": 10.0, + "total": 2.0, + "cost": 0.2, + "costType": "perPage", + "costOrder": 3, + "runningTotal": 470.66 + ... +} +... +``` + +**`total = 10 * 0.2 = 2`** + +**``runningTotal = 468.66 + 2 = 470.66``** + +### Conditional + +This is a cost that is applied conditionally, for example: + +***Request***: + +```json +... +{ + "name": "Conditional Cost", + "costOrder": 4, + "conditionalCostVariable": "wordCount", + "conditionalCostOperator": "less", + "conditionalCostThreshold": 1000, + "cost": 100, + "conditionalCostType": "relative", + "costType": "conditional" + ... +} +... +``` + +If `[conditionalCostVariable]` `[conditionalCostOperator]` `[conditionalCostThreshold]`, then add/set `[cost]` `[conditionalCostType]`. + +This formula translates to the following: + +If `wordCount < 1000`, then add `100 relative`. + +***Response***: + +```json +... +{ + "name": "Conditional Cost", + "count": 854.0, + "total": 100.0, + "cost": 100.0, + "costType": "conditional", + "costOrder": 4, + "conditionalCostType": "relative", + "conditionalCostOperator": "less", + "conditionalCostVariable": "wordCount", + "conditionalCostThreshold": 1000.0, + "runningTotal": 570.66 + ... +} +... +``` +Since the word count (`count`) is 854 (in the example above), the condition becomes: + +If `854 < 1000` then add `100 relative`. => `true` + +**`total = cost = 100`** + +**`runningTotal = 470.66 + 100 = 570.66`** + +The total cost depends on the `conditionalCostType` field and on whether the condition evaluates to `true` or `false`. +When the condition evaluates to `false`, the total will be 0, and the running total will not change. + +If `854 > 1000`, then add `100 relative`. => `false` + +**`total = cost = 0`** +**`runningTotal = 470.66`** + + +For the same values as above, and the `conditionalCostType` set to `percentage`, the `total` and `runningTotal` values will change to: + +**`total = 100% * 470.66 = 470.66`** + +**`runningTotal = 470.66 + 470.66 = 941.32`** + +When the `conditionalCostType` is set to `absolute`, the total will be equal to the difference between the `cost` and the `runningtotal`: + +**`total = 100 - 470.66 = -370.66`** + +**`runningTotal = 100`** + +> **Note:** Setting `conditionalCostType` to `absolute` will cancel all the previous costs for the project or the target language. + +## Cost types available ONLY at project level + +### Per Target Language + +This is an additional cost that is calculated based on the number of target languages in the project. + +***Request***: + +```json +... +{ + "name": "Per Target Language", + "costOrder": 5, + "cost": 5, + "costType": "perTargetLanguage" +} +... +``` + +The total cost is calculated as `number of target languages` * `cost of a target language`: + +***Response***: +```json +... +{ + "name": "Per Target Language", + "count": 1.0, + "total": 5.0, + "cost": 5.0, + "costType": "perTargetLanguage", + "costOrder": 5, + "runningTotal": 575.66 +} +... +``` + +Since there is only one target language in the example above, the total cost becomes: +**`total = 1 * 5 = 5`** +**`runningTotal = 570.66 + 5 = 575.66`** + +### Per File + +This is an additional cost that is calculated based on the number of files in the project. + +***Request***: + +```json +... +{ + "name": "Per File", + "costOrder": 6, + "cost": 3, + "costType": "perFile" +} +... +``` + +The total cost is calculated as `number of files` * `cost of a file`: + +***Response***: +```json +... +{ + "name": "Per File", + "count": 2.0, + "total": 6.0, + "cost": 3.0, + "costType": "perFile", + "costOrder": 6, + "runningTotal": 581.66 +} +... +``` +**`total = 2 * 3 = 6`** +**`runningTotal = 575.66 + 6 = 581.66`** + +## Cost order + +The `costOrder` field defines the order in which costs are calculated. + +For example, if there are two additional costs defined in the quote (see below), the percentage cost is calculated based on the running total from the volume cost. + +```json +... +{ + "name": "Volume Cost", + "total": 427.0, + "costType": "volume", + "costOrder": 0, + "runningTotal": 512.4 +... +}, +{ + "name": "Percentage Cost", + "total": -51.24, + "count": -10.0, + "costType": "percentage", + "costOrder": 1, + "runningTotal": 461.16 +... +} +... +``` + +When the `costOrder` field is switched, the `total` percentage cost value will be calculated based on the previous running total, which in this case is the translation cost (**85.4**): +```json +... +{ + "name": "Percentage Cost", + "count": -10.0, + "total": -8.54, + "costType": "percentage", + "costOrder": 0, + "runningTotal": 76.86 +... +}, +{ + "name": "Volume Cost", + "total": 427.0, + "costType": "volume", + "costOrder": 1, + "runningTotal": 503.86 +... +} +... +``` diff --git a/articles/LCPublicAPI/docs/File-formats.md b/articles/LCPublicAPI/docs/File-formats.md new file mode 100644 index 0000000..a7bc483 --- /dev/null +++ b/articles/LCPublicAPI/docs/File-formats.md @@ -0,0 +1,69 @@ +# File formats +A file used in the Trados Cloud Platform API can have one of the three supported formats: native, SDLXLIFF or [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html): + +- Native represents the format of the file that is attached to a project by the user. The project's associated File Type Configuration specifies if the native file extensions can be attached to that project. + +- To download files for translation or review in offline mode, the *.sdlxliff format can be used. SDLXLIFF files have XML format. + +- BCM (Bilingual Content Model) documents are files used for handling content internally. BCM files have JSON content and are stored in .json format. + +## File formats in a workflow +In a workflow, each task has a supported input file type that describes which input file types are allowed for that task. A new file version can be added only if the format of this new version respects the input file type supported by the task. You can check what the supported input file types are for tasks on the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page. + +A few input file types and examples of tasks that support them are listed below: + +- nativeSource: the task handles source file versions in their uploaded native format (e.g.: *FileTypeDetection*, *Engineering*, *FileFormatConversion*) +- bcmSource: the task can process source files in their BCM format (e.g.: *DocumentContentAnalysis*, *CopySourceToTarget*) +- bcmTarget: the task accepts target files in their BCM format (e.g.: *Translation*, *Linguistic Review*, *MachineTranslation*, *TranslationMemoryMatching*, *TranslationMemoryUpdate*, *TargetFileGeneration*) +- nativeTarget: the task handles target files in their native "generated" form (e.g.: *DTP*, *FinalCheck*) +- sdlxliffTarget: the task processes target files in their SDLXLIFF form. Specifically for Import tasks. +- none: the task does not read or modify the content of a file. + +Using the Trados Cloud Platform API, the source and target files in different formats can be viewed, downloaded and added (via import operations), based on the task and its status in the project's workflow. + +### Handling Source Files + +#### Upload Source Files +Source files can be added to a project using the [Add Source File](../api/Public-API.v1-fv.html#/operations/AddSourceFile) endpoint or the [Attach Source Files](../api/Public-API.v1-fv.html#/operations/AddSourceFiles) endpoint (for multiple files). If the file's extension is supported by the File Type Configuration, the project will follow the workflow and a new version of the source file in BCM format will be automatically created in the *File Format Conversion* task. + + +#### Upload Source File Versions +New source file versions can be added in native or BCM format using the [Add Source File Version](../api/Public-API.v1-fv.html#/operations/AddSourceFileVersion) endpoint. You can add source file versions: +* in the *Engineering* task +* in custom tasks created by users having the task type set to *Engineering* +* in extension tasks that handle source files. + +If a project having attached a native source file with an unsupported extension is started, an error task will be generated in the *File Type Detection* task and the workflow is interrupted. + +>Note: For adding a source file version using an extension task, the configuration of the task type must declare the `scope`'s value as "file". + + +#### Download Source File Versions +Any of the source file versions (in native or BCM format) can be downloaded using the [Download Source File Version](../api/Public-API.v1-fv.html#/operations/DownloadSourceFileVersion) endpoint. The *Engineering* task, for instance, is an example of a task where download can be performed. + + + +### Handling Target Files +The *Copy source to target* task converts the native file to a new target file version in BCM format. + +#### Upload Target File Versions +Adding a new version for a target file in native or BCM format can be executed with the [Add Target File Version](../api/Public-API.v1-fv.html#/operations/AddTargetFileVersion) endpoint. + +>Note: For adding a target file version using an extension task, the configuration of the task type must declare the `scope`'s value as "file". + + +#### Download Target File Versions +The BCM and native target file versions can be downloaded by using [Download Target File Version](../api/Public-API.v1-fv.html#/operations/DownloadFileVersion) endpoint, while the project is, for example, in the *Translation* task. + + +#### Export Target File Versions +The BCM target file versions can be exported in native or SDLXLIFF format by calling the [Export Target File Version](../api/Public-API.v1-fv.html#/operations/ExportTargetFileVersion) endpoint. This operation triggers a conversion of the BCM target file version in a native or SDLXLIFF format based on the value of the `format` query parameter used. The endpoint starts an export operation which can be monitored using the [polling endpoint](../api/Public-API.v1-fv.html#/operations/PollTargetFileVersionExport). After the export is done, the files can be downloaded using the [Download Exported Target File Version](../api/Public-API.v1-fv.html#/operations/DownloadExportedTargetFileVersion) endpoint. + +> Note: The export endpoint is dedicated to file versions of BCM format and cannot be used on files in native or SDLXLIFF format. The export operation can only be executed on tasks where the supported output file is a bilingual target file. You can consult the output file types for tasks on the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page from the official RWS Documentation Center. +> +>In order to download file versions of BCM or native type, please use the [Download Target File Version](../api/Public-API.v1-fv.html#/operations/DownloadFileVersion) endpoint. + + +#### Import Target File Versions +Target file versions downloaded in SDLXLIFF format can be processed and afterwards replaced by using [Import Target File Version](../api/Public-API.v1-fv.html#/operations/ImportTargetFileVersion) endpoint. The import operation triggers internally the update of the BCM file associated with the imported SDLXLIFF file. This endpoint should mostly be used for offline work. + diff --git a/articles/LCPublicAPI/docs/Headers-considerations.md b/articles/LCPublicAPI/docs/Headers-considerations.md new file mode 100644 index 0000000..ecaf4ff --- /dev/null +++ b/articles/LCPublicAPI/docs/Headers-considerations.md @@ -0,0 +1,52 @@ +# Headers considerations + +The purpose of this page is to showcase the header types that could capture your interest. + +> Headers must be treated as [case-insensitive](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers). + +The Trados Cloud Platform API response headers can be classified as follows: + +Header type | Example +---------|---------- + Standard | `Content-Type` + Custom | `X-LC-TraceId` + Endpoint specific | `Content-Disposition` + +## Content-Type header + +The `application/octet-stream` content type is used to indicate that a body contains arbitrary binary data. The recommended action for a consumer that receives an +`application/octet-stream` entity is to simply offer to put the data +in a file, read more in the [RFC2046](https://www.rfc-editor.org/rfc/rfc2046#section-4.5.1) space. + +## Content-Disposition header + +For operations expected to return content that can be handled as a file, the `Content-Disposition` header can be sent in the response headers to provide more information about the response payload. The Trados Cloud Platform API will provide this header in certain situations, and its primary goal is to supply a file name for the content being downloaded or exported. +You can read more about the `Content-Disposition` header on the [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition) website or in the [RFC6266](https://www.rfc-editor.org/rfc/rfc6266) space. + +The `Content-Disposition` response header can be usually found on various download API endpoints like [Download Source File Version](../api/Public-API.v1-fv.html#/operations/DownloadSourceFileVersion), [Download Target File Version](../api/Public-API.v1-fv.html#/operations/DownloadFileVersion), [Download Exported Quote Report](../api/Public-API.v1-fv.html#/operations/DownloadQuoteReport) and others. + +> Please note that both `Content-Type` and `Content-Disposition` are **not required** and APIs might not include them in the response. There are no guarantees that an endpoint that used to return a `Content-Type` or `Content-Disposition` header will still do so, under any circumstance. Please treat these headers as **optional** for all APIs. + +### Retrieving the file name + +Here's an example of how the `Content-Type` and the `Content-Disposition` headers look like: +``` +Content-Type: application/octet-stream +Content-Disposition: attachment; filename="Public API Download.pdf"; filename*=UTF-8''Public%20API%20Download.pdf +``` + +The parameters `filename` and `filename*`, to be matched case- +insensitively, provide information on how to construct a filename for +storing the message payload. + +The parameters `filename` and `filename*` differ only in that +`filename*` uses the encoding defined in [RFC5987](https://www.rfc-editor.org/rfc/rfc5987), allowing the use of characters not present in the ISO-8859-1 character set. + +> When both `filename` and `filename*` are present in a single header field value, you **must** pick `filename*` and ignore `filename`. + +If the `Content-Disposition` header is missing or you simply want to have a different file name, you need to provide a name and the file extension. The extension can be usually inferred from the required `Content-Type` header and also from the operation that is invoked. + + +## Deprecation and sunset headers + +These types of headers are used in our endpoint retirement process and are covered broadly in the [Public API Management Process](../docs/Public-API-Management-Process.md#endpoint-retirement-process) page. diff --git a/articles/LCPublicAPI/docs/How-to-multipart.md b/articles/LCPublicAPI/docs/How-to-multipart.md new file mode 100644 index 0000000..34ce72d --- /dev/null +++ b/articles/LCPublicAPI/docs/How-to-multipart.md @@ -0,0 +1,48 @@ +--- +stoplight-id: 1hfz3c15wpkbf +--- + +# Multipart considerations + +This page goes into deeper details for uploading files. Generally you might be interested in this subject when not using the provided SDKs and are implementing your own SDK. This page should help you debug potential problems you might encounter. + +> Our APIs follows standard HTTP/1.1 protocol as described in [RFC2616](https://www.rfc-editor.org/rfc/rfc2616) and subsequent RFCs. This page does not describe any custom HTTP behavior. + +## How to perform POST requests with multipart + +Whenever you make use of endpoints that do file uploads using `multipart/form-data`, some additional details may be required to be sent alongside the file, for example a `properties` part. + +Let's take as an example the [Add Source File Version](../api/Public-API.v1-fv.html#/operations/AddSourceFileVersion) endpoint. The API specifies that the request content is `multipart/form-data` and has a `properties` part that should be serialized as a JSON (this might not be mentioned explicitly in the documentation, but any structures in multiparts should be serialized as JSON). The second property is `file` and though it is of type `string`, that means that the raw content of the file should be sent in that part. + +> The order of parts is important! Please send the parts in the order these are specified in the API contract. + +To confirm that you are sending the correct content, you can intercept the request and view the raw request (this can be done in many ways, with either built in tools if available in your IDE/tooling or even free software). + +A simplified raw HTTP request is presented bellow: + +```http +POST /tasks/
+ Project2 is listed because the default value for `locationStrategy` is "location". + + +- `locationStrategy` = "lineage" +
+ All projects are listed because sending the `locationStrategy` without `location` does not filter anything. + + +- `location` = "fea...a0b" (Customers folder identifier) AND `locationStrategy` = "location" +
+ Project2 is listed because it is similar with the first case. + + +- `location` = "fea...a0b" (Customers folder identifier) AND `locationStrategy` = "lineage" +
+ Project2, Project3 and Project4 are returned. + + +- `location` = "4f0...206" (Customer3 folder identifier) AND `locationStrategy` = "bloodline" +
+ Project1, Project2 and Project3 are returned. + + +- `location` = "fea...a0b" (Customers folder identifier) AND `locationStrategy` = "genealogy" +
+ Project1, Project2, Project3 and Project4 are returned. + + +- `location` = "fea...a0b,fea...0a0" (Customers and Customer3 folder identifiers) AND `locationStrategy` = "lineage" +
+ Project2, Project3 (only once) and Project4 are returned. + + + diff --git a/articles/LCPublicAPI/docs/Interact-with-tasks.md b/articles/LCPublicAPI/docs/Interact-with-tasks.md new file mode 100644 index 0000000..9d72927 --- /dev/null +++ b/articles/LCPublicAPI/docs/Interact-with-tasks.md @@ -0,0 +1,31 @@ +# Interact with tasks + +Once the project is started, you can interact with tasks in several ways: + +### Find the task identifier + +Make a `GET` request to the [`/tasks/assigned`](../api/Public-API.v1-fv.html#/operations/ListTasksAssignedToMe) endpoint and identify the `id` of the task you want to interact with. + +### Reclaim tasks + +If you make a `PUT` request to the [`/tasks/{taskId}/reclaim`](../api/Public-API.v1-fv.html#/operations/ReclaimTask) endpoint, the owner of task is removed and another user from the assignee's list can accept it. The task is not reassigned automatically. + +### Complete tasks + +To complete a task, make a `PUT` request to the [`/tasks/{taskId}/complete`](../api/Public-API.v1-fv.html#/operations/CompleteTask) endpoint. + +### Assign tasks + +If the tasks is rejected by all its assignees, you can update the list of assignees. Make a `GET` request to the [`/users`](../api/Public-API.v1-fv.html#/operations/ListUsers) or [`/groups`](../api/Public-API.v1-fv.html#/operations/ListGroups) endpoints and remember their identifiers. Then, make a `PUT` request to the [`/tasks/{taskId}/assign`](../api/Public-API.v1-fv.html#/operations/AssignTask) endpoint and provide the identifiers. + +### List all the tasks in a project + +Make a `GET` call to the [`/projects/{projectId}/tasks`](../api/Public-API.v1-fv.html#/operations/ListProjectTasks) endpoint to list all the tasks in a project by projectId. The response returns a total count of the tasks, and several details for each task: `taskId`, the input and outcome per task, the owner and assignees, the creation and due dates. + + +### Upload/Import a target file version + +Make a `POST` call to the [`/projects/{projectId/target-files/{targetFileId}/versions/imports`](../api/Public-API.v1-fv.html#/operations/ImportTargetFileVersion) endpoint to upload (import) a new file version that can be used as part of a task. The response returns the `importId` which you can further use to check the import result by making a `GET` call to the [`/projects/{projectId}/target-files/{targetFileId}/versions/imports/{importId}`](../api/Public-API.v1-fv.html#/operations/PollTargetFileVersionImport) endpoint. The `projectId` can be retrieved by making a `POST` call to the [`/projects`](../api/Public-API.v1-fv.html#/operations/CreateProject) endpoint, while the `targetFileId` can be retrieved by making a `GET` call to the [`/projects/{projectId}/target-files`](../api/Public-API.v1-fv.html#/operations/ListTargetFiles) endpoint. + + + diff --git a/articles/LCPublicAPI/docs/Introduction.md b/articles/LCPublicAPI/docs/Introduction.md new file mode 100644 index 0000000..27d1918 --- /dev/null +++ b/articles/LCPublicAPI/docs/Introduction.md @@ -0,0 +1,29 @@ +# Trados Cloud Platform API + +The Trados Cloud Platform API enables external applications to interact with Trados Cloud Platform. + +## Product Configurations + +This applies to all products that are based on Trados Cloud Platform. Note that, depending on the product and its configuration, certain features may not be available or the rate might be limited through the API. In general, when a certain feature is available in your specific product configuration, the corresponding endpoints will also be available in the API. + +## Features Overview + +At present, the API contains mainly capabilities that enable the creation, management and tracking of cloud translation projects. + +Resources like termbases and translation memories can also be created using the Trados Cloud Platform API. Any other resources, such as pricing models need to be set up beforehand, using the user interface. + +## Types of Integrations + +At the moment the Trados Cloud Platform API can be called by custom (integration) applications on behalf of service users (non-human users). The ability to call the API on behalf of real end users will be supported at a later date. + +## Creating Your First Project + +Follow these steps to create your first project using the API: +### 1. Create a service user, an application and authenticate + +Follow the instructions under the [Service users and custom applications](../docs/Service-users-and-custom-applications.md) and the [Service Credentials](../docs/Service-credentials.md) pages to create a service user and an application, and then authenticate, following the [Authentication](../docs/Authentication.md) page, by using the application's `client_id` and `client_secret`. + +### 2. Create your first project + +See [Create projects](../docs/Create-projects.md) and [Basic project creation flow](../docs/Basic-project-creation-flow.md) for a walk-through of the required steps to create a project. + diff --git a/articles/LCPublicAPI/docs/Known-Issues.md b/articles/LCPublicAPI/docs/Known-Issues.md new file mode 100644 index 0000000..2304413 --- /dev/null +++ b/articles/LCPublicAPI/docs/Known-Issues.md @@ -0,0 +1,13 @@ +# Known issues + +This page lists the known bugs and issues for Trados Cloud Platform API. + +> Note: 5xx status codes might be returned on any endpoint. This means that the server has encountered an unexpected error. If the error persists, use the [How to report an issue](../docs/How-to-report-an-issue.md) guideline to gather the needed information for reporting the issue. + +### Download Exported Quote Report + +The [Download Exported Quote Report](../api/Public-API.v1-fv.html#/operations/DownloadQuoteReport) endpoint is designed to be a one-time operation. After a download attempt, the file is deleted and it's no longer available for download. If the file needs to be downloaded again, the user needs to request a new export of the quote report by using the [Export Quote Report](../api/Public-API.v1-fv.html#/operations/ExportQuoteReport) and [Poll Quote Report Export](../api/Public-API.v1-fv.html#/operations/PollQuoteReportExport) endpoints. + +### Export Quote report +When the export is not using a Quote Template, the response for this call will be empty. + diff --git a/articles/LCPublicAPI/docs/Language-Cloud-APIs-for-Postman.md b/articles/LCPublicAPI/docs/Language-Cloud-APIs-for-Postman.md new file mode 100644 index 0000000..7ba6f9a --- /dev/null +++ b/articles/LCPublicAPI/docs/Language-Cloud-APIs-for-Postman.md @@ -0,0 +1,69 @@ +# Trados Cloud Platform APIs for Postman + +We provide a [Postman](https://www.postman.com/) collection for quick and easy usage of our RESTful APIs. + +## Installation + +You can download the Postman collection from [here](https://github.com/sdl/language-cloud-public-api-postman/blob/develop/postmanCollection.json?raw=true). + +If you make use of multi-region, we also provide the [EU](https://raw.githubusercontent.com/RWS/language-cloud-public-api-postman/refs/heads/develop/Trados%20EU.postman_environment.json?raw=true) and [CA](https://raw.githubusercontent.com/RWS/language-cloud-public-api-postman/refs/heads/develop/Trados%20CA.postman_environment.json?raw=true) Postman Environments. + +There are 3 setup options: +- Copy the collection URL from above and import it into Postman using `Import > Link`. +- Copy the entire file content and import it into Postman using `Import > Raw Text`. +- Save it as a `JSON` file on your computer and import it into Postman using `Import > File`. + + + + + + +## Configuration + +The imported collection is already set up for you to get started as fast as possible. + +We make use of collection level variables and an inherited authentication mechanism. + +For example, authentication is already set up to use the Bearer Token scheme and will use the token value provided by `{{lc-access-token}}` variable. This token is populated with the correct value, each time you `Obtain a client credentials access token`, via the Tests tab. + +One thing you need to do before proceeding is to fill in the `{{lc_tenant}}` variable with your own tenant ID. Prepend the ID with LC- so the final value looks like this `LC-00000000000000000`. + +Don't forget to save the collection! + + + + + + +## Multi-region environments +If you have imported the regional Postman Environments, please note that any environment-level variables (e.g., `baseUrl`) will overwrite collection variables. This means that when you have an environment selected in Postman, the value of `baseUrl` will be the one defined in the environment, not the value defined at the collection level. + + +## Authentication +To start working with the Trados Cloud Platform API, you first need to authenticate. + +You can find the authentication call under the `Authentication (Start Here)` folder. Fill in your `client_id` and `client_secret` and perform the request. + +If the authentication is successful, the token will be extracted automatically from the response and saved to the `{{lc-access-token}}` variable. + + + + + + + +## Usage + +After you have authenticated successfully, you can start interacting with the Trados Cloud Platform API. + +For example, we can get information about a project by using the **GetProject** request from the **Project** folder. + +Simply fill in your `projectId` and click SEND. Optionally, you can supply values to the `fields` parameter to receive only data that is of interest. + + + + +> IMPORTANT: make sure you are not sending any query parameters with default Postman values. If you are sending any parameters, make sure you are sending valid data or else you will get an API Error. + + + diff --git a/articles/LCPublicAPI/docs/Language-codes.md b/articles/LCPublicAPI/docs/Language-codes.md new file mode 100644 index 0000000..5c73090 --- /dev/null +++ b/articles/LCPublicAPI/docs/Language-codes.md @@ -0,0 +1,13 @@ +# Language Codes + +When getting a response that contains language codes, the case of the language code is not guaranteed and should be treated as case insensitive. + +For example the Trados Cloud Platform API can return the same language code but with different casing on different endpoints: + +- en-US +- en-us +- EN-US + +All 3 variants are equivalent. + +When making a request to the Trados Cloud Platform API, you should still ensure the correct casing of language codes, to avoid any unexpected situations. \ No newline at end of file diff --git a/articles/LCPublicAPI/docs/Multi-region.md b/articles/LCPublicAPI/docs/Multi-region.md new file mode 100644 index 0000000..4977dd5 --- /dev/null +++ b/articles/LCPublicAPI/docs/Multi-region.md @@ -0,0 +1,23 @@ +--- +stoplight-id: nfdrob1smwn00 +--- + +# Multi-region + +Trados Cloud Platform operates in multiple regions, and it's essential to know how to use the Public API correctly for each region. + +Each region has a unique Public API host, and all requests must be specific to that region. If you try to access accounts or data not available in a region, you will encounter errors. + +## Legacy integrations + +The domains for the Trados Cloud Platform API have been updated. If you are using the old domain `lc-api.sdl.com` in a legacy integration, please consider the following options: +- Use the new endpoints to discover the correct Public API host for your desired region. +- If you are only integrating with the EU region (legacy), update the host to: `api.eu.cloud.trados.com` + +## Supporting multi-region + +This information is especially relevant if you are building multi-tenant integrations. + +The provided .NET and Java SDKs already support multiple regions. For details on using these SDKs, refer to their documentation. + +> If you're building your own client, avoid hard-coding Trados Cloud Platform API hosts, as new regions may be added in the future, requiring updates to hard-coded hosts. You can discover all available regions and their corresponding Public API hosts using the [List Regions](../api/Global-Public-API.v1-fv.html#/operations/ListRegions) endpoint from the new Global Public API, which is accessible on a new global host `api.cloud.trados.com`. diff --git a/articles/LCPublicAPI/docs/Public-API-Management-Process.md b/articles/LCPublicAPI/docs/Public-API-Management-Process.md new file mode 100644 index 0000000..5d3c92b --- /dev/null +++ b/articles/LCPublicAPI/docs/Public-API-Management-Process.md @@ -0,0 +1,61 @@ +# Trados Cloud Platform API Management Process + + +## Overview +By using continuous delivery, our team regularly updates the Trados Cloud Platform API with new functionality, bug fixes and performance improvements. + +Find below the defined process (lifecycle policy) we use that enables us to maintain a set of stable APIs. + +Every release is announced on the [What's new](../docs/Whats-New.md) page in our API Docs. + +## What is a breaking change? +- Changing the type of a field +- Modifying a field name +- Marking an existing field as required with no default value +- Introducing a new validation +- Enforcing validations +- Removing or renaming enum values +- Removing fields from response + +## What isn't a breaking change? +- Adding new endpoints +- Adding optional request fields +- Adding new fields in responses +- Adding new field as required with default value +- Changing of error messages description +- Adding enum values + +## Endpoint retirement process +Retirement of an endpoint will happen in two phases: deprecation and sunset. + +Deprecation will be marked accordingly with IETF's [deprecation http-response-header-field](https://datatracker.ietf.org/doc/draft-dalal-deprecation-header/) with: +- a date in the future: representing the date, when the endpoint will be marked as deprecated +- a date in the past: representing the date, when the endpoint was marked as deprecated +- true: simply signal to the clients, that the endpoint is deprecated + +The deprecation period is six months. + +Sunset marks the point in time where the endpoint will not return the expected response. The endpoint will still be functional until sunset. + +Together with the deprecation header, a new sunset-header will be introduced to mark the date of the sunset. + +## How will we communicate an eventual breaking change or endpoint retirement? +An eventual breaking change or an endpoint retirement will be announced: +- on the [What's new](../docs/Whats-New.md) page in our API Docs +- on the [What's deprecated](../docs/Whats-deprecated.md) page in our API Docs +- on the developers [GitHub](https://developers.rws.com/languagecloud-api-docs/index.html) page +- on a new blog post in the [Language Developers Blog](https://community.rws.com/developers-more/developers/language-developers/b/language-developers-blog) and [Trados Blog](https://community.rws.com/product-groups/trados-portfolio/trados-live/b/blog) + +Any breaking change will be announced six months in advance. + + +> #### Info +> +> We may introduce breaking changes for critical bugs or security vulnerabilities. + +## What is our process for testing changes before releasing them to the Trados Cloud Platform API? +All changes undergo comprehensive testing and validation, following our deployment chronology in both non-customer and customer facing environments. + +As part of development, unit and contract tests are built as appropriate and undergo in-depth code review before being merged into master. + +As part of testing, once the changes are merged, they are tested according to our testing strategy, where testing scope and test coverage are identified. A test plan for the changes is created and quality assurance engineers decide upon manual and automation testing percentage to ensure the feature is implemented according to the specifications. On top of this we make sure regressions are not introduced by running the automated tests we have in place, as part of the release pipeline. Before new code is deployed to an environment (either customer or non-customer facing), all smoke tests must pass. diff --git a/articles/LCPublicAPI/docs/Service-credentials.md b/articles/LCPublicAPI/docs/Service-credentials.md new file mode 100644 index 0000000..75e7290 --- /dev/null +++ b/articles/LCPublicAPI/docs/Service-credentials.md @@ -0,0 +1,43 @@ +# Service Credentials + +Before service users can authenticate with the Trados Cloud Platform API, they need to get their client credentials from a Trados Cloud Platform administrator. Service users can then use their client credentials to authenticate with the API via an Auth0 access token. + +## Step 1: Trados Cloud Platform administrators add service users to the Trados Cloud Platform account. + +1. Log in to the Trados UI as a human **Administrator** user type or contact the administrator to perform the operations in this section. +2. Go to the **Users** view and select the **Service Users** sub-tab. +3. Select **New Service User** and enter the following information: + - **Name** – Enter a unique name for your service user. + - **Location** – Select a location (the **Root** folder or any of its children) for your service user. A location is a folder in your account hierarchy where resources are stored and managed. + - **Groups** – Select one or more groups (from the same **Location** as the one selected above) where you want to include your service user. Each group corresponds to a predefined role, and each predefined role has a set of permissions. Resource access is influenced by the role you choose. + - (Optional) **Description** – Enter any other relevant details. +4. Select **Create**. + +## Step 2: Trados Cloud Platform administrators add additional notification options for service users + +1. Log in to the Trados UI as a human **Administrator** user type or contact the administrator to perform the operations in this section. +2. Go to the **Users** view and select the **Service Users** sub-tab. +3. Select the service user to be edited +4. **Additional users to notify** - Add existing users to be notified of actions via email. +4. Select **Save**. + +## Step 3: Trados Cloud Platform administrators create a custom application, assign the service user to it, and retrieve the client credentials from within this application. + +1. Log in to the Trados UI as a human **Administrator** user type or contact the administrator to perform the operations in this section. +2. Expand the account menu on the top right-hand corner and select **Integrations**. +3. Select the **Applications** sub-tab. +4. Select **New Application** and enter the following information: + - **Name** – Enter a unique name for your custom application. + - (Optional) **URL** – Enter your custom application URL. + - (Optional) **Description** – Enter any other relevant details. + - **Service User** – Select a service user from the dropdown menu. +5. Select **Add**. +6. Back in the **Applications** sub-tab, select the check box corresponding to your application. +7. Select **Edit**. +8. On the **Overall Information** page you can change any of the following, if necessary: name, URL, description. +9. On the **Webhooks** page you can: + - Enter a default callback URL for your application Webhooks (all Webhooks defined in Trados Cloud Platform). + - Enter a value for **Webhook URL** (this is your Webhook endpoint URL which you expose and which Trados Cloud Platform calls), select one or more event types, and hit Enter. You can create a separate webhook for every event you are interested in or combine notifications for multiple event types to one webhook. If you delete your application, all its associated webhooks are also deleted. +10. Finally, from the **API Access** page you can retrieve your **Client ID** and **Client Secret**. + +> Although you have the option to change the **Service User** later on, it is not recommended. Due to the caching layers, changes from one **Service User** to another can take between 10 to 20 minutes to fully take effect. During this period, calls made with this **Application**'s credentials may randomly use either the new or the old **Service User.** If you can't stop your services to wait for the cache to expire, it's recommended to create a new **Application** with the new **Service User** and delete the old one. \ No newline at end of file diff --git a/articles/LCPublicAPI/docs/Service-users-and-custom-applications.md b/articles/LCPublicAPI/docs/Service-users-and-custom-applications.md new file mode 100644 index 0000000..2a1b398 --- /dev/null +++ b/articles/LCPublicAPI/docs/Service-users-and-custom-applications.md @@ -0,0 +1,20 @@ +# Service users and custom applications + +Service users are special users created when developing custom applications that integrate with the Trados Cloud Platform API. + +Service users: +- Are non-human users +- Don’t have login credentials +- Can only access Trados Cloud Platform via the Trados Cloud Platform API + +### Who can create service users? + +Service users are managed by administrators within a Trados Cloud Platform account. Administrators add service users to one or more groups. Once service users become part of a group, they automatically get a role, namely the group role which is associated with a predefined set of permissions. Service users access resources based on the permissions associated with the group (role) they belong to. + +### How are service users assigned to custom applications? + +When Trados Cloud Platform administrators create a custom application from the Trados UI, they assign one service user per application. + +### How does the authentication process of service users work? + +Whenever a third-party client authenticates with the application credentials, calls against the Trados Cloud Platform API will assume the identity of the service user within the platform for the purpose of authorizing access to data. diff --git a/articles/LCPublicAPI/docs/Track-projects.md b/articles/LCPublicAPI/docs/Track-projects.md new file mode 100644 index 0000000..0d36e1c --- /dev/null +++ b/articles/LCPublicAPI/docs/Track-projects.md @@ -0,0 +1,6 @@ +# Track projects + +After you create a project, you can track it by making a `GET` request to the [`/projects/{projectId}`](../api/Public-API.v1-fv.html#/operations/GetProject) endpoint to obtain information such as: creation date, due date, status, and resources used. + +When requesting a list of projects, you can filter out projects that have a file download restriction by sending the `excludeOnline` query parameter. + diff --git a/articles/LCPublicAPI/docs/Update-project-quote.md b/articles/LCPublicAPI/docs/Update-project-quote.md new file mode 100644 index 0000000..93983e6 --- /dev/null +++ b/articles/LCPublicAPI/docs/Update-project-quote.md @@ -0,0 +1,426 @@ +# Update project quote +To update a quote, make a `PUT` request to the [`/projects/{projectId}`](../api/Public-API.v1-fv.html#/operations/UpdateProject) end point, and specify the `quote` field. + +## Cost types + +There are two types of translation costs that can be updated using the Trados Cloud Platform API: +- **Language Costs** + - Costs that are applied at language level: *volume, percentage, hourly, per page, conditional* +- **Project Costs** + - Costs that are applied at project level as additional cost: *volume, percentage, hourly, per page, conditional, per file, per target language* + + +## Cost types available at project and language level + +> Note: Both language costs and project costs have identical request/response bodies, but for `languageCosts`, the `targetLanguage` field is required. + + +The examples below use the following translation costs: + +```json +... +{ + "translationCosts": [{ + "total": 85.4, + "targetLanguage": { + "languageCode": "fr-FR", + "englishName": "French (France)" + }, + "new": { + "count": 854.0, + "rate": 0.1, + "total": 85.4, + "runningTotal": 85.4 + } + } + ] +} +... +``` + +### Volume + +This is a fixed per word/character cost. + +***Request***: +```json +... +{ + "name": "Volume Cost", + "costOrder": 0, + "cost": 0.5, + "volumeUnitType": "Words", + "costType": "volume" + ... +} +... +``` + +The total cost is calculated as `number of words/characters` * `cost of a unit`: + +**`total = count * cost`** + +***Response***: + +```json +... +{ + "name": "Volume Cost", + "count": 854.0, + "total": 427.0, + "cost": 0.5, + "costType": "volume", + "volumeUnitType": "words", + "costOrder": 0, + "runningTotal": 512.4 + ... +} +... +``` + +The running total up until this point is equal to `total cost of the current additional cost` + `translation costs`.
+Using the data above, we can get the following running total: + +**`85.4 + 427 = 512.4`** + +### Percentage + +This is a percentage cost calculated against the current cost (current language-level cost or current project-level cost). + +***Request***: + +```json +... +{ + "name": "Percentage Cost", + "costOrder": 1, + "count": -10, + "costType": "percentage" + ... +} +... +``` + +The `total cost of the current additional cost` is calculated using the value from the `count` field as a percentage from the previous `running total`. + +**`total = count% * previousRunningTotal`** + +***Response***: + +```json +... +{ + "name": "Percentage Cost", + "count": -10.0, + "total": -51.24, + "cost": 0.0, + "costType": "percentage", + "costOrder": 1, + "runningTotal": 461.16 + ... +} +... +``` + +Since the previous `running total` is **512.4**, the total cost of the `current additional cost` is calculated as follows: + +**`total = -10% * 512.4 = -51.24`** + +As a result, the new running total becomes: + +**`runningTotal = 512.4 - 51.24 = 461.16`** + +### Hourly + +This is a fixed cost per hour. + +***Request***: + +```json +... +{ + "name": "Hourly Cost", + "costOrder": 2, + "count": 5, + "cost": 1.5, + "costType": "hourly" + ... +} +... +``` + +The total cost is calculated as `number of hours` * `cost of an hour`: + +**`total = count * cost`** + +***Response***: + +```json +... +{ + "name": "Hourly Cost", + "count": 5.0, + "total": 7.5, + "cost": 1.5, + "costType": "hourly", + "costOrder": 2, + "runningTotal": 468.66 + ... +} +... +``` + +**`total = 5 * 1.5 = 7.5`** + +**`runningTotal = 461.16 + 7.5 = 468.66`** + +### Per Page + +This is a fixed cost per page. + +***Request***: + +```json +... +{ + "name": "Per Page Cost", + "costOrder": 3, + "count": 10, + "cost": 0.2, + "costType": "perPage" + ... +} +... +``` + + +The total cost is calculated as `number of pages` * `cost of a page`: + +**`total = count * cost`** + +***Response***: + +```json +... +{ + "name": "Per Page Cost", + "count": 10.0, + "total": 2.0, + "cost": 0.2, + "costType": "perPage", + "costOrder": 3, + "runningTotal": 470.66 + ... +} +... +``` + +**`total = 10 * 0.2 = 2`** + +**``runningTotal = 468.66 + 2 = 470.66``** + +### Conditional + +This is a cost that is applied conditionally, for example: + +***Request***: + +```json +... +{ + "name": "Conditional Cost", + "costOrder": 4, + "conditionalCostVariable": "wordCount", + "conditionalCostOperator": "less", + "conditionalCostThreshold": 1000, + "cost": 100, + "conditionalCostType": "relative", + "costType": "conditional" + ... +} +... +``` + +If `[conditionalCostVariable]` `[conditionalCostOperator]` `[conditionalCostThreshold]`, then add/set `[cost]` `[conditionalCostType]`. + +This formula translates to the following: + +If `wordCount < 1000`, then add `100 relative`. + +***Response***: + +```json +... +{ + "name": "Conditional Cost", + "count": 854.0, + "total": 100.0, + "cost": 100.0, + "costType": "conditional", + "costOrder": 4, + "conditionalCostType": "relative", + "conditionalCostOperator": "less", + "conditionalCostVariable": "wordCount", + "conditionalCostThreshold": 1000.0, + "runningTotal": 570.66 + ... +} +... +``` +Since the word count (`count`) is 854 (in the example above), the condition becomes: + +If `854 < 1000` then add `100 relative`. => `true` + +**`total = cost = 100`** + +**`runningTotal = 470.66 + 100 = 570.66`** + +The total cost depends on the `conditionalCostType` field and on whether the condition evaluates to `true` or `false`. +When the condition evaluates to `false`, the total will be 0, and the running total will not change. + +If `854 > 1000`, then add `100 relative`. => `false` + +**`total = cost = 0`** +**`runningTotal = 470.66`** + + +For the same values as above, and the `conditionalCostType` set to `percentage`, the `total` and `runningTotal` values will change to: + +**`total = 100% * 470.66 = 470.66`** + +**`runningTotal = 470.66 + 470.66 = 941.32`** + +When the `conditionalCostType` is set to `absolute`, the total will be equal to the difference between the `cost` and the `runningtotal`: + +**`total = 100 - 470.66 = -370.66`** + +**`runningTotal = 100`** + +> **Note:** Setting `conditionalCostType` to `absolute` will cancel all the previous costs for the project or target language. + +## Cost types available ONLY at project level + +### Per Target Language + +This is an additional cost that is calculated based on the number of target languages in the project. + +***Request***: + +```json +... +{ + "name": "Per Target Language", + "costOrder": 5, + "cost": 5, + "costType": "perTargetLanguage" +} +... +``` + +The total cost is calculated as `number of target languages` * `cost of a target language`: + +***Response***: +```json +... +{ + "name": "Per Target Language", + "count": 1.0, + "total": 5.0, + "cost": 5.0, + "costType": "perTargetLanguage", + "costOrder": 5, + "runningTotal": 575.66 +} +... +``` + +Since there is only one target language in the example above, the total cost becomes: +**`total = 1 * 5 = 5`** +**`runningTotal = 570.66 + 5 = 575.66`** + +### Per File + +This is an additional cost that is calculated based on the number of files in the project. + +***Request***: + +```json +... +{ + "name": "Per File", + "costOrder": 6, + "cost": 3, + "costType": "perFile" +} +... +``` + +The total cost is calculated as `number of files` * `cost of a file`: + +***Response***: +```json +... +{ + "name": "Per File", + "count": 2.0, + "total": 6.0, + "cost": 3.0, + "costType": "perFile", + "costOrder": 6, + "runningTotal": 581.66 +} +... +``` +**`total = 2 * 3 = 6`** +**`runningTotal = 575.66 + 6 = 581.66`** + +## Cost order + +The `costOrder` field defines the order in which costs are calculated. + +For example, if there are two additional costs defined in the quote (see below), the percentage cost is calculated based on the running total from the volume cost. + +```json +... +{ + "name": "Volume Cost", + "total": 427.0, + "costType": "volume", + "costOrder": 0, + "runningTotal": 512.4 +... +}, +{ + "name": "Percentage Cost", + "total": -51.24, + "count": -10.0, + "costType": "percentage", + "costOrder": 1, + "runningTotal": 461.16 +... +} +... +``` + +When the `costOrder` field is switched, the `total` percentage cost value will be calculated based on the previous running total, which in this case is the translation cost (**85.4**): +```json +... +{ + "name": "Percentage Cost", + "count": -10.0, + "total": -8.54, + "costType": "percentage", + "costOrder": 0, + "runningTotal": 76.86 +... +}, +{ + "name": "Volume Cost", + "total": 427.0, + "costType": "volume", + "costOrder": 1, + "runningTotal": 503.86 +... +} +... +``` diff --git a/articles/LCPublicAPI/docs/Updating-data-with-PUT.md b/articles/LCPublicAPI/docs/Updating-data-with-PUT.md new file mode 100644 index 0000000..6918108 --- /dev/null +++ b/articles/LCPublicAPI/docs/Updating-data-with-PUT.md @@ -0,0 +1,18 @@ +# Updating data with PUT + +All update endpoints follow the rules listed in [JSON Merge Patch Semantics](https://tools.ietf.org/html/rfc7386). + +### Pay special attention when updating array fields + +The update overrides the entire array, not just the elements that are sent. See the following example: + +| ORIGINAL | PATCH | RESULT | +|:--- | :--- | :--- | +|`{"a" :[{"b": "c"}]}`| `{"a" :[1]}` | `{"a" :[1]}`| + + +If you don't send the "b" element from array "a", the element "b" will be removed from result after the update operation. + +If you send a new array element `[1]`, this element will be added into the result. + +Updating an existing array element requires that you send the original array with a new value for the desired element. \ No newline at end of file diff --git a/articles/LCPublicAPI/docs/Use-fields-in-your-requests.md b/articles/LCPublicAPI/docs/Use-fields-in-your-requests.md new file mode 100644 index 0000000..c0951e4 --- /dev/null +++ b/articles/LCPublicAPI/docs/Use-fields-in-your-requests.md @@ -0,0 +1,54 @@ +# Use fields in your requests + +All the endpoints that return a resource representation allow the `fields` query parameter. Fields are used to specify the property values you want returned for your entities. + +When you make a call using the `fields` query parameter, make sure that you: +- Separate the fields by commas. +- Query by `properties` and/or `subproperties`. Write `subproperties` in the following format: `propertyname.subpropertyname`. +- Familiarize yourself with the elements that get returned: + - The fields marked as “**required**” are always returned. + - If fields are not customized for a given level and the requested field is non null then the default fields will be returned. + - If fields are customized for a given level and the requested field is non null, the fields you requested will be returned. + - The rules above are applied at nested level as well. + +Let’s look at an example to understand how the `fields` parameter can be used. +We will perform a `GET` request to the [`/projects/projectId`](../api/Public-API.v1-fv.html#/operations/GetProject) endpoint and we will consider that in our example the `projectId`= 101. + +#### 1. Fields consist of properties and subproperties. Here are some examples: +- `Properties`: `id`; `name`; `customer`; `createdBy` and so on +- `Subproperties`: `customer.name`; `customer.keyContact`; `customer.Location`; `createdBy.email` and so on + +#### 2. You can make calls in several ways: +- No field customization + +Request: `GET/projects/101` + +Response: the project **identifier**, the project **name**, the project **language directions** + + + + +* Field customization (no nesting) + +Request: `GET/projects/101?fields=customer` + +Response: the project **identifier**; the customer **identifier**; the customer **name**; the customer’s **key contact**; the customer **location** + + + + +* Field customization (nesting) + +Request: `GET/projects/101?fields=customer.keyContact,customer.name` + +Response: the project **identifier**; the customer **name**; the customer’s **key contact** + + + + diff --git a/articles/LCPublicAPI/docs/Use-paging-and-sorting-for-lists.md b/articles/LCPublicAPI/docs/Use-paging-and-sorting-for-lists.md new file mode 100644 index 0000000..4ed1872 --- /dev/null +++ b/articles/LCPublicAPI/docs/Use-paging-and-sorting-for-lists.md @@ -0,0 +1,26 @@ +# Use paging and sorting for lists + +When the outcome of a `GET` call is a list of items (item properties and total count), you can control the number of results displayed on a page as well as sort the results. + +To control the number of results displayed on a page, do the following: + +- To retrieve the full size of an entity, make a `GET` call to its corresponding endpoint. + +For example, make a `GET` call to the [`/projects`](../api/Public-API.v1-fv.html#/operations/ListProjects) endpoint. The result consists in a list of all the projects (and their details) as well as a project count. The project count field returns the same value even if you further apply the `top` or `skip` query parameters. + +- To display only the first 10, 20, 30 (and so on) results in your list, use the `top` query parameter. + +For example, for the [`/projects`](../api/Public-API.v1-fv.html#/operations/ListProjects) endpoint, your query may look like this if you are interested in the first 10 projects: `/projects?top=10` + +- To get to a particular set of retrieved results in your list, use the `skip` query parameter. + +For example, for the [`/projects`](../api/Public-API.v1-fv.html#/operations/ListProjects) endpoint, if you want to skip the first 100 results, your query will look like this: `/projects?skip=100`. + +- To sort your list by certain properties, use the `sort` query parameter. + +The default sorting strategy is ascending. Add unary operators for ascending (+) and descending (-) sorting. If you do not add any operator, the default ascending strategy kicks in. + +For example, if you want to sort results by due date (-) and name (+), your query will look like this: `/projects?sort=-dueBy,name`. + +Note that sorting can be performed only on first-level fields (not nested fields), for naturally comparable types like strings, numbers, and dates. + diff --git a/articles/LCPublicAPI/docs/Whats-New.md b/articles/LCPublicAPI/docs/Whats-New.md new file mode 100644 index 0000000..8f7da76 --- /dev/null +++ b/articles/LCPublicAPI/docs/Whats-New.md @@ -0,0 +1,383 @@ +# What's new + + + +## 10 September 2025 +- With this release we deliver [Lookup](../api/Public-API.v1-fv.html#/operations/TranslationsLookup), [Concordance](../api/Public-API.v1-fv.html#/operations/TranslationsConcordanceSearch), [Add](../api/Public-API.v1-fv.html#/operations/TranslationsAdd) and [Update](../api/Public-API.v1-fv.html#/operations/TranslationsUpdate) translation units to a translation memory. See [this](./translations/Translations.md) page for more details. +- You can now [obtain](../api/Public-API.v1-fv.html#/operations/GetTranslationEngine) and [update](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) the resources sequence information for a Translation Engine. +- A new project event `PROJECT.STARTED` has been added. See [this](./webhooks/Webhooks-payload.md) page for more details. + + +## 18 August 2025 + +- The new, modernized Trados Cloud Platform SDK for Java is now available. See the upgrade guide [here](../docs/api-clients/java/Java-Client-Upgrade-Guide.md). + +## 12 August 2025 + +- You can now get word count and cost estimation analysis of files without the need to create a project. The functionality is accessible via the [Request File Analysis](../api/Public-API.v1-fv.html#/operations/RequestFileAnalysis) and [Poll File Analysis](../api/Public-API.v1-fv.html#/operations/PollFileAnalysis) endpoints. +- As previously announced, the `languageProcessingRuleId` parameter is now mandatory for [Update Translation Engine](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) endpoint. +- We fixed various bugs. + +## 15 July 2025 +- You can now add the `systemStatus` property on termbase entries. See [Update Termbase Entry](../api/Public-API.v1-fv.html#/operations/UpdateTermbaseEntry). +- We've improved the documentation around zip files on [Add Source File](../api/Public-API.v1-fv.html#/operations/AddSourceFile) and [Attach Source File](../api/Public-API.v1-fv.html#/operations/AddSourceFiles) endpoints. +- As a reminder, we want to let our users know that the field `languageProcessingRuleId` under [Update Translation Engine](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) endpoint will be mandatory. +- [Import Termbase](../api/Public-API.v1-fv.html#/operations/ImportTermbase) and [Poll Termbase Import](../api/Public-API.v1-fv.html#/operations/PollTermbaseImport) endpoints will return `pending` instead of `queued` for the status. This change is scheduled to take effect no sooner than six months from now. + +## 8 May 2025 +- You can now download the target files associated with a project in a ZIP format. This functionality is accessible through three endpoints: [Export](../api/Public-API.v1-fv.html#/operations/ExportProjectFiles), [Poll](../api/Public-API.v1-fv.html#/operations/ExportProjectFilesStatus), and [Download](../api/Public-API.v1-fv.html#/operations/DownloadFile). +- With this release we deliver the [Create](../api/Public-API.v1-fv.html#/operations/CreatePricingModel), [Update](../api/Public-API.v1-fv.html#/operations/UpdatePricingModel) and [Delete](../api/Public-API.v1-fv.html#/operations/DeletePricingModel) pricing model endpoints. Together with these, several changes were required to correct the pricing model response: + - `name` : changed from required to default. + - `additionalCosts.volumeUnitType` changed from required to non required. + - `additionalCosts.conditionalCostType` changed from required to non required. + - `additionalCosts.costOperator` changed from required to non required. + - `additionalCosts.costVariable` changed from required to non required. + - `additionalCosts.operand` changed from required to non required. + - `perTargetLanguage` and `perFile` cost types have been removed from `languageCosts` to clean up the structure. + +- We have expanded the cost types by introducing two new values: **adhoc** and **adhoc volume**. +- Import and Export TM endpoints are now subject to API limits. For more details, please refer to [this page](../docs/API-rate-limits.md). +- We updated the [Java Client samples](../docs/api-clients/java/Java-Samples.md) to reflect the usage of the latest version. +- We fixed various bugs. + +## 1 April 2025 +- As part of the Connected AI feature, we have added the following updates and new endpoints: + - We have introduced a new endpoint for listing [Large Language Models](../api/Public-API.v1-fv.html#/operations/ListLlmConfigurations) (LLMs). + - We have added the functionality to [update your translation engines](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) with the new LLM resource type. +- We have added the source word count to the [List Source Files](../api/Public-API.v1-fv.html#/operations/ListSourceFiles) endpoint. +- We fixed various bugs. + + +## 10 March 2025 + +- We've introduced the concept of [Batched Webhooks](../docs/webhooks/Batched-webhooks.md). +- We've updated the models for [Import Translation Memory](../api/Public-API.v1-fv.html#/operations/ImportTranslationMemory), [Export Translation Memory](../api/Public-API.v1-fv.html#/operations/ExportTranslationMemory) and [Get Translation Memory Import History](../api/Public-API.v1-fv.html#/operations/GetTMImportHistory). + - As part of this, the existing `status` field is now marked as deprecated in the response model of [Import Translation Memory](../api/Public-API.v1-fv.html#/operations/ImportTranslationMemory) and [Export Translation Memory](../api/Public-API.v1-fv.html#/operations/ExportTranslationMemory). + - Additionally, the fields `importAsPlainText` and `triggerRecomputeStatistics` are marked as deprecated in the request model of [Import Translation Memory](../api/Public-API.v1-fv.html#/operations/ImportTranslationMemory) and in the response model of [Get Translation Memory Import History](../api/Public-API.v1-fv.html#/operations/GetTMImportHistory), alongside the `traceId` field. + - Their decommissioning is scheduled at a minimum of six months from now. + + +## 10 December 2024 +- You can now associate existing users with a service user to notify them of actions via email, using Trados UI. More details [here](../docs/Service-credentials.md#step-2-trados-cloud-platform-administrators-add-additional-notification-options-for-service-users). +- We have officially rebranded from RWS Language Cloud API to Trados Cloud Platform API. All references to our previous brand name will now reflect our new identity, Trados. +- Provided [Postman Environments](../docs/Language-Cloud-APIs-for-Postman.md) for multi-region. + +## 18 November 2024 +- As part of our multi-region support, we have added global endpoints to facilitate the discovery of available regions and hosts. For more details, see the [Multi-region](../docs/Multi-region.md) page. +- We have updated the documentation on how to use the new SDK with multi-region features. +- Additionally, we made various minor contract corrections. +- As a reminder, we want to let our users know that the field `languageProcessingRuleId` under [Update Translation Engine](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) endpoint will become mandatory. + +## 6 November 2024 +- We are planning to transition the hosting of our API from **lc-api.sdl.com** to **api.eu.cloud.trados.com** on November 9th: + + - **lc-api.sdl.com** for API and integrations will remain active. + + - Existing integrations will continue to work as before. We do recommend planning to change the URL when possible. + + - For new integrations, we recommend using the new URL to avoid additional work in the future. + +- You now have the ability to add notes to customer quotes. + + - We have updated the deprecated types for the `language` and `targetLanguages` fields in the [Add Source File Request](../api/Public-API.v1-fv.html#/schemas/source-file-request) model, which now reference [Language Request](../api/Public-API.v1-fv.html#/schemas/language-request) model. In the updated API contract, these fields have been changed from simple strings to structured objects containing a `languageCode` property, enhancing clarity and consistency in language handling. + + > We will provide backwards compatibility until May 2025. However, starting with this release, SDKs will be updated to use the new types. Please ensure your integration is updated to use the new [Language Request](../api/Public-API.v1-fv.html#/schemas/language-request) model. + +- We fixed various bugs. +## 11 September 2024 + +- With this release we deliver the [PerfectMatch](https://docs.rws.com/791595/1155478/trados-enterprise---accelerate/perfectmatch-general-information) functionality. You can apply PerfectMatch either at the start of a project or midway through the translation process. These capabilities are accessible via the [PerfectMatch Mapping](../api/Public-API.v1-fv.html#/operations/CreatePerfectMatchMapping) menu. +- We've improved filtering for projects lists. See the [List Projects](../api/Public-API.v1-fv.html#/operations/ListProjects) endpoint. +- A recent update has been made to the [Webhooks Setup](../docs/webhooks/Webhooks-setup.md) page, informing the customers that the order of webhook event deliveries cannot be guaranteed. Please take this into consideration using the `timestamp` field to determine the event generation time. +- You can now set due dates for tasks during project creation. +- We fixed various bugs. + + +## 28 August 2024 +- We have introduced a new option which allows users to switch to a different pricing model at the Customer Quote Review task using the dedicated endpoint [Update Project Pricing Model](../api/Public-API.v1-fv.html#/operations/UpdateProjectPricingModel). +- You now have the ability to view the locking color options for MTQE segments by utilizing the [Get Project Template](../api/Public-API.v1-fv.html#/operations/GetProjectTemplate) endpoint. +- The parameter `termbaseStructure.fields.type` in the [Get Termbase](../api/Public-API.v1-fv.html#/operations/GetTermbase) endpoint is no longer marked as mandatory. +- We fixed various bugs. + +## 1 July 2024 +- We updated the folder/resource locations to the new format, which now includes the [path](../api/Public-API.v1-fv.html#/schemas/folder). +- We fixed various bugs. + +## 9 May 2024 + +- You can configure the number of days after which projects are given the Completed or Archived status automatically using the `completionConfiguration` option under the following endpoints: [Create](../api/Public-API.v1-fv.html#/operations/CreateProject) and [Update](../api/Public-API.v1-fv.html#/operations/UpdateProject) Project, [Create](../api/Public-API.v1-fv.html#/operations/CreateProjectTemplate) and [Update](../api/Public-API.v1-fv.html#/operations/UpdateProjectTemplate) Project Template. +- The field `languageProcessingRuleId` under [Update Translation Engine](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) endpoint will become mandatory. The enforcement is scheduled at a minimum of six months from now. +- As a reminder, we want to let our users know that we updated the folder/resource locations to the new format, which now includes the [path](../api/Public-API.v1-fv.html#/schemas/folder-v2). The old fields are marked as deprecated and their decommissioning is planned for near future. Please ensure you update the implementation if you are using fields that are marked as deprecated. +- We fixed various bugs. + +## 8 April 2024 + +- We extended the information available on the webhooks setup page, [Circuit Breaker](../docs/webhooks/Webhooks-setup.md#circuit-breaker) section. +- We removed the `languageId` allowed values for the [Export Quote Report](../api/Public-API.v1-fv.html#/operations/ExportQuoteReport) endpoint. +- As a reminder, we want to let our users know that we updated the folder/resource locations to the new format, which now includes the [path](../api/Public-API.v1-fv.html#/schemas/folder-v2). The old fields are marked as deprecated and their decommissioning is planned for near future. Please ensure you update the implementation if you are using fields that are marked as deprecated. +- We fixed various bugs. + +## 27 February 2024 + +- With this release we deliver the [Update](../api/Public-API.v1-fv.html#/operations/UpdateProjectTemplate) and [Delete Project Template](../api/Public-API.v1-fv.html#/operations/DeleteProjectTemplate) endpoints. Subsequent iterations with new implementations will follow, ensuring continuous enhancement for project template update. +- We published a new page about [multipart considerations](../docs/How-to-multipart.md) +- We fixed various bugs. + +## 13 December 2023 + +- With this release we deliver the [Create Project Template](../api/Public-API.v1-fv.html#/operations/CreateProjectTemplate) endpoint. Subsequent iterations with new implementations will follow, ensuring continuous enhancement for project template creation. +- We enhanced the response model for the [Get Project Template](../api/Public-API.v1-fv.html#/operations/GetProjectTemplate) endpoint, which now includes settings for verification and batch tasks. The existing `forceOnline` and `quoteTemplate` fields from root level are now marked as deprecated, as they have been moved to the `settings` section. Their decommissioning is scheduled at a minimum of six months from now. +- Webhooks will stop trying to send on urls that cause timeouts, retrying later. Read more [here](../docs/webhooks/Webhooks-setup.md#circuit-breaker). +- We fixed various bugs. + +## 16 November 2023 +- We introduced the `applicableOutcomes` field under the [get task](../api/Public-API.v1-fv.html#/operations/GetTask) endpoint to be used when completing the tasks. +- You can now change the folder visibility when updating a customer. +- We fixed various bugs. + +## 17 October 2023 +- This release delivers more integrations for the customer resource type. You can now [create](../api/Public-API.v1-fv.html#/operations/CreateCustomer), [update](../api/Public-API.v1-fv.html#/operations/UpdateCustomer) and [delete](../api/Public-API.v1-fv.html#/operations/DeleteCustomer) customers. +- We enhanced the response model for [pricing](../api/Public-API.v1-fv.html#/operations/ListPricingModels) endpoints. +- As previously announced, we made the `dueBy`, the `location` and the `languageDirections` fields mandatory for [creating a project](../api/Public-API.v1-fv.html#/operations/CreateProject). +- We added `deliveredBy` as a new field for the [update project](../api/Public-API.v1-fv.html#/operations/UpdateProject) capabilities. +- We extended the information available on the [webhooks setup](../docs/webhooks/Webhooks-setup.md) page. +- We fixed various bugs. + +## 06 September 2023 +- With this release we deliver the [create](../api/Public-API.v1-fv.html#/operations/CreateScheduleTemplate), [read](../api/Public-API.v1-fv.html#/operations/GetScheduleTemplate), [update](../api/Public-API.v1-fv.html#/operations/UpdateScheduleTemplate) and [delete](../api/Public-API.v1-fv.html#/operations/DeleteScheduleTemplate) endpoints of the new schedule template resource. You will find the endpoints under the [schedule templates](../api/Public-API.v1-fv.html#/operations/ListScheduleTemplates) menu. You can also retrieve the schedule template attached to a [project](../api/Public-API.v1-fv.html#/operations/GetProject) or to a [project template](../api/Public-API.v1-fv.html#/operations/GetProjectTemplate) using the relevant fields. +- Additionally, the [create project](../api/Public-API.v1-fv.html#/operations/CreateProject) now supports the schedule template resource, either individually or from the project template. +- We added the `apiInternalId` to [task type](../api/Public-API.v1-fv.html#/schemas/task-type) and [workflow task template](../api/Public-API.v1-fv.html#/schemas/workflow-task-template) to easily identify custom tasks. +- We fixed various bugs. + +## 17 August 2023 +- We updated the folder/resource locations to the new format, which now includes the [path](../api/Public-API.v1-fv.html#/schemas/folder-v2). The old fields are marked as deprecated and their decommissioning is scheduled at a minimum of six months from now. Please ensure you update the implementation if you are using fields that are marked as deprecated. +- Enhanced [project configuration](../api/Public-API.v1-fv.html#/operations/UpdateProjectConfiguration) now includes new choices for updating translation memory settings. +- We fixed various bugs. +- As a reminder, we want to let our users know that validations related to the following fields used at project creation: `dueBy`, `location` and `languageDirections` will become **required** in near future. + +## 02 August 2023 +- With this release we provide a new endpoint to allow integrators to update only one [custom field](../api/Public-API.v1-fv.html#/operations/UpdateCustomField) of a project +- We extended the information available on the [webhooks](../docs/webhooks/Webhooks-payload.md) page +- You can now update a translation engine as a stand alone resource or one that is linked to a live project. Read this [page](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) for more details. +- We fixed various bugs. + +## 15 June 2023 +- We extended the information provided for both [source](../api/Public-API.v1-fv.html#/operations/ListSourceFileVersions) and [target](../api/Public-API.v1-fv.html#/operations/ListTargetFileVersions) files in a task with the `name`, the `version` and `originatingTaskId` details +- We made available a new [rate-limits](../api/Public-API.v1-fv.html#/operations/ListRateLimits) endpoint and a new header which includes the relevant policy name, namely, the `X-RateLimit-Policy` header. Read the [API-rate-limits](../docs/API-rate-limits.md) page for more details. +- We improved descriptions for the `default` and `required` fields [here](../docs/Use-fields-in-your-requests.md). +- We updated the JAVA samples to reflect changes in the SDK. +- We fixed various bugs. + + +## 19 May 2023 +- We replaced the `friendlyId` on all Project Group endpoints with `shortId` and we've exposed it on all Project endpoints too. +- As a security enhancement, we will restrict some characters in naming projects and project files. The unsupported characters are: `<`, `>`, `:`, `"`, `/`, `\`, `|`, `?`, `*`. +- In 6 months we will introduce the following breaking change: on the [Export Quote Report](../api/Public-API.v1-fv.html#/operations/ExportQuoteReport) endpoint, if the quote is not generated using a Quote Template, the response will be an empty object. +- We will enforce validations related to the following fields at project creation: `dueBy`, `location` and `languageDirections`. These fields will become **required** in 3 months. +- As a reminder, we want to let our users know that for security issues or bugs we may introduce breaking changes at any time. + + + +## 20 April 2023 +- With this release we enforce validations listed in the documentation for the Create and Update Project endpoints. This impacts the SDKs, so please update your integration accordingly. +- We extended the [webhooks](../docs/Webhooks.md) functionality to support error tasks +- We introduced the `customFields` field for project webhooks, and the `dueBy` field for task webhooks +- We added the `name` of the `customFields` under the response for the Get Project endpoint +- We fixed various bugs. + +## 21 March 2023 +- We extended the list of [webhooks](../docs/Webhooks.md) available for tasks, projects, project files, project templates and enabled the first webhook for project group +- We fixed several bugs. + +## 03 March 2023 +- We introduced fields displaying the project status history and the `completedAt` date for a task. +- We exposed the project creator as a sorting option on list projects. +- We fixed several bugs +- We want to remind our users we will enforce validations listed in the documentation for the Create and Update Project endpoints. + +## 15 February 2023 +- We enabled support for the Trados Enterprise Quote Template functionality +- We introduced the `projectManagers` field to enable the selection of individuals or of users groups at [project creation](../api/Public-API.v1-fv.html#/operations/CreateProject). +- We removed unnecessary outcome values for the [Task Completed Request](../api/Public-API.v1-fv.html#/schemas/task-complete-request) model on the [Complete Task](../api/Public-API.v1-fv.html#/operations/CompleteTask) operation. This impacts the SDKs, so update your integration accordingly. +- You can now specify the `projectCreator` as an assignee type for a task when [updating a project](../api/Public-API.v1-fv.html#/operations/UpdateProject). +- We will enforce validations related to the following fields at project creation: `dueBy`, `location` and `languageDirections`. These fields will become **required** in 6 months. + + +## 11 January 2023 + +- You can now [create](../api/Public-API.v1-fv.html#/operations/CreateProjectGroup), [read](../api/Public-API.v1-fv.html#/operations/GetProjectGroup), [update](../api/Public-API.v1-fv.html#/operations/UpdateProjectGroup) and [delete](../api/Public-API.v1-fv.html#/operations/DeleteProjectGroup) Project Groups +- We've improved filtering for projects lists, namely by status and by creation date +- We've introduced fields displaying more details for error tasks +- We fixed various bugs + + +## 22 November 2022 +- To enable support for the Trados Enterprise multi-source resources functionality, we're introducing an important breaking change: when creating workflows with multi-source languages from the TE UI, please use the new `languageDirection` scope value. As the new feature may limit previously working functionality, inconsistencies within applications or certain products may appear. For integrations that are impacted, please contact their developers to update the integrations. +- We've made 3 new endpoints available for [TM export](../api/Public-API.v1-fv.html#/operations/ExportTranslationMemory) +- We removed the old 10 MB size limitations for files, termbases and translation memories. We now support [these values](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) for files and [these values](https://docs.rws.com/791595/741139/trados-enterprise---accelerate/importing-tm-content) for importing translation memory content. +- Users can now retrieve task comments. +- We've added the [TM Import history](../api/Public-API.v1-fv.html#/operations/GetTMImportHistory) endpoint. +- We are postponing the breaking change in the `LanguageDirectionRequest` model, previously announced for November, and consequently the model can be used until the end of 2022. +- 4 new endpoints are subject to [API limits](https://languagecloud.sdl.com/lc/api-docs/d2266fabaa1bf-api-rate-limits#project-files-rate-limits) +- We fixed various bugs. + +## 28 October 2022 +- You can [import translation memories](../docs/translation-memory/Translation-memory-import-export.md) using the [import](../api/Public-API.v1-fv.html#/operations/ImportTranslationMemory) and [poll](../api/Public-API.v1-fv.html#/operations/PollTMImport) endpoints. Note that the maximum size for an imported translation memory is 10 MB. +- We added traceability fields for terminology entries: createdAt, createdBy, lastModifiedAt, lastModifiedBy +- We added recommendations for [HTTP headers](../docs/Headers-considerations.md) +- We updated the recommendations for [Authentication](../docs/Authentication.md) and the [API rate limits](../docs/API-rate-limits.md) with token values and other details +- We fixed various bugs + +## 15 September 2022 +- We introduced a new [Export Quote Report](../docs/Export-quote-report.md) mechanism and deprecated the older endpoint +- We updated the constrains for the 'name' and 'description' fields for the [Create Project](../api/Public-API.v1-fv.html#/operations/CreateProject) and [Update Project](../api/Public-API.v1-fv.html#/operations/UpdateProject) endpoints that will be enforced starting December 2022 +- We introduced a new page for the currently [Known issues](../docs/Known-Issues.md) +- We fixed various bugs + + +## 22 August 2022 +- You can now read [language processing rules](../api/Public-API.v1-fv.html#/operations/ListLanguageProcessingRules) and [translation memory field templates](../api/Public-API.v1-fv.html#/operations/ListFieldTemplates) +- You can now [create](../api/Public-API.v1-fv.html#/operations/CreateTranslationMemory), [read](../api/Public-API.v1-fv.html#/operations/GetTranslationMemory), [update](../api/Public-API.v1-fv.html#/operations/UpdateTranslationMemory), [delete](../api/Public-API.v1-fv.html#/operations/DeleteTranslationMemory) and [copy](../api/Public-API.v1-fv.html#/operations/CopyTranslationMemory) translation memories + +## 12 August 2022 +- Retiring of the Export Quote endpoint will happen in 6 months. You can read more about it [here](../docs/Public-API-Management-Process.md#endpoint-retirement-process). +- We now support the Export Quote Report functionality with 3 new endpoints: [Poll Quote Export Report](../api/Public-API.v1-fv.html#/operations/PollQuoteReportExport), [Export Quote](../api/Public-API.v1-fv.html#/operations/ExportQuoteReport) and [Download Exported Quote](../api/Public-API.v1-fv.html#/operations/DownloadQuoteReport). +- You can now upload [source](../api/Public-API.v1-fv.html#/operations/AddSourceFileVersion) and [target](../api/Public-API.v1-fv.html#/operations/AddTargetFileVersion) file versions +- We published a new page about [File formats](../docs/File-formats.md) +- We fixed various bugs + +## 28 July 2022 +- We published a new page about [How to use location and folders](../docs/How-to-use-location-and-folders.md) +- We published a new page about [How to report an API issue](../docs/How-to-report-an-issue.md) +- We fixed various bugs + +## 19 July 2022 + +- You can now update [source](../api/Public-API.v1-fv.html#/operations/UpdateSourceFile) and [target](../api/Public-API.v1-fv.html#/operations/UpdateTargetFile) file names +- We fixed various bugs + +## 28 June 2022 + +- You can now [read](../api/Public-API.v1-fv.html#/operations/GetProjectConfiguration) and [update](../api/Public-API.v1-fv.html#/operations/UpdateProjectConfiguration) translation memory settings for a project's configuration +- We updated the user guide page for [using fields](../docs/Use-fields-in-your-requests.md) with new animated gifs +- We fixed various bugs + + +## 07 June 2022 +- We have increased the API limits, you can find the new limits on [this page](../docs/API-rate-limits.md). +- Deprecation of the language direction code will happen in 6 months. You can read more about it [here](../docs/Whats-deprecated.md). +- Enforce validations related to the length of the *name* and *description* fields and the accepted input values for the Create and Update Project endpoints will be delivered in 6 months. + +## 24 May 2022 +- To address potentially infected files, we've updated our API contracts to support In-Product Antivirus scanning + +## 04 May 2022 +- You can now upload a .zip archive using [this](../api/Public-API.v1-fv.html#/operations/UploadZipFile) endpoint and then [poll](../api/Public-API.v1-fv.html#/operations/PollUploadZipFile) for the extracted files. After extraction, you can upload multiple source files to a project using a [single call](../api/Public-API.v1-fv.html#/operations/AddSourceFiles). The maximum size for an imported .zip file is 10 MB. +- Our Java SDK client is now available in **public beta**. [Here](../docs/api-clients/java/Java-Client.md) are more details on how to start integrating it into your solution +- We published the API limits [here](../docs/API-rate-limits.md) +- We updated the Custom fields [page](../docs/Custom-Fields.md) with useful gifs +- We fixed various bugs + +**We update the .NET and Java client versions with each API release.** + +## 11 March 2022 +- You can now export a termbase and a termbase template in Trados Enterprise using the Trados Cloud Platform API +- We fixed various bugs + +## 22 February 2022 +- You can now convert an xdt file into a termbase structure using [this](../api/Public-API.v1-fv.html#/operations/ConvertTermbaseTemplate) dedicated endpoint +- When updating a termbase entry you will have to provide either the name or the identifier for the `termbaseFieldValues` +- We fixed various bugs + +## 2 February 2022 +- You can now import a termbase in Trados Enterprise using the Trados Cloud Platform API. The supported extensions are `xml` and `tbx`. The maximum size for an imported termbase is 10 MB. +- Our .NET SDK client is now available in **public beta**. [Here](../docs/api-clients/net/NET-Client.md) are more details on how to start integrating it into your solution. +- We updated the [basic project creation](../docs/Basic-project-creation-flow.md) page with useful gifs and added a small Postman collection to help you get started quickly +- We fixed various bugs + + +## 15 December 2021 +- You can now create, read, update and delete terminology termbases, termbase templates and termbase entries +- We fixed various bugs + +## 18 November 2021 +- You can now update the configurations of future tasks using the `projectPlan` field, in the [`update project`](../api/Public-API.v1-fv.html#/operations/UpdateProject) endpoint +- Fixed various bugs + +## 20 October 2021 +- Basic project creation flow added +- Fixed various bugs + +## 04 October 2021 +- Added multiple date formats +- Added pagination for [`List File Processing Configurations`](../api/Public-API.v1-fv.html#/operations/ListFileProcessingConfigurations) endpoint +- Fixed various bugs + +## 08 September 2021 +- Added support for downloading quote files +- Enum values updated to follow camelCase convention +- Updated documentation for projectTemplate in create project request +- Renamed customProperty to customFields in error responses +- Improved documentation for [Reclaim Task](../docs/Interact-with-tasks.md) +- Updated documentation for [Quotes](../docs/Export-quote-report.md) + +## 26 August 2021 +- Added support to restrict file downloads +- When creating/updating projects using a project template which has mandatory custom fields, you must supply those custom fields +- Fixed various bugs + +**We will remove deprecated fields from the [`ErrorResponse`](../api/Public-API.v1-fv.html#/schemas/error-response) model in an upcoming release. Please ensure you are not using fields marked as deprecated!** + +## 29 July 2021 +- Added endpoints for custom field definitions. +- Added support for custom fields on projects and project templates. +- The `translationEngine`, `fileProcessingConfiguration`, `workflow` fields are now required on the [`/projects`](../api/Public-API.v1-fv.html#/operations/CreateProject) endpoint. +- The `isSkipped` field is now marked as required on the [`/workflow/updateworkflow`](../api/Public-API.v1-fv.html#/operations/UpdateWorkflow) endpoint. +- Added new assignee type `projectCreator` when retrieving workflows. +- Improved contract documentation on TQA endpoints. +- Fixed various bugs. + +## 08 June 2021 +* For endpoints that return multiple items, the `top` query parameter has a default value of `100` and a maximum value of `100`; `skip` has a default value of `0`. +* The `Authorization` and `X-LC-Tenant` headers are now required for all endpoints. +* Improved the returned error structure. +* Fixed various issues with incorrect contract. +* Added new conditional cost fields (`costOrder`, `conditionalCostType`, `conditionalCostOperator`, `conditionalCostVariable`, `conditionalCostThreshold`) when working with project quotes. +* Added currency types for quote model. + +## 17 May 2021 +A Postman Collection is now available for integrators. Check out [this](../docs/Language-Cloud-APIs-for-Postman.md) page for details. + +## 10 February 2021 + +* **Target File** > **Download File Version** endpoint + +When you make a `GET` request to the [`/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/download`](../api/Public-API.v1-fv.html#/operations/DownloadFileVersion) endpoint, you can now perform a direct download of the native file as well as of the `BCM` file version. + +* **Target File** > **Export Target File Version** endpoint + +When you make a `POST` request to the [`/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/exports`](../api/Public-API.v1-fv.html#/operations/ExportTargetFileVersion) endpoint, you now have a query parameter where you can specify whether the file version export should be a native file or an `sdlxliff` file. The default value is `native`. + +## 28 January 2021 + +* **Project** > **List Project’s Tasks** endpoint + +When you make a `GET` request to the [`/projects/{projectId}/tasks`](../api/Public-API.v1-fv.html#/operations/ListProjectTasks) endpoint, you can now retrieve the available project tasks and their details. + + +* **Retrieving tasks** + +Retrieving tasks provides the following new additional details: + +- the Vendor Order Quote information +- the translation status for each task: the type of matches, the number of segments, the number of words/characters. + +* **Specifying target languages for source files** + +When adding source files to a project, you can specify their target languages via the `targetLanguages` and `path` elements. + + + + +â‚Ť^. .^₎⟆ + diff --git a/articles/LCPublicAPI/docs/Whats-deprecated.md b/articles/LCPublicAPI/docs/Whats-deprecated.md new file mode 100644 index 0000000..22584fe --- /dev/null +++ b/articles/LCPublicAPI/docs/Whats-deprecated.md @@ -0,0 +1,33 @@ +# What's Deprecated + + +## 1 July 2024 +We have removed the old fields in the folder/resource structure and are no longer available. Use the [path](../api/Public-API.v1-fv.html#/schemas/folder-v2) field going forward. + +## 13 December 2023 +- The `Export Quote` endpoint has been removed. +- In the Get Project Template model we deprecated: + - `forceOnline` field from root level and we added `forceOnline` to the settings → general + - `quoteTemplate` field from root level and we added `quoteTemplate` to the settings → general + They will only be available for use until July 2024. + +## 17 August 2023 + +We updated the folder/resource locations to the new format, which now includes the [path](../api/Public-API.v1-fv.html#/schemas/folder-v2). The old fields are marked as deprecated and their decommissioning is scheduled at a minimum of six months from now. + +## 12 August 2022 +In the `Quote` code, we deprecated the `Export Quote` endpoint. It will only be available for use until December 2022. + + +## 7 June 2022 + +In the `LanguageDirectionRequest` model we deprecated: +- the `sourceLanguageCode` field and introduced `sourceLanguage` as an object containing the `languageCode` field; +- the `targetLanguageCode` field and introduced `targetLanguage` as an object containing the `languageCode` field. + +They will no longer be available to use starting with November 2022. + +## 8 September 2021 + +We removed deprecated fields from the ErrorResponse model. + diff --git a/articles/LCPublicAPI/docs/api-clients/java/Java-Client-Upgrade-Guide.md b/articles/LCPublicAPI/docs/api-clients/java/Java-Client-Upgrade-Guide.md new file mode 100644 index 0000000..e0c2359 --- /dev/null +++ b/articles/LCPublicAPI/docs/api-clients/java/Java-Client-Upgrade-Guide.md @@ -0,0 +1,169 @@ +--- +stoplight-id: b309fcde3938d +--- + + +# Trados Cloud Platform SDK - Migration Guide v25.x.x + +## Executive Summary + +The Trados Cloud Platform API SDK has transitioned from a "fat JAR" to a "light JAR" architecture, delivering faster downloads, improved dependency management, and better build performance. For most users, migration requires only a version update in your build configuration. + + +**What Changed:** +1. **Modernized Dependencies:** JUnit 4 → 5, Apache HttpClient 4 → 5, Commons Lang 2→3 +2. **OpenAPI Generator:** Version 6.5.0 → 7.14.0 with enhanced nullability annotations +3. **Enhanced Features:** New `LCContext.executeInScope()` methods for improved tenant/trace context management +4. **Updated Tooling:** Latest versions of Jackson, Feign, and other core libraries + +## Step-by-Step Migration Guide + +### For Standard API Usage (Most Users): + +If you're using the generated SDK classes like `ProjectApi`, `SourceFileApi`, etc., migration is straightforward: + +1. Update SDK version to 25.x.x in your build configuration. +2. Run your build command to verify everything works. +3. Review and update your code for compatibility with the new OpenAPI Generator output (see the section [OpenAPI Generator & Generated Code Changes](#openapi-generator--generated-code-changes) below for details). +4. Your API calls should work as before, but review and resolve any compilation issues related to the above changes. + +```java +// Your existing code continues to work +ProjectApi projectApi = languageCloudClientProvider.getProjectClient(); +Project project = projectApi.createProject(projectCreateRequest, queryParams); +``` +## Troubleshooting + +**Most Common Issue**: Build fails after version update +**Solution**: Run `mvn dependency:tree` to check for dependency conflicts + +**Issue**: `ClassNotFoundException: feign.Client` +**Solution**: Verify Feign dependencies: `mvn dependency:tree | grep feign` + +**Issue**: `NoClassDefFoundError` for HTTP client classes +**Solution**: Update imports from `org.apache.http` to `org.apache.hc.core5.http` + +**Issue**: Commons Lang methods not found +**Solution**: Update imports from `org.apache.commons.lang` to `org.apache.commons.lang3` + +## Success Validation + +**For Standard Users:** +1. Clean build: `mvn clean install` succeeds +2. API functionality works as before +3. Faster builds and smaller downloads + +**For Advanced Users:** +- Run `mvn dependency:tree` - no conflicts shown +- Test application startup and core functionality + +### Advanced Scenarios + +
+
+
+## Validation & Success Criteria
+
+**For Standard Users:**
+1. **Clean Build**: Your project builds successfully
+2. **API Functionality**: SDK operations work as before - no code changes needed
+3. **Performance**: Faster builds and smaller downloads
+
+**Advanced Validation:**
+- **Dependency Check**: `mvn dependency:tree` shows no conflicts
+- **Custom Configurations**: Test application startup and functionality
+
+## Reference: Key Dependencies
+
+### High-Impact Dependencies (Most Likely to Affect You)
+
+| Library | Previous | New | Notes |
+|---------------------|----------|--------|------------------------------|
+| Feign (HTTP Client) | 10.11 | 13.6 | Core SDK communication |
+| Jackson (JSON) | 2.10.3 | 2.19.1 | API serialization |
+| Apache HttpClient | 4.5.8 | 5.5 | HTTP transport |
+| JUnit (Tests) | 4.13 | 5.13.2 | Test framework modernization |
+
+Click here if you use direct dependency imports or custom configurations
+ +#### Direct Dependency Usage: +- Update HttpClient imports: `org.apache.http` → `org.apache.hc.core5.http` +- Update Commons Lang imports: `org.apache.commons.lang` → `org.apache.commons.lang3` +- Use dependency exclusions if you encounter version conflicts + +#### Custom Classpath Management: +1. Review current JAR collection and identify SDK dependencies +2. Ensure all transitive dependencies are included in classpath +3. Test application startup and core functionality +4. Consider migrating to Maven/Gradle for simplified dependency management + +#### Test Framework Updates: +- **JUnit Migration**: JUnit 4 → JUnit 5 (Jupiter) + - Update test annotations: `@Test` imports change from `org.junit.Test` → `org.junit.jupiter.api.Test` + - Replace `@Before/@After` with `@BeforeEach/@AfterEach` + - Update assertion imports: `org.junit.Assert` → `org.junit.jupiter.api.Assertions` +- **Mockito Updates**: Version 3.x → 5.x + - Update imports if using `mockito-junit-jupiter` directly + - Verify mock behavior with newer Mockito features + +#### OpenAPI Generator & Generated Code Changes: +- **OpenAPI Generator**: Version 6.5.0 → 7.14.0 (major version upgrade) +- **Generated Code Improvements**: Enhanced code generation with: + - **New Nullability Annotations**: `@javax.annotation.Nullable` and `@javax.annotation.Nonnull` annotations for better null safety + - **Bean Validation Support**: Enhanced validation annotations for API parameters + - **Improved Code Quality**: Updated Mustache templates producing cleaner, more maintainable generated code + - **Better Method Naming**: Collection helper methods use improved naming conventions for better readability + - **Enhanced Enum Handling**: Improved enum comparison and naming with configurable case sensitivity support + - **Modernized Templates**: Generated classes follow current Java best practices + +#### Benefits: +- Generated classes are easier to use and understand +- Better IDE support with improved nullability annotations +- More consistent naming conventions across generated code +- Enhanced type safety and validation + +
+
+
+*Different groupId or artifactId in previous version
+
+### Test Dependencies
+
+| GroupId | ArtifactId | Previous Version | New Version | Impact |
+|-------------------|-----------------------|------------------|-------------|----------|
+| org.junit.jupiter | junit-jupiter-engine | 4.13* | 5.13.2 | **High** |
+| org.mockito | mockito-junit-jupiter | 3.12.1* | 5.18.0 | **High** |
+
+*Different groupId or artifactId in previous version
+
+### Most Important Changes
+
+**Critical**: Maven Shade Plugin removed (enables fat→light JAR transition)
+**Modernization**: All dependencies updated to current versions
+**Code Quality**: OpenAPI Generator 6.5.0 → 7.14.0 with better nullability support
+
+
diff --git a/articles/LCPublicAPI/docs/api-clients/java/Java-Client.md b/articles/LCPublicAPI/docs/api-clients/java/Java-Client.md
new file mode 100644
index 0000000..3d6d9f2
--- /dev/null
+++ b/articles/LCPublicAPI/docs/api-clients/java/Java-Client.md
@@ -0,0 +1,91 @@
+# Java Client
+
+This client library targets Java 11 and above. It provides API clients organized by API documentation sections.
+
+The generated Java clients are based on [OpenFeign](https://spring.io/projects/spring-cloud-openfeign).
+
+
+> The Java Client library is auto-generated from the current API contracts, so any updates to the contract will reflect as changes in the SDK client. Minor version increases do not guarantee backwards compatibility.
+
+## Installation
+You can add this library to your project as a [Maven](https://search.maven.org/artifact/com.rws.lt.lc.public-api/lc-public-api-sdk/24.0.9/jar) dependency.
+
+Include the client library in the `pom.xml`:
+
+```java
+View Complete Dependency List
+ +**All Updated Dependencies:** + +| GroupId | ArtifactId | Previous Version | New Version | Impact | +|-----------------------------------|---------------------------|------------------|-------------|------------| +| io.github.openfeign | feign-core | 10.11 | 13.6 | **High** | +| io.github.openfeign | feign-jackson | 10.11 | 13.6 | **High** | +| io.github.openfeign | feign-slf4j | 10.11 | 13.6 | **High** | +| io.github.openfeign | feign-form | 3.8.0 | 13.6 | **High** | +| io.github.openfeign | feign-okhttp | 10.11 | 13.6 | **High** | +| com.fasterxml.jackson.core | jackson-core | 2.10.3 | 2.19.1 | **Medium** | +| com.fasterxml.jackson.core | jackson-annotations | 2.10.3 | 2.19.1 | **Medium** | +| com.fasterxml.jackson.core | jackson-databind | 2.10.3 | 2.19.1 | **Medium** | +| org.apache.httpcomponents.client5 | httpclient5 | 4.5.8* | 5.5 | **Medium** | +| com.fasterxml.jackson.datatype | jackson-datatype-jsr310 | 2.10.3 | 2.19.1 | Low | +| com.fasterxml.jackson.datatype | jackson-datatype-joda | 2.0.4 | 2.19.1 | Low | +| org.openapitools | jackson-databind-nullable | 0.2.1 | 0.2.6 | Low | +| org.apache.commons | commons-lang3 | 2.6* | 3.18.0 | Low | +| com.github.spotbugs | spotbugs-annotations | 3.0.2* | 4.9.3 | Low | +| javax.annotation | javax.annotation-api | 1.0* | 1.3.2 | Low | +| org.projectlombok | lombok | RELEASE | 1.18.38 | Low | +| org.slf4j | slf4j-simple | - | 2.0.13 | Low | + ++ +## Web API Sample +The web API sample is available for download on [GitHub](https://github.com/RWS/language-cloud-public-api-samples/tree/main/Java/PublicApi.Sample.Web.Java). + +The sample contains two examples of how to instantiate and work with an API client provided by the Trados Cloud Platform SDK for Java: + +- *If you want to use the provided authentication mechanism, create a custom handler that inherits from `CustomServiceAuthenticationHandler`.* + +In our example, we created the `CustomAuthenticationHandler` class, which inherits from `CustomServiceAuthenticationHandler`. The `CustomServiceAuthenticationHandler` class already provides an authentication mechanism. + +We have overridden the `getServiceCredentials`, `getTraceId`, and `getTenantId` methods and provided our implementations, as these will be called by `CustomAuthenticationHandler`: + +```java +// Provide your implementation. A possible example can be: +@Override +public ServiceCredentials getServiceCredentials() { + return repository.getServiceCredentialsById(getCurrentUser().getUserId()); +} + +// serviceCredentials may or may not be bound to a tenant +@Override +public String getTenantId() { + return repository.getServiceCredentialsById(getCurrentUser().getUserId()).getTenantId(); + // or + // return repository.getTenantForUserId(getCurrentUser().getUserId()); +} + +@Override +public String getTraceId() { + return UUID.randomUUID().toString(); +} + +private User getCurrentUser() { + Authentication authentication = SecurityContextHolder.getContext().getAuthentication(); + return (User) authentication.getPrincipal(); +} +``` + +We registered an instance of `LanguageCloudClientProvider` as a bean in the `ConfigClass` class and created beans for all exposed API clients: +```java +// the LanguageCloudClientProvider instance +@Bean +public LanguageCloudClientProvider getPublicApiClient(CustomAuthenticationHandler customAuthenticationHandler) { + return LanguageCloudClientProvider.builder() + .withRegion("eu") // optional (default is "eu") + .withRequestInterceptors(List.of(customAuthenticationHandler)).build(); +} + +//the AccountApi bean +@Bean +public AccountApi getAccountApi(LanguageCloudClientProvider languageCloudClientProvider) { + return languageCloudClientProvider.getAccountClient(); +} +``` + +We can then use the registered client in the controller (or any other class resolved through Dependency Injection): + +```java +@RestController +public class AccountController extends ResponseEntityExceptionHandler { + + @Autowired + private AccountApi accountApi; + + @GetMapping("/getAccounts/{userId}") + public List
+ +| Event | Data payload object model | Trigger operations in Trados Cloud Platform API | Trigger operations in Trados UI | +|---|---|---|---| +| `PROJECT.TASK.ACCEPTED` | [`task-event`](../../api/Webhooks.v1-fv.html#/schemas/task-event) | Accept task
Accept error task | Accept task
Accept error task | +| `PROJECT.TASK.CREATED` | [`task-event`](../../api/Webhooks.v1-fv.html#/schemas/task-event) | Generate task | Generate task | +| `PROJECT.TASK.COMPLETED` | [`task-event`](../../api/Webhooks.v1-fv.html#/schemas/task-event) | Complete task | Complete task | +| `PROJECT.TASK.UPDATED` | [`task-event`](../../api/Webhooks.v1-fv.html#/schemas/task-event) | Generate task
Accept task
Reject task
Release task
Assign task
Reassign task
Complete task | Generate task
Accept task
Reject task
Release task
Assign task
Reassign task
Complete task | +| `PROJECT.TASK.DELETED` | [`task-event`](../../api/Webhooks.v1-fv.html#/schemas/task-event) | Delete project and its tasks | Delete project and its tasks | +| `PROJECT.CREATED` | [`project-event`](../../api/Webhooks.v1-fv.html#/schemas/project-event) | Create project | Create project | +| `PROJECT.STARTED` | [`project-event`](../../api/Webhooks.v1-fv.html#/schemas/project-event) | Start project | Start project | +| `PROJECT.UPDATED` | [`project-event`](../../api/Webhooks.v1-fv.html#/schemas/project-event) | Start project (This event will also be emitted in addition to `PROJECT.STARTED`)
Update project by changing any field
Complete project
Cancel source file
Complete target file | Start project (This event will also be emitted in addition to `PROJECT.STARTED`)
Update project by changing the `Project Information`, `Configuration` or `Custom Fields` fields in the `Settings` tab
Complete project
Set project back in progress
Cancel project
Complete target file | +| `PROJECT.DELETED` | [`project-event`](../../api/Webhooks.v1-fv.html#/schemas/project-event) | Delete project | Delete project | +| `PROJECT.TEMPLATE.CREATED` | [`project-template-event`](../api/Webhooks.v1-fv.html#/schemas/project-template-event) | | Create project template | +| `PROJECT.TEMPLATE.UPDATED` | [`project-template-event`](../../api/Webhooks.v1-fv.html#/schemas/project-template-event) | | Create project template
Update project template | +| `PROJECT.TEMPLATE.DELETED` | [`project-template-event`](../../api/Webhooks.v1-fv.html#/schemas/project-template-event) | | Delete project template | +| `PROJECT.SOURCE.FILE.CREATED` | [`source-file-event`](../api/Webhooks.v1-fv.html#/schemas/source-file-event) | Add source file to project
Attach source files to project | Add reference file to project
Add translatable file to project | +| `PROJECT.SOURCE.FILE.UPDATED` | [`source-file-event`](../../api/Webhooks.v1-fv.html#/schemas/source-file-event) | Update source file by changing the `name` field
Add source file version
The project reaches the `File Type Detection` task
The project reaches the `File Format Conversion` task | Update source file by changing the `fileType` or `fileRole` fields
Add source file version via `Replace file` action
Delete source file version
Cancel source file
The project reaches the `File Type Detection` task
The project reaches the `File Format Conversion` task | +| `PROJECT.SOURCE.FILE.DELETED` | [`source-file-event`](../../api/Webhooks.v1-fv.html#/schemas/source-file-event) |Delete project and its tasks | Delete project and its tasks | +| `PROJECT.TARGET.FILE.CREATED` | [`target-file-event`](../../api/Webhooks.v1-fv.html#/schemas/target-file-event) | The project reaches the `File Format Conversion` task | The project reaches the `File Format Conversion` task | +| `PROJECT.TARGET.FILE.UPDATED` | [`target-file-event`](../../api/Webhooks.v1-fv.html#/schemas/target-file-event) | Update source file by changing the `name` field
Add target file version
Import target file version
The project reaches the `File Format Conversion` task
The project reaches the `Copy Source to Target` task
The project reaches the `Machine Translation` task
The project reaches the `Bilingual Engineering` task
The project reaches the `Translation` task
The project reaches the `Linguistic Review` task
The project reaches the `Customer Review` task
The project reaches the `Implement Customer Review` task
The project reaches the `Target File Generation` task | Add target file version via `Upload SDLXLIFF` action
Replace target file
Delete target file version
Cancel target file
The project reaches the `File Format Conversion` task
The project reaches the `Copy Source to Target` task
The project reaches the `Machine Translation` task
The project reaches the `Bilingual Engineering` task
The project reaches the `Translation` task
The project reaches the `Linguistic Review` task
The project reaches the `Customer Review` task
The project reaches the `Implement Customer Review` task
The project reaches the `Target File Generation` task | +| `PROJECT.TARGET.FILE.DELETED` | [`target-file-event`](../../api/Webhooks.v1-fv.html#/schemas/target-file-event) | Delete project and its tasks | Delete project and its tasks | +| `PROJECT.GROUP.PROJECT.MEMBERSHIP.CHANGE` | [`project-group-event`](../../api/Webhooks.v1-fv.html#/schemas/project-group-event) | Add project to project group
Remove project from project group | Add project to project group
Remove project from project group | +| `PROJECT.ERROR.TASK.CREATED` | [`error-task-event`](../../api/Webhooks.v1-fv.html#/schemas/error-task-event) | Generate error task | Generate error task | +| `PROJECT.ERROR.TASK.COMPLETED` | [`error-task-event`](../../api/Webhooks.v1-fv.html#/schemas/error-task-event) | Complete error task | Complete error task | +| `PROJECT.ERROR.TASK.ACCEPTED` | [`error-task-event`](../../api/Webhooks.v1-fv.html#/schemas/error-task-event) | Accept error task | Accept error task | + + diff --git a/articles/LCPublicAPI/docs/webhooks/Webhooks-setup.md b/articles/LCPublicAPI/docs/webhooks/Webhooks-setup.md new file mode 100644 index 0000000..e38f01e --- /dev/null +++ b/articles/LCPublicAPI/docs/webhooks/Webhooks-setup.md @@ -0,0 +1,200 @@ +--- +stoplight-id: eg4ja9nrs9wtk +--- + +# Webhooks Setup + +A webhook is a web callback by which Trados Cloud Platform notifies an external application when a specific event occurs in a specific account in Trados Cloud Platform. You can subscribe to events by registering webhooks from within the Trados UI. + +> When integrating with our webhook service, please be aware that we cannot guarantee the order of webhook event deliveries. This means that notifications may arrive out of sequence, and consumers should not rely on receiving messages in a specific order. Instead, make use of the `timestamp` field to determine the event generation time. + +## Subscribe to Webhook events + +You subscribe to Webhook events from the Trados UI by creating a Trados Cloud Platform custom application. + +Several prerequisites must be met so that you can configure the right webhooks for the right customer, namely: + +1. Create a Service User in the correct customer folder. +2. Create an application based on the Service User created above. This means that the application is saved in the same customer folder as the Service User. +3. Use the application to configure the webhooks for your customer. + +Here are the detailed steps: + +1. Log in to the Trados UI as a human Administrator user. +2. Expand the account menu on the top right-hand corner and select **Integrations**. +3. Select the **Applications** sub-tab. +4. Select **New Application** and enter the following information: + - **Name** – Enter a unique name for your custom application. + - (Optional) **URL** – Enter your custom application URL. + - **Service User** – Select a service user from the dropdown list. To understand how service users are added in Trados Cloud Platform, check step 1 in the [Authenticate](../../docs/Service-credentials.md) topic. +5. Select **Add**. +6. Back in the **Applications** sub-tab, select the check box corresponding to your application. +7. Select **Edit**. +8. On the **Overall Information** page change any of the following, if necessary: name, URL, description. +9. On the **API Access** page you can find your **Client ID** and **Client Secret**. +10. On the **Webhooks** page: + - Enter a default callback URL for your application Webhooks (all Webhooks defined in Trados Cloud Platform). + - Enter a value for **Webhook URL** (this is your Webhook endpoint URL which you expose and which Trados Cloud Platform calls), select one or more event types, and hit Enter. You can create a separate webhook for every event you are interested in or combine notifications for multiple event types to one webhook. If you delete your application, all its associated webhooks are also deleted. +11. Select **Save**. + +A webhook is triggered for all the projects located in the same folder as the selected service user. + +> Similar to other resource types, webhooks are governed by inheritance, the propagation rule giving users visibility and work access with resources in the [account hierarchy](https://docs.rws.com/791595/797020/trados-enterprise---accelerate/inheritance-within-the-account).
+> Please be aware that the webhooks will be delivered only for the users having the READ permission on the resource triggering the webhook. + +For example, given there is a folder structure: + +- Root + - Customer1 + - Customer2 + - Customer3 + +Let's say that: +- the `Group1` has the location `Customer1` +- the `Group2` has the location `Customer2` +- the `Group3` has the location `Customer3` + +Let's presume that: +- the service user `S1`, with the webhook `WB1`, is in the group `Group1` +- the service user `S2`, with the webhook `WB2`, is in the group `Group2` +- the service user `S3`, with the webhook `WB3`, is in the group `Group3` + +The followings are true: +1. if you create a project in `Customer1`: + - the webhook event is sent to `WB1`; + +2. if you create a project in `Customer2`: + - the webhook event is sent to `WB1` url and `WB2` url; + +3. if you create a project in `Customer3`: + - the webhook event is sent to `WB1` url and `WB3` url. + + + +Remember that each time events occur, Trados Cloud Platform will call your server on a `POST` request, on the URL you configured in the Trados Cloud Platform application, and the request body will emulate the [Webhook](../../api/Webhooks.v1-fv.html#/schemas/webhook) object format. + +## Validate the Webhook notifications + +In terms of security, you must ensure that Trados Cloud Platform is the system which sent the event. For this, webhook requests must be verified in terms of authenticity, integrity, and confidentiality. + +### Webhook authenticity + +The webhook `POST` request sent by Trados Cloud Platform will include a digital signature which concatenates the following information: `transmissionTime|applicationId|webhookId|crc32 `. For more information on request headers, check the *Reference* section at the end. The [crc32](https://en.wikipedia.org/wiki/Cyclic_redundancy_check) component is a checksum for the HTTP request body. + +The signature is decrypted using your Public Key. You can get the Public Key as follows: + +1. Log in to the Trados UI as a human Administrator user. +2. Expand the account menu on the top right-hand corner and select **Integrations**. +3. Select the **Applications** sub-tab. +4. Open your application and go to the **Webhooks** tab. Copy the value from the **Secret Key** field. This is the Public Key which validates and decrypts the signature sent by the header. + +The validation process mimics the generation sequence, where the recipient system use its Public Key to verify the received signature using the same concatenation: `transmissionTime|applicationId|webhookId|crc32 `. + +**Here is a Java sample:** + +``` +//retrieve transmissionTime, applicationId, webhookId, signatureAlg & signature from request headers* + +// event = request message body +//generate crc32 from the request body + +CRC32 checkSum = new CRC32(); +checksum.update(event.getBytes(UTF_8)); +long crc32Val = checksum.getValue(); + +//build the message +String message = transmissionTime + “|” + applicationId + “|” + webhookId + “|” + crc32Val; + +//build PublicKey +byte[] bytes = org.springframework.security.crypto.codec.Base64.decode(publicKeyAsString.getBytes()); +X509EncodeKeySpec ks = new X509EncodeKeySpec(bytes); +KeyFactory kf = KeyFactory.getInstance(“RSA”); +PublicKey publicKey = kf.generatePublic(ks); + +//verify signature + +Signature publicSignature = Signature.getInstance(signatureAlg); +publicSignature.initVerify(publicKey); +publicSignature.update(message.getBytes(UTF_8)); +byte[] signatureBytes = Base64.getDecoder().decode(signature); + +publicSignature.verify(signatureBytes); +``` + +A valid message implies that the message was sent by Trados Cloud Platform. + +### Webhook integrity + +The fact that the signature is created based on payload content ensures that the message is not altered ([CRC32](https://en.wikipedia.org/wiki/Cyclic_redundancy_check)). + +### Webhook confidentiality + +To ensure that the message cannot be read by 3rd-parties, Trados Cloud Platform Webhooks only accept the HTTPS communication protocol specified in the webhook URLs you provide. + +## Return notification responses + +### Success notifications + +A notification delivery is considered successful when applications respond with a 2xx status code within 3 seconds. + +> It is recommended that applications perform little processing when receiving events and, for instance, that they make use of a queuing mechanism to perform further processing asynchronously after having acknowledged the event notification request. + +Trados Cloud Platform does not inspect the HTTP response body. + +### Failure notifications + +Notifications will fail in the following scenarios: +- Response time: the response status code is `2xx`, but the response is received after 3 seconds +- Response status code: + - `3xx`: Trados Cloud Platform does not follow redirects + - `4xx` + - `5xx` + +### Retry policies + +Trados Cloud Platform will try its best to redeliver the notification. Retries will include specific headers with information about the retry: +- `X-LC-Retry-Num`: header indicating the retry number (1, 2 or 3) +- `X-LC-Retry-Reason`: header indicating why the retry is sent + +Trados Cloud Platform will try to delivery the notification up to 8 times using an exponential back-off strategy (namely, it will delay the next delivery attempt exponentially with the number of retries already made). + +Retry No.| Interval (relative to last retry)/ Minutes| Interval (relative to original attempt)/ Minutes| +---- |---- |---- | +1 |5 |5 | +2 |10 |15 | +3 |30 |45 | +4 |120 (2h) |165 | +5 |360 (6h) |525 | +6 |600 (10h) |1125 | +7 |960 (16h) |2085 | +8 |1440 (24h) |3525 | + +### Circuit Breaker + +To protect the platform and ensure problems from one tenant do not affect other tenants, we have a circuit breaker that will stop sending webhook on URLs that do not respond within the allowed time (mentioned in **Failure** notifications section). The actual HTTP response code is not relevant since the connection is closed before the response is received. + +The circuit breaker is triggered when 3 calls to a URL fail within a short time window. The circuit breaker is opened for an hour only for that URL, not for the tenant. During that hour, any webhooks sent to that URL are scheduled for the next retry. + +> Frequent timeouts may compromise the performance of our delivery system.
+> We may need to remove your webhook from our database without advance notice if it is negatively impacting the platform.
+> This action is reserved for cases of major incidents and is necessary to prevent potential issues that can arise from repeated delivery attempts. +## Reference + +**The request headers** are: + +* `X-LC-Signature`: Contains the message digital signature (see section on *Webhook authenticity* above). + +* `X-LC-Signature-Algo`: Contains the algorithm used for signing the message. Possible values: "*SHA256withRSA*". + +* `X-LC-Retry-Num`: Contains the retry attempt counter. Initial value is 0, which will be increased with each attempt at redelivering the webhook message. + +* `X-LC-Retry-Reason`: Contains a textual description of the previous error, which resulted in the current attempt to redeliver the webhook message. + +* `X-LC-Transmission-Time`: Contains the date/time when the webhook message was delivered, in ISO 8601 date time format. + +* `X-LC-Application`: Unique identifier of the Trados Cloud Platform application, which is the recipient of the webhook message. Every webhook has an application associated in Trados Cloud Platform, which can be found in the Trados UI, in the account dropdown menu from the top right corner, under the **Applications** tab, in **Integrations**. The configured webhooks for an application are listed on the **Webhooks** tab of the respective application. + +* `X-LC-Webhook`: Unique identifier of the webhook defined for the LC application which is the recipient of the webhook message. It can be ignored because it is not exposed in the Trados UI. + +* `X-LC-Region`: Region of the account of the user, which is the recipient of the webhook message. + diff --git a/articles/LCPublicAPI/toc.yml b/articles/LCPublicAPI/toc.yml new file mode 100644 index 0000000..606b1f4 --- /dev/null +++ b/articles/LCPublicAPI/toc.yml @@ -0,0 +1,119 @@ +- name: Introduction + href: docs/Introduction.md + +- name: Public API Management Process + href: docs/Public-API-Management-Process.md + +- name: What's new + href: docs/Whats-New.md + +- name: What's deprecated + href: docs/Whats-deprecated.md + +- name: How to report an issue + href: docs/How-to-report-an-issue.md + +- name: Known issues + href: docs/Known-Issues.md + +- name: Getting started + items: + - name: Multi-region + href: docs/Multi-region.md + - name: API rate limits + href: docs/API-rate-limits.md + - name: Use fields in your requests + href: docs/Use-fields-in-your-requests.md + - name: Use paging and sorting for lists + href: docs/Use-paging-and-sorting-for-lists.md + - name: Updating data with PUT + href: docs/Updating-data-with-PUT.md + - name: Language codes + href: docs/Language-codes.md + - name: How to use location and folders + href: docs/How-to-use-location-and-folders.md + - name: File formats + href: docs/File-formats.md + - name: Headers considerations + href: docs/Headers-considerations.md + - name: Multipart considerations + href: docs/How-to-multipart.md + +- name: Authentication + items: + - name: Service users and custom applications + href: docs/Service-users-and-custom-applications.md + - name: Service credentials + href: docs/Service-credentials.md + - name: Authentication + href: docs/Authentication.md + +- name: Projects + items: + - name: Basic project creation flow + href: docs/Basic-project-creation-flow.md + - name: Create projects + href: docs/Create-projects.md + - name: Track projects + href: docs/Track-projects.md + - name: Interact with tasks + href: docs/Interact-with-tasks.md + +- name: Termbases + items: + - name: Termbases + href: docs/termbase/Termbase.md + - name: Termbase templates + href: docs/termbase/Termbase-templates.md + - name: Termbase entries + href: docs/termbase/Termbase-entries.md + - name: Termbase import and export + href: docs/termbase/Termbase-import-export.md + +- name: Translation Memories + items: + - name: Translation Memory import and export + href: docs/translation-memory/Translation-memory-import-export.md + +- name: Translations + items: + - name: Translation Memory import and export + href: docs/translations/Translations.md + +- name: Custom fields + href: docs/Custom-Fields.md + +- name: Export quote report + href: docs/Export-quote-report.md + +- name: Webhooks + items: + - name: Webhooks Setup + href: docs/webhooks/Webhooks-setup.md + - name: Webhooks Payload + href: docs/webhooks/Webhooks-payload.md + - name: Batched Webhooks + href: docs/webhooks/Batched-webhooks.md + +- name: Trados Cloud Platform APIs for Postman + href: docs/Language-Cloud-APIs-for-Postman.md + +- name: API Clients + items: + - name: .NET Client + href: docs/api-clients/net/NET-Client.md + - name: .NET Samples + href: docs/api-clients/net/Net-Samples.md + - name: Java Client + href: docs/api-clients/java/Java-Client.md + - name: Java Samples + href: docs/api-clients/java/Java-Samples.md + +- name: APIs + items: + - name: Public API + href: api/Public-API.v1.md + - name: Global Public API + href: api/Global-Public-API.v1.md + - name: Webhooks + href: api/Webhooks.v1.md \ No newline at end of file diff --git a/index.md b/index.md index f976e32..60d6816 100644 --- a/index.md +++ b/index.md @@ -7,17 +7,19 @@ Var:ProductName is the platform on which RWS host a number of products. You're i - Trados Studio (cloud capabilities) - Trados Go -## Integrating with Var:ProductName products -To create an integration with any of the products listed above, you'll need to use the Public API. You can find the documentation for the API [here](https://languagecloud.sdl.com/lc/api-docs). Note that the API is updated regularly so make sure that you check out the [What's new](https://languagecloud.sdl.com/lc/api-docs/whats-new) section to find out information on recently added features. To enable RWS to extend and improve the API, and to support the latest features in the products, sometimes it's necessary to remove or change functionality. For that, you'll need to check the [What's deprecated](https://languagecloud.sdl.com/lc/api-docs/whats-deprecated) page where RWS will post advance notice of any API endpoints that will be removed or change in the future. Don't worry though because RWS will try and give six months notice of any breaking changes. +## Integrating with