• Show convenient version of this site
  • Deutsch
  • English
Contact
Newsletter
  • Products
    • ALS
      • Across Language Server
        • Translation Management
        • Terminology Management
        • Translation Memory
      • Editions
      • Interfaces
    • ATE
      • Across Translator Edition
      • Editions
      • Download
      • Across Account
    • Elanion
      • Overview
      • Login
  • Solutions
    • Customers
      • Enterprises
      • Language Service Providers
      • Translators
    • Industries
      • E-Commerce & Trade
      • Pharmaceuticals & medicine
      • IT & Software
    • Departments
      • Marketing & E-Commerce
      • Technical Documentation
      • Software User Interfaces
  • Services
    • Hosting
    • Training
    • Consulting
  • Partners
    • Language Service Providers
    • Universities
  • Company
    • Across Systems
    • News
    • Events
    • Career
    • Contact
  • Knowledge
    • Blog
    • Video Library
    • Case Studies
    • White Papers
    • Fact Sheets
    • File Formats
    • Expert Features
  • Support
    • New Functions
    • Online Help
    • FAQ
    • Support Request
    • Updates
Schedule Consultation
  • Online-Help
  • SDK
  • APIs
  • crossAPI SI
  • List of Objects in crossAPI SI
  • ProjectManager - Overview
  • Part 1
  • General Information
    • Connectors
    • LCIDs
    • GUIDs
    • Paragraph states and flags
    • crossTerm Web
    • crossTransform
      • crossTransform - examples
  • Connecting Third-party Systems
    • crossConnect for content systems
      • Requirements
      • Configuration
        • Configuring the connector
        • Job configuration
        • Testing crossConnect
      • Troubleshooting
    • crossConnect for External Editing
      • Purpose and usage
        • Use case - Machine translation
        • Use Case - Review and QA
        • Use case - Machine review
      • Requirements
      • Implementation
        • Across XLIFF format
          • Across-specific Extensions
          • <xliff> Element Attributes
          • <file> Element Extensions
          • <trans-unit> Element Extension
          • Paragraph States
          • Paragraph State Flags
          • <source> and <target> Element Content
          • <bpt> Element Attributes
          • <ph> Element Attributes
          • <x> Element Attributes
          • Across-specific Properties
          • Analysis Results
          • Sample Files
          • Across XLIFF - import, export and segmentation
          • Context information
          • Exporting best matches in Across XLIFF
          • Hyperlinks to XLIFF
        • Secure file handling with C#
        • Secure file handling with JAVA
        • Workflow and vendor configuration
          • Adding workflows to crossAutomate Host Manager
          • Adjusting preset watchfolders
          • The filter rules
          • External editing workflows
        • Sample code - Integrated solution
    • Generic File Connector
      • Process Overview
      • Exchange Folder Structure
      • Package Format
        • Control File
  • Display Texts
    • Solution approaches
    • The Across solution in detail
    • Requirements
    • Integration
    • The display text format
      • Line height vs. line spacing
      • DT-XML format structure
        • DT-XML - Main elements
        • Children of paragraphStyles and characterStyles
        • Children of the sizeInfos element
        • Children of the paragraph element
        • DT-XML v5 example
        • DT-XML v4 example
    • The display text package
      • Creating a display text package
  • APIs
    • APIs - Technology
    • crossTank API v1
      • Requirements
      • Testing the crossTank API installation
      • OData-URLs in Chrome
      • Example
    • crossTank API v2
      • Requirements
      • QuickStart
        • Searching for Translations
        • Creating Translations
      • crossTank API v2 Overview
        • Finding Translations
        • Creating Translations
        • Translation Properties
        • Formatting and Auto-Adjustment of Formatting and Numbers
      • C# Example
    • crossTerm API v1
      • Scenarios of use
        • Example - usage information
        • Example - finding terms
      • Requirements
      • Special Controllers
      • OData-URLs in Chrome
      • crossTerm API with C#
      • crossTerm API with Java
      • crossTerm API with JavaScript
    • crossTerm API v2
      • Requirements
      • QuickStart
        • Authentication Basics
        • First Request Examples
      • crossTerm API v2 Example in C#
        • Used Functions
      • crossTank API, crossTerm API v2 - Authentication
      • crossTerm API v2 - Examples of Use
        • Finding Terms of Entry
        • Searching Terminology via API
    • crossAPI SI
      • Requirements
      • Function Return Types
      • crossAPI SI and Java
        • Example: hot integration
        • Executing the hot integration example
      • List of Objects in crossAPI SI
        • AssignManager
        • Authorization
        • CheckInManager
        • CheckOutManager
        • CrossTankManager
        • CrossTermManager
        • DocumentManager
        • FileManager
        • LanguageJobManager
        • LanguageManager
        • LicenseManager
        • Message
        • ObjectManager - Overview
          • Part 1
          • Part 2
          • Part 3
        • ReportManager
          • ID values for analysis and analysis-result
        • ProjectManager - Overview
          • Part 1
          • Part 2
          • Attribute Information
        • SqlQuery
        • SystemManager
        • TaskManager
        • WanGridManager - Overview
          • Part 1
          • Part 2
      • Sample - transferring checkout files via FileManager
      • Sample - VBS
    • Text Preprocessing API
      • Introduction
      • How to browse the API
      • Sentence splitting
      • Abbreviations

