Server project API classes and interfaces
Classes
AddProjectLanguageFault
Contains information about project termbases which do not contain the new target language.
AnalysisAsCSVResult
The CSV export of an analysis. Contains the reports for all languages the report was created for.
AnalysisAsCSVResultForLang
The CSV export of an analysis for a single target language.
AnalysisOptions
Options of creating an analysis report.
AnalysisReportCounts
Encapsulates segment counts in an analysis report for a specific category of rows.
AnalysisReportForDocument
Encapsulates an analysis report for a single document.
AnalysisReportInfo
Describes meta information of an analysis report.
AnalysisReportItem
Details segment counts in an analysis report for a given scope (depends on the encapsulating class).
AnalysisResultForLang
Encapsulates the result of an analysis operation for a single target language.
AnalysisResultInfo
The result of an analysis query. Contains the report data.
AsiaOnlineBeginTranslationResultInfo
Encapsulates the result of AsiaOnlineBeginTranslation operation for each document.
AsiaOnlineDomainCombination
Describes an Asia Online domain combination.
AsiaOnlineGetDomainCombinationsResultInfo
Encapsulates the result of AsiaOnlineGetDomainCombinations operation.
AsiaOnlineGetLanguagePairCodeResultInfo
Encapsulates the result of AsiaOnlineGetLanguagePairCode operation.
AsiaOnlineGetProjectIdsResultInfo
Encapsulates the result of AsiaOnlineGetProjectIds operation.
AsiaOnlineTranslateOptions
Encapsulates options for performing Asia Online translate on server project translation documents.
AsiaOnlineTranslationResultInfo
Encapsulates the status of an Asia Online transation operation for a single document (known as a job in Asia Online).
AssignmentChangeHistoryItemInfo
Encapsulates history information related to the document assignment changes.
AutomatedActionStartedHistoryItemInfo
Encapsulates history information related to the automated actions.
CannotStartOperationFault
Thrown when the requested operation cannot start because there is another operation or automated action in progress.
ConfirmAndUpdateDocError
Encapsulates the result of a confirm and update operation for a single document.
ConfirmAndUpdateOptions
Encapsulates options for confirm and update rows on server project translation documents.
ConfirmAndUpdateResultInfo
Encapsulates the result of a confirm and update operation.
ConfirmAndUpdateTaskResult
Result of an async confirm and update operation.
CreateDeliveryResult
Describes the result of a CreateDeliveryPackage operation.
CustomPreTranslateParameter
Encapsulates a custom pre-translate parameter.
DeadlineChangeHistoryItemInfo
Encapsulates history information related to the document deadline changes.
DeliverDocumentFault
Contains information about a document delivery problem.
DeliverDocumentRequest
Represents a delivery request of a particular document or slice.
DocDeliveryResultInfo
The result of the delivery of a single document in a delivery package.
DocumentBilingualImportHistoryItemInfo
Encapsulates history information related to the bilingual document imports.
DocumentDeliverHistoryItemInfo
Encapsulates history information related to the document deliveries.
DocumentExportOptions
Represents options for exporting documents into their original format.
DocumentHistoryItemInfo
Encapsulates document history item information for a document.
DocumentHistoryRequest
Represents a document history request.
DocumentImportHistoryItemInfo
Encapsulates history information related to the document imports.
DocumentReturnHistoryItemInfo
Encapsulates history information related to the document deliveries to the previous users.
DocumentRowsLockedHistoryItemInfo
Encapsulates history information related to the lock document rows operations.
DocumentSlicingHistoryItemInfo
Encapsulates history information related to the document slicing operations.
DocumentSnapshotCreatedHistoryItemInfo
Encapsulates history information related to the create document snapshot operations.
DocumentXTranslationHistoryItemInfo
Encapsulates history information related to the X-translation operations.
FileResultInfo
Encapsulates the result of a server operation whose output is a file.
FirstAcceptAcceptHistoryItemInfo
Encapsulates history information related to the FirstAccept accept operations.
FirstAcceptAssignHistoryItemInfo
Encapsulates history information related to the document assignments with FirstAccept.
FirstAcceptDeclineHistoryItemInfo
Encapsulates history information related to the FirstAccept decline operations.
FirstAcceptFailedHistoryItemInfo
Encapsulates history information which is will be created when a FirstAccept had failed.
GenericFault
Used for faults that do not have data held, and which are probably not handled in a special way by the caller.
GroupSourcingAssignHistoryItemInfo
Encapsulates history information related to the document assignments with GroupSourcing.
GroupSourcingDocumentDeliverHistoryItemInfo
Encapsulates history information related to the document delivery operation when the assignment type is GroupSourcing.
ImportImageLocalizationPackResultInfo
Encapsulates the result of importing a localization package back into a project.
ImportTranslationDocumentOptions
Describes the configuration options of importing a file as a document into a server projects.
ListServerProjectTranslationDocument2Options
Encapsulates the listing options of the server project translation documents.
ListServerProjectTranslationDocumentSliceOptions
Encapsulates the listing options of the server project translation document's slices.
ListTranslationDocumentAssignmentsOptions
Encapsulates the listing options of the server project translation documents' assignments.
NewRevisionScenarioOptions
Encapsulates the options for X-translation, if the X-translate scenario is NewRevision.
PackageContentDocument
Describes a document in a package.
PackageContentInfo
Describes a package in a project that allows creating packages. Contains detailed information about the content of the package, if available.
PackageCreationNotAllowedFault
Contains information about a package creation related problem.
PackageDeliveryOptions
Describes the delivery options of the packages.
PackageDeliveryResultInfo
Describes the result of a delivery.
PackageInfo
Describes a package in a project that allows creating packages.
PostTransAnalysisReportForDocument
Encapsulates a post-translation analysis report for a single document, and details the user's contributions one by one.
PostTransAnalysisReportForUser
Encapsulates a post-translation analysis report for a single user. Holds the counts the user has translated.
PostTransAnalysisReportItem
Details segment counts in a post-translation analysis report for a given scope (depends on the encapsulating class).
PostTranslationAnalysisAsCSVResult
The CSV export of a post translation analysis. Contains the reports for all languages the report was created for.
PostTranslationAnalysisAsCSVResultForLang
The CSV export of a post translation analysis for a single target language.
PostTranslationAnalysisOptions
Options of creating a post-translation analysis report.
PostTranslationAnalysisReportInfo
Describes meta information of a post-translation analysis report.
PostTranslationAnalysisResultInfo
The result of a post-translation analysis query. Contains the report data.
PostTranslationAnalysisTaskResult
Result of an async PTA reporting operation.
PostTranslationReportCounts
Encapsulates segment counts in a post-translation analysis report for a specific category of rows.
PostTranslationResultForLang
Encapsulates the result of a post translation analysis operation for a single target language.
PreparePackageResultInfo
The result of a PreparePackageForDownload operation.
PretranslateCopySourceToTargetBehavior
Encapsulates options of copy source to target behavior during a pre-translation operation on server project translation documents.
PretranslateOptions
Encapsulates options for performing pre-translate on server project translation documents.
PreTranslateProblem
Result of an async pretranslate operation.
PreTranslateTaskResult
Result of an async pretranslate operation.
ProjectLaunchedHistoryItemInfo
Encapsulates history information related to the project launch operations.
QAReport
The report after running QA.
QAReportForDocument
The report after running QA.
ReconsolidateDocumentFault
Contains information about a document reconsolidation problem.
ReimportDocumentOptions
Encapsulates details of a document reimport action for a particular source file.
RenameProjectFault
Contains information about a project rename problem.
ResultInfo
Encapsulates the result of a server operation (such as document import, export, etc.)
RtfBilingualExportOptions
Represents options for Trados-like RTF bilingual export.
RunQAGetReportOptions
Options of running QA and getting a report.
RunQATaskResult
Result of an async QA report operation.
ServerProjectAddLanguageInfo
Encapsulates the parameters of adding a new target language to a server projects.
ServerProjectCommunicationSettings
Encapsulates the communication settings of the server project. All fields are optional, only the values set will be considered during project creation and updating. Null value means no change.
ServerProjectConfidentialitySettings
Encapsulates the confidentiality settings (disable MT/TB/TM plugins) settings of the server project. All fields are optional, only the values set will be considered during project creation and updating. Null value means no change.
ServerProjectCorporaAssignments
Encapsulates server project corpora assignments.
ServerProjectCreateInfo
Encapsulates information required to create a server project with Live Docs.
ServerProjectDesktopDocsCreateInfo
Encapsulates information required to create a server project with Desktop Docs.
ServerProjectInfo
Encapsulates information about a server project.
ServerProjectListFilter
Encapsulates filtering information for listing server projects.
ServerProjectNotificationSettings
Encapsulates the email notification settings of the server project. All fields are optional, only the values set will be considered during project creation and updating. Null value means no change.
ServerProjectResourceAssignment
Represents the assignment of a single resource to the involved server project.
ServerProjectResourceAssignmentDetails
Represents the assignment of a single resource to the involved server project with detailed information about the assigned resource.
ServerProjectResourceAssignmentForResourceType
Represents assignments of light resources of a specific resource type to a server project.
ServerProjectRoles
Represents user roles in server projects. A user can have any combination of the ProjectManager and Terminologist project roles.
ServerProjectTBAssignments
Encapsulates server project term base assignments.
ServerProjectTBsForTargetLang
Encapsulates server project termbase assignments for a specific target language.
ServerProjectTMAssignmentDetails
Encapsulates server project translation memory assignments for a specific target language.
ServerProjectTMAssignmentsForTargetLang
Encapsulates server project translation memory assignments for a specific target language.
ServerProjectTranslationDocBasicInfo
Represents basic information about a server project translation document.
ServerProjectTranslationDocInfo
Represents information about a server project translation document.
ServerProjectTranslationDocInfo2
Encapsulates information about a server project translation document. It contains detailed information about the FirstAccept, GroupSourcing and subvendor assignments as well.
ServerProjectTranslationDocSliceInfo
Encapsulates information about a server project translation document slice.
ServerProjectTranslationDocumentsDifferentLanguageTranslations
Represents a group of documents that are the various target language translations of the same document. E.g. if a DOCX file is imported into various target languages, all resulting documents will be in one such group.
ServerProjectTranslationDocumentsFromSameSourceFile
Represents a group of documents in a project that originated from the same source file. E.g. if a multilingual Excel file is imported into various target languages, all resulting documents will be in one such group; similarly if a DOCX file is imported into multiple target languages, all resulting documents will be in one such group.
ServerProjectTranslationDocumentUserAssignments
Represents assignments of users to a server project translation document. Used when setting user-to-document assignments.
ServerProjectTranslationDocumentWorkflowStatusChange
Represents manual Workflow status change of a particular document or slice.
ServerProjectUpdateInfo
Encapsulates information required to update server project header information.
ServerProjectUserInfo
Represents a server project user assignment. Only the guid of the user is included.
ServerProjectUserInfoHeader
Represents a server project user assignment. All information about the user is included.
SetDocumentWorkflowStatusFault
Contains information about a workflow status problem.
SetTranslationDocumentAssignmentsOptions
Encapsulates the assignment parameters of the server project translation documents.
SliceDocumentFault
Contains information about a document slicing problem.
SliceDocumentRequest
Represents a slice request of a particular document.
StatisticsOptions
Encapsulates options for running statistics on server project translation documents.
StatisticsResultForLang
Encapsulates the result of a statistics operation for a single target language.
StatisticsResultInfo
Encapsulates the result of a statistics operation for possibly more than one target languages.
StatisticsTaskResult
Result of an async statistics operation.
SubvendorAssignDeadlineChangeHistoryItemInfo
Encapsulates history information related to the deadline changes when the document had been assigned to a subvendor group.
SubvendorAssignHistoryItemInfo
Encapsulates history information related to the subvendor assignment changes.
TemplateBasedProjectCreateInfo
Encapsulates information required to create a server project from a project template.
TemplateBasedProjectCreationFault
Contains information about a template-based project creation problem (such as missing meta information (e.g. client, project, domain, subject), etc.)
TemplateBasedProjectCreationInvalidMetaFault
Contains information about an invalid meta value. It is thrown if the template specifies pre-defined values and the sent value is not in the pre-defined value set.
TemplateBasedProjectCreationResultInfo
Encapsulates the result of a template-based project creation.
TranslationDocExportResultInfo
Encapsulates the result of a translation document export operation.
TranslationDocImportResultInfo
Encapsulates the result of a document import operation.
TranslationDocumentAssigneeInfo
Describes a user or a subvendor group who is assigned to a document.
TranslationDocumentAssignmentFault
Contains information about a translation document assignment problem (such as the same user is assigned in more than one roles, etc.)
TranslationDocumentAssignmentInfo
Base class of the assignment descriptor classes.
TranslationDocumentAssignmentResultInfo
Encapsulates the result of a document assignment operation.
TranslationDocumentAssignments
Represents assignments of users to a server project translation document or to a document slice. Used when setting user-to-document or user-to-document-slice assignments.
TranslationDocumentDetailedAssignmentInfo
Base class of the detailed assignment descriptor classes.
TranslationDocumentDetailedAssignments
Represents the detailed assignments of users to a server project translation document or slice.
TranslationDocumentDetailedFirstAcceptAssignmentInfo
Describes the details of a FirstAccept assignment.
TranslationDocumentDetailedGroupSourcingAssignmentInfo
Describes the details of a GroupSourcing assignment.
TranslationDocumentDetailedRoleAssignmentInfo
Describes the details of a user/user group/subvendor group assignment.
TranslationDocumentDetailedSingleUserAssignmentInfo
Describes the details of a single user assignment.
TranslationDocumentDetailedSubvendorAssignmentInfo
Describes the details of a subvendor assignment.
TranslationDocumentFirstAcceptAssignmentInfo
Represents the FirstAccept assignment of a group of users to a server project translation document for a document assignment role with a deadline and a FirstAccept deadline (e.g. user X, user Y to document Z with document assignment role reviewer1 with deadline 10/10/2011 and FirstAccept deadline 1/10/2011). Can be used with translation documents only.
TranslationDocumentFirstAcceptUserInfo
Describes a user who is assigned to a document in a role with FirstAccept assignment.
TranslationDocumentGroupSourcingAssignmentInfo
Represents the GroupSourcing assignment of a group of users to a server project translation document for a document assignment role with a deadline (e.g. user X, user Y to document Z with document assignment role reviewer1 with deadline 10/10/2011). Can be used with translation documents only.
TranslationDocumentGroupSourcingUserInfo
Describes a user who is assigned to a document in a role with GroupSourcing assignment.
TranslationDocumentNoUserAssignmentInfo
Represents an empty user assignment. Used when assigning the document or document slice to no one.
TranslationDocumentRoleAssignmentInfo
Represents a user or a user group assignment for a role of a document. Used when setting single user, FirstAccept, GroupSourcing or subvendor group assignments.
TranslationDocumentRoleAssignmentResultInfo
Encapsulates the result of a document assignment operation.
TranslationDocumentSingleUserAssignmentInfo
Represents the assignment of a user to a server project translation document for a document assignment role with a deadline (e.g. user X to document Y with document assignment role reviewer1 with deadline 10/10/2011). Can be used with translation documents and document slices as well.
TranslationDocumentSubvendorAssignmentInfo
Represents a subvendor group assignment. Used when setting subvendor group to document assignments. Can be used with translation documents only.
TranslationDocumentUserRoleAssignment
Represents the assignment of a user to a server project translation document for document assignment role with a deadline (e.g. userX to document Y with document assignment role reviewer1 with deadline 1/1/2011).
TranslationDocumentUserRoleAssignmentDetails
Represents information about a user, with respect to its document assignment. Used when listing documents with their user assignments.
TwoColumnRtfBilingualExportOptions
Represents options for Two-column RTF bilingual export.
UnexpectedFault
Throw in case of unexpected errors
UpdateWithTableRtfOptions
Options of performing an update of a document in memoQ with a table rtf (two-column rtf) file.
UserInfoHeader
Represents brief information about a user.
WorkflowStatusChangeHistoryItemInfo
Encapsulates history information related to the workflow change operations.
WorkingTMsDeletedHistoryItemInfo
Encapsulates history information related to the delete working TM operations.
WrapUpProjectFault
Contains information about a project wrap up problem.
XliffBilingualExportOptions
Represents options for XLIFF bilingual export.
XTranslateDocInfo
Encapsulates the document identifier and the document's source major version to use for for X-translation.
XTranslateDocumentResult
Encapsulates the result of the X-translation for a document.
XTranslateOptions
Encapsulates options for X-translation on server project translation documents.
XTranslateResultInfo
Encapsulates the result of the X-translation.
XTranslateTaskResult
Result of an async xtranslate operation.
Interfaces
IServerProjectService
This interface has operations for server project management.
Enums
AddProjectLanguageTBHandlingBehavior
Represents termbase handling behavior during the add project language operation when the project termbases do not contain the neccessary languages.
Please note that it is no longer necessary for term bases to contain all languages of a project, hence adding a new language to the project can leave TBs that do not hve the new language intact. These options, except NoChangeOfTBs, are compatible with previous behaviors.
AsiaOnlineTranslationStatus
Statuses of an Asia Online translation operations for a single document.
AutomatedActionStartedHistoryItemInfo.AutomatedActionTypes
Describes the possible automated action types.
BilingualDocFormat
Represents bilingual document formats.
ConfirmAndUpdateSegmentStatuses
Represents the status of segments that should be confirmed.
ConfirmAndUpdateTMBehaviors
Represents the TM updating behavior for confirm and update operation.
ConfirmAndUpdateUserNameBehaviors
Represents the user name behavior for confirming.
DocDeliveryResult
Describes the result of the delivery for a single document in a delivery package.
DocumentHistoryItemType
Represents the possible document history item types.
DocumentRowsLockedHistoryItemInfo.LockModes
Describes the possible lock modes.
DocumentStatus
Translation status of the document.
ExpectedFinalStateAfterXTranslate
Represents the expected translation states of the X-translated segmenst.
ExpectedSourceStateBeforeXTranslate
Represents the statuses of the segments which segments should be applied during the X-translation.
FirstAcceptStatus
Describes the possible statuses of a FirstAccept.
FirstAcceptUserDecision
Describes the possible FirstAccept decisions of a user.
PackageDeliveryResult
Describes the result of the delivery of an entire package.
PretranslateCopySourceToTargetConditions
Describes the type of rows where copy source to target is used during pre-translation.
PretranslateExpectedFinalTranslationState
Represents the statuses of segments after pretranslation.
PretranslateLookupBehavior
Represents pre-tanslate lookup behavior.
PretranslateStateToConfirmAndLock
Represents the state of segments that should be conformed and locked after pre-translation.
PreviewCreation
Specifies preview creation behavior for document import
QAReportTypes
ResultStatus
Indicates the result of a server operation.
ServerProjectResourcesInPackages
Describes the options how the TMs, TBs and LiveDocs corpora are included in packages.
ServerProjectStatus
Describes the possible statuses of an online project.
SlicingMeasurementUnit
Describes how to measure the content in the document's parts when slicing.
StatisticsAlgorithm
Identifies calculation algoritms used by statistics.
StatisticsResultFormat
Identifies different output formats for statistics.
TranslationDocumentAssignmentType
Describes the possible user-to-document assignment types.
WorkflowStatus
Workflow status of the document.
XTranslateScenario
Represents the X-translate scenarios of the X-translate logic.