Anforderungsparameter
|
Datentyp |
Beispielwert |
Beschreibung |
|---|---|---|
|
Zeichensatz |
windows-1250 |
Jeder unterstützte Zeichensatz. |
|
Währung |
EUR |
Jede unterstützte Währung. |
|
datetime |
2012-07-30 17:30 |
Datum und Uhrzeit im yyyy-MM-dd HH:mm Format. Die UTC Zeitzone wird immer verwendet, wenn das Datum gelesen wird. |
|
Fachbereich(Typ) |
348 |
Identifikator (ID-Eigenschaft) eines Domainobjekts des angegebenen Typs. Zum Beispiel, wenn ein Projekt erstellt wird, wird id (z.B. 348) in der JSON-Struktur zurückgegeben. Dieser Identifikator kann später verwendet werden, um den Status des Projekts zu ändern, indem der projekt=348 Parameter gesetzt wird. |
|
enum(Name) |
Ein Wert aus einer festen Menge von Werten. Jede Menge von Werten (enum) hat einen Namen. Enums sind immer nicht groß-/kleinschreibungsempfindlich. |
|
|
Datei |
Binärdaten. Die gesamte Anfrage muss im multipart/form-data Format gesendet werden. Beispiele für Code in Java und C++. |
|
|
exfile |
Kompatibel mit dem |
|
|
jsonObject(type) |
{ 'id': 'xyz' } |
Ein Objekt des angegebenen Typs (dargestellt mit JSON-Notation). Siehe unten für eine Beschreibung bestimmter Typen. |
|
jsonObjectList(type) |
[{ 'id': 'xyz' }] |
Eine Liste von Objekten des angegebenen Typs (dargestellt mit JSON-Notation). |
|
lang |
de |
Jeder unterstützte Sprachcode. |
|
Liste(Typ) |
Eine Liste von Werten eines anderen Typs. Beim Aufrufen einer API-Aktion wird die Liste definiert, indem der gleiche Parametername mehrfach verwendet wird (z.B. |
|
|
Zeichenfolge |
Mein Projekt |
Die Zeichenfolge (UTF-8 kodiert). |
|
Aufgabe |
RiYnxBD0xBY1lwhf1 |
Ein Identifikator einer Übersetzungsaufgabe. Mehrere Jobteile (wenn sie durch das Teilen des übergeordneten Jobteils erstellt wurden) können dieselbe Aufgabe teilen. |
|
map(Typ, Typ) |
Eine Karte von Schlüsseln und Werten eines bestimmten Typs. Beim Aufrufen einer API-Aktion wird die Karte definiert, indem der gleiche Parametername mehrfach verwendet wird (z. B. |
Antwort
Der Körper eines HTTP kann diese Datentypen enthalten:
-
JSON
Datenstruktur (UTF-8 kodiert). Jeder API-Aufruf, der JSON zurückgibt, enthält ein Beispiel für eine Antwort.
-
binär
Binärdaten.
Aufgabe vs. Job Teil
Aufgabe
Eine Aufgabe stellt einen Übersetzungsauftrag (d. h. Datei, die übersetzt werden soll) in einer Zielsprache dar. Wenn ein Auftrag in mehreren Zielsprache hochgeladen wird, wird für jede Zielsprache eine unabhängige Aufgabe erstellt.
Wenn ein Auftrag in mehreren Arbeitsabläufen übersetzt wird, teilen sich alle Arbeitsabläufe die gleiche Aufgabe, unterscheiden sich jedoch im Arbeitsablaufniveau. (Deshalb haben einige API-Aufrufe zwei Argumente für Aufgabe und Niveau.) Eine Aufgabenkennung besteht aus alphanumerischen Zeichen (z. B. RiYnxBD0xBY1lwhf1), während ein Niveau durch eine ganze Zahl identifiziert wird (normalerweise 1-10). Das erste Niveau in jedem Projekt, das Arbeitsabläufe verwendet, hat immer die Kennung 1.
Aufträge, die in mehrere Teile aufgeteilt werden, haben die gleiche Aufgaben-ID, und der Parameter isParentJobSplit wird true sein.
Job Teil
Ein jobPart stellt einen Auftrag pro Zielsprache(n) und Arbeitsablaufschritte dar. Zum Beispiel führt eine einzelne Datei, die in ein Projekt mit 2 Arbeitsabläufen und 3 Zielsprache importiert wird, zu 6 jobParts. Jeder jobPart kann einem anderen Linguist zugewiesen werden oder ein anderes Fälligkeitsdatum oder einen anderen Status haben.
Jeder jobPart kann auch in mehrere jobParts aufgeteilt werden, die ihre eigene jobPart ID erhalten. Ein jobPart ist immer einzigartig.
Objekttypen (verwendet in JSON-Parametern)
TagMetadata {
Zeichenfolge ID
Zeichenfolge Typ
Zeichenfolge Inhalt
Zeichenfolge transAttributes
}