Créer un enregistrement
La syntaxe permettant de modifier un enregistrement avec un identifiant unique est la suivante (méthode PUT
):
curl --insecure --silent \
-H "Authorization: Bearer <bearer_token>" \
--json '{"field":"value"}'
-X PUT
'https://<host>/SNV4SRV-ws-war/api/v1/<taskId>'
La clé spéciale $recordId
est ignorée et n’a pas besoin d’être spécifiée. Les champs non définis prennent la valeur par défaut.
Les champs de type enum
peuvent être spécifiés soit de manière complète ("FIELD":{"key":"KEY","value":"VALUE"}
) ou simplifiée ("FIELD":"KEY"
). Lors de la récupération d’un enregistrement, ces champs sont toujours spécifiés de manière complète.
Si le code de retour HTTP est 200, la réponse sera structurée comme ceci (comme le retour de récupération):
{
"metadata": {
"apiVersion": "1.0",
"taskId": "<taskId>",
"taskType": "<type>",
"domainId": "<domain>"
},
"data": { ... }
}
La création est uniquement supportée dans les tâches simples et dossier (types B
et R
).
La création d’une page s’effectue avec la commande suivante:
curl --insecure --silent \
-H "Authorization: Bearer <bearer_token>" \
--json '{"field":"value"}'
-X PUT
'https://<host>/SNV4SRV-ws-war/api/v1/<taskId>/<recordId>/<pageId>'
Si le code de retour HTTP est 200, la réponse sera structurée comme ceci:
{
"metadata": {
"apiVersion": "1.0",
"taskId": "<taskId>",
"taskType": "<type>",
"domainId": "<domain>"
},
"data": { ... }
}
Le numéro d’occurrence est calculé automatiquement. Si la clé $occurrence
est précisée dans les données de création, elle est ignorée.
Selon la configuration, la création d’un nouveau dossier s’effectue par la création de la page d’en-tête. La génération de l’identifiant du dossier est
généraement automatique, dans ce cas utiliser la valeur AUTO
comme identifiant générique lors de la création:
curl --insecure --silent \
-H "Authorization: Bearer <bearer_token>" \
--json '{"field":"value"}'
-X PUT
'https://<host>/SNV4SRV-ws-war/api/v1/ADR02/AUTO/DONNEESBASE'
L’identifiant généré sera retourné dans les données de la page en réponse.