ApiDocument
Represents a project document in a given language.
FORMAT
<ApiDocument>
<ProjectId>2147483647</ProjectId>
<DocumentId>2147483647</DocumentId>
<Locale>String content</Locale>
<Name>String content</Name>
<CreationDate>1999-05-31T11:20:00</CreationDate>
<ParserDomain>String content</ParserDomain>
<IsSegmented>true</IsSegmented>
<Reference>String content</Reference>
<Version>String content</Version>
<VersionDate>1999-05-31T11:20:00</VersionDate>
<IsCurrent>true</IsCurrent>
<Format>String content</Format>
<Encoding>String content</Encoding>
<LibraryPath>String content</LibraryPath>
<SourceLocale>String content</SourceLocale>
<CheckDate>1999-05-31T11:20:00</CheckDate>
<CheckErrorCount>2147483647</CheckErrorCount>
<RevisionSetId>2147483647</RevisionSetId>
<TasksStatus_>255</TasksStatus_>
<TasksOpen>32767</TasksOpen>
</ApiDocument>
PROPERTIES
ProjectId | The project |
DocumentId | Uniquely Identifies the source document |
Locale | The language version of this document. If different from property SourceLocale, then the record represents a translation. |
Name | The unique path/name of the document |
CreationDate | Date when the source document was added to Wordbee Translator. |
ParserDomain | The type of document: HTML, WORD, etc. See Parser configurations. |
IsSegmented | True if the document is marked for online translation. False if it is marked for offline translation. |
Reference | The optional reference of the document. The reference does not need to be unique within a project and is entirely user defined. |
Version | The optional version number of the document version. |
VersionDate | Date/time of version. User defined. |
IsCurrent | Indicates whether the document is the most recent version. Applies to Codyt source documents only. |
Format | Document format. Internal use. |
Encoding | Document encoding. Internal use. |
LibraryPath | The physical file path/name in the document library. This typically is the same as "Name" but may vary if translations are created with a different name. If empty, then the translation was not yet saved to the library. |
SourceLocale | The language of the original document. If the present record shows a translation then this tells you the original language. |
CheckDate | If set then this represents the last time the document was validated (quality check). |
CheckErrorCount | If the CheckDate is set then this field contains the number of errors found. |
RevisionSetId | Codyt only. Internal use. |
TasksOpen | Codyt only. The number of tasks that are neither completed nor cancelled. |
TasksStatus | Codyt only. The workflow status for this language ("Locale"): Contains one of the numeric values listed below: /// <summary> /// If not Finished then: /// At least one task is in progress /// COLOR = BLUE /// </summary> InProgress = 0, /// <summary> /// Means that the workflow does not need to go further. /// All tasks are Completed or Cancelled. At least one is Completed. /// COLOR = GREEN /// </summary> Finished = 1, /// <summary> /// Workflow is not yet kicked off. /// - Some tasks are Not Started /// - Some tasks are On Hold /// COLOR = ORANGE /// </summary> Waiting = 2, /// <summary> /// Workflow is in on hold position and can't proceed. Or all tasks are cancelled. /// Condition: all must be true: /// - LocaleStatus != Finished /// - LocaleStatus != Waiting /// - LocaleStatus != Waiting /// COLOR = RED /// </summary> Blocked = 3, |