• Introduction
  • Web Service API
  • Callback service
Show / Hide Table of Contents
  • Overview
  • Concepts
    • API functionality
    • Web Service technology
    • Security
    • Accessing the services
    • Error reporting
    • Synchronous and asynchronous API
    • Testing
  • Translation memory API
    • Overview
    • ITMService
    • Lookup, concordance
    • Import, export
    • API
      • ConcordanceRequest
      • GenericFault
      • HeavyResourceInfo
      • HeavyResourceUpdateInfo
      • InlineTagStrictness
      • InvalidSessionIdFault
      • ITMService
      • LookupSegmentRequest
      • NoLicenseFault
      • RequestXmlFormatFault
      • ResourceInfo
      • ResourceListFilter
      • ResourceUpdateInfo
      • TMFault
      • TMInfo
      • TMListFilter
      • TMOptimizationPreference
      • TMUpdateInfo
      • TmxImportResult
      • UnauthorizedAccessFault
      • UnexpectedFault
  • Term bases API
    • Overview
    • ITBService
    • Import, export
      • CSV
      • TBX
      • MultiTerm
    • API
      • CreateQTermTBFromTBXSettings
      • CreateQTermTBFromTBXTaskResult
      • CSVImportResult
      • CSVImportSettings
      • GenericFault
      • HeavyResourceInfo
      • HeavyResourceUpdateInfo
      • ITasksService
      • ITBService
      • QTermTBImportSettings
      • ResourceInfo
      • ResourceListFilter
      • ResourceUpdateInfo
      • TaskDoesNotExistFault
      • TaskInfo
      • TaskNotFinishedFault
      • TaskResult
      • TaskStatus
      • TBCaseSensitivity
      • TBCloneInfo
      • TBFilter
      • TBFilterLangMode
      • TBInfo
      • TBMatching
      • TBNewTermDefaultForLanguage
      • TBUpdateInfo
      • TBXExportOptions
      • TBXExportTaskResult
      • TBXImportIntoExistingSettings
      • TBXImportResults
      • TBXImportSettings
      • TBXImportTaskResult
      • UnexpectedFault
  • LiveDocs API
    • Overview
    • ILiveDocsService
    • Alignment
    • API
      • AlignmentOptions
      • AlignmentResultInfo
      • CorpusIndexingOptions
      • CorpusIndexingSchedule
      • CorpusInfo
      • CorpusListFilter
      • CorpusUpdateInfo
      • DocumentForAlignment
      • GenericFault
      • HeavyResourceInfo
      • HeavyResourceUpdateInfo
      • ILiveDocsService
      • ImportBinaryFileIntoLiveDocsOptions
      • ImportFileIntoLiveDocsOptions
      • ImportFileIntoLiveDocsResultInfo
      • ImportLiveDocsXliffFileIntoLiveDocsOptions
      • ImportMonoOrBilingualFileIntoLiveDocsOptions
      • ResourceInfo
      • ResourceListFilter
      • ResourceUpdateInfo
      • ResultInfo
      • ResultStatus
      • UnexpectedFault
  • Light resources API
    • Overview
    • IResourceService
    • API
      • ExpectedFault
      • FilterConfigResourceInfo
      • FilterNames
      • GenericFault
      • IResourceService
      • LightResourceInfo
      • LightResourceInfoWithLang
      • LightResourceListFilter
      • PathRuleResourceInfo
      • PathRuleType
      • ProjectTemplateResourceInfo
      • ResourceInfo
      • ResourceType
      • ResourceUpdateInfo
      • UnexpectedFault
  • Server project API
    • Overview
    • User assignment
    • Omniscien Technologies services
    • IServerProjectService
    • API
      • AddProjectLanguageFault
      • AddProjectLanguageTBHandlingBehavior
      • AnalysisAsCSVResult
      • AnalysisAsCSVResultForLang
      • AnalysisOptions
      • AnalysisReportCounts
      • AnalysisReportForDocument
      • AnalysisReportInfo
      • AnalysisReportItem
      • AnalysisResultForLang
      • AnalysisResultInfo
      • AsiaOnlineBeginTranslationResultInfo
      • AsiaOnlineDomainCombination
      • AsiaOnlineGetDomainCombinationsResultInfo
      • AsiaOnlineGetLanguagePairCodeResultInfo
      • AsiaOnlineGetProjectIdsResultInfo
      • AsiaOnlineTranslateOptions
      • AsiaOnlineTranslationResultInfo
      • AsiaOnlineTranslationStatus
      • AssignmentChangeHistoryItemInfo
      • AutomatedActionStartedHistoryItemInfo
      • AutomatedActionStartedHistoryItemInfo.AutomatedActionTypes
      • BilingualDocFormat
      • CannotStartOperationFault
      • ConfirmAndUpdateDocError
      • ConfirmAndUpdateOptions
      • ConfirmAndUpdateResultInfo
      • ConfirmAndUpdateSegmentStatuses
      • ConfirmAndUpdateTaskResult
      • ConfirmAndUpdateTMBehaviors
      • ConfirmAndUpdateUserNameBehaviors
      • CreateDeliveryResult
      • CustomPreTranslateParameter
      • DeadlineChangeHistoryItemInfo
      • DeliverDocumentFault
      • DeliverDocumentRequest
      • DocDeliveryResult
      • DocDeliveryResultInfo
      • DocumentBilingualImportHistoryItemInfo
      • DocumentDeliverHistoryItemInfo
      • DocumentExportOptions
      • DocumentHistoryItemInfo
      • DocumentHistoryItemType
      • DocumentHistoryRequest
      • DocumentImportHistoryItemInfo
      • DocumentReturnHistoryItemInfo
      • DocumentRowsLockedHistoryItemInfo
      • DocumentRowsLockedHistoryItemInfo.LockModes
      • DocumentSlicingHistoryItemInfo
      • DocumentSnapshotCreatedHistoryItemInfo
      • DocumentStatus
      • DocumentXTranslationHistoryItemInfo
      • ExpectedFinalStateAfterXTranslate
      • ExpectedSourceStateBeforeXTranslate
      • FileResultInfo
      • FirstAcceptAcceptHistoryItemInfo
      • FirstAcceptAssignHistoryItemInfo
      • FirstAcceptDeclineHistoryItemInfo
      • FirstAcceptFailedHistoryItemInfo
      • FirstAcceptStatus
      • FirstAcceptUserDecision
      • GenericFault
      • GroupSourcingAssignHistoryItemInfo
      • GroupSourcingDocumentDeliverHistoryItemInfo
      • ImportImageLocalizationPackResultInfo
      • ImportTranslationDocumentOptions
      • IServerProjectService
      • ListServerProjectTranslationDocument2Options
      • ListServerProjectTranslationDocumentSliceOptions
      • ListTranslationDocumentAssignmentsOptions
      • NewRevisionScenarioOptions
      • PackageContentDocument
      • PackageContentInfo
      • PackageCreationNotAllowedFault
      • PackageDeliveryOptions
      • PackageDeliveryResult
      • PackageDeliveryResultInfo
      • PackageInfo
      • PostTransAnalysisReportForDocument
      • PostTransAnalysisReportForUser
      • PostTransAnalysisReportItem
      • PostTranslationAnalysisAsCSVResult
      • PostTranslationAnalysisAsCSVResultForLang
      • PostTranslationAnalysisOptions
      • PostTranslationAnalysisReportInfo
      • PostTranslationAnalysisResultInfo
      • PostTranslationAnalysisTaskResult
      • PostTranslationReportCounts
      • PostTranslationResultForLang
      • PreparePackageResultInfo
      • PretranslateCopySourceToTargetBehavior
      • PretranslateCopySourceToTargetConditions
      • PretranslateExpectedFinalTranslationState
      • PretranslateLookupBehavior
      • PretranslateOptions
      • PreTranslateProblem
      • PretranslateStateToConfirmAndLock
      • PreTranslateTaskResult
      • PreviewCreation
      • ProjectLaunchedHistoryItemInfo
      • QAReport
      • QAReportForDocument
      • QAReportTypes
      • ReconsolidateDocumentFault
      • ReimportDocumentOptions
      • RenameProjectFault
      • ResultInfo
      • ResultStatus
      • RtfBilingualExportOptions
      • RunQAGetReportOptions
      • RunQATaskResult
      • ServerProjectAddLanguageInfo
      • ServerProjectCommunicationSettings
      • ServerProjectConfidentialitySettings
      • ServerProjectCorporaAssignments
      • ServerProjectCreateInfo
      • ServerProjectDesktopDocsCreateInfo
      • ServerProjectInfo
      • ServerProjectListFilter
      • ServerProjectNotificationSettings
      • ServerProjectResourceAssignment
      • ServerProjectResourceAssignmentDetails
      • ServerProjectResourceAssignmentForResourceType
      • ServerProjectResourcesInPackages
      • ServerProjectRoles
      • ServerProjectStatus
      • ServerProjectTBAssignments
      • ServerProjectTBsForTargetLang
      • ServerProjectTMAssignmentDetails
      • ServerProjectTMAssignmentsForTargetLang
      • ServerProjectTranslationDocBasicInfo
      • ServerProjectTranslationDocInfo
      • ServerProjectTranslationDocInfo2
      • ServerProjectTranslationDocSliceInfo
      • ServerProjectTranslationDocumentsDifferentLanguageTranslations
      • ServerProjectTranslationDocumentsFromSameSourceFile
      • ServerProjectTranslationDocumentUserAssignments
      • ServerProjectTranslationDocumentWorkflowStatusChange
      • ServerProjectUpdateInfo
      • ServerProjectUserInfo
      • ServerProjectUserInfoHeader
      • SetDocumentWorkflowStatusFault
      • SetTranslationDocumentAssignmentsOptions
      • SliceDocumentFault
      • SliceDocumentRequest
      • SlicingMeasurementUnit
      • StatisticsAlgorithm
      • StatisticsOptions
      • StatisticsResultForLang
      • StatisticsResultFormat
      • StatisticsResultInfo
      • StatisticsTaskResult
      • SubvendorAssignDeadlineChangeHistoryItemInfo
      • SubvendorAssignHistoryItemInfo
      • TemplateBasedProjectCreateInfo
      • TemplateBasedProjectCreationFault
      • TemplateBasedProjectCreationInvalidMetaFault
      • TemplateBasedProjectCreationResultInfo
      • TranslationDocExportResultInfo
      • TranslationDocImportResultInfo
      • TranslationDocumentAssigneeInfo
      • TranslationDocumentAssignmentFault
      • TranslationDocumentAssignmentInfo
      • TranslationDocumentAssignmentResultInfo
      • TranslationDocumentAssignments
      • TranslationDocumentAssignmentType
      • TranslationDocumentDetailedAssignmentInfo
      • TranslationDocumentDetailedAssignments
      • TranslationDocumentDetailedFirstAcceptAssignmentInfo
      • TranslationDocumentDetailedGroupSourcingAssignmentInfo
      • TranslationDocumentDetailedRoleAssignmentInfo
      • TranslationDocumentDetailedSingleUserAssignmentInfo
      • TranslationDocumentDetailedSubvendorAssignmentInfo
      • TranslationDocumentFirstAcceptAssignmentInfo
      • TranslationDocumentFirstAcceptUserInfo
      • TranslationDocumentGroupSourcingAssignmentInfo
      • TranslationDocumentGroupSourcingUserInfo
      • TranslationDocumentNoUserAssignmentInfo
      • TranslationDocumentRoleAssignmentInfo
      • TranslationDocumentRoleAssignmentResultInfo
      • TranslationDocumentSingleUserAssignmentInfo
      • TranslationDocumentSubvendorAssignmentInfo
      • TranslationDocumentUserRoleAssignment
      • TranslationDocumentUserRoleAssignmentDetails
      • TwoColumnRtfBilingualExportOptions
      • UnexpectedFault
      • UpdateWithTableRtfOptions
      • UserInfoHeader
      • WorkflowStatus
      • WorkflowStatusChangeHistoryItemInfo
      • WorkingTMsDeletedHistoryItemInfo
      • WrapUpProjectFault
      • XliffBilingualExportOptions
      • XTranslateDocInfo
      • XTranslateDocumentResult
      • XTranslateOptions
      • XTranslateResultInfo
      • XTranslateScenario
      • XTranslateTaskResult
  • Security API
    • Overview
    • Users, groups, permissions
    • Session management
    • ISecurityService
    • API
      • GenericFault
      • GroupInfo
      • ISecurityService
      • ObjectPermission
      • UnexpectedFault
      • UserInfo
      • UserPackageWorkflowType
  • File upload/download API
    • Overview
    • IFileManagerService
    • API
      • GenericFault
      • IFileManagerService
      • UnexpectedFault
  • License (ELM) API
    • Overview
    • IELMService
    • API
      • ELMAssignment
      • ELMAssignmentType
      • ELMFault
      • ELMPermission
      • ELMPoolInfo
      • ELMProduct
      • ELMProjectPermission
      • GenericFault
      • IELMService
      • UnexpectedFault
  • Tasks API
    • Overview
    • ITasksService
    • API
      • GenericFault
      • ITasksService
      • TaskDoesNotExistFault
      • TaskInfo
      • TaskNotFinishedFault
      • TaskResult
      • TaskStatus
      • UnexpectedFault
  • Changelog

