Paramètres de demande
|
Type de données |
Valeur d'exemple |
Description |
|---|---|---|
|
jeu de caractères |
windows-1250 |
|
|
devise |
EUR |
Toute devise prise en charge. |
|
date et heure |
2012-07-30 17:30 |
Date et heure au format yyyy-MM-dd HH:mm. Le fuseau horaire UTC est toujours utilisé lors de la lecture de la date. |
|
domain(type) |
348 |
Identifiant (propriété ID) d'un objet de domaine du type spécifié. Par exemple, lors de la création d'un projet, id (par exemple, 348) est renvoyé dans la structure JSON. Cet identifiant peut être utilisé ultérieurement pour modifier le statut du projet en définissant le paramètre projet=348. |
|
enum(nom) |
Une valeur d'un ensemble fixe de valeurs. Chaque ensemble de valeurs (enum) a un nom. Enums sont toujours insensibles à la casse. |
|
|
fichier |
Données binaires. L'ensemble de la demande doit être envoyé au format multipart/form-data. Exemples de code en Java et C++. |
|
|
exfile |
Compatible avec le |
|
|
jsonObject(type) |
{ 'id': 'xyz' } |
Un objet du type spécifié (représenté en utilisant la notation JSON). Voir ci-dessous pour une description des types particuliers. |
|
jsonObjectList(type) |
[{ 'id': 'xyz' }] |
Une liste d'objets du type spécifié (représentée en utilisant la notation JSON). |
|
lang |
en |
Tout code de langue pris en charge. |
|
list(type) |
Une liste de valeurs d'un autre type. Lors de l'appel d'une action API, la liste est définie en utilisant le même nom de paramètre plusieurs fois (par exemple, |
|
|
chaîne |
Mon Projet |
La séquence de caractères (encodée en UTF-8). |
|
tâche |
RiYnxBD0xBY1lwhf1 |
Un identifiant d'une tâche de traduction. Plus de parties de travail (si elles ont été créées en divisant la partie de travail parent) peuvent partager la même tâche. |
|
map(type, type) |
Une carte de clés et de valeurs d'un type donné. Lors de l'appel d'une action API, la carte est définie en utilisant le même nom de paramètre plusieurs fois (par exemple, |
Réponse
Le corps d'un HTTP peut contenir ces types de données :
-
JSON
Structure de données (codée en UTF-8). Chaque appel API retournant du JSON contient un exemple de réponse.
-
binaire
Données binaires.
Tâche vs. Partie de tâche
Tâche
Une tâche représente un travail de traduction (c'est-à-dire un fichier à traduire) dans une langue cible. Si un travail est téléchargé dans plusieurs langues cibles, une tâche indépendante est créée pour chaque langue cible.
Si un travail est traduit dans plusieurs flux de travaux, chaque flux partage la même tâche mais diffère au niveau du flux de travaux. (C'est pourquoi certains appels API ont deux arguments pour la tâche et le niveau.) Un identifiant de tâche est composé de caractères alphanumériques (par exemple, RiYnxBD0xBY1lwhf1) tandis qu'un niveau est identifié par un entier (généralement 1-10). Le premier niveau de chaque projet qui utilise des flux de travaux a toujours l'identifiant 1.
Les travaux divisés en plusieurs parties auront le même ID de tâche, et le paramètre isParentJobSplit sera true.
Partie de travail
Un jobPart représente un travail par langue cible(s) et étapes de flux de travaux. Par exemple, un seul fichier importé dans un projet avec 2 étapes de flux de travaux et 3 langues cibles donnera lieu à 6 partiesDeTravail. Chaque partieDeTravail peut être assignée à un linguiste différent ou avoir une date d'échéance ou un statut différent.
Chaque partieDeTravail peut également être divisé en plusieurs partiesDeTravail qui auront leur propre Identifiant de partieDeTravail. Une partieDeTravail est toujours unique.
Types d'objets (utilisés dans les paramètres JSON)
TagMetadata {
chaîne Identifiant
chaîne type
chaîne contenu
chaîne transAttributes
}