Skip to main content

SOAP API

Definitions

  1. Definitions of common objects:

    • LoginAPI: userId, username,

      password, client, integrationKey

      Required for all web service calls.

      Please set integrationKey if provided by XTM International.

    • XTMCustomerDescriptorAPI: id, name, externalId

      The 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, domainName

      The Domain descriptor is used to specify a domain. Firstly, the domain definition from XTM_DOMAINS enumeration type is checked, then the custom domain name.

    • XTMFileDescriptorAPI: id

      The File descriptor is used to specify a file.

    • XTMJobDescriptorAPI: id, externalId (deprecated, please use integrationId), integrationId

      The Job descriptor is used to specify a job. Firstly, the job ID is checked, then the job integration ID.

    • XTMProjectDescriptorAPI: id, externalId (deprecated, please use integrationId), integrationId

      The Project descriptor is used to specify a project. Firstly, the project ID is checked, then the project integration ID.

    • XTMUserBaseDescriptorAPI: id, name

      The Base user descriptor is used to specify a user. Firstly, the user ID is checked, then the user name.

    • XTMUserDescriptorAPI: id, name, actorType

      The 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, workflowName

      A workflow descriptor is used to specify a workflow. Firstly, the workflow ID is checked, then the workflow definition from the XTM_WORKFLOWS enumeration type, and finally the custom workflow name.

    • XTMWorkflowStepDescriptorAPI: id, orderNumber, workflowStep, workflowStepName

      A 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_STEP enumeration 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, externalId

      The Template descriptor is used to specify a project template. Firstly, the template ID is checked, then the template external ID.

    • XTMDeleteFileDescriptorAPI: fileName

      This descriptor is used to specify a file to delete.

    • XTMTMBaseFileDescriptorAPI: id

      This descriptor is used to specify TM import or TM export file.

    • XTMPenaltyProfileDescriptorAPI: id, name

      This descriptor is used to specify a TM or Term penalty profile. Firstly, the profile ID is checked, then the profile name.

    • XTMTagDescriptorAPI: id, name

      This 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 XTMTagValueDescriptorAPI object.

    • XTMTagValueDescriptorAPI: id, name

      This descriptor is used to specify a tag. Firstly, the tag ID is checked, then the tag name.

    • XTMCostDescriptorAPI: costBaseDescriptor, projectDescriptor, source

      This 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: id

      This descriptor is used to specify a custom field.

    • XTMCustomFieldValueAPI: ids, value, dateValue, booleanValue

      This 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, customFieldValue

      This descriptor is used to specify a custom field and its value.

    • XTMAnalysisTemplateDescriptor: id

      This descriptor is used to specify an analysis template.

  2. Enumeration types

    • XTM_WORKFLOW_STEP – a list of possible workflow steps:

      Table 2. : XTM_WORKFLOW_STEP – list of possible workflow steps

      Option

      Option

      TRANSLATE1

      Define for ‘translate 1’ step.

      REVIEW1

      Define for ‘review 1’ step.

      REVIEW2

      Define for ‘review 2’ step.

      CORRECT1

      Define for ‘correct 1’ step.

      CORRECT2

      Define for ‘correct 2’ step.


    • ActorType – a list of possible Linguist types:

      Table 3. : ActorType – list of possible workflow steps

      Option

      Option

      INTERNALLINGUIST

      Define for Linguist type. The default value if not set.

      LSP

      Define for LSP type.


    • LANGUAGE_CODE

      Contains 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.