Anforderungsparameter
Datentyp |
Musterwert |
Beschreibung |
---|---|---|
Zeichensatz |
windows-1250 |
Jeder unterstützte Zeichensatz. |
Währung |
EUR |
|
datetime |
2012-07-30 17:30 |
Datum und Uhrzeit im HH:mm Format. Beim Lesen des Datums wird immer die UTC-Zeitzone verwendet. |
Fachbereich(typ) |
348 |
Identifier (ID Eigenschaft) eines Fachbereichs der angegebenen Art. Beim Erstellen eines Projekts wird in der JSON-Struktur beispielsweise die ID (z. B. 348) zurückgegeben. Diese Kennung kann später verwendet werden, um den Status des Projekts durch Setzen des Parameters Projekt = 348 zu ändern. |
Enum(Name) |
Ein Wert aus einem festen Satz von Werten. Jeder Wertesatz (enum) hat einen Namen. Zähler sind immer großschreibungsunempfindlich. |
|
Datei |
Binäre Daten. Der gesamte Antrag muss im Format Multipart/Formulardaten 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 mit Werten eines anderen Typs. Beim mehrfachen Aufruf einer API Aktion wird die Liste unter Verwendung desselben Parameternamens definiert (z.B. |
|
Zeichenfolge |
Mein Projekt |
Die Zeichenfolge (UTF-8 kodiert). |
Aufgabe |
RiYnxBD0xBY1lwhf1 |
Ein Identifikator für eine Aufgabe. Möglicherweise teilen sich mehrere Jobs (wenn sie durch Aufteilen des übergeordnetes Elements Job erstellt wurden) dieselbe Aufgabe. |
Karte(Typ, Typ) |
Eine Karte mit Keys und Werten eines bestimmten Typs. Beim mehrfachen Aufruf einer API Aktion wird die Map unter Verwendung desselben Parameternamens definiert (z.B. |
Antwort
Der Hauptteil eines HTTP kann die folgenden Datentypen enthalten:
-
JSON
Datenstruktur (UTF-8 kodiert). Jeder API Aufruf, der die JSON zurückgibt, enthält ein Beispiel für eine Antwort.
-
binär
Binäre Daten.
Aufgabe vs. Job Part
Aufgabe
Eine Aufgabe repräsentiert einen Job in einer Zielsprache. Wenn ein Job in mehreren Zielsprachen hochgeladen wird, wird für jede Zielsprache eine eigenständige Aufgabe erstellt.
Wenn ein Job in mehreren Arbeitsabläufen übersetzt wird, hat jeder Arbeitsablauf dieselbe Aufgabe, unterscheidet sich jedoch im Arbeitsablauf. (Aus diesem Grund haben einige API Aufrufe zwei Argumente für Aufgabe und Ebene.) Eine Aufgabe besteht aus alphanumerischen Zeichen (z. B. RiYnxBD0xBY1lwhf1), während eine Ebene durch eine ganze Zahl (normalerweise 1 - 10) gekennzeichnet ist. Die erste Ebene in jedem Projekt, das Workflows verwendet, hat immer die Kennung 1.
Jobs, die in mehrere Teile aufgeteilt werden, haben dieselbe Aufgabe ID, und der Parameter isParentJobSplit
ist wahr.
Job Part
Ein JobPart repräsentiert einen Job pro Zielsprache(n) und Arbeitsablauf. So führt beispielsweise eine einzelne Datei, die in ein Projekt mit 2 Arbeitsabläufen und 3 Zielsprachen importiert wird, zu 6 JobParts. Jeder JobPart kann einem anderen Linguisten zugewiesen werden oder ein anderes Fälligkeitsdatum oder einen anderen Status haben.
Jeder JobPart kann auch in mehrere JobParts aufgeteilt werden, die eine eigene JobPart ID erhalten. Ein JobPart ist immer eindeutig.
Objekttypen (in JSON-Parametern verwendet)
TagMetadata { Zeichenfolge ID Zeichenfolge Zeichenfolge Inhalt Zeichenfolge transAttribute }