Skip to main content

SOAP API

Project management

  1. assignLinguistToProject()

    Assigns Linguists or LSPs to all jobs (all bundles, all files, and all languages) for a specific workflow step in the project and returns the result of the assignment operation. It requires a project descriptor and a list of XTMStepLinguistAssignmentAPI objects. The XTMStepLinguistAssignmentAPI object includes a workflow step descriptor and a user descriptor.

  2. assignLinguistToJob()

    Assigns Linguists or LSPs to the specified jobs and returns the result of the assignment operation. It requires a list of XTMJobLinguistAssignmentAPI objects. The XTMJobLinguistAssignmentAPI object includes a job descriptor and a list of XTMStepLinguistAssignmentAPI objects, which are described in point 1.

  3. startProject()

    Starts the given projects. It requires a list of project descriptors. All jobs in the projects are started, and Linguists receive emails about their tasks.

  4. findProject()

    This method can be used to search for projects. It is necessary to specify search parameters in the XTMFilterProjectAPI object. It returns all projects matching the given criteria with details. There are two additional settings in the method’s object XTMFindProjectOptionsAPI. The projectCreator parameter filters the projects by the user who created them. The pagination parameter splits the returned project listing into pages and displays only the requested page. The number of projects listed on a page can be specified using the pageSize parameter. Pagination is optional, and when it is not used, all projects are displayed on a single page. The user is specified in the LoginAPI object (XTMProjectCreatorEnum).

  5. updateProject()

    This method can be used to update project details. It requires a list of XTMUpdateProjectAPI objects specifying the projects to update. The XTMUpdateProjectAPI object includes the project descriptor, fields to update (name, description, and domain descriptor), project custom fields, and project translation properties to update. When the project domain is updated, estimates have to be recalculated. Custom fields can be set or changed for the project. The XTMUpdateProjectTranslationPropertiesAPI object includes translation properties that can be updated:

    • allow editing ICE matches.

  6. updateProjectActivity()

    This method can be used to delete, activate, archive, or reanalyze specified projects. It requires a list of project descriptors and activity. There is an additional setting in the method options that filters the projects by the user who created them. The user is specified in the LoginAPI object (XTMProjectCreatorEnum).

  7. updateJobActivity()

    This method can be used to cancel specific jobs. It requires a list of job descriptors and the activity to be set (available job activity states are listed in the XTMJobActivity object). Cancelled jobs are no longer processed, but they are not removed from projects.

  8. updateProjectWorkflow()

    This method can be used to change the workflow for the specified project. It requires the project descriptor and the XTMUpdateWorkflowAPI object, where the workflow can be defined using the XTMWorkflowDescriptorAPI object or definitions of workflow steps (the list of XTMUpdateWorkflowStepAPI objects).

    The XTMUpdateWorkflowStepAPI object includes the step descriptor, role, forward blocking type, and TM approval step.

    There are two algorithms for updating the workflow, which can be specified by the XTM_WORKFLOW_MATCH enum:

    • MATCH_NAMES – XTM Cloud tries to find the existing workflow step with the same name and updates the properties. Changing the step role will clear any assigned Linguists.

    • NO_MATCH – XTM Cloud deletes the current workflow steps and creates new ones.

  9. updateJobGroupWorkflow()

    This method can be used to change the workflow for a specified group of project jobs. It requires the XTMJobGroupDescriptorAPI object, which can be used to define a group of project jobs in the following ways:

    • jobDescriptors – a list of project jobs from a single project.

    • projectDescriptor – all project jobs from a project.

    • projectDescriptor and projectTargetLanguages – a list of project jobs from a project for specific target languages.

    The workflow definition and possible workflow update algorithms are described in the updateProjectWorkflow() method.

  10. updateTargetLanguages()

    This method can be used to change target languages for the specified project. It requires the XTMUpdateTargetLanguagesAPI object, which includes the project descriptor and objects that define changes in the target languages:

    • XTMAddTargetLanguagesAPI – languages to add.

    • XTMDeleteTargetLanguagesAPI – languages to delete.

    This operation cannot be performed when the project is being analysed.

  11. updateTranslationFilesMTOM()

    This method can be used to add, update, or delete source files in a project using MTOM or BASE64, depending on the chosen webservice. It requires the project descriptor and a list of files. Source files can be added or updated only for all languages. By specifying target languages in the xtmDeleteTranslationFilesAPI object, source files can be deleted only for a selection of languages. This operation cannot be performed when the project is inactive or being analysed.

  12. updateTranslationFilesURL()

    This method can be used to add, update, or delete source files in the project based on the file URL. It requires the project descriptor and a list of files. Source files can be added or updated only for all languages. By specifying target languages in the xtmDeleteTranslationFilesAPI object, source files can be deleted only for a selection of languages. This operation cannot be performed when the project is inactive or being analysed.

  13. moveJobWorkflow()

    This method can be used to move the workflow forward or backward, or restart a failed automatic step for specific jobs. It requires the XTMMoveJobWorkflowAPI object, which consists of a list of the XTMJobWorkflowMoveAPI objects. The XTMJobWorkflowMoveAPI object includes the job descriptor and the field that defines the type of movement that should be made (XTM_WORKFLOW_MOVE).

    Additional settings:

    • concurrentStepsAsOne – defines if concurrent steps should be treated as one.

    • mailing – possibility to disable email notifications (XTMMoveWorkflowMailing).

  14. moveProjectWorkflow()

    This method can be used to move the workflow forward or backward, or restart a failed automatic step for the specific project. It requires the XTMMoveProjectWorkflowAPI object, which includes the project descriptor and the field that defines the type of movement that should be made (XTM_WORKFLOW_MOVE). Additional settings are the same as under the moveJobWorkflow() method.

  15. checkProjectAnalysisCompletion()

    Checks if the analysis of the project and its jobs is completed. This method requires a project descriptor and returns the general project status (XTM_PROJECT_COMPLETION_STATUS) and status for each job (XTM_JOB_COMPLETION_STATUS).

  16. checkJobAnalysisCompletion()

    Checks if the analysis of the job is completed. This method requires a list of job descriptors and returns the status for each job (XTM_JOB_COMPLETION_STATUS).

  17. checkProjectCompletion()

    Checks if the project and jobs are completed. This method requires the project descriptor and returns

    • the general project status (XTM_PROJECT_COMPLETION_STATUS).

    • the status for each job (XTM_JOB_COMPLETION_STATUS).

    • the locked status for each job (XTMJobLockingStatusEnum)

      – provides locked status information for segments locked in a TIPP package that has been downloaded by a user. If the segments are locked, the target file cannot be generated or uploaded by anyone else.

    • the status for all workflow steps in the job (XTM_STEP_COMPLETION_STATUS).

    • the status for all automatic workflow steps in the job (XTM_AUTOSTEP_COMPLETION_STATUS).

  18. checkJobCompletion()

    Checks if the job is completed. This method requires a list of the job descriptors and returns:

    • the status for each job (XTM_JOB_COMPLETION_STATUS).

    • the locked status for each job (XTMJobLockingStatusEnum).

    • the status for all workflow steps in the job (XTM_STEP_COMPLETION_STATUS).

    • the status for all automatic workflow steps in the job (XTM_AUTOSTEP_COMPLETION_STATUS).

  19. updateJobStepProperty()

    This method can be used to update workflow step due dates for specific jobs and set a due date for the entire project.

  20. updateProjectStepProperty()

    This method can be used to update workflow step due dates for all jobs in translation into the specified target languages and set a due date for the entire project.

  21. updateJobWorkflowActivity()

    This method can be used to finish, reopen or reset the workflow for specific jobs. A workflow activity setting should be set using the XTM_WORKFLOW_ACTIVITY enumeration type.

  22. updateProjectWorkflowActivity()

    This method can be used to finish, reopen or reset the workflow for all jobs in the specified projects. A workflow activity setting should be set using the XTM_WORKFLOW_ACTIVITY enumeration type.

  23. findAnalysisTemplates()

    This method can be used to search for analysis templates. It returns all global templates and templates for customers from the list that can be specified in the XTMFindAnalysisTemplatesFilterAPI object.

  24. findWorkflow()

    This method can be used to search for workflow definitions. It returns active definitions that match the given criteria. Optional search parameters, such as the list of workflow IDs or workflow names can be specified in the XTMFindWorkflowFilterAPI object.