ProjectManager - Part 1

ProjectManager.AddAttachmentToProject

Adds an attachment to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
string
FilePath
The path to the attachment that should be added.

Return Values

Result
Type/Value
Interpretation
Success
int
The ID of the attachment.
Error
19
Project does not exist.
Error
73
Cannot add attachment.

ProjectManager.AddAttributeToProject

Adds an attribute to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
string
AttributeGuid
The GUID of the attribute.
4
string
AttributeValueGuid
The GUID of the value of the attribute.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
19
Project does not exist.
Error
170
Attribute does not exist.
Error
171
Attribute value does not exist.
Error
172
Cannot add the attribute.
Tip

For builds after v7.0 13387, the function will report success in case the attribute is already set on the project. Previously, the function would report an error in case the attribute was already present.

ProjectManager.AddProjectComment

Adds a comment to a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
string
CommentTitle
The title of the comment.
4
string
CommentText
The text of the comment.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
19
Project does not exist.
Error
57
Unable to add comment to project.

ProjectManager.AddProjectMTLanguagePair

Description

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
string
MtEngineId
The GUID identifying the MT engine to check.
4
int
SourceLanguageLcid
The LCID of the source language.
5
int
TargetLanguageLcid
The LCID of the target language.

Return Values

Result
Type/Value
Interpretation
Success
Error
19
Project does not exist.
Error
203
Given MT engine is disabled
Error
204
MT engine does not contain any language configurations
Error
205
Language configuration with given language pair does not exist

ProjectManager.ArchiveProject

Archives a project or reactivates it.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
bool
ArchiveFlag
Specifies whether the project is to be archived (true) or reactivated (false).

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
19
Project does not exist.
Error
32
Unable to move project to archive. More detailed information can be found in the error description.
Error
109
Cannot revoke the task.

ProjectManager.CancelJob

Cancels the specified job. The function only works for jobs created from ProjectManager functions.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
JobGuid
The GUID of the job.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
17
Job does not exist.
Error
87
Job already finished.
Error
88
Canceling is not supported for the job.

ProjectManager.CreateProject

Creates a new project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
Name
The name of the project.
3
string
ProjectManagerGuid
The GUID of the project manager. If the project does not yet exist and has to be newly created, this user will become the project manager of the newly created project. Can be obtained via the GetUserGuidByLogin function.
4
string
RelationGuid
The GUID of the relation.
5
string
SubjectGuid
The GUID of the subject.

