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. Die UTC-Zeitzone wird immer verwendet, wenn das Datum gelesen wird. |
|
Fachbereich (Typ) |
348 |
Identifikator (ID-Eigenschaft) eines Domainobjekts 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 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 groß- und kleinschreibungsempfindlich. |
|
|
Datei |
Binärdaten. Die gesamte Anfrage muss im multipart/form-data Format gesendet werden. Beispiele für Code in Java und C++. |
|
|
exdatei |
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 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 von Zeichen (UTF-8 kodiert). |
|
Aufgabe |
RiYnxBD0xBY1lwhf1 |
Ein Identifikator für eine Übersetzungsaufgabe. Weitere Jobteile (falls sie durch das Aufteilen des übergeordneten Jobteils erstellt wurden) können dieselbe Aufgabe teilen. |
|
map(Typ, Typ) |
Eine Zuordnung von Schlüsseln und Werten eines bestimmten Typs. Beim Aufrufen einer API-Aktion wird die Zuordnung mit demselben Parameternamen mehrfach definiert (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. Jobteil
Aufgabe
Eine Aufgabe stellt einen Übersetzungsjob (d. h. eine zu übersetzende Datei) in einer Zielsprache dar. Wenn ein Job in mehreren Zielsprache hochgeladen wird, wird für jede Zielsprache eine unabhängige Aufgabe erstellt.
Wenn ein Job in mehreren Workflows übersetzt wird, teilt sich jede Workflow dieselbe Aufgabe, unterscheidet sich jedoch im Workflow-Level. (Deshalb haben einige API-Aufrufe zwei Argumente für Aufgabe und Ebene.) Ein Aufgabenbezeichner besteht aus alphanumerischen Zeichen (z. B. RiYnxBD0xBY1lwhf1), während eine Ebene durch eine ganze Zahl (normalerweise 1-10) identifiziert wird. Die erste Ebene in jedem Projekt, das Workflows verwendet, hat immer den Bezeichner 1.
Jobs, die in mehrere Teile aufgeteilt werden, haben die gleiche Aufgaben-ID, und der Parameter isParentJobSplit wird true sein.
Job Teil
Ein jobPart stellt einen Job pro Zielsprache(n) und Workflow-Schritte dar. Zum Beispiel wird eine einzelne Datei, die in ein Projekt mit 2 Workflow-Schritten und 3 Zielsprache importiert wird, zu 6 jobParts führen. 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 ihre eigene jobPart ID erhalten. Ein jobPart ist immer einzigartig.
Objekttypen (verwendet in JSON-Parametern)
TagMetadata {
Zeichenfolge id
Zeichenfolge typ
Zeichenfolge Inhalt
Zeichenfolge transAttributes
}