ObjectManager - Part 2
ObjectManager.GetDocumentAttachmentList
Returns a list of the attachments of a specific document.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | DocumentGuid | The GUID of the document for which the attachment list should be returned. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The attachments as an XML structure. See the info below for details on the exact structure. |
Error | 15 | Language does not exist. |
Error | 16 | Document does not exist. |
The returned XML structure has the following layout:
<?xmlversion="1.0"encoding="UTF-16"?><Attachments><AttachmentName="[File-Name]"ID="[DB-ID]"/><AttachmentName="[File-Name]"ID="[DB-ID]"/><AttachmentName="[File-Name]"ID="[DB-ID]"/> ... </Attachments>
To save attachments, see ObjectManager.SaveAttachment.
ObjectManager.GetDocumentComments
Returns the comments of a document.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | DocumentGuid | The GUID of the document for which the comments should be retrieved. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The comments as an XML structure. See info below for details on the exact structure. |
Error | 16 | Document does not exist. |
Error | 77 | Cannot load comments. |
The returned XML structure has the following layout:
<Comments><CommentDate="[Date]"Time="[Time]"Author="[Author]"Title="[Title]"> [Text] </Comment><CommentDate="[Date]"Time="[Time]"Author="[Author]"Title="[Title]"> [Text] </Comment><CommentDate="[Date]"Time="[Time]"Author="[Author]"Title="[Title]"> [Text] </Comment> ... </Comments>
Date and Time are formatted according to the current locale.
ObjectManager.GetDocumentLanguages
Returns all languages of the document. The source language is the first one in the list.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | DocumentGuid | The GUID of the document for which the languages should be retrieved. |
Return Values
Result | Type/Value | Interpretation |
Success | string | A list of LCIDs. Separated by semicolons. |
Error | 16 | Document does not exist. |
ObjectManager.GetDocumentName
Returns the name of the document with the specified GUID.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | DocumentGuid | The GUID of the document for which the name should be retrieved. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The name of the document. |
Error | 16 | Document does not exist. |
ObjectManager.GetDocumentParagraphCount
Returns the number of paragraphs in a document.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | DocumentGuid | The GUID of the document. |
Return Values
Result | Type/Value | Interpretation |
Success | int | The number of paragraphs in the document. |
Error | 16 | Document does not exist. |
ObjectManager.GetDocumentTemplateGuidByName
Returns the GUID of a document template according to its name.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | Name | The name of the document template. |
Return Values
Result | Type/Value | Interpretation |
Success | string | Contains the GUID of the document template. |
Error | 28 | Document template does not exist. |
Since this function has no parameter for the document type, it will return a document template with the specified name. In case there are multiple templates with the same name (e.g. Default for Visual XML and Default for Tagged XML), this function returns one of these templates. Which one is undefined. Generally, it is advised to use GetDocumentTemplateGuidByName2.
ObjectManager.GetDocumentTemplateGuidByName2
Returns the GUID of a document template according to its name which belongs to a specific document type.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | Name | The name of the document template. |
3 | string | DocumentTypeGuid | The GUID of the document type to which the returned template belongs. |
Return Values
Result | Type/Value | Interpretation |
Success | string | Contains the GUID of the document template. |
Error | 28 | Document template does not exist. |
Error | 56 | Document type is not supported. |
ObjectManager.GetDocumentWorkflow
Returns the workflow that has been assigned to the specified document.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | DocumentGuid | The GUID of the document. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the assigned workflow. |
Error | 16 | Document does not exist. |
ObjectManager.GetFinishedDocumentLanguages
Returns the fully translated languages for a document.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | DocumentGuid | The GUID of the document. |
Return Values
Result | Type/Value | Interpretation |
Success | string | Contains the LCIDs of the completely translated languages, separated by semicolons. |
Error | 16 | Document does not exist. |
ObjectManager.GetGroupIdByName
Returns the ID of an Across user group.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | GroupName | The name of the group for which the ID should be returned. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The ID of the group with the specified name. |
Error | 49 | The user group does not exist. |
ObjectManager.GetGroupIdsByName
Returns the IDs of the groups with the specified name.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | GroupName | The group name that should be searched for. |
Return Values
Result | Type/Value | Interpretation |
Success | int | The IDs of the found groups. |
Error | 49 | The user group does not exist. |
ObjectManager.GetGroupIdsByNameCSV
Returns the IDs of the groups with the specified name.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | GroupName | The group name that should be searched for. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The IDs of the found groups as a semicolon-separated list. |
Error | 49 | The user group does not exist. |
ObjectManager.GetGroupIDsByUserGuid
Returns the IDs of the groups to which the user belongs
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserGuid | The GUID of the user. |
Return Values
Result | Type/Value | Interpretation |
Success | int | The IDs of the groups the the user belongs to. |
Error | 2 | User does not exist. |
ObjectManager.GetGroupIDsByUserGuidCSV
Returns the IDs of the groups to which the user belong as semi-colon separated list.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserGuid | The GUID of the user. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The IDs of the groups as a semicolon-separated list. |
Error | 2 | User does not exist. |
ObjectManager.GetGroupNameByID
Returns the name of the group with the specified ID.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | int | GroupID | The ID of the group for which the name should be returned. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The name of the group. |
Error | 49 | The user group does not exist. |
ObjectManager.GetLanguageAttachmentList
Returns a list of the attachments of a language of a specific document.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | DocumentGuid | The GUID of the document to which the language belongs. |
3 | int | LanguageLcid | The LCID of the language for which the attachment list should be returned. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The attachments as an XML structure. See info below for details on the exact structure. |
Error | 15 | Language does not exist. |
Error | 16 | Document does not exist. |
The returned XML structure has the following layout:
<?xmlversion="1.0"encoding="UTF-16"?><Attachments><AttachmentName="[File-Name]"ID="[DB-ID]"/><AttachmentName="[File-Name]"ID="[DB-ID]"/><AttachmentName="[File-Name]"ID="[DB-ID]"/> ... </Attachments>
ObjectManager.GetLanguageComments
Returns the comments of a language.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | DocumentGuid | The GUID of the document for which the comments should be retrieved. |
3 | int | LanguageLcid | The LCID of the language for which the comments should be retrieved. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The comments as an XML structure. See info below for details on the exact structure. |
Error | 15 | Language does not exist. |
Error | 16 | Document does not exist. |
Error | 77 | Cannot load comments. |
The returned XML structure has the following layout:
<Comments><CommentDate="[Date]"Time="[Time]"Author="[Author]"Title="[Title]"> [Text] </Comment><CommentDate="[Date]"Time="[Time]"Author="[Author]"Title="[Title]"> [Text] </Comment><CommentDate="[Date]"Time="[Time]"Author="[Author]"Title="[Title]"> [Text] </Comment> ... </Comments>
Date and Time are formatted according to the current locale.
ObjectManager.GetLanguageParagraphCountByState
Returns the number of paragraphs in the target language of a certain document that have a certain (Untouched, Touched, Translated, Checked, etc.) paragraph state.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | DocumentGuid | The GUID of the document. |
3 | int | TargetLanguageLcid | The LCID of a target language within the given document from which the number of paragraphs with a certain state should be counted. |
4 | string | StateGuid | The GUID of a paragraph state from which the number of existing paragraphs should be counted. The GUID can be obtained via the GetParagraphStateGuidByName function. |
Return Values
Result | Type/Value | Interpretation |
Success | int | The number of paragraphs with the assigned state in the assigned target language in the assigned document. |
Error | 15 | Language does not exist. |
Error | 16 | Document does not exist. |
Error | 23 | This document format is not supported. Across checks this according to the document extension and not to the content. When a file is checked in or updated, Across first checks whether the document extension is supported and only then if the file is present at the given location. |
Error | 41 | The paragraph state does not exist. |
ObjectManager.GetLanguageRatingsForUser
Returns the language ratings for the specified Across user.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserGuid | The GUID of the user. |
3 | int | SourceLanguageLcid | The LCID of the source language. |
4 | int | TargetLanguageLcid | The LCID of the target language. |
Return Values
Result | Type/Value | Interpretation |
Success | string | An XML structure containing all ratings of the specified Across user with the specified source and target language. It has the following form: <Ratings><RatingValue="8"SubjectGuid="0E9A4B4C-1893-4cac-B3B0-F0B190DF3274"/></Ratings> |
Error | 2 | User does not exist. |
Error | 15 | Language does not exist. |
ObjectManager.GetLanguageRatingsForUser2
Returns all language ratings of the specified Across user.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserGuid | The GUID of the user. |
Return Values
Result | Type/Value | Interpretation |
Success | string | An XML structure containing all ratings of the specified Across user with the specified source and target language. It has the following form: <Ratings><RatingValue="8"SubjectGuid="0E9A4B4C-1893-4cac-B3B0-F0B190DF3274"SourceLanguage="1031"TargetLanguage="1033"/><RatingValue="8"SubjectGuid="0E9A4B4C-1893-4cac-B3B0-F0B190DF3274"SourceLanguage="1031"TargetLanguage="1872"/> ... </Ratings> |
Error | 2 | User does not exist. |
ObjectManager.GetLanguageWordCountByState
Returns the number of words in the target language of a certain document that have a certain (Untouched, Touched, Translated, Checked, etc.) paragraph state.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | DocumentGuid | The GUID of the document. |
3 | int | TargetLanguageLcid | The LCID of a target language within the given document from which the number of words with a certain state should be counted. |
4 | string | StateGuid | The GUID of a paragraph state from which the number of words should be counted. The GUID can be obtained via the GetParagraphStateGuidByName function. |
Return Values
Result | Type/Value | Interpretation |
Success | int | The number of words with the assigned state in the assigned target language in the assigned document. |
Error | 15 | Language does not exist. |
Error | 16 | Document does not exist. |
Error | 23 | This document format is not supported. Across checks this according to the document extension and not to the content. When a file is checked in or updated, Across first checks whether the document extension is supported and only then if the file is present at the given location. |
Error | 41 | The paragraph state does not exist. |
ObjectManager.GetMainSubjects
Returns the GUIDs of the main subjects.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | bool | IncludeGrid | True if the Grid should be included, false otherwise. |
Return Values
Result | Type/Value | Interpretation |
Success | string[] | The GUIDs of the main subjects. |
ObjectManager.GetMainSubjectsCSV
Returns the GUIDs of t he main subjects as semi-colon separated values.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | bool | IncludeGrid | True if the Grid should be included, false otherwise. |
Return Values
Result | Type/Value | Interpretation |
Success | bool | The GUIDs of the main subjects as semicolon-separated values. |
ObjectManager.GetOrCreateProject
Returns the GUID of a project according to its name, relation and subject. If no project matches these criteria, one will then 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 a relation. It is used for both searching for the relation and creating a new relation. Can be obtained via the GetRelationGuidByName function. |
5 | string | SubjectGuid | The GUID of a subject. It is used for both searching for the subject and for creating a new subject. Can be obtained via the GetSubjectGuidByName function. |
Return Values
Result | Type/Value | Interpretation |
Success | string | Contains the GUID of the 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. |
ObjectManager.GetOrCreateRelation
Returns the GUID of a relation according to its name. If no relation exists with this name, one will then 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 relation. |
Return Values
Result | Type/Value | Interpretation |
Success | string | Contains the GUID of the created relation. |
Error | 11 | Unable to create relation. |
ObjectManager.GetParagraphStateGuidByName
Returns the GUID of a paragraph state according to its name.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | Name | The name of the paragraph state. |
Return Values
Result | Type/Value | Interpretation |
Success | string | Contains the GUID of the paragraph state. |
Error | 41 | The paragraph state does not exist. |
ObjectManager.GetParagraphStatesGuidsByName
Returns the GUIDs of all paragraph states with the specified name.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | Name | The name of the paragraph state. |
Return Values
Result | Type/Value | Interpretation |
Success | string | An array of the GUIDs of the paragraph states that match the specified name. |
Error | 41 | The paragraph state does not exist. |
ObjectManager.GetParagraphStatesGuidsByNameCSV
Returns the GUIDs of all paragraph states with the specified name.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | Name | The name of the paragraph state. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUIDs of the paragraph states that match the specified name. Separated by semicolons. |
Error | 41 | The paragraph state does not exist. |
ObjectManager.GetProfileByUserGUID
Returns the user settings of a specified user.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserGuid | The GUID of the user. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The settings of the user in XML format. |
Error | 2 | User does not exist. |
Error | 155 | Cannot load profile. |
ObjectManager.GetProfileTemplateGuidByName
Returns the GUID of the user settings template which can be assigned to a user.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | Name | The name of the user settings template. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the profile. |
ObjectManager.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. |
ObjectManager.GetProjectStatus
Returns the status 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 | Contains the progress of a project in percent. The figure states how many percent of the existing languages have already been completely translated. |
Error | 19 | Project does not exist. |
ObjectManager.GetReferences
Returns the relation GUIDs.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | bool | IncludeGrid | True if the Grid should be included, false otherwise. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUIDs of the relations. |
ObjectManager.GetReferencesCSV
Returns the relation GUIDs as semicolon-separated values.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | bool | IncludeGrid | True if the Grid should be included, false otherwise. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUIDs of the relations as semicolon-separated values. |
ObjectManager.GetRelationComments
With Across v7.0, this function is no longer supported.
Returns the comments of a relation.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | RelationGuid | The GUID of the relation for which the comments should be retrieved. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The comments as an XML structure. See info below for details on the exact structure. |
Error | 13 | Relation does not exist. |
Error | 77 | Cannot load comments. |
Error | 230 | v7.0 only: The function is not supported. |
The returned XML structure has the following layout:
<Comments><CommentDate="[Date]"Time="[Time]"Author="[Author]"Title="[Title]"> [Text] </Comment><CommentDate="[Date]"Time="[Time]"Author="[Author]"Title="[Title]"> [Text] </Comment><CommentDate="[Date]"Time="[Time]"Author="[Author]"Title="[Title]"> [Text] </Comment> ... </Comments>
Date and Time are formatted according to the current locale.
ObjectManager.GetRelationGuidByName
Returns the GUID of a relation according to its name.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | Name | The name of the relation. |
Return Values
Result | Type/Value | Interpretation |
Success | string | Contains the GUID of the relation. |
Error | 13 | Relation does not exist. |
ObjectManager.GetRelationID
Returns the ID of the relation as specified in the properties of the relation.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | RelationGuid | The GUID of the relation for which the ID should be returned. |
Return Values
Result | Type/Value | Interpretation |
Success | int | The ID of the relation as it is specified in the properties of the relation. |
Error | 13 | Relation does not exist. |
ObjectManager.GetRelationNameByGuid
Returns the name of a relation according to its GUID.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | RelationGuid | The GUID of the relation for which the name should be returned. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The name of the relation. |
Error | 13 | Relation does not exist. |
ObjectManager.GetReportTemplateGuidByName
Returns the GUID of the report 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 report template. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the report template. |
ObjectManager.GetReportTemplateNameByGuid
Returns the name of the report template.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | Guid | The GUID of the template. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The name of the report template. |
ObjectManager.GetSubjectGuidByName
Returns the GUID of a subject according to its name.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | MainName | The main subject (e.g. Technology). |
3 | string | SubName | The sub-subject (e.g. Internet). |
Return Values
Result | Type/Value | Interpretation |
Success | string | Contains the GUID of the subject. |
Error | 14 | Subject does not exist. |
ObjectManager.GetSubjectNameByGuid
Returns the name of a subject according to its GUID.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | SubjectGuid | The GUID of the subject for which the name should be returned. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The name of the subject. |
ObjectManager.GetTaskDeadline
Returns the due date of a specific task.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | DocumentGuid | The GUID of the document to which the task belongs. |
3 | int | SourceLanguageLcid | The LCID of the source language. |
4 | int | TargetLanguageLcid | The LCID of the target language. |
5 | string | TaskTemplateGuid | The GUID of the task template. |
Return Values
Result | Type/Value | Interpretation |
Success | DateTime | The due date of the task. |
Error | 53 | Task does not exist. |
ObjectManager.GetTaskProgress
Returns the progress of a task in percent.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | DocumentGuid | The GUID of the document to which the task belongs. |
3 | int | SourceLanguageLcid | The LCID of the source language. |
4 | int | TargetLanguageLcid | The LCID of the target language. |
5 | string | TaskTemplateGuid | The GUID of the task template. |
Return Values
Result | Type/Value | Interpretation |
Success | int | The progress of the task in percent. |
Error | 53 | Task does not exist. |