ObjectManager - Part 1

ObjectManager.AddAttachmentToDocument

This function lets you add an attachment to 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 to which the attachment should be added.
3	string	FilePath	The path to the attachment that should be added.

Return Values

Result	Type/Value	Interpretation
Success	int	Database ID of attachment.
Error	73	Cannot add attachment.

ObjectManager.AddAttachmentToLanguage

Adds an attachment to the language 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 to which the attachment should be added.
3	int	LanguageLcid	The LCID of the language to which the attachment should be added.
4	string	FilePath	The path to the attachment that should be added.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	15	Language does not exist.
Error	16	Document does not exist.
Error	73	Cannot add attachment.

ObjectManager.AddDocumentComment

Adds a comment 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 to which the comment should be added.
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	16	Document does not exist.
Error	60	Unable to add comment to document.

ObjectManager.AddLanguageComment

Adds a comment to the language 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 to which the comment should be added.
3	int	LanguageLcid	The LCID of the language from the document to which the comment should be added.
4	string	CommentTitle	The title of the comment.
5	string	CommentText	The text of the comment.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	15	Language does not exist.
Error	16	Document does not exist.
Error	61	Unable to add comment to language.

ObjectManager.AddLanguageRatingToUser

Adds a language rating to the 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.
3	int	SourceLanguageLcid	The LCID of the source language.
4	int	TargetLanguageLcid	The LCID of the target language.
5	string	SubjectGuid	The GUID of the subject for which this rating should be added.
6	int	Rating	The actual user rating from 1 (=Perfect) to 8 (=Unknown).

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	2	User does not exist.
Error	14	Subject does not exist.
Error	15	Language does not exist.
Error	105	Cannot add rating.
Error	106	Rating already exists.
Error	108	crossGrid user cannot be edited.

ObjectManager.AddLanguageToDocument

Adds another target language 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 to which the language should be added.
3	int	TargetLanguageLcid	The LCID of the target language.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	15	Language does not exist.
Error	16	Document does not exist.
Error	113	Language already exists for this document.
Error	114	Cannot add language.
Error	116	The language is involved in crossGrid process and cannot be edited or deleted.

ObjectManager.AddRelationComment

Attention

With Across v7.0, this function is no longer supported.

Adds a comment to the specified 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 to which the comment should be added. This GUID can be retrieved via CreateRelation, CreateRelation2 or GetOrCreateRelation.
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	13	Relation does not exist.
Error	58	Unable to add comment to relation.
Error	230	v7.0 only: The function is not supported.

ObjectManager.AddUserComment

Attention

With Across v7.0, this function is no longer supported.

Adds a comment to a 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	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	2	User does not exist.
Error	62	Unable to add comment to user.
Error	230	v7.0 only: The function is not supported.

ObjectManager.AddUserToGroup

Adds a user to a specified user group.

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	string	GroupID	The GUID of the group.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.

ObjectManager.ArchiveProject

Archives or reactivates 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	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.

ObjectManager.BinaryCompare

Compares two files binary, to tell if both are the same.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	string	FilePath	The path of the external file that is to be compared with the checked in document.
3	string	DocumentGuid	The GUID of the checked in document.

Return Values

Result	Type/Value	Interpretation
Success	bool	true if the files are the same, false otherwise.
Error	16	Document does not exist.
Error	71	File not found.
Error	162	Cannot compare files.

ObjectManager.CheckUserRight

Checks if a user has a specific right.

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	RightID	The ID number of the right that has to be checked. UserRights

Return Values

Result	Type/Value	Interpretation
Success	bool	true if the user has the right, false otherwise.
Error	2	User does not exist.

Tip

Please see this topic for RightID values.

ObjectManager.CreateGroup

Creates a new Across user group.

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 group.
3	string	Description	The description of the new group.
4	int	BaseGroupID	The ID of the base group. This group will be used to initialize the settings of the new group.
5	string	GroupRightsXML	The rights of this group as an XML. Group rights which are not specified will be used from the base group.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	49	The user group does not exist.
Error	149	Cannot create group.

