Parámetros de solicitud
Tipo de datos |
Valor de muestra |
Descripción |
---|---|---|
charset |
windows-1250 |
Cualquier admitido (TMS). |
Moneda |
EUR |
Cualquier admite moneda. |
datetime |
2012-07-30 17:30 |
Fecha y hora en formato aaaa-MM-dd HH:mm. La zona horaria UTC se utiliza siempre cuando se lee la fecha. |
domain(type) |
348 |
Identificador (propiedad ID) de un objeto de dominio del tipo especificado. Por ejemplo, cuando se crea un proyecto, se devuelve ID (p. ej. 348) en la estructura JSON. Este identificador puede utilizarse posteriormente para cambiar el estado del proyecto estableciendo el parámetro proyecto = 348. |
enum(nombre) |
Un valor de un conjunto fijo de valores. Cada conjunto de valores (enum) tiene un nombre. Los números siempre son insensibles a las mayúsculas. |
|
archivo |
Datos binarios. Toda la solicitud debe enviarse en formato multiparte/formulario de datos. Ejemplos de código en Java y C++. |
|
exfile |
Compatible con el tipo de |
|
jsonObject(type) |
{ 'id': 'xyz' } |
Un objeto del tipo especificado (representado mediante notación JSON). Ver abajo para una descripción de tipos particulares. |
jsonObjectList(type) |
[{ 'id': 'xyz' }] |
Una lista de objetos del tipo especificado (representados mediante notación JSON). |
lang |
en |
Cualquier código de idioma admitido. |
list(type) |
Una lista de valores de otro tipo. Al llamar a una acción API, la lista se define utilizando el mismo nombre de parámetro varias veces (p. ej., |
|
cadena |
Mi proyecto |
La secuencia de caracteres (UTF-8 codificada). |
tarea |
RiYnxBD0xBY1lwhf1 |
Un identificador de una tarea de traducción. Más partes de trabajo (si se crearon dividiendo la parte de trabajo elemento raíz) pueden compartir la misma tarea. |
mapa (tipo, tipo) |
Un mapa de claves y valores de un tipo específico. Al llamar a una acción API, el mapa se define utilizando el mismo nombre de parámetro varias veces (p. ej., |
Respuesta
El cuerpo de un HTTP puede contener estos tipos de datos:
-
JSON
Estructura de datos (UTF-8 codificada). Cada llamada API que devuelve JSON contiene un ejemplo de respuesta.
-
binario
Datos binarios.
Tarea vs. Parte del trabajo
Tarea
Una tarea representa un trabajo de traducción (es decir, el archivo a traducir) en un idioma meta. Si se carga un trabajo en más idiomas meta, se crea una tarea independiente para cada idioma meta.
Si un trabajo se traduce en varios flujos de trabajo, cada flujo de trabajo comparte la misma tarea pero difiere en el nivel del flujo de trabajo. (Es por esto que algunas llamadas API tienen dos argumentos para tarea y nivel.) Un identificador de tarea se compone de caracteres alfanuméricos (por ejemplo, RiYnxBD0xBY1lwhf1) mientras que un nivel se identifica mediante un número entero (generalmente 1-10). El primer nivel en cada proyecto que utiliza flujos de trabajo siempre tiene un identificador 1.
Los trabajos divididos en varias partes tendrán la misma tarea ID, y el parámetro esParentJobSplit
será cierto.
Parte del trabajo
Un jobPart representa un trabajo por idioma meta y flujo de trabajo. Por ejemplo, un solo archivo importado a un proyecto con 2 pasos del flujo de trabajo y 3 idiomas meta dará como resultado 6 partes del trabajo. Cada parte del trabajo se puede asignar a un lingüista diferente o tener una fecha de entrega o estado diferente.
Cada jobPart también se puede dividir en varias jobPart que obtendrán su propio jobPart ID. Una parte del trabajo siempre es única.
Tipos de objetos (utilizados en los parámetros JSON)
TagMetadata { cadena ID tipo cadena contenido cadena cadena transAtributos }