Commande HB_API_DELETE

Envoie une requête DELETE à l'API HighBond.

Syntaxe

HB_API_DELETE URL_demande_API_HighBond HEADERS informations_en-tête PASSWORD num <TO fichier_réponse>HighBond_API_request_URL

Paramètres

Nom Description
URL_demande_API_HighBond

Les détails de la requête pour la ressource Diligent One.

Indiquez les informations suivantes dans l'URL de requête :

  • informations sur l'hôte, dont la région de Diligent One

  • numéro de version de l'API (numéro de version principale actuel)

  • ID d'instance de Diligent One (ID d'organisation)

  • nom du point de terminaison de l'API HighBond et toute autre information relative au point de terminaison tel que le numéro d'ID

Par exemple :

"https://apis-us.highbond.com/v1/orgs/11594/robots"

Pour la syntaxe de la requête concernant une ressource Diligent One spécifique, consultez la page Référence d'API HighBond.Diligent OneHighBond API

HEADERS informations_en-tête

Les informations sur l'en-tête de requête.

Dans l'en-tête, indiquez le type de contenu de la requête de l'API HighBond :

'{"content-type": "application/vnd.api+json"}'

PASSWORD num

Définition de mot de passe à utiliser.

Vous n'utilisez pas PASSWORD num pour inviter à saisir ou pour spécifier un mot de passe réel. La définition de mot de passe renvoie à un mot de passe fourni ou défini auparavant à l'aide de la commande PASSWORD, de la commande SET PASSWORD ou de la balise d'outil d'analyse PASSWORD.

num correspond au numéro de la définition de mot de passe. Par exemple, si deux mots de passe ont été fournis ou définis auparavant dans un script, ou lors de la planification d'un script d'analyse de données, PASSWORD 2 indique que le mot de passe n° 2 est utilisé.

Pour plus d'informations sur la fourniture ou définition de mots de passe, consultez les rubriques :

La valeur du mot de passe obligatoire est un jeton d’accès à Diligent One. Pour plus d'informations, consultez la rubrique Création d'une définition de mot de passe et spécification d'une valeur de mot de passe.

Selon l'environnement d'exécution du script, PASSWORD num peut être requis ou non :

Environnement d'exécution du script Condition requise relative à PASSWORD num
Analytics

(activation en ligne)

Le numéro de PASSWORD n'est pas obligatoire.

Le jeton d’accès Diligent One de l’utilisateur actuel stocké dans son registre Windows est utilisé automatiquement.
Analytics

(activation hors ligne)

Le numéro de PASSWORD est obligatoire.
Robots
TO fichier_réponse

optionnel

Nom du fichier qui contient la réponse de requête.

Indiquez fichier_réponsesous forme de chaîne entre guillemets avec une extension de fichier *.json. Par exemple :

TO "response.json"

Emplacement d'enregistrement du fichier JSON de réponse

L'emplacement auquel vous enregistrez le fichier JSON de réponse dépend de l'emplacement où vous exécutez le script.

Exécuter les scripts d'outil d'analyse

Par défaut, le fichier JSON de réponse est enregistré dans le dossier contenant le projet Analytics.

Ajoutez un chemin de fichier avec le nom pour enregistrer le fichier vers un autre dossier existant :

TO "C:\HighBond API responses\response.json"

Exécuter le script dans Robots

Si vous indiquez une balise //RESULT FILE dans l'en-tête d'outil d'analyse, le fichier JSON de réponse est enregistré en tant que sortie pour chaque tâche exécutée dans le robot.

Indiquez uniquement le nom de fichier. N'indiquez pas de chemin de fichier.

Remarques

Création d'une définition de mot de passe et spécification d'une valeur de mot de passe

Lorsque vous exécutez un script dans Robots qui envoie une requête à l'API HighBond, vous devez inclure une définition de mot de passe avec la commande qui envoie la requête. La même condition requise s'applique aux scripts exécutés dans Analytics si vous avez utilisé l'activation hors connexion.

Quelle que soit la méthode que vous utilisez pour créer la définition de mot de passe, la valeur de mot de passe requise est un jeton d’accès à Diligent One, que vous pouvez générer dans Barre de lancement. Pour plus d'informations, consultez la rubrique Obtenir un jeton d’accès Diligent One.

Méthodes de définition de mot de passe

Méthode Description

Balise d'outil d'analyse PASSWORD

(Pour les scripts exécutés dans Robots)

Si vous utilisez la balise d'analyse de données PASSWORD afin de créer la définition de mot de passe numéroté pour la connexion à Diligent One, aucune valeur de mot de passe n'est indiquée dans le script. Lorsque vous créez une tâche pour exécuter le script dans Robots, un champ d'entrée dans le Concepteur de tâches permet d'indiquer le mot de passe réel.

Pour plus d'informations, consultez la section Balise d'outils d'analyse PASSWORD.

Commande PASSWORD

(Pour les scripts exécutés dans Analytics, activation hors ligne)