Return Values

Result
Type/Value
Interpretation
Success
string
Contains the GUID of the newly created project.
Error
2
User does not exist.
Error
12
Unable to create project.
Error
13
Relation does not exist.
Error
14
Subject does not exist.
Error
144
Project settings do not exist.
Error
160
The reporting template does not exist.
Tip

Please see this topic for information on how attributes are set.

ProjectManager.CreateProject2

Creates a new project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
Name
The name of the project.
3
int
ProjectID
The ID of the project. Can be an arbitrary number that has not already been used for a different project. If you want to make Across select a number automatically, use "0".
4
DateTime
DeadlineDate
Specifies the due date of the whole project.
5
string
ProjectManagerGuid
The GUID of the project manager. If the project does not yet exist and has to be newly created, this user will become the project manager of the newly created project. Can be obtained via the GetUserGuidByLogin function.
6
string
RelationGuid
The GUID of the relation.
7
string
SubjectGuid
The GUID of the subject.

Return Values

Result
Type/Value
Interpretation
Success
string
Contains the GUID of the newly created project.
Error
2
User does not exist.
Error
12
Unable to create project.
Error
13
Relation does not exist.
Error
14
Subject does not exist.
Error
144
Project settings do not exist.
Error
160
The reporting template does not exist.
Tip

Please see this topic for information on how attributes are set.

ProjectManager.CreateProject3

Creates a new project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
Name
The name of the project.
3
int
ProjectID
The ID of the project. Can be an arbitrary number that has not already been used for a different project. If you want to make Across select a number automatically, use "0".
4
DateTime
DeadlineDate
Specifies the due date of the whole project.
5
string
ProjectManagerGuid
The GUID of the project manager. If the project does not yet exist and has to be newly created, this user will become the project manager of the newly created project. Can be obtained via the GetUserGuidByLogin function.
6
string
RelationGuid
The GUID of the relation.
7
string
SubjectGuid
The GUID of the subject.
8
string
ProjectSettingsGuid
The GUID of a project settings template.

Return Values

Result
Type/Value
Interpretation
Success
string
Contains the GUID of the newly created project.
Error
2
User does not exist.
Error
12
Unable to create project.
Error
13
Relation does not exist.
Error
14
Subject does not exist.
Error
144
Project settings do not exist.
Error
160
The reporting template does not exist.
Tip

Please see this topic for information on how attributes are set.

ProjectManager.CreateProject4

Creates a new project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
Name
The name of the project.
3
int
ProjectID
The ID of the project. Can be an arbitrary number that has not already been used for a different project. If you want to make Across select a number automatically, use "0".
4
DateTime
DeadlineDate
Specifies the due date of the whole project.
5
string
ProjectManagerGuid
The GUID of the project manager. If the project does not yet exist and has to be newly created, this user will become the project manager of the newly created project. Can be obtained via the GetUserGuidByLogin function.
6
string
RelationGuid
The GUID of the relation.
7
string
SubjectGuid
The GUID of the subject.
8
string
ProjectSettingsGuid
The GUID of a project settings template.
9
string
CreatorGuid
The GUID of the user that is listed as creator of the project. Can be obtained via the ObjectManager.GetUserGuidByLogin function.

Return Values

Result
Type/Value
Interpretation
Success
string
Contains the GUID of the newly created project.
Error
2
User does not exist.
Error
12
Unable to create project.
Error
13
Relation does not exist.
Error
14
Subject does not exist.
Error
144
Project settings do not exist.
Error
160
The reporting template does not exist.
Tip

Please see this topic for information on how attributes are set.

ProjectManager.CreateProject5

