• 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 ServerProjectInfo

Encapsulates information about a server project.

Inheritance
Object
ServerProjectInfo
Syntax
public class ServerProjectInfo

Fields

AllowOverlappingWorkflow

Indicates whether overlapping workflow phases are allowed or not. It should be false if the AllowPackageCreation property is true.

Declaration
public bool AllowOverlappingWorkflow
Type
Boolean

AllowPackageCreation

Indicates whether the package creation is allowed or not.

Declaration
public bool AllowPackageCreation
Type
Boolean

Client

The client attribute of the project. Can be null.

Declaration
public string Client
Type
String

CommunicationSettings

The communication settings of the server project. Can be null. Null value means no change to the current settings.

Declaration
public ServerProjectCommunicationSettings CommunicationSettings
Type
ServerProjectCommunicationSettings

ConfirmedCharacterCount

The total number of characters in confirmed segments of all documents of the server project.

Declaration
public int ConfirmedCharacterCount
Type
Int32

ConfirmedSegmentCount

The total number of confirmed segments of all documents of the server project.

Declaration
public int ConfirmedSegmentCount
Type
Int32

ConfirmedWordCount

The total number of words in confirmed segments of all documents of the server project.

Declaration
public int ConfirmedWordCount
Type
Int32

CreateOfflineTMTBCopies

When the project is checked out by a user, she will automatically get an offine copy of the Term bases and Translation memories (as opposed to having them used as remote resources).

Declaration
public bool CreateOfflineTMTBCopies
Type
Boolean

CreationTime

The date and time the server project was created.

Declaration
public DateTime CreationTime
Type
DateTime

CreatorUser

The guid of the user creating the project. T

Declaration
public Guid CreatorUser
Type
Guid

CustomMetas

The default values of custom fields that server saves to the primary translation memory when you confirm segments during translation. It can be an empty string if there are no custom meta values set in the project. Each line has three or more columns, separated by tabs:

metaName   metaType   value   [value2...valueN]

Possible metaType values:

  • FreeText
  • Number
  • DateTime
  • PickListSingle
  • PickListMultiple
The following example demonstrates how to use the CustomMetas field if you have three meta fields: one free text, one number and one single picklist. The string <tab> marks a tabulator character.
FirstMeta<tab>FreeText<tab>The value of the first meta
SecondMeta<tab>Number<tab>12
ThirdMeta<tab>PickListSingle<tab>Value 1<tab>Value 2<tab>Value 3
Declaration
public string CustomMetas
Type
String

Deadline

The deadline of the project.

Declaration
public DateTime Deadline
Type
DateTime

Description

The description of the project. Can be null.

Declaration
public string Description
Type
String

DesktopDocs

True if the project uses DesktopDocs; false for Server documents.

Declaration
public bool DesktopDocs
Type
Boolean

DocumentStatus

The status of the document.

Declaration
public DocumentStatus DocumentStatus
Type
DocumentStatus

Domain

The domain attribute of the project. Can be null.

Declaration
public string Domain
Type
String

DownloadPreview

Downloads the preview of the documents when a user check out the project. Without the preview information no preview is available while translating.

Declaration
public bool DownloadPreview
Type
Boolean

DownloadSkeleton

Downloads the skeleton files (required for exporting documents) when a user checks out the project. Without the files export is not possible. Project managers always recieve these files.

Declaration
public bool DownloadSkeleton
Type
Boolean

EnableCommunication

If true, online communication (chat) is enabled for the project. No forum will be created/assigned to the project even if true.

Declaration
public bool EnableCommunication
Type
Boolean

EnableSplitJoin

Enables the users to split and join segments.

Declaration
public bool EnableSplitJoin
Type
Boolean

EnableWebTrans

Enables web based translation for the project. Split/join is not supported for web based translation, therefore both EnableWebTrans and EnableSplitJoin can not be true (an exception is thrown in this case). For projects created since memoQ server verion 7.0 this member is always true.

Declaration
public bool EnableWebTrans
Type
Boolean

LastChanged

Last change date of the project (content or configuration change).

Declaration
public DateTime LastChanged
Type
DateTime

LockedCharacterCount

