Parámetros de solicitud
|
Tipo de dato |
Valor de muestra |
Descripción |
|---|---|---|
|
charset |
windows-1250 |
Cualquier conjunto de caracteres soportado. |
|
moneda |
EUR |
Cualquier moneda soportada. |
|
fecha y hora |
2012-07-30 17:30 |
Fecha y hora en formato yyyy-MM-dd HH:mm. La zona horaria UTC siempre se utiliza al leer la fecha. |
|
dominio(tipo) |
348 |
Identificador (ID propiedad) de un objeto de dominio del tipo especificado. Por ejemplo, al crear un proyecto, id (p. ej., 348) se devuelve en la estructura JSON. Este identificador puede ser utilizado más tarde para cambiar el estado del proyecto configurando el parámetro proyecto=348. |
|
enum(nombre) |
Un valor de un conjunto fijo de valores. Cada conjunto de valores (enum) tiene un nombre. Enums siempre son insensibles a mayúsculas y minúsculas. |
|
|
archivo |
Datos binarios. Toda la solicitud debe enviarse en formato multipart/form-data. Ejemplos de código en Java y C++. |
|
|
exfile |
Compatible con el tipo de |
|
|
jsonObject(type) |
{ 'id': 'xyz' } |
Un objeto del tipo especificado (representado usando notación JSON). Vea a continuación una descripción de tipos particulares. |
|
jsonObjectList(type) |
[{ 'id': 'xyz' }] |
Una lista de objetos del tipo especificado (representado usando notación JSON). |
|
lang |
en |
Cualquier código de idioma soportado. |
|
lista(tipo) |
Una lista de valores de otro tipo. Al llamar a una acción de API, la lista se define usando el mismo nombre de parámetro varias veces (por ejemplo, |
|
|
cadena |
Mi Proyecto |
La secuencia de caracteres (codificada en UTF-8). |
|
tarea |
RiYnxBD0xBY1lwhf1 |
Un identificador de una tarea de traducción. Más partes de trabajo (si fueron creadas al dividir la parte de trabajo padre) pueden compartir la misma tarea. |
|
mapa(tipo, tipo) |
Un mapa de claves y valores de un tipo dado. Al llamar a una acción de API, el mapa se define utilizando el mismo nombre de parámetro varias veces (por ejemplo, |
Respuesta
El cuerpo de un HTTP puede contener estos tipos de datos:
-
JSON
Estructura de datos (codificada en UTF-8). Cada llamada a la API que devuelve JSON contiene un ejemplo de una respuesta.
-
binario
Datos binarios.
Tarea vs. Parte del trabajo
Tarea
Una tarea representa un trabajo de traducción (es decir, un archivo a ser traducido) en un idioma objetivo. Si se sube un trabajo en más idiomas objetivo, se crea una tarea independiente para cada idioma objetivo.
Si un trabajo se traduce en múltiples flujos de trabajo, cada flujo de trabajo comparte la misma tarea pero difiere en el nivel de flujo de trabajo. (Por eso algunas llamadas a la API tienen dos argumentos para tarea y nivel.) Un identificador de tarea está compuesto de caracteres alfanuméricos (por ejemplo, RiYnxBD0xBY1lwhf1) mientras que un nivel se identifica por un entero (generalmente 1-10). El primer nivel en cada proyecto que utiliza flujos de trabajo siempre tiene el identificador 1.
Los trabajos divididos en múltiples partes tendrán el mismo ID de tarea, y el parámetro isParentJobSplit será true.
Parte del trabajo
Un jobPart representa un trabajo por idioma(s) de destino y pasos de flujo de trabajo. Por ejemplo, un solo archivo importado a un proyecto con 2 pasos de flujo de trabajo y 3 idiomas de destino resultará en 6 jobParts. Cada jobPart puede ser asignado a un lingüista diferente o tener una fecha de entrega o estado diferente.
Cada jobPart también puede dividirse en múltiples jobParts que tendrán su propio jobPart ID. Un jobPart es siempre único.
Tipos de objeto (utilizados en parámetros JSON)
TagMetadata {
cadena id
cadena tipo
cadena contenido
cadena transAttributes
}