Tip

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

ObjectManager.CreateMainSubject

Creates a main subject.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	string	MainName	The name of the main subject to be created.

Return Values

Result	Type/Value	Interpretation
Success	string	Contains the GUID of the created main subject.
Error	34	Unable to create subject. More detailed information can be found in the error description.

ObjectManager.CreateProject

Creates a new project.

Parameters

	Type	Name	Description
1	string	ST
2	string	Name
3	string	ProjectManagerGuid
4	string	RelationGuid
5	string	SubjectGuid

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.

Tip

This function will create a new project, even if a project with this name already exists.

ObjectManager.CreateRelation

Creates a new relation.

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 to be created.

Return Values

Result	Type/Value	Interpretation
Success	string	Contains the GUID of the created relation.
Error	11	Unable to create relation.

ObjectManager.CreateRelation2

Creates a new relation.

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 to be created.
3	int	RelationID	The ID of the relation to be created.
4	string	Web	The web address of the object to be created.

Return Values

Result	Type/Value	Interpretation
Success	string	Contains the GUID of the created relation.
Error	11	Unable to create relation.

Tip

This function creates a new relation in every case. Even if a relation with this name already exists, a further relation will still be created.

ObjectManager.CreateSubSubject

Creates a sub-subject.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	string	MainName	The name of the main subject to which the new sub-subject should be added.
3	string	SubName	The name of the sub-subject to be created.

Return Values

Result	Type/Value	Interpretation
Success	string	Contains the GUID of the created sub-subject.
Error	14	Subject does not exist.
Error	34	Unable to create subject. More detailed information can be found in the error description.

ObjectManager.CreateUser

Creates a new Across user.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	string	Login	The login of the new user.
3	string	Password	The password of the user.
4	bool	IsOfflineUser	Specifies whether the new user is an offline user or not.
5	bool	IsWindowsUser	Specifies whether the new user will be authorized by Windows or not.
6	string	FirstName	The first name of the new user.
7	string	LastName	The last name of the new user.
8	string	AssignedGroups	The IDs of the groups of which the user shall be a member, separated by semicolons.
9	string	Ratings	A semicolon-separated list of comma-separated LCID pairs. The first LCID in each pair is the LCID of the source language, the second of the target language. Example: 1031,1033;1033,1040. Attention The list must not contain duplicates of the same language pair.

Return Values

Result	Type/Value	Interpretation
Success	string	The GUID of the newly created user.
Error	2	User does not exist.
Error	15	Language does not exist.
Error	49	The user group does not exist.
Error	50	Unable to create user.

ObjectManager.CreateUser2

Creates a new Across user.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	string	Login	The login of the new user.
3	string	Password	The password of the user.
4	bool	IsOfflineUser	Specifies whether the new user is an offline user or not.
5	bool	IsWindowsUser	Specifies whether the new user will be authorized by Windows or not.
6	string	FirstName	The first name of the new user.
7	string	LastName	The last name of the new user.
8	string	AssignedGroups	The IDs of the groups of which the user shall be a member, separated by semicolons.
9	string	Ratings	A semicolon-separated list of comma-separated LCID pairs. The first LCID in each pair is the LCID of the source language, the second of the target language. Example: 1031,1033;1033,1040. Attention The list must not contain duplicates of the same language pair.
10	string	ProfileName	The profile name to be assigned to the new user.

Return Values

Result	Type/Value	Interpretation
Success	string	The GUID of the newly created user.
Error	2	User does not exist.
Error	15	Language does not exist.
Error	49	The user group does not exist.
Error	50	Unable to create user.

ObjectManager.ExportDocumentSettings

Exports document settings from Across to a DST file.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	string	FileName	The file to which the document settings should be exported.
3	string	DocTypeGUID	The GUID of the document type from which the settings should be exported.
4	string	TemplateName	The name of the template that should be exported.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	28	Document template does not exist.
Error	56	Document type is not supported.
Error	96	Cannot save document settings.

