ObjectManager - Part 3

ObjectManager.GetTaskState

Used to query the state 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	int	The state of the task: 0: Task is unassigned 1: Task is unconfirmed 2: Task has been rejected 3: Task has been confirmed 4: Task is a WAN task. It is unknown whether it has been confirmed or not 5: Task is finished
Error	16	Document does not exist.
Error	53	Task does not exist.

ObjectManager.GetTaskStatistics

Returns the statistics of a task. It is the same data that is used to generate the Task Report.

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	string	The statistics as an XML structure. See info below for details on the exact structure.
Error	53	Task does not exist.
Error	148	Cannot load statistics.

The returned XML structure has the following layout:

<?xmlversion="1.0"encoding="UTF-16"?><TaskStatisticsType="[task template name"Description="[description of the task: project name, document name, percentage]"SourceLanguage="[source language name]"TargetLanguage="[target language name]"Deadline="[deadline date]"Translations="[amount of added translations]"SourceTerms="[amount of added source language terms]"TargetTerms="[amount of added target language terms]"TermEntries="[amount of added term entries]"AmountOfTime="[hours, minutes and seconds spent on this task]"/>

Date and Time are formatted according to the current locale.

ObjectManager.GetTaskTemplateGuidByName

Returns the GUID of a task template according to its name.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	string	WorkflowGuid	The GUID of the corresponding workflow.
3	string	Name	The name of the task template.

Return Values

Result	Type/Value	Interpretation
Success	string	Contains the GUID of the task template.
Error	27	Task template does not exist.

ObjectManager.GetTaskTemplateNameByGuid

Returns the name of a task template.

Parameters

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

Return Values

Result	Type/Value	Interpretation
Success	string	The name of the task template.
Error	27	Task template does not exist.

ObjectManager.GetTaskTemplateType

Returns the type of a specified task template.

Parameters

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

Return Values

Result	Type/Value	Interpretation
Success	int	The type of the task template.
Error	27	Task template does not exist.

ObjectManager.GetUserComments

Attention

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

Returns the comments of 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.

Return Values

Result	Type/Value	Interpretation
Success	string	The comments as an XML structure. See info below for details on the exact structure.
Error	2	User 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.GetUserContact

Returns the contact data 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	The contact information of the specified user as an XML representation of the following form: <User FirstName="test" LastName="user" Street="street" Zip="zip" City="city" Country="country" Phone="phone" Mobile="mobile" Fax="fax" EMail="test@user.de" Web="web" />
Error	2	User does not exist.

ObjectManager.GetUserGuidByLogin

Returns the GUID of a user according to the login name.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	string	Login	The users login, the username.

Return Values

Result	Type/Value	Interpretation
Success	string	Contains the GUID of the user.
Error	2	User does not exist.

ObjectManager.GetUserGuidsByGroupID

Returns a list of user GUIDs that belong to the group specified by the 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.

Return Values

Result	Type/Value	Interpretation
Success	string	The GUIDs of the users.
Error	49	The user group does not exist.

ObjectManager.GetUserGuidsByGroupIDCSV

Returns a list of user GUIDs that belong to the group specified by the ID as semicolon-separated list.

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.

Return Values

Result	Type/Value	Interpretation
Success	string	The GUIDs of the users as semicolon-separated lists.
Error	49	The user group does not exist.

ObjectManager.GetUserID

Returns the ID of a user according to the corresponding GUID.

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	Contains the ID of the user.
Error	2	User does not exist.

ObjectManager.GetUserIDByLogin

Returns the ID of a user according to the login name.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	string	Login	The users login, the username.

Return Values

Result	Type/Value	Interpretation
Success	int	Contains the ID of the user.
Error	2	User does not exist.

ObjectManager.GetUserLoginByGuid

Returns the login of the specified user GUID.

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 login of the user.
Error	2	User does not exist.

ObjectManager.GetWorkflowGuidByName

Returns the GUID of a workflow 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 workflow.

Return Values

Result	Type/Value	Interpretation
Success	string	Contains the GUID of the workflow.
Error	24	Workflow does not exist.

ObjectManager.GetWorkflowNameByGuid

Returns the name of a workflow according to its GUID.

Parameters

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

Return Values

Result	Type/Value	Interpretation
Success	string	The name of the workflow.
Error	24	Workflow does not exist.

ObjectManager.GetWorkflows

Returns the GUIDs of the workflows. Use the parameter to specify whether to include workflows received via crossGrid.

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

Tip

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

ObjectManager.GetWorkflowsCSV

Returns the GUIDs of the workfows as semicolon-separated values. Use the parameter to specify whether to include workflows received via crossGrid.

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 workflows as semicolon-separated values.

ObjectManager.GetWorkflowTaskTemplateGuids

Returns the GUIDs of the task templates that belong to a specific 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 corresponding workflow.

Return Values

Result	Type/Value	Interpretation
Success	string	The GUIDs of the task templates of the specified workflow.
Error	24	Workflow does not exist.