Si vous utilisez la commande PASSWORD afin de créer la définition de mot de passe numéroté pour la connexion à Diligent One, aucune valeur de mot de passe n'est indiquée dans le script. Une invite de mot de passe est affichée lorsque le script tente de se connecter.

Pour plus d'informations, consultez la section Commande PASSWORD.

Commande SET PASSWORD

(Pour les scripts exécutés dans Analytics, activation hors ligne)

Si vous utilisez la commande SET PASSWORD pour créer la définition de mot de passe numéroté pour la connexion à Diligent One, aucune valeur de mot de passe n'est indiquée dans le script et aucune invite de mot de passe n'est affichée. Cette approche convient pour les scripts conçus pour être exécutés sans assistance, mais elle dévoile un mot de passe réel en texte clair dans le script, ce qui risque de ne pas être adapté à votre situation.

Pour plus d'informations, consultez la rubrique Commande SET PASSWORD.

Obtenir un jeton d’accès Diligent One

Attention

Le jeton d'accès généré correspond au compte utilisé pour se connecter à Diligent One. En tant que rédacteur de scripts, indiquer votre propre jeton d'accès dans un script n'est peut-être pas très approprié si le script sera utilisé par d'autres personnes.

Protégez les jetons d’accès comme n’importe quel mot de passe de compte.

Utilisez un jeton d'accès existant sauf si vous avez une bonne raison d'en créer un nouveau. Si le jeton existant ne fonctionne pas, créez-en un nouveau. L'utilisation d'un jeton existant réduit le nombre de jetons que vous devez gérer.

  1. Effectuez l'une des actions suivantes :

    • Dans le menu principal d’Analytics, sélectionnez Outils > Jeton d’accès à Diligent One.

    • Dans l’Éditeur de script, cliquez avec le bouton droit de la souris, puis sélectionnez Insérer > Jeton Diligent One.

    La page Gérer des jetons API s'ouvre dans votre navigateur. Il est possible que vous deviez d'abord vous connecter à Diligent One.

    L'accès à la page Gérer des jetons API via Analytics est une fonctionnalité d'ordre pratique. Vous pouvez également vous connecter à Diligent One et accéder à la page via votre profil utilisateur sans passer par Analytics.

  2. Effectuez l'une des actions suivantes :

    • Utiliser un jeton existant

      1. Dans la colonne Jeton, cliquez sur le jeton en partie masqué que vous voulez utiliser.

      2. Saisissez le mot de passe de votre compte Diligent One et cliquez sur Confirmer.Diligent One

        Le jeton démasqué s'affiche.

      3. Cliquez sur Copier pour copier le jeton.

        Astuce

        Ne fermez pas la boîte de dialogue contenant le jeton tant que vous n'avez pas fini de copier-coller le jeton.

    • Créer un nouveau jeton

      1. Cliquez sur Ajouter un jeton > Analytics.

      2. Dans le panneau latéral Nouveau jeton Analytics, indiquez les informations suivantes :

        Champ ou option Description
        Description

        Saisissez une description qui fournit des informations utiles, telles que :

        • L'objet du jeton
        • L'emplacement d'utilisation du jeton : par exemple, le nom et l'emplacement du script Analytics, ou le nom et l'emplacement des tâches du robot
        Expiration du jeton
        • Activée le jeton expire au bout du nombre de jours que vous avez spécifié
        • Désactivée le jeton n'expire pas

        Remarque

        Votre organisation dispose peut-être d'une politique de sécurité qui demande à ce que les jetons expirent au bout d'un certain temps. Créer des jetons avec une date d'expiration est une bonne pratique. Diligent One vous envoie une notification automatique par e-mail quelques jours avant la date d'expiration.
        Expire dans Indiquez le nombre de jours avant l'expiration du jeton (de 1 à 365)
        Mot de passe Saisissez le mot de passe de votre compte Diligent One.

      3. Cliquez sur Générer un jeton.

      4. Cliquez sur Copier pour copier le jeton.

        Astuce

        Ne fermez pas le panneau latéral contenant le jeton tant que vous n'avez pas fini de copier-coller le jeton.

  3. Selon la méthode de définition de mot de passe utilisée, effectuez l'une des actions suivantes :

    • Balise d'analyse de données PASSWORD Dans leConcepteur de tâches d'un robot ACL, collez le jeton copié dans un champ de paramètre de mot de passe.ACL robot

    • Commande PASSWORD Dans Analytics, collez le jeton copié dans l'invite de mot de passe qui apparaît lors de l'exécution du script.Analytics

    • Commande SET PASSWORD Dans Analytics, collez le jeton copié à l'endroit approprié dans la syntaxe de la commande SET PASSWORD dans un scriptAnalytics

  4. Dans la barre de lancement, fermez la boîte de dialogue ou le panneau latéral contenant le jeton.

    Si vous avez créé un nouveau jeton, une version partiellement masquée du jeton est ajoutée en haut de votre liste de jetons.

    Pour plus d’informations, consultez la rubrique Créer et gérer des jetons d’accès Diligent One.