ObjectManager.Finish100progressTasks

Sets all confirmed tasks with a progress of 100% to finished.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	bool	CascadeFinish	If set to true, finishes the language and the project if they also have a progress of 100%.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	89	Task cannot be finished. More detailed information can be found in the error description.

ObjectManager.GetAllMainSubjects

Returns all existing main subjects.

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 existing main subjects.

Tip

JavaScript and VBA have problems dealing with the returned arrays. In these cases, use the CSV variant GetAll[...]CSV of the function instead.

ObjectManager.GetAllMainSubjectsCSV

Returns all existing main subjects.

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 existing main subjects. Separated by semicolons.

ObjectManager.GetAllOfflineUsers

Returns all existing offline users.

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 existing offline users.

Tip

JavaScript and VBA have problems dealing with the returned arrays. In these cases, use the CSV variant GetAll[...]CSV of the function instead.

ObjectManager.GetAllOfflineUsersCSV

Returns all existing offline users.

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 existing offline users. Separated by semicolons.

ObjectManager.GetAllOnlineUsers

Returns all existing online users.

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 existing online users.

Tip

JavaScript and VBA have problems dealing with the returned arrays. In these cases, use the CSV variant GetAll[...]CSV of the function instead.

ObjectManager.GetAllOnlineUsersCSV

Returns all existing online users.

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 existing online users. Separated by semicolons.

ObjectManager.GetAllRelations

Returns all existing relations.

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 existing relations.

Tip

JavaScript and VBA have problems dealing with the returned arrays. In these cases, use the CSV variant GetAll[...]CSV of the function instead.

ObjectManager.GetAllRelationsCSV

Returns all existing relations.

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 existing relations. Separated by semicolons.

ObjectManager.GetAllReportTemplates

Returns the GUIDs of all the report templates.

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 all the report templates.

ObjectManager.GetAllReportTemplatesCSV

Returns the GUIDs of all the report templates as semicolon-separated values.

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 all the report templates separated by semicolons.

ObjectManager.GetAllSubSubjects

Returns all existing sub-subjects.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	string	MainSubjectGuid	The GUID of the main subject for which the sub-subjects should be returned.

Return Values

Result	Type/Value	Interpretation
Success	string	The GUIDs of the existing sub-subjects.

Tip

JavaScript and VBA have problems dealing with the returned arrays. In these cases, use the CSV variant GetAll[...]CSV of the function instead.

ObjectManager.GetAllSubSubjectsCSV

Returns all existing workflows.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	string	MainSubjectGuid	The GUID of the main subject for which the sub-subjects should be returned.

Return Values

Result	Type/Value	Interpretation
Success	string	The GUIDs of the existing sub-subjects. Separated by semicolons.

ObjectManager.GetAllTaskTemplates

Returns all task templates of a given workflow.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	string	WorkflowGuid	The GUID of the workflow for which all task templates should be returned.

Return Values

Result	Type/Value	Interpretation
Success	string	A string array with the GUIDs of the task templates that belong to the specified workflow.
Error	24	Workflow does not exist.

ObjectManager.GetAllTaskTemplatesCSV

Returns all task templates of a given workflow.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	string	WorkflowGuid	The GUID of the workflow for which all task templates should be returned.

Return Values

Result	Type/Value	Interpretation
Success	string	A string with the GUIDs of the task templates that belong to the specified workflow. Separated by semicolons.
Error	24	Workflow does not exist.

ObjectManager.GetAllUsers

Returns all existing users.

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 existing users.

Tip

JavaScript and VBA have problems dealing with the returned arrays. In these cases, use the CSV variant GetAll[...]CSV of the function instead.

ObjectManager.GetAllUsersCSV

Returns all existing users.

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 existing users. Separated by semicolons.

ObjectManager.GetAllWorkflows

Returns all existing workflows. This includes workflows that were received via crossGrid.

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 existing workflows.

Tip