ObjectManager.GetWorkflowTaskTemplateGuidsCSV

Returns the GUIDs of the task templates that belong to a specific 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 corresponding workflow.

Return Values

Result	Type/Value	Interpretation
Success	string	The GUIDs of the task templates of the specified workflow as a list of semicolon-separated GUIDs.
Error	24	Workflow does not exist.

ObjectManager.ImportDocumentSettings

Imports document settings into Across from 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 that should be imported.
3	string	DocTypeGUID	The GUID of the document type for which the document settings should be imported.
4	string	TemplateName	The name of the template the imported settings will be saved as.

Return Values

Result	Type/Value	Interpretation
Success	string	The GUID of the document settings.
Error	56	Document type is not supported.
Error	71	File not found.
Error	97	Cannot load document settings.

ObjectManager.IsDocumentFinished

Returns whether a document has been completely translated or not.

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/bool	0 (false) if the document has not been completely translated, otherwise (true) if it has been completely translated.
Error	16	Document does not exist.

ObjectManager.IsMtEngineEnabled

Checks if the specified MT engine is enabled.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	string	MtEngineId	The GUID identifying the MT engine to check.

Return Values

Result	Type/Value	Interpretation
Success	int/bool	1 if the engine is enabled, 0 otherwise.

ObjectManager.IsProjectArchived

Returns whether a project is in the archive or not.

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/bool	0 (false) if the project is not in the archive, otherwise (true) if it has been archived.
Error	19	Project does not exist.

ObjectManager.IsProjectFinished

Returns whether a project has been completed or not.

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/bool	0 (false) if the project has not been completed, otherwise (true) if it has been completed.
Error	19	Project does not exist.

ObjectManager.IsTaskFinished

Returns whether a task is finished or not.

Parameters

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

Return Values

Result	Type/Value	Interpretation
Success	int	0 if the task is not finished, 1 if it is finished.
Error	53	Task does not exist.

ObjectManager.RemoveAttachment

Removes an attachment from a document or language.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	int	AttachmentID	The ID of the attachment.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	139	The attachment does not exist.
Error	141	Cannot remove attachment.

ObjectManager.RemoveComment

Removes a comment from a project, a language, a document, a user, or a relation.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	int	commentID	The ID of the comment.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	135	Cannot remove comment.
Error	136	Comment not found.

Tip

Although the ID of the comment is not a GUID, it is unique throughout Across.

ObjectManager.RemoveDocument

Deletes an existing 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		Is always empty.
Error	16	Document does not exist.
Error	31	Unable to delete document. More detailed information can be found in the error description.

ObjectManager.RemoveLanguageFromDocument

Removes a target language from 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.
3	int	TargetLanguageLcid	The LCID of the language that should be removed from the document.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	15	Language does not exist.
Error	16	Document does not exist.
Error	115	Cannot remove language.
Error	116	The language is involved in crossGrid process and cannot be edited or deleted.

ObjectManager.RemoveLanguageRatingFromUser

Removes a language rating from 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 language that should be removed from the document.
5	string	SubjectGuid	The GUID of the subject for which this rating should be removed.

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	107	Rating does not exist.
Error	117	Cannot remove rating.

ObjectManager.RemoveProject

Deletes an existing 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		Is always empty.
Error	19	Project does not exist.
Error	30	Unable to delete project. More detailed information can be found in the error description.

ObjectManager.RemoveRelation

Deletes an existing 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.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	13	Relation does not exist.
Error	33	Unable to delete relation. More detailed information can be found in the error description.

ObjectManager.RemoveSubject

Removes a subject.

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.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.

ObjectManager.RemoveUser

Deletes an 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		Is always empty.
Error	2	User does not exist.
Error	31	Unable to delete document. More detailed information can be found in the error description.

ObjectManager.RemoveUserFromGroup

Removes a user from a 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	int	GroupID	The ID of the group.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	2	User does not exist.
Error	49	The user group does not exist.
Error	186	Cannot remove user from group.

ObjectManager.RenameDocument

Renames 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.
3	string	Name	The new name of the document.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	16	Document does not exist.
Error	40	Unable to rename document. More detailed information can be found in the error description.

ObjectManager.SaveAttachment

Saves an attachment to the hard disk.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	int	AttachmentID	The ID of the attachment.
3	string	TargetPath	The path the attachment should be saved to. This path also contains the filename.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	139	The attachment does not exist.
Error	140	Cannot load attachment.

ObjectManager.SetDocumentFinished

Sets the finished flag of 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.
3	bool	Finished	True if the document should be set to finished, false if it should be set to unfinished.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	16	Document does not exist.
Error	110	Document cannot be finished.
Error	111	Document cannot be set to unfinished.
Error	112	Is not ready to be finished.

ObjectManager.SetEmailUserSettings

