Parametry požadavku
|
Typ dat |
Ukázková hodnota |
Popis |
|---|---|---|
|
znaková sada |
windows-1250 |
Jakákoli podporovaná znaková sada. |
|
měna |
EUR |
Jakákoli podporovaná měna. |
|
datum a čas |
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 vlastnost) objektu domény daného typu. Například při vytváření projektu se v JSON struktuře vrací id (např. 348). Tento identifikátor můžeš později použít ke změně stavu projektu nastavením parametru projekt=348. |
|
enum(název) |
Hodnota z pevně dané množiny hodnot. Každá množina 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 Javě a C++. |
|
|
exfile |
Kompatibilní s typem |
|
|
jsonObject(type) |
{ 'id': 'xyz' } |
Objekt specifikovaného typu (představovaný pomocí JSON notace). Podívej se níže na popis jednotlivých typů. |
|
jsonObjectList(type) |
[{ 'id': 'xyz' }] |
Seznam objektů specifikovaného typu (představovaný pomocí JSON notace). |
|
jazyk |
en |
Jakýkoli podporovaný kód jazyk|a. |
|
seznam(type) |
Seznam hodnot jiného typu. Při volání akce API je seznam definován pomocí stejného názvu parametru vícekrát (např. |
|
|
řetěz|ec |
Můj projekt |
Sekvence znaků (kódována v UTF-8). |
|
úkol |
RiYnxBD0xBY1lwhf1 |
Identifikátor úkolu překladu. Více částí zakázky (pokud byly vytvořeny rozdělením hlavní části zakázky) může sdílet stejný úkol. |
|
map(type, type) |
Mapa klíčů a hodnot daného typu. Při volání akce API je mapa definována pomocí stejného názvu parametru vícekrát (např. |
Odpověď
Tělo HTTP může obsahovat tyto datové typy:
-
JSON
Datová struktura (kódována v UTF-8). Každé volání API, které vrací JSON, obsahuje příklad odpovědi.
-
binární
Binární data.
Úkol vs. Část zakázky
Úkol
Úkol představuje jednu zakázku (tj. soubor, který má být přeložen) v jednom cílovém jazyce. Pokud je jedna zakázka nahrána ve více cílových jazycích, pro každý cílový jazyk je vytvořen nezávislý úkol.
Pokud je zakázka přeložena v několika pracovních postupech, každý pracovní postup sdílí stejný úkol, ale liší se v úrovni pracovního postupu. (To je důvod, proč některé API volání 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
A jobPart představuje část zakázky pro cílový jazyk(y) a fáze pracovního postupu. Například jediný soubor importovaný do projektu se 2 fázemi pracovního postupu a 3 cílovými jazyky povede k 6 části zakázky. Každá jobPart může být přiřazena jinému překladateli nebo mít jiný termín nebo stav.
Každá část zakázky může být také rozdělena na více částí zakázky, které dostanou své vlastní ID části zakázky. část zakázky je vždy jedinečná.
Typy objektů (použité v JSON parametrech)
TagMetadata {
řetěz|ec ID
řetěz|ec typ
řetěz|ec obsah
řetěz|ec transAtributy
}