JavaScript and VBA have problems dealing with the returned arrays. In these cases, use the CSV variant GetAll[...]CSV of the function instead.

Tip

If you need only local workflows, consider using ObjectManager.GetWorkflows.

ObjectManager.GetAllWorkflowsCSV

Returns all existing workflows. This includes workflows that were received via crossGrid.

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 existing workflows. Separated by semicolons.

Tip

If you need only local workflows, consider using ObjectManager.GetWorkflows.

ObjectManager.GetAttributesList

Returns the list attribute descriptions as XML.

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 list of attribute descriptions as XML.

<?xmlversion="1.0"encoding="UTF-16"?><Attributes><AttributeName="References"Guid="aa325813-3578-458c-b05b-434fba9aa7ec"/><AttributeName="Subjects"Guid="8698f741-f1c9-49c3-b551-1202da84b447"/><AttributeName="Users"Guid="276261be-50a8-4871-9110-8c98ffc838a5"/><AttributeName="Projects"Guid="3d7a90c2-7604-4d71-99ed-a44e813d8909"/></Attributes>

ObjectManager.GetAttributesList2

Returns the list attribute descriptions as XML.

Parameters

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

Return Values

Result	Type/Value	Interpretation
Success	string	The list of attribute descriptions as XML.

<?xmlversion="1.0"encoding="UTF-16"?><Attributes><AttributeName="References"Guid="aa325813-3578-458c-b05b-434fba9aa7ec"/><AttributeName="Subjects"Guid="8698f741-f1c9-49c3-b551-1202da84b447"/><AttributeName="Users"Guid="276261be-50a8-4871-9110-8c98ffc838a5"/><AttributeName="Projects"Guid="3d7a90c2-7604-4d71-99ed-a44e813d8909"/></Attributes>

ObjectManager.GetAttributesListFile

Gets a file with the list of existing attributes.

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 GUID of the result file.
Error	70	Cannot open file.

ObjectManager.GetAttributeValuesList

Returns the description of the values of an attribute as XML.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	string	AttributeGuid	The GUID of the attribute whose values should be returned.

Return Values

Result	Type/Value	Interpretation
Success		The description of the values of the attribute as XML.
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"/><AttributeValueValue="Product Group 2"Guid="a7c0628d-5f7d-4193-b14d-aaf9e62c0f45"Default="false"/><AttributeValueValue="Product Group 3"Guid="e1905513-971b-4d83-9750-a817aeecb3e0"Default="false"/><AttributeValueValue="Product Group 4"Guid="b3e846ce-ae5d-4f14-a32b-9c1af11d1765"Default="false"/><AttributeValueValue="testRelation"Guid="19b33818-5f20-4632-83ca-67709aec15d8"Default="false"/><AttributeValueValue="Product Group 5"Guid="fab7af08-dcaf-489d-ab78-eeadb7835a81"Default="false"/></AttributeValues>

ObjectManager.GetDocTypeGuidByFileName

Returns the GUID of the document type that matches the supplied filename.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	string	FileName	The file name for which the GUID of the corresponding document type should be returned.

Return Values

Result	Type/Value	Interpretation
Success	string	The GUID of the document type that can handle a file with this filename.
Error	53	Task does not exist.

Tip

Please be aware that this method returns only one randomly selected document type in case there exist more.

ObjectManager.GetDocTypeGuidsByFileName

Returns the GUIDs of the document types that match the supplied filename.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	string	FileName	The filename for which the supported document types should be returned.

Return Values

Result	Type/Value	Interpretation
Success	string	An array of the GUIDs of the document types that match the supplied filename.
Error	56	Document type is not supported.

ObjectManager.GetDocTypeGuidsByFileNameCSV

Returns the GUIDs of the document types that match the supplied filename.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	string	FileName	The filename for which the supported document types should be returned.

Return Values

Result	Type/Value	Interpretation
Success	string	Returns the GUIDs of the document types that match the supplied filename. Separated by semicolons.
Error	56	Document type is not supported.