• 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

Class DocumentForAlignment

Specifies one of the documents and its import settings for alignment.

Inheritance
Object
DocumentForAlignment
Syntax
public class DocumentForAlignment

Fields

FileId

The guid of the file to be imported. The file has to be uploaded before calling invoking the alignment. IFileManagerService.BeginChunkedFileUpload and related operations. This guid is returned by IFileManagerService.BeginChunkedFileUpload.

Declaration
public Guid FileId
Type
Guid

ImportConfigurationResourceAsString

The settings of the import in memoQ import filter XML format or memoQ resource former. This setting also determines the filter (txt, doc, etc.) to be used. Either this, or ImportConfigurationResourceId must specify the configuration.

Declaration
public string ImportConfigurationResourceAsString
Type
String

ImportConfigurationResourceId

The identifier of the Filter Configuration resource published by memoQ Server which spcifies the filter and the configuration for importing the document. This setting also determines the filter (txt, doc, etc.) to be used. Either this, or ImportConfigurationResourceAsString must specify the configuration.

Declaration
public Guid? ImportConfigurationResourceId
Type
Nullable<Guid>

Language

The language of the document.

Declaration
public string Language
Type
String

SegmentationRuleResourceId

The identifier of the Segmentation rule resource published by memoQ Server which spcifies the segmentation rule for importing the document. If the value is not specified (null), the document will not be segmented. If Guid.Empty is specified, the langauge's default segmentation rule specified by the server will be used. If the value is a valid Guid, the segmentation rule identified by the Guid is used. The default is null/missing value, which means no segmentation.

Declaration
public Guid? SegmentationRuleResourceId
Type
Nullable<Guid>
Back to top memoQ Server API documentation