Definitions
Definitions of common objects:
LoginAPI:userId,username,password,client,integrationKeyRequired for all web service calls.
Please set integrationKey if provided by XTM International.
XTMCustomerDescriptorAPI:id,name,externalIdThe Customer descriptor is used to specify a customer. Firstly, the customer ID is checked, then the customer name, finally the customer external ID.
XTMDomainDescriptorAPI:domain,domainNameThe Domain descriptor is used to specify a domain. Firstly, the domain definition from
XTM_DOMAINSenumeration type is checked, then the custom domain name.XTMFileDescriptorAPI:idThe File descriptor is used to specify a file.
XTMJobDescriptorAPI:id,externalId(deprecated, please useintegrationId),integrationIdThe Job descriptor is used to specify a job. Firstly, the job ID is checked, then the job integration ID.
XTMProjectDescriptorAPI:id,externalId(deprecated, please useintegrationId),integrationIdThe Project descriptor is used to specify a project. Firstly, the project ID is checked, then the project integration ID.
XTMUserBaseDescriptorAPI:id,nameThe Base user descriptor is used to specify a user. Firstly, the user ID is checked, then the user name.
XTMUserDescriptorAPI:id,name,actorTypeThe user descriptor is used to specify a Linguist or LSP. Firstly, the user ID is checked, then the user name. Actor type enables you to specify a Linguist or LSP.
XTMWorkflowDescriptorAPI:id,workflow,workflowNameA workflow descriptor is used to specify a workflow. Firstly, the workflow ID is checked, then the workflow definition from the
XTM_WORKFLOWSenumeration type, and finally the custom workflow name.XTMWorkflowStepDescriptorAPI:id,orderNumber,workflowStep,workflowStepNameA workflow step descriptor is used to specify a workflow step. Firstly, the workflow step ID and orderNumber are checked, then the workflow step definition from
XTM_WORKFLOW_STEPenumeration type, and then the custom workflow step name. To view the workflow step ID, in XTM Cloud, select Configuration > Settings > Workflow > Workflow steps. Then, in the Workflow steps table, find the required table row and hover over the information icon in the last column.XTMTemplateDescriptorAPI:id,externalIdThe Template descriptor is used to specify a project template. Firstly, the template ID is checked, then the template external ID.
XTMDeleteFileDescriptorAPI:fileNameThis descriptor is used to specify a file to delete.
XTMTMBaseFileDescriptorAPI:idThis descriptor is used to specify TM import or TM export file.
XTMPenaltyProfileDescriptorAPI:id,nameThis descriptor is used to specify a TM or Term penalty profile. Firstly, the profile ID is checked, then the profile name.
XTMTagDescriptorAPI:id,nameThis descriptor is used to specify a tag group and the list of tags. Firstly, the tag group ID is checked, then the tag group name, and then the tags which are defined by the
XTMTagValueDescriptorAPIobject.XTMTagValueDescriptorAPI:id,nameThis descriptor is used to specify a tag. Firstly, the tag ID is checked, then the tag name.
XTMCostDescriptorAPI:costBaseDescriptor,projectDescriptor,sourceThis descriptor is used to specify a cost. Firstly, the ID from the costBaseDescriptor is checked, then the project descriptor with a cost calculation source, and finally the project descriptor.
XTMCustomFieldDescriptorAPI:idThis descriptor is used to specify a custom field.
XTMCustomFieldValueAPI:ids,value,dateValue,booleanValueThis object is used to specify a custom field value. Custom fields can be set to have multiple values.
The ids in a multiple selection or a dropdown custom field are used to choose the options.
The booleanValue field is used for checkbox custom fields.
The dateValue for custom fields with dates.
The value field is used for other types of custom fields.
XTMCustomFieldAPI:customFieldDescriptor,customFieldValueThis descriptor is used to specify a custom field and its value.
XTMAnalysisTemplateDescriptor:idThis descriptor is used to specify an analysis template.
Enumeration types
XTM_WORKFLOW_STEP– a list of possible workflow steps:Table 2. : XTM_WORKFLOW_STEP – list of possible workflow stepsOption
Option
TRANSLATE1Define for ‘translate 1’ step.
REVIEW1Define for ‘review 1’ step.
REVIEW2Define for ‘review 2’ step.
CORRECT1Define for ‘correct 1’ step.
CORRECT2Define for ‘correct 2’ step.
ActorType– a list of possible Linguist types:Table 3. : ActorType – list of possible workflow stepsOption
Option
INTERNALLINGUISTDefine for Linguist type. The default value if not set.
LSPDefine for LSP type.
LANGUAGE_CODEContains languages in the IANA format where a single language subtag composed of two letters is followed by a region subtag composed of two letters, for example:
en_GB,pl_PL,ru_RU.