Parâmetros de solicitação
Tipo de dado |
Valor de amostra |
Descrição |
---|---|---|
charset |
windows-1250 |
Qualquer conjunto de caracteres . |
moeda |
EUR |
Qualquer moeda |
data/hora |
2012-07-30 17:30 |
Data e hora no formato aaaa-MM-dd HH:mm. O fuso horário UTC é sempre usado ao ler a data. |
domínio(tipo) |
348 |
Identificador (propriedade ID) de um objeto de domínio do tipo especificado. Por exemplo, ao criar um projeto, id (por exemplo, 348) é retornado na estrutura JSON. Esse identificador pode ser usado posteriormente para alterar o status do projeto definindo o parâmetro project=348. |
enum(nome) |
Um valor de um conjunto fixo de valores. Cada conjunto de valores (enum) tem um nome. Os enums são sempre sensíveis a maiúsculas e minúsculas. |
|
arquivo |
Dados binários. Todo o pedido tem de ser enviado em formato de várias partes/formulários-dados. Exemplos de código em Java e C++. |
|
exfile |
Compatível com o tipo |
|
jsonObject(type) |
{ 'id': 'xyz' } |
Um objeto do tipo especificado (representado usando notação JSON). Veja abaixo uma descrição de tipos específicos. |
jsonObjectList(type) |
[{ 'id': 'xyz' }] |
Uma lista de objetos do tipo especificado (representado usando notação JSON). |
Lang |
en |
Qualquer código de idioma suportado. |
lista(tipo) |
Uma lista de valores de outro tipo. Ao chamar uma ação de API, a lista é definida usando o mesmo nome de parâmetro várias vezes (por exemplo, |
|
string |
Meu Projeto |
A sequência de caracteres (UTF-8 codificada). |
tarefa |
RiYnxBD0xBY1lwhf1 |
Um identificador de uma tarefa de tradução. Mais partes de trabalho (se tiverem sido criadas dividindo a parte de trabalho pai) podem compartilhar a mesma tarefa. |
map(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 estes tipos de dados:
-
JSON
Estrutura de dados (UTF-8 codificada). 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 carregado em mais idiomas de destino, uma tarefa independente será 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.
Os trabalhos divididos em várias partes terão a mesma 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 jobParts. Cada jobPart pode ser atribuído a um linguista diferente ou ter uma data de vencimento ou status diferente.
Cada jobPart também pode ser dividido em vários jobParts que receberão seu próprio jobPart ID. Um jobPart é sempre único.
Tipos de objeto (usados em parâmetros JSON)
TagMetadata { ID da cadeia de caracteres tipo de cadeia de caracteres conteúdo da cadeia de caracteres string transAtributos }