Term bases API classes and interfaces

Classes

CreateQTermTBFromTBXSettings

Settings for importing from a TBX file source.

CreateQTermTBFromTBXTaskResult

Encapsulates the result of TBX Import into a new QTerm TB.

CSVImportResult

Represents summary information about a TB import process.

CSVImportSettings

Settings for importing from a CSV file source.

GenericFault

Used for faults that do not have data held, and which are probably not handled in a special way by the caller.

HeavyResourceInfo

Base class for heavy resources (TMInfo, TBInfo and CorpusInfo classes) including some meta data (Domain, Subject, etc.).

HeavyResourceUpdateInfo

Base class for heavy resource property update objects (TMInfo, TBInfo and CorpusInfo classes) including some meta data (Domain, Subject, etc.).

QTermTBImportSettings

Defines the multiterm import settings

ResourceInfo

Base class for resource information objects (such as the TMInfo, TBInfo and CorpusInfo classes encapsulating common information for a TM/TB/Corpus, such as Guid, name and description).

ResourceListFilter

Specifies filter criteria for listing TM/TB/Corpora resources.

ResourceUpdateInfo

Base class for resource property update objects (such as the TMInfo, TBInfo and CorpusInfo classes encapsulating common information for a TM/TB/Corpus, such as Guid, name and description).

