HB_API_POST-Befehl

Sendet eine POST-Anfrage an die HighBond-API.

Syntax

HB_API_POST HighBond_API_Anfrage_URL HEADERS Headerinformationen DATA Payload_Datei PASSWORD Zahl <TO Antwortdatei>HighBond_API_request_URL

Parameter

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

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

DATA "payload.json"

COMMENT
//ANALYTIC Test HB API commands
//FILE payload.json
END

DATA "C:\HighBond API payloads\payload.json"

TO "response.json"

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

Beispiele

HB_API_POST "https://apis-us.highbond.com/v1/orgs/11594/projects/19756/issues" HEADERS '{"content-type": "application/vnd.api+json"}' DATA "create_issue.json" PASSWORD 1 TO "hb_api_response.json"

{
"data":	{ 
        "type": "issues",
        "attributes": {
            "description": "Description of issue",
            "owner": "Jane Sleaman",
            "deficiency_type": "Deficiency",
            "title": "Data retention and backup",
            "severity": "High",
            "published": true,
            "identified_at": "2021-11-01T18:15:30Z"
                }
    }
}

Bemerkungen

Eine Kennwortdefinition erstellen und ein Kennwort festlegen

Wenn Sie ein Skript in Robots ausführen, das eine Anfrage an die HighBond-API sendet, müssen Sie eine Kennwortdefinition im Befehl angeben, der die Anfrage sendet. Dieselbe Anforderung gilt auch für Skripts, die in Analytics ausgeführt werden, wenn Sie die Offline-Aktivierung verwendet haben.

Unabhängig von Ihrer verwendeten Methode beim Erstellen einer Kennwortdefinition handelt es sich bei dem erforderlichen Kennwortwert um einen Diligent One-Zugriffstoken, den Sie in Launchpad erstellen können. Weitere Informationen finden Sie unter Diligent One-Zugriffstoken beantragen.

Kennwortdefinitionsmethoden

Diligent One-Zugriffstoken beantragen

Verwenden Sie einen bereits bestehenden Token, solange es keinen Grund gibt, einen neuen zu erstellen. Erstellen Sie einen neuen Token, falls der existierende Token nicht funktioniert. Wenn Sie bestehende Token verwenden, müssen Sie eine geringere Anzahl von Token verwalten.

1. Führen Sie einen der folgenden Schritte aus:

   • Wählen Sie aus dem Analytics-Hauptmenü Extras > Diligent One-Zugriffstoken.

   • Im Skript-Editor klicken Sie mit der rechten Maustaste und wählen Einfügen > Diligent One-Token.

   Die Seite API-Token verwalten wird in Ihrem Browser geöffnet. Möglicherweise müssen Sie sich zuerst bei Diligent One anmelden.

   Sie können ganz einfach über Analytics auf die Seite API-Token verwalten zugreifen. Sie können sich aber auch ohne Analytics über Ihr Benutzerprofil bei Diligent One anmelden und die Seite aufrufen.

2. Führen Sie einen der folgenden Schritte aus:

   • Bestehenden Token verwenden

     1. Klicken Sie in der Spalte Token auf die teilweise verborgene Version des gewünschten Tokens.

     2. Geben Sie Ihr Diligent One-Kennwort ein und klicken Sie auf Bestätigen.Diligent One

        Der Token wird nicht verborgen angezeigt.

     3. Klicken Sie auf Kopieren, um den Token zu kopieren.

        Tipp

        Schließen Sie das Dialogfeld mit dem Token nicht, bevor Sie den Token erfolgreich eingefügt haben.

   • Neuen Token erstellen

     1. Klicken Sie auf Token hinzufügen > Analytics.

     2. Geben Sie im Seitenbereich Neuer Analytics-Token die folgenden Informationen ein:

        Feld oder Option	Beschreibung
        Beschreibung	Geben Sie eine Beschreibung ein, die nützliche Informationen enthält, wie beispielsweise: Der Zweck des Tokens Wo der Token verwendet wird – zum Beispiel den Namen und Ort des Analytics-Skripts oder den Namen und Ort der Robot-Aufgabe
        Token-Ablauf	Aktiviert der Token läuft nach der von Ihnen angegebenen Anzahl von Tagen ab Deaktiviert der Token läuft niemals ab Hinweis Möglicherweise gilt in Ihrer Organisation eine Sicherheitsrichtlinie, die verlangt, dass Token nach einer gewissen Zeitdauer ablaufen. Die Erstellung von Token mit einer Ablauffrist ist eine gute Praxis. Diligent One sendet Ihnen vor dem Ablaufdatum eine automatisierte E-Mail-Benachrichtigung.
        Läuft ab in	Geben Sie die Anzahl der Tage an, bevor das Token abläuft (1 bis 365).
        Kennwort	Geben Sie das Kennwort für Ihr Diligent One-Konto ein.

     3. Klicken Sie auf Token generieren.

     4. Klicken Sie auf Kopieren, um den Token zu kopieren.

        Tipp

        Schließen Sie den Seitenbereich mit dem Token nicht, bevor Sie den Token erfolgreich eingefügt haben.

3. Führen Sie einen der folgenden Schritte aus, je nach Ihrer Kennwortdefinitionsmethode:

   • PASSWORD-Analysetag Fügen Sie im Aufgaben-Designer in einem ACL-Robot den kopierten Token in ein Kennwort-Parameterfeld ein.ACL robot

   • PASSWORD-Befehl Fügen Sie in Analytics den kopierten Token in eine Kennwortaufforderung ein, die bei der Skriptausführung angezeigt wird.Analytics

   • SET PASSWORD-Befehl Fügen Sie in Analytics den kopierten Token an der geeigneten Stelle des Skripts in der SET PASSWORD-Befehlssyntax ein.Analytics

4. Schließen Sie in Launchpad das Dialogfeld oder den Seitenbereich mit dem Token.

   Nachdem Sie einen neuen Token erstellt haben, wird eine teilweise verborgene Version des Tokens am Anfang Ihrer Tokenliste hinzugefügt.

   Weitere Informationen finden Sie unter Diligent One-Zugriffstoken erstellen und verwalten.