XTM_WORKFLOW_MOVE – list of possible types of workflow moves:

Table 23. : XTM_WORKFLOW_MOVE – list of possible types of workflow moves

Option

Description

FORWARD

The workflow will be moved forward.

BACKWARD

The workflow will be moved backward.

RESTART

The failed automatic step will be restarted.


XTM_PROJECT_COMPLETION_STATUS – the possible project completion statuses:

Table 24. : XTM_PROJECT_COMPLETION_STATUS – the possible project completion statuses

Option

Description

IN_PROGRESS

All jobs in the given project are still processing.

PARTIALLY_FINISHED

At least one job in the given project is completed.

FINISHED

All jobs in the given project are completed.


XTM_JOB_COMPLETION_STATUS – the possible job completion statuses:

Table 25. : XTM_JOB_COMPLETION_STATUS – the possible job completion statuses

Option

Description

IN_PROGRESS

A job is still processing.

FINISHED

A job could not be completed.

ERROR

A job is completed successfully.


XTM_STEP_COMPLETION_STATUS – the possible workflow step completion statuses:

Table 26. : XTM_STEP_COMPLETION_STATUS – the possible workflow step completion statuses

Option

Description

IN_PROGRESS

A workflow step is still processing.

FINISHED

A workflow step is completed successfully.

ERROR

A workflow step is not started.


XTM_AUTOSTEP_COMPLETION_STATUS – the possible completion statuses for auto workflow steps:

Table 27. : XTM_AUTOSTEP_COMPLETION_STATUS – the possible completion statuses for auto workflow steps

Option

Description

SUCCESS

An auto workflow step has been completed successfully.

ERROR

An auto workflow step could not be completed.


XTMJobLockingStatusEnum – the possible job locked statuses:

Table 28. : XTMJobLockingStatusEnum – the possible job locked statuses

Option

Description

LOCKED

A job is locked.


XTMProjectCreatorEnum – provides an option for filtering the projects by project creator:

Table 29. : XTMProjectCreatorEnum – provides an option for filtering the projects by project creator

Option

Description

LOGIN_API_USER

Projects created by the user specified in the LoginAPI object.


XTM_WORKFLOW_ACTIVITY – available workflow states:

Table 30. : XTM_WORKFLOW_ACTIVITY – available workflow states

Option

Description

FINISH

Sets the workflow state as finished.

REOPEN

Reopens the workflow.

RESET

Sets the workflow state as not started.


XTMMoveWorkflowMailing – the possible options for email notifications:

Table 31. : XTMMoveWorkflowMailing – the possible options for email notifications

Option

Description

ENABLED

Email notifications will be sent (default value if not set).

DISABLED

Email notifications will not be sent.


updateJobActivity – the possible job activity statuses:

Table 32. : updateJobActivity – the possible job activity statuses

Option

Description

CANCEL

Cancels processing of a job without removing it from the project.