Sets the SMTP settings in the user settings used for sending notifications in the client from this 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	EmailSettingsXML	The full or partial e-mail settings to set.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	2	User does not exist.
Error	98	Cannot load XML content.
Error	99	Cannot set user properties.
Error	131	Cannot apply profile.
Error	178	The profile does not exist.

Format of the EmailSettingsXML parameter:

<Email><PropertyName="SMTP Server"Value="mail"/><PropertyName="SMTP Port"Value="25"/><PropertyName="From Address"Value="adress@domain.com"/><PropertyName="Reply Address"Value=""/><PropertyName="Number Of Retries"Value="3"/><PropertyName="Timeout"Value="60"/><PropertyName="OutboxTimeout"Value="3600"/><PropertyName="Use for all"Value="1"/><PropertyName="SmtpSslEnabled"Value="0"/><PropertyName="SmtpAuthEnabled"Value="0"/><PropertyName="SmtpUser"Value=""/><PropertyName="SmtpPass"Value=""/><PropertyName="FooterText"Value=""/></Email>

It is possible to update only some settings by using a partial XML like this:

<Email><Property Name="From Address" Value="newEmailAdress@domain.com"/></Email>

ObjectManager.SetLanguageParagraphsState

Sets the state of all paragraphs to a certain value. Optionally, only empty paragraphs can be taken into account.

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 in the given document for which the paragraph state should be set.
4	string	StateGuid	The GUID of the paragraph state that should be set. The GUID can be obtained via the GetParagraphStateGuidByName function.
5	bool	WithEmptySourceOnly	Only apply to empty paragraphs. This option originates from the context of software localization. In these cases, positionable control elements that do not contain text represent empty paragraphs that frequently occur.

Return Values

Result	Type/Value	Interpretation
Success	int	The number of changed paragraphs.
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.
Error	42	Unable to set paragraph state. More detailed information can be found in the error description.

ObjectManager.SetRelationAddress

Sets the address for 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.
3	string	Address1	The first line of the address.
4	string	Address2	The second line of the address.
5	string	Zip	The ZIP code of the address.
6	string	City	The city of the address.
7	string	Country	The country of the address.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	13	Relation does not exist.
Error	59	Unable to set properties of relation.

ObjectManager.SetRelationPrimaryContact

Sets the primary contact for 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 for which the primary contact should be set. This GUID can be retrieved via CreateRelation, CreateRelation2 or GetOrCreateRelation.
3	string	FirstName	The first name of the contact.
4	string	LastName	The last name of the contact.
5	string	Department	The department this contact belongs to.
6	string	Phone1	The first phone number of the contact.
7	string	Phone2	The second phone number of the contact.
8	string	Fax	The fax number of the contact.
9	string	Email	The e-mail address of the contact.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	13	Relation does not exist.
Error	59	Unable to set properties of relation.

ObjectManager.SetRelationSecondaryContact

Sets the secondary contact for 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 for which the secondary contact should be set. This GUID can be retrieved via CreateRelation, CreateRelation2 or GetOrCreateRelation.
3	string	FirstName	The first name of the contact.
4	string	LastName	The last name of the contact.
5	string	Department	The department this contact belongs to.
6	string	Phone1	The first phone number of the contact.
7	string	Phone2	The second phone number of the contact.
8	string	Fax	The fax number of the contact.
9	string	Email	The e-mail address of the contact.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	13	Relation does not exist.
Error	59	Unable to set properties of relation.

ObjectManager.SetTaskDeadline

Sets 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.
6	DateTime	Deadline	The date by which the task should be finished.

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	138	Cannot set deadline.

ObjectManager.SetUserContact

Sets the contact information 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.
3	string	UserInfoXml	The contact data of the user to be set. The data is passed as XML. The XML has the following layout: <UserFirstName="test"LastName="user"Street="street"Zip="zip"City="city"Country="country"Phone="phone"Mobile="mobile"Fax="fax"EMail="test@user.de"Web="web"/>

Return Values

Result	Type/Value	Interpretation
Success		Is always empty.
Error	98	Cannot load XML content.
Error	99	Cannot set user properties.

ObjectManager.SwitchLanguageParagraphState

Changes one paragraph state to another for a certain target language in a certain document.

Parameters

	Type	Name	Description
1	string	ST	A security token for use in other crossAPI SI functions.
2	string	DocumentGuid	The GUID of a document in which the paragraph states should be replaced.
3	int	TargetLanguageLcid	The LCID of a target language in the given document in which the paragraph state should be replaced with a different one.
4	string	OriginalStateGuid	The GUID of a paragraph state that should be replaced. The GUID can be obtained via the GetParagraphStateGuidByName function.
5	string	TargetStateGuid	The GUID of a paragraph state that should replace the original one. The GUID can be obtained via the GetParagraphStateGuidByName function.

Return Values

Result	Type/Value	Interpretation
Success	int	The number of changed paragraphs.
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.
Error	42	Unable to set paragraph state. More detailed information can be found in the error description.