Creates a new project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
Name
The name of the project.
3
int
ProjectID
The ID of the project. Can be an arbitrary number that has not already been used for a different project. If you want to make Across select a number automatically, use "0".
4
DateTime
DeadlineDate
Specifies the due date of the whole project.
5
string
ProjectManagerGuid
The GUID of the project manager. If the project does not yet exist and has to be newly created, this user will become the project manager of the newly created project. Can be obtained via the GetUserGuidByLogin function.
6
string
RelationGuid
The GUID of the relation.
7
string
SubjectGuid
The GUID of the subject.
8
string
ProjectSettingsGuid
The GUID of a project settings template.
9
string
CreatorGuid
The GUID of the user that is listed as creator of the project. Can be obtained via the ObjectManager.GetUserGuidByLogin function.
10
string
ReportSettingsGuid
The GUID of the report settings template. Can be obtained via the ObjectManager.GetReportTemplateGuidByName function.

Return Values

Result
Type/Value
Interpretation
Success
string
Contains the GUID of the newly created project.
Error
2
User does not exist.
Error
12
Unable to create project.
Error
13
Relation does not exist.
Error
14
Subject does not exist.
Error
144
Project settings do not exist.
Error
160
The reporting template does not exist.
Tip

Please see this topic for information on how attributes are set.

ProjectManager.CreateProjectSettings

Creates a new project settings template.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
Name
The name of the new project settings template.
3
string
Description
The description of the new project settings template.
4
string
XMLSettings
The project settings as XML. See info below for more details.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the newly created project settings.
Error
98
Cannot load XML content.
Error
147
Cannot create project settings.

Find the ProjectSettings.xsd here or in the installation folder of the SDK: %ProgramFiles%\across\across SDK\Tools\crossAPI SI\ProjectSettings.xsd

ProjectManager.CreateTemporaryProject

Creates a project that is not stored in the database and only exists in the memory of crossAPI.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
Name
The name of the project.
3
int
ProjectID
The ID of the project. Can be an arbitrary number that has not already been used for a different project. If you want to make Across select a number automatically, use "0".
4
DateTime
DeadlineDate
Specifies the due date of the whole project.
5
string
ProjectManagerGuid
The GUID of the project manager. If the project does not yet exist and has to be newly created, this user will become the project manager of the newly created project. Can be obtained via the GetUserGuidByLogin function.
6
string
RelationGuid
The GUID of the relation.
7
string
SubjectGuid
The GUID of the subject.
8
string
ProjectSettingsGuid
The GUID of a project settings template.
9
string
CreatorGuid
The GUID of the user that is listed as creator of the project. Can be obtained via the ObjectManager.GetUserGuidByLogin function.

Return Values

Result
Type/Value
Interpretation
Success
string
Contains the GUID of the newly created project.
Error
2
User does not exist.
Error
12
Unable to create project.
Error
13
Relation does not exist.
Error
14
Subject does not exist.
Error
144
Project settings do not exist.
Error
160
The reporting template does not exist.
Attention

Temporary projects are lost when crossAPI is stopped or restarted.

Since the project is not stored in the database, reports generated for the project do not contain any matches. For cost estimaton purposes, it is advisable to create projects using one of the ProjectManager.CreateProject functions and to remove the project when it is no longer needed using ProjectManager.RemoveProject or ProjectManager.RemoveProject2.

ProjectManager.DuplicateProject

Copies a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
bool
KeepOriginalAssignments
If false, the task assignments are switched to the copied project.

Return Values

Result
Type/Value
Interpretation
Success
string
Contains the GUID of the new project.
Error
19
Project does not exist.
Error
37
Unable to copy project. More detailed information can be found in the error description.

ProjectManager.DuplicateProjectAsync

Creates a job to copy a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
bool
KeepOriginalAssignments
If false, the task assignments are switched to the copied project.

Return Values

Result
Type/Value
Interpretation
Success
string
Contains the GUID of the new project.
Error
18
Unable to create job.
Error
19
Project does not exist.

ProjectManager.ExportProject

Exports a project to a file, e.g. as backup.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
bool
ProjectPath
The file that should receive the export.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
19
Project does not exist.
Error
101
Cannot export project.

