Paramètres de requête
|
Type de données |
Valeur d'exemple |
Description |
|---|---|---|
|
charset |
windows-1250 |
Tout caractère pris en charge. |
|
Devise |
EUR |
Toute Devise prise en charge. |
|
datetime |
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 (Identifiant de propriété) d'un objet domaine du type spécifié. Par exemple, lors de la création d'un projet, l'Identifiant (par ex. 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 issue d'un ensemble fixe de valeurs. Chaque ensemble de valeurs (enum) possède un nom. Les énumérations ne sont jamais sensibles à la casse. |
|
|
fichier |
Données binaires. L'intégralité de la requête doit être envoyée au format multipart/form-data. Exemples de code en Java et C++. |
|
|
exfile |
Compatible avec le type |
|
|
jsonObject(type) |
{ 'Identifiant': '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) |
[{ 'Identifiant': '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 ex., |
|
|
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. Davantage de parties de tâche (si elles ont été créées en divisant la partie de tâche 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 ex. |
Réponse
Le corps d'un HTTP peut contenir ces types de données :
-
JSON
Structure de données (encodée en UTF-8). Chaque appel API retournant du JSON contient un exemple de réponse.
-
binary
Données binaires.
Tâche vs. Partie de tâche
Tâche
Une tâche représente une tâche de traduction (c.-à-d. un fichier à traduire) dans une langue cible. Si une tâche est téléchargée dans plusieurs langues cibles, une tâche indépendante est créée pour chaque langue cible.
Si une tâche est traduite dans plusieurs flux de travaux, chaque flux de travaux 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 ex. RiYnxBD0xBY1lwhf1) tandis qu'un niveau est identifié par un entier (généralement 1-10). Le premier niveau dans chaque projet qui utilise des flux de travaux a toujours l'Identifiant 1.
Les tâches divisées en plusieurs parties auront le même Identifiant de tâche, et le paramètre isParentJobSplit sera true.
Partie de tâche
Une jobPart représente une tâche par langue(s) cible 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 résultera en 6 jobParts. Chaque jobPart peut être assigné à un linguiste différent ou avoir une date d'échéance ou un statut différent.
Chaque jobPart peut également être divisé en plusieurs jobParts qui obtiendront leur propre Identifiant de jobPart. Un jobPart est toujours unique.
Types d'objets (utilisés dans les paramètres JSON)
TagMetadata {
Identifiant de chaîne
type de chaîne
contenu de chaîne
transAttributes de chaîne
}