--- title: "Create Vendor Order Template" method: POST path: "/vendors/{vendorId}/order-templates" tags: ["Vendor"] --- # Create Vendor Order Template `POST /vendors/{vendorId}/order-templates` Creates a new vendor order template for the specified vendor. For more information on creating vendor order templates, see [Creating order templates for vendors](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/creating-order-templates-for-vendors-708439). ## Query parameters - `fields` string ## Headers - `X-LC-Tenant` string, required - `Authorization` string, required ## Request body - VendorOrderTemplateCreateRequest — Request body for creating a new vendor order template. - `name` string, required — The name of the vendor order template. - `description` string — A description of the vendor order template. - `allowQuoteEditing` boolean — Whether the vendor is allowed to edit the vendor quote at any time. When `false` (default), vendor project managers can only edit the quote during the Vendor Quote Review task. - `serviceTypes` string[], required — The service type identifiers to associate with this vendor order template. Use the [List Service Types](#/operations/ListTranslationServiceTypes) endpoint to retrieve available values. - `pricingModelId` string, required — The identifier of the pricing model to associate with this vendor order template. Use the [List Pricing Models](#/operations/ListPricingModels) endpoint with `location` set to the vendor's folder identifier. Set `locationStrategy=location` to see only pricing models saved directly in the vendor folder. - `quoteConfiguration` VendorOrderTemplateQuoteConfiguration, required — Controls when and how the vendor quote is generated. - `behaviour` 'waitForAllFiles' | 'perFileQuote' | 'finalQuoteAfterBatchCompleted' | 'quoteBeforeCustomerQuoteGeneration', required — The strategy that determines when the vendor quote is generated. For details on how each strategy behaves, see [Vendor order template strategies and their behavior](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/vendor-order-template-strategies-and-their-behavior-1170239). - `waitForAllFiles`: Wait until all files assigned to the vendor have reached their task, up to `holdingDelay` minutes (default: 1440 = 24 hours). If all files have not arrived within the waiting period, the quote is generated for the files that did arrive; remaining files are added to the same quote when they arrive. - `perFileQuote`: Generate a separate quote for each file individually as it reaches the vendor task. - `finalQuoteAfterBatchCompleted`: Generate a single quote immediately after the Project Planning task is completed. This is the default strategy. - `quoteBeforeCustomerQuoteGeneration`: Generate the vendor quote before the customer quote is generated. - `holdingDelay` integer — The maximum time in minutes the system waits for all files to reach the vendor task before generating the quote. Only applicable when `behaviour` is `waitForAllFiles`. Defaults to 1440 (24 hours). - `customFields` CustomFieldRequest[] — Custom field values to associate with the vendor order template. Use the [List Custom Field Definitions](#/operations/ListCustomFields) endpoint with `location` set to the vendor's folder identifier and `resourceType=vendorOrderTemplate` to retrieve applicable definitions. - `key` string, required — Custom Field friendly key. - `value` object — 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. - `languagePairs` LanguagePair[], required — The language pairs supported by this vendor order template. - `source` string, required — Language code. ex: "en-US", de-DE". - `target` string, required — Language code. ex: "en-US", de-DE". - `assignments` VotConfiguration[], required — Assignee and manager assignments per language pair. Must contain exactly one entry for each language pair listed in `languagePairs`. - `languagePair` LanguagePair, required - `source` string, required — Language code. ex: "en-US", de-DE". - `target` string, required — Language code. ex: "en-US", de-DE". - `managers` VotPersonRequest[], required — The vendor project managers responsible for the Vendor Quote Review task for this language pair. All entries must be members of the vendor's Vendor Project Manager group. - `type` 'user' | 'group', required — The kind of assignment. - `id` string, required — The identifier of the user or group being assigned, according to `type`. - `assignees` VotPersonRequest[], required — The vendor users who will perform the actual service tasks (e.g. Translation, Linguistic Review, DTP) for this language pair. All entries must be members of the vendor's Vendor Project Manager group. - `type` 'user' | 'group', required — The kind of assignment. - `id` string, required — The identifier of the user or group being assigned, according to `type`. ## Response `201` Vendor Order Template created successfully. - VendorOrderTemplateResponse — A vendor order template resource. - `id` string, required — The unique identifier of the vendor order template. - `name` string — The name of the vendor order template. - `description` string — A description of the vendor order template. - `allowQuoteEditing` boolean — Whether the vendor is allowed to edit the quote. - `serviceTypes` TranslationServiceType[] — The service types associated with this vendor order template. - `id` string, required — The Service Type identifier. - `name` string —
default
The Service Type name.
- `pricingModel` PricingModel — Pricing Model resource. (Not available for List Projects endpoint) - `id` string, required — The pricing model identifier. - `name` string —
default
The name of the Pricing Model.
- `description` string — The description of the Pricing Model. - `currencyCode` string —
default
The currency code (ISO 4217).
- `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. - `languageDirectionPricing` LanguageDirectionCost[] — Costs applied for languages. - `sourceLanguage` string, required — The source language code. For example: "en-US", "de-DE". - `targetLanguage` string, required — The target language code. For example: "en-US", "de-DE". - `contextMatch` number —
default
The price of context matches. - `exactMatch` number —
default
The price of exact matches. - `new` number —
default
The price of new matches. - `perfectMatch` number —
default
The price of PerfectMatches. - `repetition` number —
default
The price of repetition matches. - `machineTranslation` number —
default
The price of machine translation matches. - `pricingUnit` 'words' | 'characters' - `fuzzyMatches` FuzzyMatch[] —
default
- `price` number, required — Fuzzy match price for the range expressed in the category field. - `category` FuzzyMatchCategory, required — Fuzzy match category range. - `minimumMatchValue` integer, nullable, required — Minimum matching value of this range. - `maximumMatchValue` integer, nullable, required — Maximum matching value of this range. - `additionalCosts` LanguageCost[] —
default
- `name` string, required — The name of the additional cost. - `type` 'volume' | 'hourly' | 'percentage' | 'perPage' | 'conditional' | 'adhoc' | 'adhocVolume', required - `index` number, required — The number of the additional cost. - `costPerUnit` number, required — The cost of a unit. - `unitCount` number, required — The number of units for which a cost is applied. - `volumeUnitType` 'words' | 'characters' | 'custom' - `conditionalCostType` 'absolute' | 'relative' | 'percentage' - `costOperator` 'less' | 'lessOrEqual' | 'greater' | 'greaterOrEqual' - `costVariable` 'wordCount' | 'runningTotal' - `operand` number —
default
Operand of the Conditional type cost. - `serviceTypes` string[] —
default
Array of Service Type identifiers where this additional cost is applied. - `customUnitName` string — The name of the custom unit. - `additionalCosts` ProjectCost[] — Additional costs applied at project level. - `name` string, required — The name of the additional cost. - `type` 'volume' | 'perTargetLanguage' | 'perFile' | 'hourly' | 'percentage' | 'perPage' | 'conditional' | 'adhoc' | 'adhocVolume', required - `index` number, required — The number of the additional cost. - `costPerUnit` number, required — The cost of a unit. - `unitCount` number, required — The number of units for which a cost is applied. - `volumeUnitType` 'words' | 'characters' | 'custom' - `conditionalCostType` 'absolute' | 'relative' | 'percentage' - `costOperator` 'less' | 'lessOrEqual' | 'greater' | 'greaterOrEqual' - `costVariable` 'wordCount' | 'runningTotal' - `operand` number — Operand of the Conditional type cost. - `serviceTypes` string[] —
default
Array of Service Type identifiers where this additional cost is applied. - `customUnitName` string — The name of the custom unit. - `quoteConfiguration` VendorOrderTemplateQuoteConfiguration — Controls when and how the vendor quote is generated. - `behaviour` 'waitForAllFiles' | 'perFileQuote' | 'finalQuoteAfterBatchCompleted' | 'quoteBeforeCustomerQuoteGeneration', required — The strategy that determines when the vendor quote is generated. For details on how each strategy behaves, see [Vendor order template strategies and their behavior](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/vendor-order-template-strategies-and-their-behavior-1170239). - `waitForAllFiles`: Wait until all files assigned to the vendor have reached their task, up to `holdingDelay` minutes (default: 1440 = 24 hours). If all files have not arrived within the waiting period, the quote is generated for the files that did arrive; remaining files are added to the same quote when they arrive. - `perFileQuote`: Generate a separate quote for each file individually as it reaches the vendor task. - `finalQuoteAfterBatchCompleted`: Generate a single quote immediately after the Project Planning task is completed. This is the default strategy. - `quoteBeforeCustomerQuoteGeneration`: Generate the vendor quote before the customer quote is generated. - `holdingDelay` integer — The maximum time in minutes the system waits for all files to reach the vendor task before generating the quote. Only applicable when `behaviour` is `waitForAllFiles`. Defaults to 1440 (24 hours). - `customFields` CustomField[] — Custom field values associated with the vendor order template. - `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. - `languagePairs` LanguagePair[] — The language pairs supported by this vendor order template. - `source` string, required — Language code. ex: "en-US", de-DE". - `target` string, required — Language code. ex: "en-US", de-DE". - `assignments` VotConfigurationResponse[] — Assignee and manager assignments per language pair. Contains exactly one entry for each language pair in `languagePairs`. - `languagePair` LanguagePair, required - `source` string, required — Language code. ex: "en-US", de-DE". - `target` string, required — Language code. ex: "en-US", de-DE". - `managers` VotPersonResponse[], required — The vendor project managers responsible for the Vendor Quote Review task for this language pair. All entries must be members of the vendor's Vendor Project Manager group. - `type` 'user' | 'group', required — The kind of assignment. - `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 - `assignees` VotPersonResponse[], required — The vendor users who will perform the actual service tasks (e.g. Translation, Linguistic Review, DTP) for this language pair. All entries must be members of the vendor's Vendor Project Manager group. - `type` 'user' | 'group', required — The kind of assignment. - `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 ## Other responses - `400` — Error codes: * "invalid": Invalid input in the field mentioned in the "name" field on the error response. * "empty": Empty input in the body parameter mentioned in the "name" field on the error response. * "minSize": Minimum size exceeded for the value mentioned in the "name" field on the error response. * "maxSize": Maximum size exceeded for the value 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 create vendor order templates. - `404` — Error codes: * "notFound": the vendor 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)