Anforderungsparameter
|
Datentyp |
Beispielwert |
Beschreibung |
|---|---|---|
|
Zeichenkodierung |
windows-1250 |
Jeder unterstützte character set. |
|
Währung |
EUR |
Jede unterstützte Währung. |
|
datetime |
2012-07-30 17:30 |
Datum und Uhrzeit im Format yyyy-MM-dd HH:mm. Die UTC-Zeitzone wird immer verwendet, wenn das Datum gelesen wird. |
|
Fachbereich(Typ) |
348 |
Identifikator (ID-Eigenschaft) eines Fachbereich-Objekts des angegebenen Typs. Zum Beispiel wird beim Erstellen eines Projekts die 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 project=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 von 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 |
en |
Jeder unterstützte language code. |
|
Liste(Typ) |
Eine Liste von Werten eines anderen Typs. Beim Aufrufen einer API-Aktion wird die Liste mit demselben Parameternamen mehrfach definiert (z.B. |
|
|
Zeichenfolge |
Mein Projekt |
Die Zeichenfolge (UTF-8 kodiert). |
|
Aufgabe |
RiYnxBD0xBY1lwhf1 |
Ein Bezeichner einer Übersetzungsaufgabe. Weitere Jobteile (wenn sie durch das Aufteilen des übergeordneten Elements erstellt wurden) können dieselbe Aufgabe teilen. |
|
map(type, type) |
Eine Zuordnung von Keys 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.
-
binary
Binärdaten.
Aufgabe vs. Job-Teil
Aufgabe
Eine Aufgabe stellt einen Übersetzungs-Job (d. h. eine Datei, die übersetzt werden soll) in einer Zielsprache dar. Wenn ein Job in mehreren Zielsprache(n) 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 im Workflow-Level. (Deshalb haben einige API-Aufrufe zwei Argumente für Aufgabe und Level.) Eine Aufgaben-ID besteht aus alphanumerischen Zeichen (z. B. RiYnxBD0xBY1lwhf1), während ein Level durch eine Ganzzahl identifiziert wird (normalerweise 1-10). Das erste Level in jedem Projekt, das Workflows verwendet, hat immer die ID 1.
Jobs, die in mehrere Teile aufgeteilt sind, haben dieselbe Aufgaben-ID, und der Parameter isParentJobSplit wird true sein.
Job-Teil
Ein jobPart steht für einen Job pro Zielsprache(n) und Arbeitsschritt(en). Zum Beispiel führt eine einzelne Datei, die in ein Projekt mit 2 Workflow-Schritten und 3 Zielsprache importiert wird, zu 6 jobParts. Jeder jobPart kann einem anderen Linguist zugewiesen oder ein anderes Fälligkeitsdatum bzw. ein anderer 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
}