ProjectManager.ExportProject2

Exports one or more projects to a file so it can be backed up or easily transferred to another server.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DataSelector
An XML structure that defines which projects, documents etc. to export. See the remarks for a detailed description.
3
string
ExportPath
The file that should receive the export.
4
int
PackageVersion
Attention

In v7 and later please specify -1 or specify the latest version directly. A downgrade is no longer supported.

Before v7: The version of the package file format to be used.
  • The following values are valid:
  • 1 - corresponds to the DB version 326
  • 2 - corresponds to the DB version 327
  • 3 - corresponds to the DB version 328
  • 4 - corresponds to the DB version 329
  • 19 - corresponds to the DB version 344
To automatically use the latest package version specify -1.
With Across version 6.3 7720 or higher it is possible to specify -1 to use the latest package version.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
101
Cannot export project.

ProjectManager.ExportProject3

Exports one or more projects to a file so it can be backed up or easily transferred to another server.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DataSelector
An XML structure that defines which projects, documents etc. to export. See the remarks for a detailed description.
3
string
ExportPath
The file that should receive the export.
4
int
PackageVersion
Attention

In v7 and later please specify -1 or specify the latest version directly. A downgrade is no longer supported.

Before v7: The version of the package file format to be used.
  • The following values are valid:
  • 1 - corresponds to the DB version 326
  • 2 - corresponds to the DB version 327
  • 3 - corresponds to the DB version 328
  • 4 - corresponds to the DB version 329
  • 19 - corresponds to the DB version 344
To automatically use the latest package version specify -1.
With Across version 6.3 7720 or higher it is possible to specify -1 to use the latest package version.
5
bool
ExportParagraphHistory
Indicates if the export should contain the paragraph history. This history is needed in case change tracking information should be exported.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
101
Cannot export project.

You can find the ExportProjectSettings.xsd here or in the installation folder of the SDK: %ProgramFiles%\across\across SDK\Tools\crossAPI SI\ExportProjectSettings.xsd

ProjectManager.ExportProjectAsync

Exports a project to a file so it can be backed up or easily transferred to another server.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
bool
ProjectPath
The file that should receive the export.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the export job.
Error
18
Unable to create job.
Error
19
Project does not exist.
Error
101
Cannot export project.

ProjectManager.ExportProjectAsync2

Exports one or more projects to a file so it can be backed up or easily transferred to another server.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DataSelector
An XML structure that defines which projects, documents etc. to export. See the remarks for a detailed description.
3
string
ExportPath
The file that should receive the export.
4
int
PackageVersion
Attention

In v7 and later please specify -1 or specify the latest version directly. A downgrade is no longer supported.

Before v7: The version of the package file format to be used.
  • The following values are valid:
  • 1 - corresponds to the DB version 326
  • 2 - corresponds to the DB version 327
  • 3 - corresponds to the DB version 328
  • 4 - corresponds to the DB version 329
  • 19 - corresponds to the DB version 344
To automatically use the latest package version specify -1.
With Across version 6.3 7720 or higher it is possible to specify -1 to use the latest package version.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
18
Unable to create job.
Error
101
Cannot export project.

You can find the ExportProjectSettings.xsd here or in the installation folder of the SDK: %ProgramFiles%\across\across SDK\Tools\crossAPI SI\ExportProjectSettings.xsd

ProjectManager.ExportProjectAsync3

Exports one or more projects to a file so it can be backed up or easily transferred to another server.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DataSelector
An XML structure that defines which projects, documents etc. to export. See the remarks for a detailed description.
3
string
ExportPath
The file that should receive the export.
4
int
PackageVersion
Attention

In v7 and later please specify -1 or specify the latest version directly. A downgrade is no longer supported.

