Parametri di richiesta
Tipo di dati |
Valore di esempio |
Descrizione |
---|---|---|
set di caratteri |
windows-1250 |
Qualsiasi supportato (TMS). |
valuta |
EUR |
|
data e ora |
2012-07-30 17:30 |
Data e ora in formato yyyy-MM-dd HH:mm. Il fuso orario UTC viene sempre usato durante la lettura della data. |
dominio (tipo) |
348 |
Identificatore (proprietà ID) di un oggetto di dominio del tipo specificato. Ad esempio, durante la creazione di un progetto, nella struttura JSON viene restituito ID (ad esempio 348). Questo identificatore può essere successivamente utilizzato per modificare lo stato del progetto impostando il parametro Progetto = 348. |
enum(nome) |
Un valore da un insieme fisso di valori. Ogni insieme di valori (enum) ha un nome. Gli enum sono sempre insensibili alle maiuscole e minuscole. |
|
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 (tipo) |
{ 'id': 'xyz' } |
Un oggetto del tipo specificato (rappresentato tramite notazione JSON). Vedi sotto per una descrizione di tipi particolari. |
jsonObjectList(type) |
[{ 'ID': 'xyz' }] |
Un elenco di oggetti del tipo specificato (rappresentati tramite notazione JSON). |
lang |
it |
Qualsiasi codice della lingua supportato. |
Elenco (tipo) |
Un elenco di valori di un altro tipo. Quando si chiama un'azione API, l'elenco viene definito utilizzando più volte lo stesso nome di parametro (ad esempio |
|
stringa |
Il mio progetto |
La sequenza di caratteri (codifica UTF-8). |
attività |
RiYnxBD0xBY1lwhf1 |
Un identificatore di un'attività di traduzione. Più parti lavoro (se sono state create dividendo la parte lavoro dell'entità principale) possono condividere la stessa attività. |
mappa (tipo, tipo) |
Mappa di chiavi e valori di un dato tipo. Quando si chiama un'azione API, la mappa viene definita utilizzando più volte lo stesso nome di parametro (ad esempio, |
Risposta
Il corpo di un HTTP può contenere questi tipi di dati:
-
JSON
Struttura dati (codifica UTF-8). Ogni chiamata API che restituisce JSON contiene un esempio di risposta.
-
binario
Dati binari.
Attività vs. Parte lavoro
Attività
Un'attività rappresenta un lavoro di traduzione (es. file da tradurre) in una lingua di destinazione. Se un lavoro viene caricato in più lingue di destinazione, viene creata un'attività indipendente per ogni lingua di destinazione.
Se un lavoro viene tradotto in più flussi di lavoro, ogni flusso di lavoro condivide la stessa attività ma differisce a livello di flusso di lavoro. (Questo è il motivo per cui 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 numero intero (di solito 1-10). Il primo livello in ogni progetto che utilizza flussi di lavoro ha sempre l'identificatore 1.
I lavori divisi in più parti avranno lo stesso ID attività e il parametro isParentJobSplit
sarà vero.
Parte lavoro
Un jobPart rappresenta un lavoro per lingua di destinazione e passaggi del flusso di lavoro. Ad esempio, un singolo file importato in un progetto con 2 passaggi del flusso di lavoro e 3 lingue di destinazione darà luogo a 6 jobPart. Ogni jobPart può essere assegnato a un traduttore diverso o avere una data di scadenza o uno stato diverso.
Ogni jobPart può anche essere diviso in più jobPart che otterranno il proprio jobPart ID. Un jobPart è sempre unico.
Tipi di oggetto (utilizzati nei parametri JSON)
TagMetadata { ID stringa tipo stringa contenuto stringa stringa transAttributes }