Unique identifier of custom task types set in the workflow. If no custom id is set, it will return the default identifier for the custom task type.
- `description` string
- `automatic` boolean, nullable — This indicates whether the task is automatic or human.
- `scope` 'file' | 'targetLanguage' | 'batch' | 'vendorOrder' | 'task', nullable — The resource type scope for the task.
- `outcomes` TaskTypeOutcome[]
- …
- `configurationDefinitions` TaskTypeConfigurationDefinition[] — Defines the configurable options available for this task type. Each entry describes one configuration option including its data type, default value, allowed values and constraints.
- …
- `location` FolderV2 — Folder used for resource storage.
- …
- `phase` WorkflowPhase — A set of workflow steps which work together towards a localization outcome.
- `id` string, required — The phase identfier.
- `name` string —
The phase name.
- `phases` WorkflowPhase[]
- `id` string, required — The phase identfier.
- `name` string —
The phase name.
- `transitions` WorkflowTemplateTransition[]
- `from` WorkflowTemplateTransitionNode
- `type` 'taskTemplate' | 'start' | 'end' —
- `taskTemplate` WorkflowTaskTemplate
- …
- `to` WorkflowTemplateTransitionNode
- `type` 'taskTemplate' | 'start' | 'end' —
- `taskTemplate` WorkflowTaskTemplate
- …
- `condition` WorkflowTemplateTransitionCondition
- `type` 'outcome' | 'expression', nullable —
- `configurationValues` WorkflowTaskTypeConfigValue[] — The task type configuration values set on this task. Each item corresponds to a configuration key defined in `taskTemplates.taskType.configurationDefinitions`.
- `id` string, required — The configuration key identifier (e.g. `FORCE_CLOSE_MAX_AGE`, `EDITOR_MODE`, `CONCURRENT_EDITING_ENABLED`).
- `value` object, required — The configuration value.
- `taskConfigurations` WorkflowTaskConfiguration[]
- `scope` TaskConfigurationScope, required
- `type` 'global' | 'sourceLanguage' | 'targetLanguage' | 'languageDirection', required — The applicability impact of the workflow configuration: - global: used for global tasks which are not associated to a target language - sourceLanguage: changes affect only the task associated to the source language specified in **sourceLanguage** field - targetLanguage: changes affect only the task associated to the target language specified in **targetLanguage** field - languageDirection: changes affect only the task associated to the language direction specified in **languageDirection** field
- `sourceLanguage` Language — The language object.
- `languageCode` string, required — Language code. ex: "en-US", "de-DE".
- `englishName` string —
Human readable name.
- `direction` string
- `parentLanguageCode` string
- `defaultSpecificLanguageCode` string
- `isNeutral` boolean, nullable
- `targetLanguage` Language — The language object.
- `languageCode` string, required — Language code. ex: "en-US", "de-DE".
- `englishName` string —
Human readable name.
- `direction` string
- `parentLanguageCode` string
- `defaultSpecificLanguageCode` string
- `isNeutral` boolean, nullable
- `languageDirection` LanguageDirectionItem
- `id` string, required — The language direction identifier.
- `assignees` WorkflowTaskAssignee — 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.
- `type` 'user' | 'group' | 'vendorOrderTemplate' | 'projectCreator' | 'projectManager', required
- `user` User — User in the account.
- `id` string, required — User account identifier.
- `description` string — Description of this account user. For Service account users only.
- `email` string —
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.
The user's name. Retrieved only for Service users (not RWS ID users) that the authenticated entity is authorized to read.
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.
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.
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.
Retrieved if the authenticated entity does not have access to read the User.
- `account` Account
- …
- `location` FolderV2 — Folder used for resource storage.
- …
- `groups` Group[]
- …
- `userType` 'user' | 'serviceUser' — The type of the account user.
- `status` 'inactive' | 'active' | 'deleted' | 'provisioned' — Status of this account user.
- `invitationLink` string — The user's invitation link. Retrieved only for RWS ID (formerly SDL ID) users—not service users. It is available only if the user has not yet accepted the invitation (status is `inactive`).
- `membership` 'member' | 'collaborator' — Type of membership of this account user.
- `metadata` unknown
- `group` Group — Group of Users.
- `id` string, required — The group identifier.
- `name` string —
The group name.
- `description` string — The group description.
- `location` FolderV2 — Folder used for resource storage.
- …
- `users` User[]
- …
- `roles` Role[] — **Note**: The identifier of `Administrator` role will not be exposed publicly and a `********` placeholder will be returned on this endpoint for the role.
- …
- `additionalRoles` GroupAdditionalRoles[]
- …
- `groupType` 'default' | 'custom' | 'vendor' | 'customer' — - default : groups in the Root folder (location) provisioned by the system, automatically. Examples: Administrator, Project Manager, Engineer, Terminologist. - customer : groups provisioned by the system, automatically, for each customer location you add. Examples: Customer Requester, Customer Reviewer. - vendor : group provisioned by the system, automatically, for each vendor location you add. Examples: Vendor Project Manager. - custom : groups you can create in a location of your choice. Examples: Project Manager, Translator.
- `metadata` unknown
- `vendorOrderTemplate` VendorOrderTemplate — The vendor order template.
- `id` string, required
- `isSkipped` boolean, nullable —
- `taskTemplate` WorkflowTaskTemplate, required
- `id` string, required — The workflow task template identifier.
- `name` string —
The workflow task template name.
- `description` string
- `canSkip` boolean, nullable
- `requiresAssignment` boolean, nullable
- `taskType` TaskType — Task type.
- `id` string, required
- `key` string —
Identifier key for the task.
Unique identifier of custom task types set in the workflow. If no custom id is set, it will return the default identifier for the custom task type.
- `description` string
- `automatic` boolean, nullable — This indicates whether the task is automatic or human.
- `scope` 'file' | 'targetLanguage' | 'batch' | 'vendorOrder' | 'task', nullable — The resource type scope for the task.
- `outcomes` TaskTypeOutcome[]
- …
- `configurationDefinitions` TaskTypeConfigurationDefinition[] — Defines the configurable options available for this task type. Each entry describes one configuration option including its data type, default value, allowed values and constraints.
- …
- `location` FolderV2 — Folder used for resource storage.
- …
- `phase` WorkflowPhase — A set of workflow steps which work together towards a localization outcome.
- `id` string, required — The phase identfier.
- `name` string —
default
The phase name.
- `configurationValues` WorkflowTaskTypeConfigValue[] — The task type configuration values set on this workflow task. Each item corresponds to a configuration key defined in `taskTemplate.taskType.configurationDefinitions`.
- `id` string, required — The configuration key identifier (e.g. `FORCE_CLOSE_MAX_AGE`, `EDITOR_MODE`, `CONCURRENT_EDITING_ENABLED`).
- `value` object, required — The configuration value.
- `languageDirections` LanguageDirectionNoStatistics[]
- `id` string, required — The language direction identifier.
- `sourceLanguage` Language, required — The language object.
- `languageCode` string, required — Language code. ex: "en-US", "de-DE".
- `englishName` string —
default
Human readable name.
- `direction` string
- `parentLanguageCode` string
- `defaultSpecificLanguageCode` string
- `isNeutral` boolean, nullable
- `targetLanguage` Language, required — The language object.
- `languageCode` string, required — Language code. ex: "en-US", "de-DE".
- `englishName` string —
default
Human readable name.
- `direction` string
- `parentLanguageCode` string
- `defaultSpecificLanguageCode` string
- `isNeutral` boolean, nullable
- `customFields` CustomField[] — The Custom Fields.
- `id` string, required — Custom Field identifier.
- `name` string — Custom Field name. (Not available for List Projects, Get Project Template and List Project Templates endpoints)
- `key` string — Custom Field friendly key.
- `value` object — The value of the custom property. A date will be serialized as an ISO_8601 string.
- `forceOnline` boolean — (Deprecated) Moved under settings.general.forceOnline
- `projectManagers` ProjectManagerResponse[]
- `type` 'group' | 'user'
- `user` User — User in the account.
- `id` string, required — User account identifier.
- `description` string — Description of this account user. For Service account users only.
- `email` string —
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.
- `name` string —
default
The user's name. Retrieved only for Service users (not RWS ID users) that the authenticated entity is authorized to read.
- `firstName` string —
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.
- `lastName` string —
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.
- `anonymized` boolean, nullable —
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.
- `anonymizedUserName` string —
default
Retrieved if the authenticated entity does not have access to read the User.
- `account` Account
- `id` string, required — The account identifier.
- `name` string —
default
The account name.
- `location` FolderV2 — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string —
default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — 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.
- `id` string, required — The folder identifier.
- `name` string, required — The name of the folder.
- `location` string —
default
The location identifier.
- `hasParent` boolean, nullable —
default
Indicates if the folder has a parent folder.
- `groups` Group[]
- `id` string, required — The group identifier.
- `name` string —
default
The group name.
- `description` string — The group description.
- `location` FolderV2 — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string —
default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — 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.
- …
- `users` User[]
- `roles` Role[] — **Note**: The identifier of `Administrator` role will not be exposed publicly and a `********` placeholder will be returned on this endpoint for the role.
- `id` string, required — The identifier of the role.
- `type` 'provisioned' | 'custom', required — The role type.
- `name` string, required — Name of the role.
- `description` string — Description of the role.
- `permissions` Permission[] — List of permissions associated with role.
- …
- `additionalRoles` GroupAdditionalRoles[]
- `location` FolderV2, required — Folder used for resource storage.
- …
- `roles` Role[], required
- …
- `groupType` 'default' | 'custom' | 'vendor' | 'customer' — - default : groups in the Root folder (location) provisioned by the system, automatically. Examples: Administrator, Project Manager, Engineer, Terminologist. - customer : groups provisioned by the system, automatically, for each customer location you add. Examples: Customer Requester, Customer Reviewer. - vendor : group provisioned by the system, automatically, for each vendor location you add. Examples: Vendor Project Manager. - custom : groups you can create in a location of your choice. Examples: Project Manager, Translator.
- `metadata` unknown
- `userType` 'user' | 'serviceUser' — The type of the account user.
- `status` 'inactive' | 'active' | 'deleted' | 'provisioned' — Status of this account user.
- `invitationLink` string — The user's invitation link. Retrieved only for RWS ID (formerly SDL ID) users—not service users. It is available only if the user has not yet accepted the invitation (status is `inactive`).
- `membership` 'member' | 'collaborator' — Type of membership of this account user.
- `metadata` unknown
- `group` Group — Group of Users.
- `id` string, required — The group identifier.
- `name` string —
default
The group name.
- `description` string — The group description.
- `location` FolderV2 — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string —
default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — 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.
- `id` string, required — The folder identifier.
- `name` string, required — The name of the folder.
- `location` string —
default
The location identifier.
- `hasParent` boolean, nullable —
default
Indicates if the folder has a parent folder.
- `users` User[]
- `id` string, required — User account identifier.
- `description` string — Description of this account user. For Service account users only.
- `email` string —
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.
- `name` string —
default
The user's name. Retrieved only for Service users (not RWS ID users) that the authenticated entity is authorized to read.
- `firstName` string —
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.
- `lastName` string —
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.
- `anonymized` boolean, nullable —
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.
- `anonymizedUserName` string —
default
Retrieved if the authenticated entity does not have access to read the User.
- `account` Account
- `id` string, required — The account identifier.
- `name` string —
default
The account name.
- `location` FolderV2 — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string —
default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — 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.
- …
- `groups` Group[]
- `userType` 'user' | 'serviceUser' — The type of the account user.
- `status` 'inactive' | 'active' | 'deleted' | 'provisioned' — Status of this account user.
- `invitationLink` string — The user's invitation link. Retrieved only for RWS ID (formerly SDL ID) users—not service users. It is available only if the user has not yet accepted the invitation (status is `inactive`).
- `membership` 'member' | 'collaborator' — Type of membership of this account user.
- `metadata` unknown
- `roles` Role[] — **Note**: The identifier of `Administrator` role will not be exposed publicly and a `********` placeholder will be returned on this endpoint for the role.
- `id` string, required — The identifier of the role.
- `type` 'provisioned' | 'custom', required — The role type.
- `name` string, required — Name of the role.
- `description` string — Description of the role.
- `permissions` Permission[] — List of permissions associated with role.
- `name` string, required — Name of the permission.
- `description` string, required — Human-readable description of the permission.
- `category` string, required — The category a permission belongs to.
- `entityType` PermissionEntityType, required — The entity type a permission applies to.
- …
- `dependsOn` string[], required — List of permission names that this permission depends on. Empty array if no dependencies.
- `additionalRoles` GroupAdditionalRoles[]
- `location` FolderV2, required — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string —
default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — 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.
- …
- `roles` Role[], required
- `id` string, required — The identifier of the role.
- `type` 'provisioned' | 'custom', required — The role type.
- `name` string, required — Name of the role.
- `description` string — Description of the role.
- `permissions` Permission[] — List of permissions associated with role.
- …
- `groupType` 'default' | 'custom' | 'vendor' | 'customer' — - default : groups in the Root folder (location) provisioned by the system, automatically. Examples: Administrator, Project Manager, Engineer, Terminologist. - customer : groups provisioned by the system, automatically, for each customer location you add. Examples: Customer Requester, Customer Reviewer. - vendor : group provisioned by the system, automatically, for each vendor location you add. Examples: Vendor Project Manager. - custom : groups you can create in a location of your choice. Examples: Project Manager, Translator.
- `metadata` unknown
- `quoteTemplate` ProjectQuoteTemplateDeprecated — (Deprecated) moved under settings.general.quoteTemplate
- `id` string, required — The identifier of the quote template.
- `name` string — The name of the quote template.
- `description` string — The description of the quote template.
- `location` FolderV2 — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string —
default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — 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.
- `id` string, required — The folder identifier.
- `name` string, required — The name of the folder.
- `location` string —
default
The location identifier.
- `hasParent` boolean, nullable —
default
Indicates if the folder has a parent folder.
- `scheduleTemplate` ScheduleTemplate — Schedule Template resource
- `id` string, required
- `name` string —
default
Schedule Template name.
- `description` string — Schedule Template description.
- `location` FolderV2 — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string —
default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — 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.
- `id` string, required — The folder identifier.
- `name` string, required — The name of the folder.
- `location` string —
default
The location identifier.
- `hasParent` boolean, nullable —
default
Indicates if the folder has a parent folder.
- `configurations` ScheduleTemplateConfiguration[]
- `taskTypeId` string, required — The identifier of the human task type.
- `taskTypeName` string — The name of the task type.
- `schedules` ScheduleTemplateConfigurationSchedules[]
- `scope` 'global' | 'sourceLanguage' | 'languageDirection', required — The scope of this configuration schedule. \ global -> schedule of the task \ sourceLanguage -> schedule of the specific task when the sourceLanguage matches this object's sourceLanguage\ languageDirection -> schedule of the specific task when the languageDirection matches this object's languageDirection
- `duration` integer — Expressed in minutes.
- `reminder` unknown
- `sourceLanguage` string
- `targetLanguage` string
- `projectScheduleConfiguration` ScheduleTemplateProjectConfiguration — Schedule Template Project Configuration resource
- `duration` integer —
default
Expressed in minutes.
- `reminder` unknown
- `settings` ProjectTemplateSettingsResponse — Project Template settings. See detailed description of options on the
Official Documentation page. (Not available for List Project Templates endpoint)
- `general` ProjectTemplateGeneralSettingsResponse — General settings, are detailed in section 10.a
- `forceOnline` boolean —
default
Restrict file downloads.
- `allowSourceEdit` boolean —
default
Allow editing of source text in segments.
- `quoteTemplate` ProjectQuoteTemplate — Project Quote Template resource.
- `id` string, required — The identifier of the quote template.
- `name` string — The name of the quote template.
- `description` string — The description of the quote template.
- `location` FolderV2 — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string —
default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — 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.
- …
- `customerPortalVisibility` boolean —
default
Customer Portal visibility
- `completionConfiguration` CompletionConfigRequest — Completion configuration properties.
- `completeDays` number — Number of days until automatic completion of the project. Starting from project creation date.
- `archiveDays` number — Number of days after project completion when the project will be archived..
- `archiveReminderDays` number — Number of days before archiving when a reminder will be sent.
- `batchTasks` ProjectTemplateBatchTasksSettings — Project Template Batch Tasks Settings
- `preProcessing` ProjectTemplateBatchTasksPreprocessingSettings — Pre-Processing Settings, configure how TMs are applied, are detailed in section 10.b
- `minimumMatchValue` integer —
default
- `translationOverwriteMode` 'keepExisting' | 'overwriteIfBetter' | 'overwriteAlways' | 'overwriteExceptPerfectMatch' —
default
Options: - `keepExisting`: no segments are overwritten, existing segments are kept; - `overwriteIfBetter`: unlocked segments (including confirmed segments) are overwritten, while unlocked PerfectMatch segments and locked segments are not overwritten; - `overwriteAlways`: PerfectMatch segments (both locked and unlocked) are overwritten, while other locked segments are not overwritten; - `overwriteExceptPerfectMatch`: unlocked segments (including confirmed segments) and locked segments are overwritten, while unlocked PerfectMatch segments are not overwritten;
- `afterApplyingTranslations` string[] —
default
Default: `confirmExactMatches`, `confirmContextMatches`
- `noMatchFoundAction` 'leaveTargetSegmentsEmpty' | 'copySourceToTarget' —
default
- `reportCrossFileRepetition` boolean — If enabled repetitions are identified and included in analysis reports.
- `excludeLockedSegments` boolean — If enabled locked segments (content that must not be translated) are excluded from translation.
- `updateTranslationMemory` UpdateTranslationMemorySettings
- `segmentsConfirmationLevels` string[], required — Default values are: [`translated`, `approvedTranslation`, `approvedSignOff`].
- `targetSegmentsDifferOption` 'addNew' | 'overwrite' | 'keepMostRecent' | 'leaveUnchanged' | 'merge', required — Options: - `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. - `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. - `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. - `leaveUnchanged`: keep the existing TUs and do not add any new ones. - `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.
- `verification` ProjectTemplateVerificationSettings
- `tagVerifier` ProjectTemplateVerificationTagVerifierSettings — Tag Verifier Settings, are detailed in section 10.d
- `enabled` boolean, required
- `checkAddedTags` boolean —
default
- `addedTagsSeverity` 'error' | 'warning' | 'note'
- `checkDeletedTags` boolean —
default
- `deletedTagsSeverity` 'error' | 'warning' | 'note'
- `checkTagOrderChanged` boolean —
default
- `tagOrderChangedSeverity` 'error' | 'warning' | 'note'
- `checkSpacingAroundTags` boolean —
default
- `spaceAroundTagsSeverity` 'error' | 'warning' | 'note'
- `ignoreFormattingTags` boolean —
default
- `ignoreLockedSegments` boolean —
default
- `ignoreDifferenceBetweenNormalAndNonBreakingSpace` boolean —
default
- `qaChecker` ProjectTemplateVerificationQaCheckerSettings — QA Checker Settings, are detailed in section 10.e
- `enabled` boolean, required
- `allLanguages` ProjectTemplateVerificationQaCheckerAllLanguages
- `segmentsVerification` ProjectTemplateVerificationQaCheckerSegmentsVerification
- …
- `segmentsToExclude` ProjectTemplateVerificationQaCheckerSegmentsToExclude
- …
- `inconsistencies` ProjectTemplateVerificationQaCheckerInconsistencies
- …
- `punctuation` ProjectTemplateVerificationQaCheckerPunctuation
- …
- `numbers` ProjectTemplateVerificationQaCheckerNumbers
- …
- `wordList` ProjectTemplateVerificationQaCheckerWordList
- …
- `regularExpressions` ProjectTemplateVerificationQaCheckerRegularExpressions
- …
- `trademarkCheck` ProjectTemplateVerificationQaCheckerTrademarkCheck
- …
- `lengthVerification` ProjectTemplateVerificationQaCheckerLengthVerification
- …
- `perTargetLanguage` ProjectTemplateVerificationQaCheckerPerTargetLanguage[]
- `targetLanguage` Language, required — The language object.
- …
- `punctuation` ProjectTemplateVerificationQaCheckerPunctuation
- …
- `numbers` ProjectTemplateVerificationQaCheckerNumbers
- …
- `wordList` ProjectTemplateVerificationQaCheckerWordList
- …
- `regularExpressions` ProjectTemplateVerificationQaCheckerRegularExpressions
- …
- `qualityManagement` ProjectTemplateQualityManagementSettingsResponse
- `tqaProfile` TqaProfile — As a project manager, you choose a TQA configuration and use it to automatically assess the quality of a translation document. The TQA configuration specifies: - Categories and subcategories that reviewers will use to classify the translation issues in a document. - Severities to define custom metrics you want to use to assess translation quality. - Score to measure the importance of each category or subcategory of an issue. - Pass/Fail Threshold to define the maximum number of penalty points admitted before failing the translation document.
- `id` string, required — The identifier of the TQA profile.
- `name` string —
default
The name of the TQA Profile.
- `description` string —
default
The TQA Profile description.
- `location` FolderV2 — Folder used for resource storage.
- `id` string, required — The folder identifier.
- `name` string —
default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — 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.
- …
- `passFailThreshold` TqaProfilePassFailThreshold — Pass/Fail Threshold is used to define the maximum number of penalty points admitted before failing the translation document.
- `points` integer —
default
The penalty points.
- `quantity` integer —
default
The quantity against which the points are measured.
- `scope` string —
default
Words or characters.
- `categories` TqaProfileCategory[] — Categories and subcategories are assessment options that reviewers can use to classify any translation-related issue that they find in a file.
- `id` string — The category identifier.
- `name` string —
default
The category name.
- `description` string — The category description.
- `abbreviation` string — The category abbreviation.
- `severities` TqaProfileSeverity[] — Severities are custom metrics that reviewers can use to measure the importance of any translation-related issues that they find in a file.
- `id` string — The severity identifier.
- `name` string —
default
The severity name.
- `type` string — The severity type.
- `scores` TqaProfileScore[] — The TQA scoring indicates whether translations pass or fail the acceptance threshold.
- `category` TqaProfileCategory
- …
- `severity` TqaProfileSeverity — Severities are custom metrics that reviewers can use to measure the importance of any translation-related issues that they find in a file.
- …
- `penalty` integer —
default
The associated penalty for this score's category and severity.
- `path` Folder[]
- `id` string, required — The folder identifier.
- `name` string —
default
The name of the folder.
- `hasParent` boolean, nullable — Indicates if the folder has a parent folder.
- `path` FolderPath[] — 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.
- …
- `termbaseSettings` ProjectTemplateTermbaseSettingsResponse
- `general` ProjectTemplateTermbaseGeneralSettings
- `showRecognizedTermsWithNoTranslation` boolean
- `enableRecognitionOfTwoLetterTerms` boolean
- `allowOverlappingTerms` boolean
- `minimumScore` number
- `termLength` number
- `translationMemorySettings` ProjectTemplateTranslationMemorySettingsResponse — Translation Memory settings
- `penalties` ProjectTemplateTMPenalties — Translation Memory Penalties
- `standardPenalties` ProjectTemplateTMStandardPenalties — Translation Memory Standard Penalties
- `missingFormatting` integer —
default
- `differentFormatting` integer —
default
- `multipleTranslations` integer —
default
- `autoLocalization` integer —
default
- `textReplacement` integer —
default
- `alignment` integer —
default
- `characterWidthDifference` integer —
default
- `translationUnitStatusPenalties` ProjectTemplateTMTranslationUnitStatusPenalties — Translation Memory Translation Unit Status Penalties
- `translated` integer —
default
- `rejectedTranslation` integer —
default
- `approvedTranslation` integer —
default
- `rejectedSignOff` integer —
default
- `approvedSignOff` integer —
default
- `notTranslated` integer —
default
- `draft` integer —
default
- `filters` TranslationMemorySettingsFiltersResponse
- `hardFilter` TranslationMemorySettingsHardFilterResponse — Hard filter configuration for Translation Memory matching.
- `expression` string, required — The filter expression is a set of atomic expressions connected by logical operators. An atomic expression describes the relationship of a field to a value.
- `fields` TranslationMemorySettingsFilterFieldResponse[]
- …
- `updateTranslationMemoryFields` TranslationMemorySettingsUpdateFieldResponse[]
- `fieldId` string, required — The field identifier. For system fields, use system field names. For custom fields, use the custom field identifier.
- `fieldTemplateId` string, required — `system` or identifier of the custom field template
- `fieldTemplateName` string, required — The name of the field template.
- `name` string, required — The field name. For system fields, identical to fieldId. For custom fields, use the custom field name.
- `type` 'singleString' | 'multipleString' | 'singlePicklist' | 'multiplePicklist' | 'dateTime' | 'integer', required — Type of the field.
- `allowedValues` object[] —
default
Available values for picklist fields. Only present for singlePicklist and multiplePicklist field types.
- `id` string, required — The unique identifier of the allowed value.
- `name` string, required — The display name of the allowed value.
- `values` string[] —
default
The actual values assigned to this field.
- `lastModifiedAt` string, date-time — The date and time when the project template was modified.
UTC Timezone
Allowed formats:
"YYYY-MM-DDThh:mmZ"
"YYYY-MM-DDThh:mm:ssZ"
"YYYY-MM-DDThh:mm:ss.sZ"
"YYYY-MM-DDThh:mm:ss.ssZ"
"YYYY-MM-DDThh:mm:ss.sss
## Other responses
- `400` — Error codes: * “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.
- `401` — The user could not be identified.
- `416` — Error codes: * "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.
---
[API](https://skmtc.net/rws/apis/trados-cloud-platform-api.md) · [All operations](https://skmtc.net/rws/apis/trados-cloud-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rws/trados-cloud-platform-api/revisions/d42dac7c28a3/schema)