• Introduction
  • Web Service API
  • Callback service
Search Results for

    Show / Hide Table of Contents
    • Overview
    • Concepts
      • API functionality
      • Web Service technology
      • Security
      • Accessing the services
      • Error reporting
      • Synchronous and asynchronous API
      • Testing
      • Telemetry
    • Translation memory API
      • Overview
      • ITMService
      • Lookup, concordance
      • Import, export
      • API
        • ConcordanceRequest
        • GenericFault
        • HeavyResourceInfo
        • HeavyResourceUpdateInfo
        • ImportTMMetadataSchemeResultInfo
        • InlineTagStrictness
        • InvalidSessionIdFault
        • ITMService
        • LookupSegmentRequest
        • NoLicenseFault
        • RequestXmlFormatFault
        • ResourceInfo
        • ResourceListFilter
        • ResourceUpdateInfo
        • ResultInfo
        • TMEngineType
        • TMFault
        • TMInfo
        • TMListFilter
        • TMOptimizationPreference
        • TMUpdateInfo
        • TmxImportResult
        • TmxImportSettings
        • UnauthorizedAccessFault
        • UnexpectedFault
    • Term bases API
      • Overview
      • ITBService
      • Import, export
        • CSV
        • TBX
        • MultiTerm
      • API
        • CreateQTermTBFromTBXSettings
        • CreateQTermTBFromTBXTaskResult
        • CSVExportSettings
        • CSVExportTaskResult
        • CSVImportIntoExistingSettings
        • CSVImportIntoExistingTaskResult
        • CSVImportResult
        • CSVImportSettings
        • GenericFault
        • HeavyResourceInfo
        • HeavyResourceUpdateInfo
        • ITasksService
        • ITBService
        • QTermTBImportSettings
        • ResourceInfo
        • ResourceListFilter
        • ResourceUpdateInfo
        • ResultInfo
        • 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
        • AggregatedLqaStatistics
        • AnalysisAsCSVResult
        • AnalysisAsCSVResultForLang
        • AnalysisOptions
        • AnalysisReportCounts
        • AnalysisReportForDocument
        • AnalysisReportInfo
        • AnalysisReportItem
        • AnalysisResultForLang
        • AnalysisResultInfo
        • AsiaOnlineBeginTranslationResultInfo
        • AsiaOnlineDomainCombination
        • AsiaOnlineGetDomainCombinationsResultInfo
        • AsiaOnlineGetLanguagePairCodeResultInfo
        • AsiaOnlineGetProjectIdsResultInfo
        • AsiaOnlineTranslateOptions
        • AsiaOnlineTranslationResultInfo
        • AsiaOnlineTranslationStatus
        • AssignmentChangeHistoryItemInfo
        • AutomatedActionStartedHistoryItemInfo
        • AutomatedActionStartedHistoryItemInfo.AutomatedActionTypes
        • AutoSplitJoinSettings
        • BilingualDocFormat
        • CannotStartOperationFault
        • ConfirmAndUpdateDocError
        • ConfirmAndUpdateOptions
        • ConfirmAndUpdateResultInfo
        • ConfirmAndUpdateSegmentStatuses
        • ConfirmAndUpdateTaskResult
        • ConfirmAndUpdateTMBehaviors
        • ConfirmAndUpdateUserNameBehaviors
        • CorpusLanguagePair
        • CreateDeliveryResult
        • CreateStatisticsOnDocumentsRequest
        • CreateStatisticsOnProjectRequest
        • CreateStatisticsRequestBase
        • CsvSeparator
        • CustomPreTranslateParameter
        • DeadlineChangeHistoryItemInfo
        • DeliverDocumentFault
        • DeliverDocumentRequest
        • DistanceMeasurementMode
        • DocDeliveryResult
        • DocDeliveryResultInfo
        • DocumentAssignmentRoleId
        • DocumentBilingualImportHistoryItemInfo
        • DocumentDeliverHistoryItemInfo
        • DocumentExportOptions
        • DocumentHistoryItemInfo
        • DocumentHistoryItemType
        • DocumentHistoryRequest
        • DocumentImportHistoryItemInfo
        • DocumentLqaRejectedSegments
        • DocumentLqaStatistics
        • DocumentReturnHistoryItemInfo
        • DocumentRowsLockedHistoryItemInfo
        • DocumentRowsLockedHistoryItemInfo.LockModes
        • DocumentSlicingHistoryItemInfo
        • DocumentSnapshotCreatedHistoryItemInfo
        • DocumentStatus
        • DocumentXTranslationHistoryItemInfo
        • EditDistanceCsvResult
        • EditDistanceReportInfo
        • EditDistanceStatisticsOptions
        • ExpectedFinalStateAfterXTranslate
        • ExpectedSourceStateBeforeXTranslate
        • FileResultInfo
        • FirstAcceptAcceptHistoryItemInfo
        • FirstAcceptAssignHistoryItemInfo
        • FirstAcceptDeclineHistoryItemInfo
        • FirstAcceptFailedHistoryItemInfo
        • FirstAcceptStatus
        • FirstAcceptUserDecision
        • FragmentAssemblySettings
        • FuzzyEditDistanceReport
        • FuzzyEditDistanceResult
        • FuzzyEditDistanceResultForDocument
        • FuzzyEditDistanceResultForLang
        • FuzzyEditDistanceTaskResult
        • GenericFault
        • GroupSourcingAssignHistoryItemInfo
        • GroupSourcingDocumentDeliverHistoryItemInfo
        • ImportImageLocalizationPackResultInfo
        • ImportTranslationDocumentOptions
        • IServerProjectService
        • LevenshteinEditDistanceReport
        • LevenshteinEditDistanceResult
        • LevenshteinEditDistanceResultForDocument
        • LevenshteinEditDistanceResultForLang
        • LevenshteinEditDistanceTaskResult
        • ListServerProjectTranslationDocument2Options
        • ListServerProjectTranslationDocumentSliceOptions
        • ListTranslationDocumentAssignmentsOptions
        • LockUnlockSegmentsAction
        • LockUnlockSegmentsCondition
        • LockUnlockSegmentsOptions
        • LqaCorrection
        • LqaModelBaseInfo
        • LqaModelStatisticsSummary
        • LqaRejectedSegment
        • LqaRejectedSegmentsOptions
        • LqaRejectedSegmentsReport
        • LqaRejectedSegmentsTaskResult
        • LqaRejection
        • LqaRejectionType
        • LQAResult
        • LqaStatisticsExportFormat
        • LqaStatisticsGenerationOptions
        • LqaStatisticsReport
        • LqaStatisticsTaskResult
        • MatchCoverageType
        • NewRevisionScenarioOptions
        • NumberOfErrorsForSeverity
        • NumberOfErrorsPerSeveritiesForCategory
        • OptionsForAllRowsThatMatchACertainCondition
        • OptionsForRowsInDifferentLanguage
        • PackageContentDocument
        • PackageContentInfo
        • PackageCreationNotAllowedFault
        • PackageDeliveryOptions
        • PackageDeliveryResult
        • PackageDeliveryResultInfo
        • PackageImportOptions
        • PackageInfo
        • PackageType
        • PenaltyPointsForCategory
        • PostTransAnalysisReportForDocument
        • PostTransAnalysisReportForUser
        • PostTransAnalysisReportItem
        • PostTranslationAnalysisAsCSVResult
        • PostTranslationAnalysisAsCSVResultForLang
        • PostTranslationAnalysisOptions
        • PostTranslationAnalysisReportInfo
        • PostTranslationAnalysisResultInfo
        • PostTranslationAnalysisTaskResult
        • PostTranslationReportCounts
        • PostTranslationResultForLang
        • PreparePackageResultInfo
        • PreTransFilter
        • PretranslateCopySourceToTargetBehavior
        • PretranslateCopySourceToTargetConditions
        • PretranslateExpectedFinalTranslationState
        • PretranslateLookupBehavior
        • PretranslateOptions
        • PreTranslateProblem
        • PretranslateStateToConfirmAndLock
        • PreTranslateTaskResult
        • PreviewCreation
        • ProjectLaunchedHistoryItemInfo
        • ProjectLqaStatistics
        • QAReport
        • QAReportForDocument
        • QAReportTypes
        • ReconsolidateDocumentFault
        • ReimportDocumentOptions
        • RenameProjectFault
        • ResultInfo
        • ResultStatus
        • RtfBilingualExportOptions
        • RunQAGetReportOptions
        • RunQATaskResult
        • SegmentStatuses
        • ServerProjectAddLanguageInfo
        • ServerProjectCommunicationSettings
        • ServerProjectConfidentialitySettings
        • ServerProjectCorporaAssignments
        • ServerProjectCreateInfo
        • ServerProjectDesktopDocsCreateInfo
        • ServerProjectInfo
        • ServerProjectListFilter
        • ServerProjectNotificationSettings
        • ServerProjectPackageDetails
        • ServerProjectPackageResourceHandlingOptions
        • 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
        • TMLanguagePair
        • 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
        • TurnOffAutoPilotFault
        • TwoColumnRtfBilingualExportOptions
        • UnexpectedFault
        • UpdateWithTableRtfOptions
        • UserInfoHeader
        • WordCountMode
        • 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
        • WeakPasswordFault
    • 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
    • ICR configuration API
      • Overview
      • IIcrConfigService
      • API
        • DefaultDisplayConfig
        • GenericFault
        • IcrConfig
        • IcrConfigCreate
        • IcrConfigMeta
        • IcrResources
        • IcrSettings
        • IIcrConfigService
        • NoLicenseFault
        • QACategoriesConfig
        • QAConfig
        • UnexpectedFault
    • Changelog

    Interface ILiveDocsService

    This interface has operations for listing managing corpora on the memoQ Server.

    Syntax
    public interface ILiveDocsService

    Methods

    AlignDocumentsGetTmx(DocumentForAlignment, DocumentForAlignment, AlignmentOptions)

    Performs structural alignment of two documents and exports the aligned segment pairs as a TMX. First the documents are imported using the specified configurations, then the alignment is performed, and the resulting matched segment pairs are exported into a TMX (optionally zipped). The two files must be uploaded using IFileManagerServive before invoking this operation. If the result is success, the resulting file can also be downloaded using IFileManagerService.

    Declaration
    AlignmentResultInfo AlignDocumentsGetTmx(DocumentForAlignment source, DocumentForAlignment target, AlignmentOptions options)
    Parameters
    Type Name Description
    DocumentForAlignment source

    The source document and its import configuration.

    DocumentForAlignment target

    The target document and its import configuration.

    AlignmentOptions options

    Options of the alignment operation.

    Returns
    Type Description
    AlignmentResultInfo

    Object describing the result fo the process and a reference to the TMX file containing the aligned pairs.

    Exceptions
    Type Condition
    UnexpectedFault

    An unexpected error occurred; equivalent of an 501 'Internal server error' http result.

    GenericFault

    The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

    CreateAndPublish(CorpusInfo)

    Creates a new corpus with the parameters specified by the info operation parameter.

    Declaration
    Guid CreateAndPublish(CorpusInfo info)
    Parameters
    Type Name Description
    CorpusInfo info

    The parameters of the corpus to be created. The Guid and the Languages members of the info parameter are ignored.

    Returns
    Type Description
    System.Guid

    The Guid of the newly created corpora.

    Exceptions
    Type Condition
    UnexpectedFault

    An unexpected error occurred; equivalent of an 501 'Internal server error' http result.

    GenericFault

    The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

    DeleteCorpus(Guid)

    Deletes a corpus.

    Declaration
    void DeleteCorpus(Guid corpusGuid)
    Parameters
    Type Name Description
    System.Guid corpusGuid

    The guid of the corpus to be deleted.

    Exceptions
    Type Condition
    UnexpectedFault

    An unexpected error occurred; equivalent of an 501 'Internal server error' http result.

    GenericFault

    The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

    GetCorpusInfo(Guid)

    Gets information about the specified corpus.

    Declaration
    CorpusInfo GetCorpusInfo(Guid corpusGuid)
    Parameters
    Type Name Description
    System.Guid corpusGuid

    The guid of the corpus.

    Returns
    Type Description
    CorpusInfo

    The CorpusInfo object describing the corpus.

    Exceptions
    Type Condition
    UnexpectedFault

    An unexpected error occurred; equivalent of an 501 'Internal server error' http result.

    GenericFault

    The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

    ImportReferenceDocuments(Guid, ImportFileIntoLiveDocsOptions[])

    Imports multiple reference documents into a LiveDocs corpus. The options of the import are configured for each file separately using the appropriate descendent of ImportFileIntoLiveDocsOptions, namely

    • ImportBinaryFileIntoLiveDocsOptions,
    • ImportMonoOrBilingualFileIntoLiveDocsOptions,
    • ImportLiveDocsXliffFileIntoLiveDocsOptions.
    Declaration
    ImportFileIntoLiveDocsResultInfo[] ImportReferenceDocuments(Guid corpusGuid, ImportFileIntoLiveDocsOptions[] importOptions)
    Parameters
    Type Name Description
    System.Guid corpusGuid

    The ID of corpus to import into.

    ImportFileIntoLiveDocsOptions[] importOptions
    Returns
    Type Description
    ImportFileIntoLiveDocsResultInfo[]

    A result object for each imported file in the same order the import options are specified.

    Exceptions
    Type Condition
    UnexpectedFault

    An unexpected error occurred; equivalent of an 501 'Internal server error' http result.

    GenericFault

    The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

    ListCorpora(String[])

    Returns the list of corpora published by the memoQ Server.

    Declaration
    CorpusInfo[] ListCorpora(string[] languages)
    Parameters
    Type Name Description
    System.String[] languages

    Can be used to filter the returned list of corpora based on the languages of the corpora. It is allowed to provide null.

    Returns
    Type Description
    CorpusInfo[]

    An array of CorporaInfo objects each describing one corpora.

    Exceptions
    Type Condition
    UnexpectedFault

    An unexpected error occurred; equivalent of an 501 'Internal server error' http result.

    GenericFault

    The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

    ListCorpora2(CorpusListFilter)

    Returns the list of corpora published by the memoQ Server mathing the specified filter.

    Declaration
    CorpusInfo[] ListCorpora2(CorpusListFilter filter)
    Parameters
    Type Name Description
    CorpusListFilter filter

    Optional filter criteria.

    Returns
    Type Description
    CorpusInfo[]

    An array of CorporaInfo objects each describing one corpora.

    Exceptions
    Type Condition
    UnexpectedFault

    An unexpected error occurred; equivalent of an 501 'Internal server error' http result.

    GenericFault

    The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

    UpdateProperties(CorpusUpdateInfo)

    Updates the properties of a corpus. (Renaming a corpus is also possible by updating its name via this operation.)

    Declaration
    void UpdateProperties(CorpusUpdateInfo updateInfo)
    Parameters
    Type Name Description
    CorpusUpdateInfo updateInfo

    The new properties of the corpus. The Guid member identifies the corpus to be updated.

    Exceptions
    Type Condition
    UnexpectedFault

    An unexpected error occurred; equivalent of an 501 'Internal server error' http result.

    GenericFault

    The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults.

    In This Article
    Back to top WS API documentation