Parâmetros de Solicitação
Tipo de Dados |
Valor de Exemplo |
Descrição |
---|---|---|
charset |
windows-1250 |
Qualquer conjunto de caracteres suportado. |
moeda |
EUR |
Qualquer moeda suportada. |
datahora |
2012-07-30 17:30 |
Data e hora no formato yyyy-MM-dd HH:mm. O fuso horário UTC é sempre usado ao ler a data. |
domínio(tipo) |
348 |
Identificador (ID propriedade) de um objeto de domínio do tipo especificado. Por exemplo, ao criar um projeto, id (por exemplo, 348) é retornado na estrutura JSON. Este identificador pode ser usado posteriormente para alterar o estado do projeto definindo o parâmetro projeto=348. |
enum(nome) |
Um valor de um conjunto fixo de valores. Cada conjunto de valores (enum) tem um nome. Enums são sempre insensíveis a maiúsculas e minúsculas. |
|
arquivo |
Dados binários. A solicitação inteira deve ser enviada no formato multipart/form-data. Exemplos de código em Java e C++. |
|
exfile |
Compatível com o tipo de |
|
jsonObject(type) |
{ 'id': 'xyz' } |
Um objeto do tipo especificado (representado usando notação JSON). Veja abaixo uma descrição de tipos particulares. |
jsonObjectList(type) |
[{ 'id': 'xyz' }] |
Uma lista de objetos do tipo especificado (representado usando notação JSON). |
lang |
en |
Qualquer código do idioma suportado. |
lista(tipo) |
Uma lista de valores de outro tipo. Ao chamar uma ação da API, a lista é definida usando o mesmo nome de parâmetro várias vezes (por exemplo, |
|
string |
Meu Projeto |
A sequência de caracteres (codificada em UTF-8). |
tarefa |
RiYnxBD0xBY1lwhf1 |
Um identificador de uma tarefa de tradução. Mais partes de trabalho (se foram criadas dividindo a parte de trabalho principal) podem compartilhar a mesma tarefa. |
mapa(tipo, tipo) |
Um mapa de chaves e valores de um determinado tipo. Ao chamar uma ação de API, o mapa é definido usando o mesmo nome de parâmetro várias vezes (por exemplo, |
Resposta
O corpo de um HTTP pode conter esses tipos de dados:
-
JSON
Estrutura de dados (codificada em UTF-8). Cada chamada de API que retorna JSON contém um exemplo de uma resposta.
-
binário
Dados binários.
Tarefa vs. Parte do Trabalho
Tarefa
Uma tarefa representa um trabalho de tradução (ou seja, arquivo a ser traduzido) em um idioma de destino. Se um trabalho for enviado em mais idiomas de destino, uma tarefa independente é criada para cada idioma de destino.
Se um trabalho for traduzido em vários fluxos de trabalho, cada fluxo de trabalho compartilha a mesma tarefa, mas difere no nível do fluxo de trabalho. (É por isso que algumas chamadas de API têm dois argumentos para tarefa e nível.) Um identificador de tarefa é composto por caracteres alfanuméricos (por exemplo, RiYnxBD0xBY1lwhf1) enquanto um nível é identificado por um inteiro (geralmente 1-10). O primeiro nível em cada projeto que usa fluxos de trabalho sempre tem o identificador 1.
Trabalhos divididos em várias partes terão o mesmo ID de tarefa, e o parâmetro isParentJobSplit
será true.
Parte do Trabalho
Um jobPart representa um trabalho por idioma(s) de destino e etapas do fluxo de trabalho. Por exemplo, um único arquivo importado para um projeto com 2 etapas de fluxo de trabalho e 3 idiomas de destino resultará em 6 partes do trabalho. Cada jobPart pode ser atribuído a um Linguista diferente ou ter uma data de entrega ou estado diferente.
Cada jobPart também pode ser dividido em múltiplos jobParts que terão seu próprio jobPart ID. Um jobPart é sempre único.
Tipos de Objetos (usados em parâmetros JSON)
TagMetadata { string ID string tipo string conteúdo string transAttributes }