Parametry požadavku
|
Datový typ |
Ukázková hodnota |
Popis |
|---|---|---|
|
znaková sada |
windows-1250 |
Jakákoli podporovaná znaková sada. |
|
Měna |
EUR |
Jakákoli podporovaná Měna. |
|
datetime |
2012-07-30 17:30 |
Datum a čas ve formátu yyyy-MM-dd HH:mm. Při čtení data se vždy používá časové pásmo UTC. |
|
doména(typ) |
348 |
Identifikátor (ID vlastnosti) objektu doména zadaného typu. Například při vytváření projekt se v JSON struktuře vrací ID (např. 348). Tento identifikátor lze později použít ke změnit stavu projekt nastavením parametru projekt=348. |
|
enum(název) |
Hodnota z pevně stanovené sady hodnot. Každá sada hodnot (enum) má název. Enums jsou vždy bez ohledu na velikost písmen. |
|
|
soubor |
Binární data. Celý požadavek musí být odeslán ve formátu multipart/form-data. Příklady kódu v jazycích Java a C++. |
|
|
exfile |
Kompatibilní s typem |
|
|
jsonObject(type) |
{ 'ID': 'xyz' } |
Objekt zadaného typu (reprezentovaný pomocí notace JSON). Popis jednotlivých typů naleznete níže. |
|
jsonObjectList(type) |
[{ 'ID': 'xyz' }] |
Seznam objektů zadaného typu (reprezentovaný pomocí notace JSON). |
|
lang |
en |
Jakýkoli podporovaný kód jazyka. |
|
seznam(type) |
Seznam hodnot jiného typu. Při volání akce API je seznam definován použitím stejného názvu parametru vícekrát (např. |
|
|
řetěz|ec |
Můj projekt |
Posloupnost znaků (kódování UTF-8). |
|
úkol |
RiYnxBD0xBY1lwhf1 |
Identifikátor překladového úkolu. Více částí zakázky (pokud byly vytvořeny rozdělením hlavní části zakázky) může sdílet stejný úkol. |
|
map(typ, typ) |
Mapa klíčů a hodnot daného typu. Při volání akce API je mapa definována použitím stejného názvu parametru vícekrát (např. |
Odpověď
Tělo HTTP může obsahovat tyto datové typy:
-
JSON
Datová struktura (kódování UTF-8). Každé volání API vracející JSON obsahuje příklad odpovědi.
-
binární
Binární data.
Úkol vs. Část zakázky
Úkol
Úkol představuje jednu překladovou zakázku (tj. soubor k překladu) v jednom cílovém jazyce. Pokud je jedna zakázka nahrána ve více cílových jazycích, vytvoří se pro každý cílový jazyk samostatný úkol.
Pokud je zakázka překládána ve více pracovních postupech, každý pracovní postup sdílí stejný úkol, ale liší se úrovní pracovního postupu. (To je důvod, proč některá volání API mají dva argumenty pro úkol a úroveň.) Identifikátor úkolu se skládá z alfanumerických znaků (např. RiYnxBD0xBY1lwhf1), zatímco úroveň je identifikována celým číslem (obvykle 1-10). První úroveň v každém projektu, který používá pracovní postupy, má vždy identifikátor 1.
Zakázky rozdělené na více částí budou mít stejné ID úkolu a parametr isParentJobSplit bude true.
Část zakázky
jobPart představuje zakázku pro cílový jazyk (jazyky) a kroky pracovního postupu. Například jeden soubor importovaný do projektu se 2 kroky pracovního postupu a 3 cílovými jazyky bude mít za následek 6 jobParts. Každou jobPart lze přiřadit jinému překladateli nebo může mít jiné datum dodání či stav.
Každou jobPart lze také rozdělit na více jobParts, které získají své vlastní jobPart ID. jobPart je vždy unikátní.
Typy objektů (použité v parametrech JSON)
TagMetadata {
ID řetězce
typ řetězce
obsah řetězce
transAttributes řetězce
}