Définition d'un corps de demande

Indiquez le corps de la 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 de scrutation et l'URL d'arrêt facultatives.

Ajout du corps de la demande

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

Pour créer un corps de demande :

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

    Pour créer un corps de demande pour une URL de scrutation ou d'arrêt, allez à la page Sélectionner des critères d'achèvement et cochez la case Configurer une condition de scrutation et d'arrêt pour un appel REST sans attente. Dans l'onglet Sondage ou Résiliation, sélectionnez Demande.

    Si vous ne voyez pas l'onglet Demande, assurez-vous d'avoir sélectionné la méthode HTTP appropriée.

  2. Dans l'éditeur, entrez le corps de la demande.
    • Vous pouvez saisir ou copier et coller l'ensemble des données utiles.

    • Vous pouvez référencer des paramètres existants dans les données utiles à 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
          }
      }
    Note

    Le valideur intégré dans l'éditeur valide le corps de la demande. Si vous voyez un point rouge avec un "x" à côté de l'éditeur, pointez sur l'icône pour voir l'erreur relative à cette ligne de code.
  3. Pour affecter un paramètre de tâche à l'ensemble du corps de la demande, sélectionnez Exposer en tant que paramètre de tâche. Voir Paramétrage du corps de la demande.

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

Voir Paramétrage du corps de la demande.

En plus d'utiliser des paramètres dans le corps de la demande, vous pouvez paramétrer l'ensemble du corps de la demande.

Voir Ajout du corps de la 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 configurer le corps complet de la demande :

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

    Pour paramétrer le corps d'une demande pour une URL de scrutation ou d'arrêt, allez à la page Spécifier les critères d'achèvement. Dans l'onglet Sondage ou Résiliation, sélectionnez Demande.

  2. Sélectionnez Exposer en tant que paramètre de tâche.

    Si vous n'avez pas encore entré le corps de la demande, le service d'intégration de données 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 un nom pour le 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 courante des paramètres de la tâche, voir Consultation de tous les paramètres d'une tâche REST.

  4. (Facultatif) Entrez une description pour aider les autres utilisateurs à identifier la fonction du paramètre.
  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 les données 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'un corps de demande paramétré, 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 la demande paramétrée :

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

    Pour modifier le corps paramétré d'une URL de scrutation ou d'arrêt, allez à la page Spécifier les critères d'achèvement. Dans l'onglet Sondage ou Résiliation, sélectionnez Demande.

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

    Pour modifier la description, voir Modification d'un paramètre de tâche REST.

  4. Sélectionnez enregistrer.
Suppression du paramètre du corps de la demande

La suppression du paramètre supprime 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 :

  1. À l'étape Définir les détails d'exécution de la page Configurer les détails de l'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 de scrutation ou d'arrêt, allez à la page Spécifier les critères d'achèvement. Dans l'onglet Sondage ou Résiliation, sélectionnez Demande.

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

    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.

    Note

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