Documents
Last updated
Was this helpful?
Last updated
Was this helpful?
id
string
The unique identifier of the document.
ref
string
The reference identifying the document.
title
string
The title of the document.
activity_name
string
The activity of the document.
status
string
created_at
string
updated_at
string
completed_at
string
started_at
string
submitted_at
string
language_from_code
string
language_to_code
string
word_count
integer
The number of words in the document.
category
string
deliver_work_as_file
boolean
Whether the author has to submit its work as a file or not. Default to false.
TextMaster supports automated word-counting for translation and proofreading documents. An automated count can be scheduled by setting the perform_word_count to true. In this case word_count can be omitted and will be ignored if provided.
In case of an error, the API response will contain a word_count_error: true node. The two most common failure reasons are:
Unsupported file format for file attachments, in this case a new file must be uploaded
For key/value and plain text documents, the only possible reason is a temporary service issue
For translation documents, the automated word-counting can be configured to count translatable content in HTML/XML documents, using the markup_in_content option.
Warning: If you're using this parameter, you must wait for word_count_finished callback for all documents before attempting to launch the project.
Warning: Due to HTTP protocol limitation, prefere using remote_file_url field than original_content field to avoid server timeout. HTTP protocol purpose is not to transfer large amount of data, like file or various document. See Providing content as a file Section for more information
The markup_in_content option indicates whether the original content contains markup (HTML, XML, …) or not. Always set it to true for HTML/XML files. Failing to doing so could result in tag names being counted as words and translated, and you being charged for that work. For files with a .html or .xml extension, this parameter is assumed to be true. It defaults to false otherwise.
You can choose to provide the original content as a file instead of providing as raw data. To do so, provide the URL of the file as remote_file_url. To learn more about uploading files, see:
Creates several documents at once. Accepts the same document parameters as singular version, but there can be several of them and they must be placed into a documents array.
Generates the document's review URL which points to the work that requires author review. You can for example, copy this URL into the message sent to the assigned author when completed the document.
The update document endpoint takes the same parameters as the create endpoint. Note that you can't update a document once its project has been launched.
Approve the work done by the assigned author and mark the document as completed. Note that when all documents in a project are completed, the project is considered completed too.
Note that you can't delete a document once its project has been launched.
You can use the to filter documents on a collection of criteria.
The status of the document. See the section.
Describes the time the document was created. This is a timestamp in format: YYYY-MM-DDTHH:MM:SSZ.
Describes the time the document was last updated. This is a timestamp in format: YYYY-MM-DDTHH:MM:SSZ.
Describes the time the document was completed. This is a timestamp in format: YYYY-MM-DDTHH:MM:SSZ.
Describes the time the assigned author started working on the document. This is a timestamp in format: YYYY-MM-DDTHH:MM:SSZ.
Describes the time the assigned author submitted its work on the document. This is a timestamp in format: YYYY-MM-DDTHH:MM:SSZ.
The source language code of the document. One of the language code returned by the endpoint.
The target language code of the document. One of the language code returned by the endpoint.
The category identifier for the document. One of the category returned by the endpoint.
For translation or proofreading documents, the content can be provided directly or by using the . For standard documents, the original content is a sentence in a readable format (txt, html, …). For key/value documents, the original content has to be an object with a unique key associated to a value.
You can specify callbacks using the callback property. It's an object listing URLs to call for each document status. See the list of supported .
The Project ID.
Search results are limited to 100 items. Specify page number to read more than the first page.
URL encoded JSON selector composed of one or several criteria.
Comma separated order list
The Project ID.
The Document ID.
Satisfaction level. * positive * neutral (default) * negative
Message addressed to the Author.
The Project ID.
Satisfaction level. * positive * neutral (default) * negative
Message addressed to the Author.