Parametri di richiesta
Tipo di dato |
Valore di esempio |
Descrizione |
---|---|---|
charset |
windows-1250 |
Qualsiasi insieme di caratteri supportato. |
valuta |
EUR |
Qualsiasi valuta supportata. |
data e ora |
2012-07-30 17:30 |
Data e ora nel formato yyyy-MM-dd HH:mm. Il fuso orario UTC è sempre utilizzato quando si legge la data. |
dominio(tipo) |
348 |
Identificatore (ID property) di un oggetto dominio del tipo specificato. Ad esempio, quando si crea un progetto, id (ad es., 348) viene restituito nella struttura JSON. Questo identificatore può essere utilizzato in seguito per modificare lo stato del progetto impostando il parametro project=348. |
enum(nome) |
Un valore da un insieme fisso di valori. Ogni insieme di valori (enum) ha un nome. Enums sono sempre insensibili al maiuscolo/minuscolo. |
|
file |
Dati binari. L'intera richiesta deve essere inviata in formato multipart/form-data. Esempi di codice in Java e C++. |
|
exfile |
Compatibile con il tipo di |
|
jsonObject(type) |
{ 'id': 'xyz' } |
Un oggetto del tipo specificato (rappresentato utilizzando la notazione JSON). Vedi sotto per una descrizione di tipi particolari. |
jsonObjectList(type) |
[{ 'id': 'xyz' }] |
Un elenco di oggetti del tipo specificato (rappresentato utilizzando la notazione JSON). |
lang |
en |
Qualsiasi codice della lingua supportato. |
elenco(tipo) |
Un elenco di valori di un altro tipo. Quando si chiama un'azione API, l'elenco è definito utilizzando lo stesso nome di parametro più volte (ad es., |
|
stringa |
Il mio Progetto |
La sequenza di caratteri (codificata in UTF-8). |
attività |
RiYnxBD0xBY1lwhf1 |
Un identificatore di un'attività di traduzione. Alcune parti del lavoro (se create dividendo la parte principale del lavoro) possono condividere la stessa attività. |
mappa(tipo, tipo) |
Una mappa di chiavi e valori di un dato tipo. Quando si chiama un'azione API, la mappa è definita utilizzando lo stesso nome di parametro più volte (ad es., |
Risposta
Il corpo di un HTTP può contenere questi tipi di dati:
-
JSON
Struttura dati (codificata in UTF-8). Ogni chiamata API che restituisce JSON contiene un esempio di risposta.
-
binario
Dati binari.
Attività vs. Parte del lavoro
Attività
Un'attività rappresenta un lavoro di traduzione (cioè un file da tradurre) in una lingua target. Se un lavoro è caricato in più lingue target, viene creata un'attività indipendente per ogni lingua target.
Se un lavoro è tradotto in più flussi di lavoro, ogni flusso di lavoro condivide la stessa attività ma differisce a livello di flusso di lavoro. (Ecco perché alcune chiamate API hanno due argomenti per attività e livello.) Un identificatore di attività è composto da caratteri alfanumerici (ad es., RiYnxBD0xBY1lwhf1) mentre un livello è identificato da un intero (di solito 1-10). Il primo livello in ogni progetto che utilizza flussi di lavoro ha sempre identificatore 1.
I lavori divisi in più parti avranno lo stesso ID attività, e il parametro isParentJobSplit
sarà true.
Parte del lavoro
Un jobPart rappresenta un lavoro per lingua/i di destinazione e fasi del flusso di lavoro. Ad esempio, un singolo file importato in un progetto con 2 fasi del flusso di lavoro e 3 lingue di destinazione risulterà in 6 jobParts. Ogni jobPart può essere assegnato a un diverso traduttore o avere una diversa data di scadenza o stato.
Ogni jobPart può anche essere suddiviso in più jobParts che avranno il proprio jobPart ID. Un jobPart è sempre unico.
Tipi di Oggetti (utilizzati nei parametri JSON)
TagMetadata { stringa id stringa tipo stringa contenuto stringa transAttributes }