Before v7: The version of the package file format to be used.
  • The following values are valid:
  • 1 - corresponds to the DB version 326
  • 2 - corresponds to the DB version 327
  • 3 - corresponds to the DB version 328
  • 4 - corresponds to the DB version 329
  • 19 - corresponds to the DB version 344
To automatically use the latest package version specify -1.
With Across version 6.3 7720 or higher it is possible to specify -1 to use the latest package version.
5
bool
ExportParagraphHistory
Indicates if the export should contain the paragraph history. This history is needed in case change tracking information should be exported.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
18
Unable to create job.
Error
101
Cannot export project.

You can find the ExportProjectSettings.xsd here or in the installation folder of the SDK: %ProgramFiles%\across\across SDK\Tools\crossAPI SI\ExportProjectSettings.xsd

ProjectManager.GetAllProjects

Returns all projects in Across.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUIDs of the projects as string[] array.

ProjectManager.GetAllProjectsCSV

Returns all projects in Across.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUIDs of the projects, separated by semicolons.

ProjectManager.GetAutomaticallyLoadUnloadedProjects

Tells whether an unloaded project is automatically loaded if needed, e.g. when trying to get a property like the finish date.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.

Return Values

Result
Type/Value
Interpretation
Success
int/bool
true if a project is automatically loaded when needed, false otherwise.

ProjectManager.GetFinishDate

Gets the finish date of the project specified by the GUID.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.

Return Values

Result
Type/Value
Interpretation
Success
DateTime
The finish date of the project.
Error
19
Project does not exist.

ProjectManager.GetJobProgress

Returns the progress of a job. The function only works for jobs created from ProjectManager functions.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
JobGuid
The GUID of the job.

Return Values

Result
Type/Value
Interpretation
Success
int
The progress of the job in percent.
Error
17
Job does not exist.
Error
21
Job has been canceled.
Tip

Other return values are possible. They depend on the executed job and mean the job itself failed.

Attention

Do not use this method to find out whether a job is finished or not. A progress of 100 does not necessarily mean that the job is finished already. Use GetJobStatus instead.

ProjectManager.GetJobResult

Returns the result of a finished job. The function only works for jobs created from ProjectManager functions.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
JobGuid
The GUID of the job.

Return Values

Result
Type/Value
Interpretation
Success
The data of the job. The type of the return value depends on the job.
Error
17
Job does not exist.
Error
21
Job has been canceled.
Error
43
The job has not yet been completed.
Tip

Other return values are possible. They depend on the executed job and mean the job itself failed.

ProjectManager.GetJobStatus

Returns the status of a job. The function only works for jobs created from ProjectManager functions.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
JobGuid
The GUID of the job.

Return Values

Result
Type/Value
Interpretation
Success
int
The status of the job.
  • The following values are possible:
  • 0 - in progress
  • 1 - finished successfully
  • 2 - finished with errors
Error
17
Job does not exist.

ProjectManager.GetOrCreateProject

Returns the GUID of a project according to its name, its relation and its subject. If there is no project that matches these criteria, one will be created.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
Name
The name of the project.
3
string
ProjectManagerGuid
The GUID of the project manager. If the project does not yet exist and has to be newly created, this user will become the project manager of the newly created project. Can be obtained via the GetUserGuidByLogin function.
4
string
RelationGuid
The GUID of the relation.
Is used for both searching for the project and for creating a new project.
5
string
SubjectGuid
The GUID of the subject.
Is used for both searching for the project and for creating a new project.

Return Values

Result
Type/Value
Interpretation
Success
string
Contains the GUID of the created project.
Error
2
User does not exist.
Error
12
Unable to create project.
Error
13
Relation does not exist.
Error
14
Subject does not exist.
Error
144
Project settings do not exist.
Error
160
The reporting template does not exist.

ProjectManager.GetProjectAttachmentList

Returns the list of the attachments of the project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.

Return Values

Result
Type/Value
Interpretation
Success
string
The attachments of the project as XML.
Error
19
Project does not exist.
<?xmlversion="1.0"encoding="UTF-16"?><Attachments><AttachmentName="TestFile.doc"ID="6"/></Attachments>