The total number of characters in locked segments of all documents of the server project.

Declaration
public int LockedCharacterCount
Type
Int32

LockedSegmentCount

The total number of locked segments of all documents of the server project.

Declaration
public int LockedSegmentCount
Type
Int32

LockedWordCount

The total number of words in locked segments of all documents of the server project.

Declaration
public int LockedWordCount
Type
Int32

Name

The name of the Project. Can not be null or empty.

Declaration
public string Name
Type
String

OmitHitsWithNoTargetTerm

Whether terminology hits with no target term are shown.

Declaration
public bool OmitHitsWithNoTargetTerm
Type
Boolean

PackageResourceHandling

Specifies how the TMs, TBs and LiveDocs corpora are included in the packages. Only for projects that allow package creation.

Declaration
public ServerProjectResourcesInPackages PackageResourceHandling
Type
ServerProjectResourcesInPackages

PreventDeliveryOnQAError

Indicates whether QA errors should prevent document deliver or not.

Declaration
public bool PreventDeliveryOnQAError
Type
Boolean

Project

The project attribute of the project. Can be null.

Declaration
public string Project
Type
String

ProjectStatus

The status of the project.

Declaration
public ServerProjectStatus ProjectStatus
Type
ServerProjectStatus

ProofreadCharacterCount

The total number of characters in proofred segments of all documents of the server project.

Declaration
public int ProofreadCharacterCount
Type
Int32

ProofreadSegmentCount

The total number of proofred segments of all documents of the server project.

Declaration
public int ProofreadSegmentCount
Type
Int32

ProofreadWordCount

The total number of words in proofred segments of all documents of the server project.

Declaration
public int ProofreadWordCount
Type
Int32

RecordVersionHistory

True if document versioning is enabled for the project.

Declaration
public bool RecordVersionHistory
Type
Boolean

Reviewer1ConfirmedCharacterCount

The total number of characters in reviewer 1 confirmed segments of all documents of the server project.

Declaration
public int Reviewer1ConfirmedCharacterCount
Type
Int32

Reviewer1ConfirmedSegmentCount

The total number of reviewer 1confirmed segments of all documents of the server project.

Declaration
public int Reviewer1ConfirmedSegmentCount
Type
Int32

Reviewer1ConfirmedWordCount

The total number of words in reviewer 1 confirmed segments of all documents of the server project.

Declaration
public int Reviewer1ConfirmedWordCount
Type
Int32

ServerProjectGuid

The guid of the server project.

Declaration
public Guid ServerProjectGuid
Type
Guid

SourceLanguageCode

The three+(two) letter code of the source language of the server project. (such as fre, eng, eng-US). Can not be null or empty.

Declaration
public string SourceLanguageCode
Type
String

StrictSubLangMatching

Whether sublanguages are treated as separate languages during TB lookup.

Declaration
public bool StrictSubLangMatching
Type
Boolean

Subject

The subject attribute of the project. Can be null.

Declaration
public string Subject
Type
String

TargetLanguageCodes

The three+(two) letter code of the target languages of the server project. (such as fre, eng, eng-US). Can not be null and the items can not be null or empty.

Declaration
public string[] TargetLanguageCodes
Type
String[]

TimeClosed

The date and time when the project was closed. If the project is not closed, the value is 01/01/2500.

Declaration
public DateTime TimeClosed
Type
DateTime

TotalCharacterCount

The total number of characters of all documents of the server project, including the number of characters in locked segments.

Declaration
public int TotalCharacterCount
Type
Int32

TotalSegmentCount

The total number of segments of all documents of the server project, including the number of locked segments.

Declaration
public int TotalSegmentCount
Type
Int32

TotalWordCount

The total number of words of all documents of the server project, including the number of words in locked segments.

Declaration
public int TotalWordCount
Type
Int32

WeightedChars

The cumulative weighted character count of the project. The value may not be available (if there is any document without analysis), in which case the value is -1.

Declaration
public float WeightedChars
Type
Single

WeightedWords

The cumulative weighted word count of the project. The value may not be available (if there is any document without analysis), in which case the value is -1.

Declaration
public float WeightedWords
Type
Single
Back to top memoQ Server API documentation