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.
- `to` WorkflowTemplateTransitionNode
- `type` 'taskTemplate' | 'start' | 'end' —
- `taskTemplate` WorkflowTaskTemplate
- `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.
- `condition` WorkflowTemplateTransitionCondition
- `type` 'outcome' | 'expression', nullable —
default
- `value` string —
default
- `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 —
default
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 —
default
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 —
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
- `vendorOrderTemplate` VendorOrderTemplate — The vendor order template.
- `id` string, required
- `isSkipped` boolean, nullable —
default
- `taskTemplate` WorkflowTaskTemplate, required
- `id` string, required — The workflow task template identifier.
- `name` string —
default
The workflow task template name.
- `apiInternalId` string —
default
Unique identifier of workflow task templates
- `description` string
- `canSkip` boolean, nullable
- `requiresAssignment` boolean, nullable
- `taskType` TaskType — Task type.
- `id` string, required
- `key` string —
default
Identifier key for the task.
- `name` string —
default
- `apiInternalId` string —
default
Unique identifier of custom task types set in the workflow. If no custom id is set, it will return the default identifier for the custom task type.
- `description` 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[]
- `name` string —
default
- `description` string
- `default` boolean, nullable —
default
- `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.
- `id` string, required — The identifier for the configuration option (e.g. `FORCE_CLOSE_MAX_AGE`).
- `name` string, required — Human-readable name for the configuration option.
- `description` string — Explanation of what this configuration option controls.
- `dataType` 'integer' | 'boolean' | 'string', required — The data type of the configuration value.
- `optional` boolean, required — Whether this configuration option is optional. If `false`, a value must always be supplied.
- `defaultValue` object, nullable — The default value applied when no value is explicitly set. The type matches `dataType`. May be `null` when no default is defined.
- `options` string[], nullable — Enumerated list of accepted string values. Present only when `dataType` is `string` and the value is restricted to a fixed set. `null` when any value is allowed.
- `constraints` TaskTypeConfigurationConstraint[] — Validation constraints applied to the value (e.g. minimum/maximum for numeric types).
- `type` 'minValue' | 'maxValue', required — The kind of constraint.
- `value` object, required — The constraint threshold. Type matches the parent configuration option's `dataType`.
- `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.
- `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
## 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.
- `403` — Error codes: * "forbidden": the authenticated user is not allowed to read the workflow.
- `404` — Error codes: * "notFound": the resource could not be found by identifier.
---
[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)