To save project attachments, see ObjectManager.SaveAttachment or ProjectManager.SaveProjectAttachment.

ProjectManager.GetProjectAttributesList

Returns the descriptions of the attributes of a project as XML.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.

Return Values

Result
Type/Value
Interpretation
Success
string
The list of attributes that have values for a project as XML.
Error
19
Project does not exist.
<?xmlversion="1.0"encoding="UTF-16"?><Attributes><AttributeName="References"Guid="aa325813-3578-458c-b05b-434fba9aa7ec"/><AttributeName="Subjects"Guid="8698f741-f1c9-49c3-b551-1202da84b447"/></Attributes>

ProjectManager.GetProjectAttributeValuesList

Returns the description of the values of the attribute of a project as XML.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.
3
string
AttributeGuid
The GUID of the attribute.

Return Values

Result
Type/Value
Interpretation
Success
string
The the list of the values of the attribute for the a project as XML.
Error
19
Project does not exist.
Error
170
Attribute does not exist.
<?xmlversion="1.0"encoding="UTF-16"?><AttributeValues><AttributeValueValue="Product Group 1"Guid="708fc609-343e-45a1-858c-fe4895486dfa"Default="false"/></AttributeValues>

ProjectManager.GetProjectComments

Returns the comments of a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.

Return Values

Result
Type/Value
Interpretation
Success
string
The comments as an XML structure. See info below for details on the exact structure.
Error
19
Project does not exist.
Error
77
Cannot load comments.

This function does NOT give access to paragraph comments.

The returned XML structure has the following layout:

<Comments> 
<Comment Date="[Date]" Time="[Time]" Author="[Author]" Title="[Title]" ID="[ID]"> 
[Text] 
</Comment> 
<Comment Date="[Date]" Time="[Time]" Author="[Author]" Title="[Title]" ID="[ID]"> 
[Text] 
</Comment> 
<Comment Date="[Date]" Time="[Time]" Author="[Author]" Title="[Title]" ID="[ID]"> 
[Text] 
</Comment> 
... 
</Comments>

Date and Time are formatted according to the current locale.

ProjectManager.GetProjectDeadline

Returns the due date of a specific project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.

Return Values

Result
Type/Value
Interpretation
Success
DateTime
The due date of the project.
Error
19
Project does not exist.

ProjectManager.GetProjectDescription

Returns the description of a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.

Return Values

Result
Type/Value
Interpretation
Success
string
The description of a project.
Error
19
Project does not exist.

ProjectManager.GetProjectDocuments

Returns the documents of a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.

Return Values

Result
Type/Value
Interpretation
Success
string
he GUIDs of the documents, separated by semicolons.
Error
19
Project does not exist.

ProjectManager.GetProjectDocumentsCount

Returns the number of documents in a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.

Return Values

Result
Type/Value
Interpretation
Success
int
The number of documents in the project.
Error
19
Project does not exist.

ProjectManager.GetProjectGuidByJobGuid

Returns the GUID of a project according to the GUID of a currently running job.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
JobGuid
The GUID of the job.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the project.
Error
17
Job does not exist.
Error
43
The job has not yet been completed.

ProjectManager.GetProjectID

Returns the ID of a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.

Return Values

Result
Type/Value
Interpretation
Success
int
The ID of the project.
Error
19
Project does not exist.

ProjectManager.GetProjectName

Returns the name of a project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.

Return Values

Result
Type/Value
Interpretation
Success
string
The name of the project.
Error
19
Project does not exist.
Register for our Newsletter now

Our newsletter provides you with exclusive news about the Across Language Server, often even before the official announcement. The newsletter also provides you with early information on events, webinars, and training sessions.

  • Legal Notice
  • GTC
  • Privacy Statement
  • Cookies
  • info@across.net