Skip to main content

ApiJobDocument

Represents a document of a job.


FORMAT

XML
<ApiJobDocument>
<ProjectJobId>2147483647</ProjectJobId>
<BeeDocumentId>2147483647</BeeDocumentId>
<Name>String content</Name>
<Version>String content</Version>
<Reference>String content</Reference>
<Locale>String content</Locale>
<CreationDate>1999-05-31T11:20:00</CreationDate>
<IsSegmented>true</IsSegmented>
<EParser_>32767</EParser_>
<ParserDomain>String content</ParserDomain>
<JobDocumentStatus_>255</JobDocumentStatus_>
<JobDocumentComments>String content</JobDocumentComments>
<JobDocumentPath>String content</JobDocumentPath>
<BeeDocumentSetId>2147483647</BeeDocumentSetId>
<ParagraphFrom>2147483647</ParagraphFrom>
<ParagraphTo>2147483647</ParagraphTo>
<Paragraphs>2147483647</Paragraphs>
</ApiJobDocument>

 

PROPERTIES

ProjectJobId

The job to which this document is attached.

BeeDocumentId

The unique document id. The document is part of the project to which the job belongs.

Name

The unique document name (within the project)

Version

The document version. Currently not used.

Reference

The document reference. Not necessarily unique and set by user.

Locale

The source language of the document. This is the same as the source language of the parent job.

CreationDate

Date when the original document was inserted into the project.

IsSegmented

True: The document is marked for online translation. False: The document is marked for offline translation.

EParser

Internal use.

ParserDomain

The type of document: HTML, WORD, EXCEL, etc.

JobDocumentStatus_

The work status of the document:

/// <summary>

/// Document was not yet submitted.

/// </summary>

InProgress = 0,

/// <summary>

/// Submitted.

/// </summary>

Done = 1,

/// <summary>

/// Document rejected.

/// </summary>

Rejected = 2,

/// <summary>

/// Work on the document has not yet started

/// </summary>

NotStarted = 3

JobDocumentComments

Comments added to the document and private to the job. Used to exchange messages between supplier and ordering party.

JobDocumentPath

The path/name of the deliverable. Usually identical to the "Name" field which is the path/name of the original document.

BeeDocumentSetId

Internal use.

ParagraphFrom

Information included when requesting details for a specific document of a job only

From which paragraph the job start with.

ParagraphTo

Information included when requesting details for a specific document of a job only

To which paragraph the job end with.

Paragraphs

Information included when requesting details for a specific document of a job only

The number of paragraphs for the document.






JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.