Parametry požadavku
|
Datový typ |
Vzorová hodnota |
Popis |
|---|---|---|
|
znaková sada |
windows-1250 |
Všechny podporované znakové sady. |
|
měna |
EUR |
Všechny podporují měnu. |
|
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žije časové pásmo UTC. |
|
doména (typ) |
348 |
Identifikátor (vlastnost ID) objektu domény zadaného typu. Například při vytváření projektu se ve struktuře JSON vrací ID (např. 348). Tento identifikátor lze později použít ke změně stavu projektu nastavením parametru projekt=348. |
|
výčet (název) |
Hodnota z pevné sady hodnot. Každá sada hodnot (výčet) má název. Výčty vždy rozlišují velká a malá písmena. |
|
|
soubor |
Binární data. Celý požadavek musí být zaslán ve formátu více částí/formulářů. Příklady kódu v Javě a C++. |
|
|
exfile |
Kompatibilní s typem |
|
|
jsonObject(type) |
{ 'id': 'xyz' } |
Objekt zadaného typu (prezentovaný pomocí JSON notace). Popis konkrétních typů naleznete níže. |
|
jsonObjectList(type) |
[{ 'id': 'xyz' }] |
Seznam objektů zadaného typu (prezentovaný pomocí notace JSON). |
|
jazyk |
cs |
Jakýkoli podporovaný kód jazyka. |
|
Seznam (typ) |
Seznam hodnot jiného typu. Při volání akce API je seznam definován vícenásobným použitím stejného názvu parametru (např. |
|
|
řetěz|ec |
Můj projekt |
Posloupnost znaků (kódováno UTC-8). |
|
úkol |
RiYnxBD0xBY1lwhf1 |
Identifikátor překladového úkolu. Jeden úkol může sdílet více částí zakázky (pokud byly vytvořeny rozdělením hlavní části zakázky). |
|
mapa (typ, typ) |
Mapa klíčů a hodnot daného typu. Při volání akce API je mapa definována vícekrát se stejným názvem parametru (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řekladatelskou zakázku (soubor k překladu) v jednom jazyce cíle. Pokud je jedna zakázka nahraná ve více jazycích cíle, vytvoří se pro každý jazyk cíle nezávislý úkol.
Pokud je zakázka přeložena ve více pracovních postupech, sdílí každý pracovní postup stejný úkol, ale liší se úrovní pracovního postupu. (Proto mají některá volání API 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 pravdivý.
Část zakázky
Zakázková část představuje zakázku pro jednotlivé jazyky cílového jazyka a fáze pracovního postupu. Například jeden soubor importovaný do projektu se 2 fázemi pracovního postupu a 3 cílovými jazyky povede k vytvoření 6 zakázkových částí. Každou zakázku lze přiřadit jinému překladateli nebo mít jiný termín dodání či stav.
Každou část zakázky lze také rozdělit na více částí zakázky, které dostanou své vlastní ID zakázky. Zakázka je vždy jedinečná.
Typy objektů (použité v parametrech JSON)
TagMetadata {
ID řetězce
typ řetězce
obsah řetězce
řetězec transAttributes
}