TaskDoesNotExistFault

Fault signalling that querying the result of the task failed because the task does not exist.

TaskInfo

Describes the state of an asynchronous task.

TaskNotFinishedFault

Fault signalling that querying the result of the task is not a valid operation while the task is not finished yet.

TaskResult

Result object of tasks. Specific tasks may have specific result objects, inheriting from this class. Exact type is described on the interface where the operation is started.

TBCloneInfo

Encapsulates information required to clone a TB.

TBFilter

Represents a TB listing filter that can be used with ListTBs2 to filter the list of returned TBs.

TBInfo

Encapsulates the description of a TB. This class is derived from ResourceInfo.

TBNewTermDefaultForLanguage

Specifies default values when new terms are added to a term base. Specific to a language of the term base.

TBUpdateInfo

Encapsulates the description of a TB. This class is derived from ResourceUpdateInfo.

TBXExportOptions

Encapsulates the options of the TBX export task.

TBXExportTaskResult

Encapsulates the result of TBX Export.

TBXImportIntoExistingSettings

Settings for importing into an existing TB from a TBX file source.

TBXImportSettings

Settings for importing from a TBX file source.

TBXImportTaskResult

Encapsulates the result of TBX Import.

UnexpectedFault

Throw in case of unexpected errors

Interfaces

ITasksService

Operations related to the management of asynchronous tasks. Tasks are started by operations that are available on other interfaces, this interfaces handles operations on already started tasks.

ITBService

This interface has operations for listing TBs published by the server, importing CSV and exporting CSV.

Enums

TaskStatus

Enumeration representing different light resource types.

TBCaseSensitivity

Specifies recognizing the same term if the capital and lowercase letters are different in the term and in the text.

TBFilterLangMode

Defines how the provided languages are used when filtering TB lists.

TBMatching

Specifies recognizing the grammatical variants, such as suffixed forms.

TBXImportResults

Back to top memoQ Server API documentation