HB_API_PUT-Befehl

Sendet eine PUT-Anfrage an die HighBond-API.

Syntax

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

Parameter

Name Beschreibung
HighBond_API_Anfrage_URL

Die Anfragedetails für die Diligent One-Ressource.

Geben Sie die folgenden Details in der Anfrage-URL an:

  • Host-Informationen, einschließlich Diligent One-Region

  • API Versionsnummer (aktuelle Hauptversionsnummer)

  • Diligent One-Instanzen-ID (Organisations-ID)

  • Endpunktname der HighBond-API und alle zusätzlichen Endpunktdetails wie die ID-Nummer

Beispiel:

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

Die Anfragesyntax einer bestimmten Diligent One-Ressource finden Sie in der HighBond-API-Referenz.Diligent OneHighBond API

HEADERS Headerinformationen

Die Informationen des Anfrage-Headers.

Geben Sie den Inhaltstyp der HighBond-API-Anfrage im Header an.

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

Der Name der Datei mit der Anfrage-Payload.

Die Anfrage-Payload enthält die Daten, die Sie an Diligent One senden möchten. Sie nehmen die Daten in eine JSON-Datei auf und verwenden DATA, um in der HighBond-API-Anfrage auf die Datei zu verweisen. Eine Anleitung zum Strukturieren der Payload-Daten für eine bestimmte Diligent One-Ressource finden Sie in der HighBond-API-Referenz.

Geben Sie Payload_Datei als in Anführungszeichen gesetzte Zeichenfolge mit der Dateierweiterung *.json an. Beispiel:

DATA "payload.json"

Hinweis

Bei Skripts, die in Robots ausgeführt werden sollen, müssen Sie auch ein //FILE-Tag im Analysekopf angeben, der dem DATA-Payload_Datei-Parameter entspricht. Beispiel:

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

Speicherort für die JSON-Payload-Datei

Der Speicherort für die JSON-Payload-Datei hängt davon ab, wo Sie das Skript ausführen möchten.

Skript in Analytics ausführen

Sie können die JSON-Payload-Datei im Ordner mit dem Analytics-Projekt oder in einem anderen Ordner speichern.

Wenn Sie die Datei in einem anderen Ordner als dem Projektordner speichern, mussPayload_Datei einen Dateipfad mit dem Dateinamen enthalten:

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

Skript in Robots ausführen

Laden Sie die JSON-Payload-Datei in die Registerkarte Eingabe/Ausgabe in dem Robot hoch, der das Skript ausführt. Die Datei muss auf der Registerkarte vorhanden sein, bevor Sie das Skript ausführen.

Geben Sie in Payload_Datei nur den Dateinamen an. Geben Sie keinen Dateipfad an.

PASSWORD Zahl

Die zu verwendende Kennwortdefinition.

Sie verwenden nicht PASSWORD Zahl, um ein tatsächliches Kennwort abzurufen oder festzulegen. Die Kennwortdefinition bezieht sich auf ein vorher angegebenes oder ein mit dem PASSWORD-, dem SET-PASSWORD-Befehl oder dem PASSWORD-Analysetag festgelegtes Kennwort.

Zahl bezieht sich auf die Zahl der Kennwortdefinition. Wenn beispielsweise zuvor zwei Kennwörter in einem Skript angegeben bzw. festgelegt wurden oder falls ein Analyseskript geplant wurde, wird mit PASSWORD 2 angegeben, dass das zweite Kennwort verwendet wird.

Weitere Informationen über die Angabe oder das Festlegen von Kennwörtern finden Sie unter:

Das benötigte Kennwort ist ein Diligent One-Zugriffstoken. Weitere Informationen finden Sie unter Eine Kennwortdefinition erstellen und ein Kennwort festlegen.

Abhängig von der Umgebung, in der das Skript ausgeführt wird, kann PASSWORD Zahl notwendig sein oder auch nicht.

Umgebung, in der das Skript ausgeführt wird Anforderung PASSWORD Zahl
Analytics

(Online-Aktivierung)

PASSWORD Zahl ist nicht erforderlich.

Es wird automatisch der Diligent One-Zugriffstoken des aktuellen Benutzers verwendet, der in der Windows-Registrierung gespeichert ist.
Analytics

(Offline-Aktivierung)

PASSWORD Zahl ist erforderlich.
Robots
TO Antwortdatei

Optional

Der Name der Datei mit der Anfrageantwort.

Geben Sie Antwortdatei als in Anführungszeichen gesetzte Zeichenfolge mit der Dateierweiterung *.json an. Beispiel:

TO "response.json"

Speicherort für die JSON-Antwortdatei

Der Speicherort für die JSON-Antwortdatei hängt davon ab, wo Sie das Skript ausführen.

Skript in Analytics ausführen

Standardmäßig wird die JSON-Antwortdatei im Ordner mit dem Analytics-Projekt gespeichert.

Wenn Sie die Datei in einem anderen vorhandenen Ordner speichern möchten, geben Sie einen Dateipfad mit dem Namen an.

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

Skript in Robots ausführen

Wenn Sie ein //RESULT FILE-Tag im Analysekopf angeben, wird die JSON-Antwortdatei als Ausgabe mit jeder im Robot ausgeführten Aufgabe gespeichert.

Geben Sie nur den Dateinamen an. Geben Sie keinen Dateipfad an.

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

Methode Beschreibung

PASSWORD-Analysetag

(Für Skripts, die in Robots ausgeführt werden)

Wenn Sie das PASSWORD-Analysetag verwenden, um die nummerierte Kennwortdefinition für die Verbindung zu Diligent One anzulegen, wird kein Wert für das Kennwort im Skript angegeben. Beim Erstellen einer Aufgabe zur Ausführung des Skripts in Robots können Sie oder andere Benutzer in einem Eingabefeld im Aufgaben-Designer das tatsächliche Kennwort angeben.

Weitere Informationen finden Sie unter PASSWORD-Analysetag.

PASSWORD-Befehl

(Für Skripts, die in Analytics ausgeführt werden, Offline-Aktivierung)

Wenn Sie den PASSWORD-Befehl verwenden, um die nummerierte Kennwortdefinition für die Verbindung zu Diligent One anzulegen, wird kein Wert für das Kennwort im Skript angegeben. Beim Herstellen der Skriptverbindung wird eine Aufforderung zur Eingabe des Kennworts angezeigt.

Weitere Informationen finden Sie unter PASSWORD-Befehl.

SET PASSWORD-Befehl

(Für Skripts, die in Analytics ausgeführt werden, Offline-Aktivierung)

Wenn Sie den SET PASSWORD-Befehl verwenden, um die nummerierte Kennwortdefinition für die Verbindung mit Diligent One anzulegen, wird ein Wert für das Kennwort im Skript angegeben. Deshalb wird keine Kennwortaufforderung angezeigt. Dieser Ansatz eignet sich für Skripts, die ohne Benutzereingriff ausgeführt werden sollen, stellt aber ein echtes Kennwort in Klartext im Skript dar. Je nach Situation kann das ungeeignet sein.

Weitere Informationen finden Sie unter SET-PASSWORD-Befehl.

Diligent One-Zugriffstoken beantragen

Achtung

Der generierte Zugriffstoken entspricht dem Konto, das zur Anmeldung bei Diligent One verwendet wurde. Es empfiehlt sich unter Umständen nicht, als Skriptautor in einem Skript Ihren eigenen Zugriffstoken festzulegen, wenn das Skript durch andere Personen benutzt wird.

Schützen Sie Zugriffstoken genauso wie Ihr Kontokennwort.

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.