Fourniture d'un corps de demande

Indiquez le corps de demande requis pour une demande REST à l'aide de la méthode POST ou PUT.

Les procédures suivantes peuvent être utilisées pour configurer un corps de demande dans l'URL HTTP principale ou l'URL d'interrogation et l'URL de terminaison facultatives.

Ajout du corps de demande

Actuellement, seul le format JSON est pris en charge pour le corps de demande.

Pour créer un corps de demande, procédez comme suit :

  1. A l'étape Définir les détails d'exécution de la page Configurer les détails d'API REST, sélectionnez Demande afin de créer un Corps de demande pour la tâche REST.

    Afin de créer un corps de demande pour une URL d'interrogation ou de terminaison, accédez à la page Indiquer des critères de fin et cochez la case Configurer une condition d'interrogation et de terminaison pour un appel REST sans attente. Dans l'onglet Interrogation ou Fin de contrat, sélectionnez Demande.

    Si vous ne voyez pas l'onglet Demande, vérifiez que vous avez sélectionné la méthode HTTP appropriée.

  2. Dans l'éditeur, entrez le corps de demande.
    • Vous pouvez procéder par saisie ou copier-coller l'intégralité de la charge utile.

    • Vous pouvez référencer des paramètres existants dans la charge utile à l'aide de la syntaxe ${}. Par exemple :

      {
          "modelType": "USER_PROJECT",
          "modelVersion": "20200901",
          "parentRef": {},
          "name": "${PROJECT_NAME}",
          "identifier": "${PROJECT_NAME}",
          "description": "Creating my project",
          "objectVersion": 0,
          "objectStatus": 8,
          "registryMetadata": {
              "registryVersion": 0
          }
      }
    Remarque

    Le valideur intégré dans l'éditeur valide le corps de la demande. Si un point rouge avec une croix apparaît sur le côté de l'éditeur, positionnez le curseur de la souris sur l'icône pour afficher l'erreur concernant cette ligne de code.
  3. Pour affecter un paramètre pour une tâche à l'ensemble du corps de demande, sélectionnez Afficher en tant que paramètre pour une tâche. Reportez-vous à Paramétrage du corps de demande.

    Pour modifier le corps d'une demande paramétrée, modifiez la valeur du paramètre.

Paramétrage du corps de demande

Outre l'utilisation de paramètres dans le corps de la demande, vous pouvez paramétrer l'intégralité du corps de la demande.

Reportez-vous à Ajout du corps de demande.

Après avoir créé le corps de la demande dans l'éditeur, vous pouvez affecter un paramètre de tâche à l'ensemble du corps.

Pour paramétrer l'intégralité du corps de demande, procédez comme suit :

  1. A l'étape Définir les détails d'exécution de la page Configurer les détails d'API REST, sélectionnez Demande.

    Pour paramétrer le corps de la demande pour une URL d'interrogation ou de terminaison, accédez à la page Spécifier des critères de fin. Dans l'onglet Interrogation ou Fin de contrat, sélectionnez Demande.

  2. Sélectionnez Afficher en tant que param. de la tâche.

    Si vous n'avez pas encore saisi le corps de la demande, Data Integration affiche un message d'avertissement dans une boîte de dialogue. Entrez d'abord un corps de demande, puis affectez un paramètre à l'ensemble du corps.

  3. Dans le panneau Ajouter un paramètre, entrez le nom du paramètre dans le champ Identificateur ou utilisez la valeur par défaut.

    Le nom du paramètre doit être unique dans la tâche REST. Pour obtenir la liste des paramètres en cours dans la tâche, reportez-vous à Affichage de tous les paramètres d'une tâche REST.

  4. (Facultatif) Entrez une description afin d'identifier l'objectif du paramètre pour les autres utilisateurs.
  5. Le type de données du paramètre est JSON, et vous ne pouvez pas le modifier.
  6. Dans le champ Valeur, définissez la valeur JSON par défaut pour ce paramètre de tâche.
  7. Sélectionnez Ajouter.
    Le nom du paramètre est ajouté en haut de l'éditeur.

Pour modifier le corps d'une demande paramétrée, modifiez la valeur du paramètre.

Modification de la valeur d'un paramètre de corps de demande

Vous pouvez modifier la valeur par défaut du paramètre de tâche pour le corps de la demande.

Pour modifier le corps de demande paramétré, procédez comme suit :

  1. A l'étape Définir les détails d'exécution de la page Configurer les détails d'API REST d'une méthode POST ou PUT, sélectionnez Demande.

    Pour modifier le corps de demande paramétré pour une URL d'interrogation ou de terminaison, accédez à la page Spécifier des critères de fin. Dans l'onglet Interrogation ou Fin de contrat, sélectionnez Demande.

  2. Sélectionnez Modifier le paramètre.
  3. Dans le panneau Modifier le paramètre, vous pouvez uniquement modifier le champ Valeur. Vous ne pouvez pas modifier le type de données ou la description.

    Pour modifier la description, reportez-vous à Modification d'un paramètre de tâche REST.

  4. Sélectionnez Save (Enregistrer).
Suppression du paramètre de corps de demande

La suppression du paramètre enlève uniquement l'association du paramètre au corps de la demande dans la tâche REST.

Pour annuler l'affectation du paramètre à l'ensemble du corps de la demande, procédez comme suit :

  1. A l'étape Définir les détails d'exécution de la page Configurer les détails d'API REST d'une méthode POST ou PUT, sélectionnez Demande.

    Pour annuler l'affectation du paramètre au corps de la demande pour une URL d'interrogation ou de terminaison, accédez à la page Spécifier des critères de fin. Dans l'onglet Interrogation ou Fin de contrat, sélectionnez Demande.

  2. Sélectionnez Enlever le paramètre.
  3. Dans la boîte de dialogue Enlever le paramètre, sélectionnez Enlever.

    L'affectation du paramètre au corps de la demande est annulée. Le corps de demande affecté au paramètre devient le corps de demande par défaut.

    Remarque

    Le paramètre n'est pas supprimé de la tâche REST. Pour supprimer le paramètre, reportez-vous à Suppression d'un paramètre de tâche REST.