Anforderungsparameter
|
Datentyp |
Beispielwert |
Beschreibung |
|---|---|---|
|
charset |
windows-1250 |
Jeder unterstützte Zeichensatz. |
|
Währung |
EUR |
Jede unterstützte Währung. |
|
datetime |
2012-07-30 17:30 |
Datum und Uhrzeit im Format yyyy-MM-dd HH:mm. Beim Lesen des Datums wird immer die UTC-Zeitzone verwendet. |
|
Fachbereich(Typ) |
348 |
Bezeichner (ID-Eigenschaft) eines Fachbereich-Objekts des angegebenen Typs. Wenn beispielsweise ein Projekt erstellt wird, wird die ID (z. B. 348) in der JSON-Struktur zurückgegeben. Dieser Bezeichner kann später verwendet werden, um den Status des Projekt zu ändern, indem der Parameter Projekt=348 festgelegt wird. |
|
enum(Name) |
Ein Wert aus einer festen Menge von Werten. Jede Menge von Werten (enum) hat einen Namen. Enums sind immer unabhängig von der Groß- und Kleinschreibung. |
|
|
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 in JSON-Notation). Siehe unten für eine Beschreibung der einzelnen Typen. |
|
jsonObjectList(type) |
[{ 'ID': 'xyz' }] |
Eine Liste von Objekten des angegebenen Typs (dargestellt in JSON-Notation). |
|
lang |
de |
Jeder unterstützte Sprachcode. |
|
Liste(Typ) |
Eine Liste von Werten eines anderen Typs. Beim Aufruf einer API-Aktion wird die Liste definiert, indem derselbe Parametername mehrfach verwendet wird (z. B. |
|
|
Zeichenfolge |
Mein Projekt |
Die Zeichenfolge (UTF-8-kodiert). |
|
Aufgabe |
RiYnxBD0xBY1lwhf1 |
Eine ID einer Übersetzungsaufgabe. Weitere Job-Teile (falls sie durch Aufteilen des übergeordneten Job-Teils erstellt wurden) können sich dieselbe Aufgabe teilen. |
|
map(type, type) |
Eine Map von Schlüsseln und Werten eines bestimmten Typs. Beim Aufrufen einer API-Aktion wird die Map definiert, indem derselbe Parametername mehrfach verwendet wird (z. B. |
Antwort
Der Body 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.
-
binary
Binärdaten.
Aufgabe vs. Job-Teil
Aufgabe
Eine Aufgabe repräsentiert einen Übersetzungs-Job (d. h. eine zu übersetzende Datei) in einer Zielsprache. Wenn ein Job in mehreren Zielsprachen hochgeladen wird, wird für jede Zielsprache eine unabhängige Aufgabe erstellt.
Wenn ein Job in mehreren Workflows übersetzt wird, teilen sich alle Workflows dieselbe Aufgabe, unterscheiden sich jedoch auf Workflow-Ebene. (Dies ist der Grund, warum einige API-Aufrufe zwei Argumente für Aufgabe und Ebene haben.) Eine Aufgaben-ID besteht aus alphanumerischen Zeichen (z. B. RiYnxBD0xBY1lwhf1), während eine Ebene durch eine Ganzzahl (normalerweise 1-10) identifiziert wird. Die erste Ebene in jedem Projekt, das Workflows verwendet, hat immer die ID 1.
Jobs, die in mehrere Teile aufgeteilt wurden, haben dieselbe Aufgaben-ID, und der Parameter isParentJobSplit ist true.
Job-Teil
Ein Job-Teil repräsentiert einen Job pro Zielsprache(n) und Workflow-Schritten. Beispielsweise führt eine einzelne Datei, die in ein Projekt mit 2 Workflow-Schritten und 3 Zielsprachen importiert wird, zu 6 Job-Teilen. Jeder Job-Teil kann einem anderen Linguist zugewiesen werden oder ein anderes Fälligkeitsdatum oder einen anderen Status haben.
Jeder Job-Teil kann auch in mehrere Job-Teile aufgeteilt werden, die ihre eigene Job-Teil ID erhalten. Ein Job-Teil ist immer eindeutig.
Objekttypen (verwendet in JSON-Parametern)
TagMetadata {
Zeichenfolge ID
Zeichenfolge Typ
Zeichenfolge Content
Zeichenfolge transAttributes
}