Méthode POST pour la ressource Cas

La méthode POST de la ressource Cas crée un cas en créant un dossier de cas sous le dossier Cas du type du cas.

Les valeurs de propriété soumises dans la demande de la méthode POST sont validées par Content Platform Engine. Si vous utilisez un service de données externes pour le type de cas, les valeurs de propriété de la demande sont également validées par le protocole IBM® Case Manager par rapport aux valeurs renvoyées par le service. Le protocole valide les valeurs en fonction des attributs de propriété définis par le service, notamment la valeur minimum, la valeur maximum et la liste d'options.

Lorsqu'un cas est sauvegardé, la valeur spécifiée pour une propriété dans Case Manager Client est conservée pour le cas si elle satisfait aux contraintes définies par le service de données externes. Lorsqu'une valeur n'est pas spécifiée dans Case Manager Client pour une propriété, le service de données externes peut définir une valeur conservée pour le cas.

Identificateur URI

/CASEREST/v1/cases

Contenu de la demande

{
  "CaseType": "<nom symbolique du type de cas>",
  "TargetObjectStore": "<nom de la librairie cible>",
  "ReturnUpdates": <true ou false>,
  "ExternalDataIdentifier" : "<chaîne définie par le service de données externes">,
  "Properties" :
  [ // le tableau des valeurs de propriété de cas peut être vide
    {
      "SymbolicName": "<nom symbolique de propriété de cas>",
      "Value" : <valeur de propriété>
    },
    ...
  ]
  "ClientContext":
  {
    "<clé>":"<valeur>",
    // Paires clé-valeur supplémentaires
  }
}}

Tableau 1. Paramètres obligatoires de la méthode POST
Nom	Type	Obligatoire	Description
CaseType	Chaîne	Oui	Nom symbolique affecté au type de cas.
TargetObjectStore	Chaîne	Oui	Nom symbolique de la librairie qui contient le cas. Dans IBM Case Manager, un nom symbolique est appelé identificateur unique.
ReturnUpdates	Booléen	Non	Valeur booléenne qui indique si la méthode doit renvoyer les valeurs de propriété une fois le cas créé. Définissez ce paramètre sur `true` pour que la méthode renvoie les valeurs des propriétés du cas. Par défaut, ce paramètre est défini sur `false`.
ExternalData Identifier	Chaîne	Non	Chaîne qui indique l'état des données renvoyées par le service de données externes. Conseil : Incluez ce paramètre dans la demande si une valeur a été fournie en réponse à un appel précédent d'extraction de données à partir d'un service de données externes.
Properties	Tableau	Non	Tableau qui contient les valeurs de propriété définies pour le type de cas. Indiquez pour chaque propriété son nom symbolique et sa valeur. Important : La valeur spécifiée pour la propriété doit correspondre au type de données de la propriété. Vous pouvez utiliser une ressource de type de cas particulier pour obtenir la liste des propriétés définies pour ce type de cas.
ClientContext	Tableau	Non	Tableau contenant une série de paires clé-valeur qui fournissent des informations contextuelles relatives à un élément de travail spécifique. Ce paramètre permet d'envoyer des informations à un service de données externes lorsqu'un agent de traitement de cas ouvre un élément de travail.

Contenu de la réponse

La méthode POST renvoie le titre du cas, l'identificateur du cas et l'identificateur du dossier de cas du nouveau dossier de cas. La méthode POST renvoie également l'un des codes de réponse suivants :

Tableau 2. Codes de réponse pour la méthode POST
Code	Description
201 Created	La méthode s'est terminée avec succès. La méthode POST renvoie l'identificateur du nouveau dossier de cas.
400 Bad Request	L'un des paramètres obligatoires est manquant ou la valeur d'un paramètre est incorrecte.
404 Not Found	Le type de cas spécifié dans la demande est introuvable.
500 Internal Server Error	Une erreur s'est produite au niveau du serveur. Pour plus d'informations sur l'erreur, voir l'élément userMessage dans la réponse JSON.

Exemple : demande de méthode POST

Cet exemple de code demande qu'un cas de type AUTO_CollisionClaim soit créé et que les valeurs de propriété soient renvoyées une fois le cas créé.

Conseil : Si le paramètre ReturnUpdates est défini sur true, la réponse renvoyée par la méthode POST est semblable à celle de la méthode GET.

POST http://example.com:9080/CaseManager/CASEREST/v1/cases
HTTP/1.1
Host: www.CaseMgmtExample.net
Content-Type: charset.json;charset-UTF-8
{
    "CaseType" : "AUTO_CollisionClaim",
    "TargetObjectStore": "ATOSME",
    "ReturnUpdates": false,
    "Properties":
    [
      {
        "SymbolicName"  : "AUTO_ClaimDate",
        "Value"         : "2010-07-16T21:50:36Z",
      },
      {
        "SymbolicName"  : "AUTO_ClaimStatus",
        "Value"         : "0",
      }
    ]
}

Exemple : réponse de méthode POST

Cet exemple de code illustre les valeurs de propriété qui sont renvoyées pour le nouveau cas AUTO_CollisionClaim :

HTTP 1.1 201 OK Created
Content-Type: application/json;charset-UTF-8
{
  "CaseTitle": "DH2_MyCase_000000100402", 
  "CaseIdentifier": "DH2_MyCase_000000100402", 
  "CaseFolderId": "{A42BE8EB-848F-4CBD-B2F7-64FAF2CE7081}"
}