api_patch()-Methode

Sendet eine PATCH-Anfrage an die HighBond-API.

Achtung

HighBond-API-Methoden interagieren live mit den Diligent One-Daten Ihrer Organisation. Wenn Sie über die notwendigen Berechtigungen verfügen, können Sie mit diesen Methoden möglicherweise wichtige Daten ändern oder löschen. Überdenken Sie daher sorgfältig die Konsequenzen von Aktionen, wenn Sie die HighBond-API verwenden.

Hinweis

Manche Diligent One-Ressourcen unterstützen PATCH, einige PUT und manche auch beide Anforderungstypen. Weitere Informationen finden Sie in der HighBond-API-Referenz.

Syntax

hcl.api_patch("Details der HighBond-API-Anfrage", data = Anfrage-Payload)

Parameter

Name	Beschreibung
Details der HighBond-API-Anfrage	Die Anfragedetails für die Diligent One-Ressource. hcl.api_patch Gibt automatisch den Standardteil der Anfragedetails im Hintergrund an. Diese Anfragebestandteile müssen Sie nicht explizit angeben, es sei denn, Sie möchten einen Standardwert überschreiben. Host-Informationen Diligent One-Region Diligent One-Instanzen-ID (Organisations-ID) Kopfzeileninformationen Die Anfragesyntax einer bestimmten Diligent One-Ressource finden Sie in der HighBond-API-Referenz. Hinweis Wenn Sie explizit Host-Informationen angeben, müssen Sie das HTTPS-Protokoll verwenden, um sich mit der HighBond-API zu verbinden. Beispielsweise: https://apis-us.highbond.com
data = Anfrage-Payload	Die Daten, die an den Diligent One API-Server gesendet werden sollen. Die Payload-Daten müssen als JSON-Daten formatiert sein.

Name

Beschreibung

Details der HighBond-API-Anfrage

Die Anfragedetails für die Diligent One-Ressource.

hcl.api_patch Gibt automatisch den Standardteil der Anfragedetails im Hintergrund an. Diese Anfragebestandteile müssen Sie nicht explizit angeben, es sei denn, Sie möchten einen Standardwert überschreiben.

Host-Informationen
Diligent One-Region
Diligent One-Instanzen-ID (Organisations-ID)
Kopfzeileninformationen

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

Hinweis

Wenn Sie explizit Host-Informationen angeben, müssen Sie das HTTPS-Protokoll verwenden, um sich mit der HighBond-API zu verbinden. Beispielsweise: https://apis-us.highbond.com

data = Anfrage-Payload

Die Daten, die an den Diligent One API-Server gesendet werden sollen.

Die Payload-Daten müssen als JSON-Daten formatiert sein.

Gibt zurück

Antwortobjekt von HighBond API-Server.

Bemerkungen

Authentifizierung

Alle HighBond-API-Anfragen erfordern eine Authentifizierung. Um auf die API zuzugreifen, müssen Sie mindestens in einer Diligent One-Instanz ein Systemadministrator sein.

Zur Authentifizierung verwenden Sie Launchpad, womit Sie einen HighBond-API-Token für Ihr Konto erstellen. Der Token ist eine Zeichenfolge, die Sie authentifiziert und Ihnen ermöglicht, sicher auf die HighBond-API zuzugreifen. Hilfe zum Erstellen von Token finden Sie unter HighBond-Zugriffstoken erstellen und verwalten.

HighBond-API-Token mit HighBond-API-Methoden verwenden

Um einen HighBond-API-Token mit den HighBond-API-Methoden zu verwenden, müssen Sie den Token einer HCL-Variable namens v_hb_token zuweisen. Sobald der Token zugewiesen ist, wird er automatisch zur Authentifizierung im Hintergrund verwendet, ohne dass er im Diligent One-Skript explizit festgelegt werden muss. Informationen über das Zuweisen des Tokens zu einer Variable finden Sie unter HCL-Variablen werden im Fenster „Variablen“ definiert..

Systembenutzertoken

Kunden, die bestimmte Diligent One-Toolkits gekauft haben, können sich auch mit einem generischen Systembenutzertoken anstatt einem Token für ein bestimmtes Benutzerkonto authentifizieren.

Lediglich den eindeutigen Teil der Ressourcen-URL angeben

Wenn Sie eine HighBond-API-Methode verwenden, müssen Sie lediglich den eindeutigen Teil der Diligent One-Ressourcen-URL angeben, also den Endpunkt. Den gemeinsamen Teil (die Basis-URL) oder die ID der Diligent One-Instanz, in der Sie arbeiten, müssen Sie nicht festlegen. Diese Informationen werden automatisch im Hintergrund angegeben.

Wenn Sie beispielsweise in einer Diligent One-Instanz mit der ID 1000236 arbeiten, liefern die beiden folgenden API-Anfragen dieselbe Antwort. Sie enthalten beide alle Probleme in Projekt 19756.

hcl.api_get("projects/19756/issues")

hcl.api_get("https://apis.highbond.com/v1/orgs/1000236/projects/19756/issues")

HighBond-API-Referenz verwenden

Die Anfragesyntax für jede Diligent One-Ressource ist in der HighBond-API-Referenz verfügbar. Hier sehen Sie beispielsweise die Anfragesyntax, um eine Liste der Probleme innerhalb eines Projekts zu erhalten.

Wenn Sie eine HCL-Methode für diese Anfrage verwenden, können Sie unter projects/... beginnen, die Syntax anzugeben.

Falls Sie die Anfrage außerhalb von Diligent One stellen, müssen Sie die gesamte Ressourcen-URL angeben und dabei mit dem Protokoll ( https://... ) beginnen.

Variablen in einer Ressourcen-URL verwenden

Anstatt einer literalen ID ist in Ihrem Code unter Umständen die Verwendung einer Variable in der URL notwendig. Die Ressourcen-URL ist als Zeichenfolge formatiert. Um eine Variable in die Zeichenfolge einzubinden, müssen Sie also eine der folgenden dargestellten Python-Techniken verwenden.

Sie können einen f-String von Python verwenden:

v_project_id = "19756"
hcl.api_get(f"projects/{v_project_id}/issues")

Sie können die Zeichenfolgenverkettung von Python nutzen:

v_project_id = "19756"
hcl.api_get("projects/" + v_project_id + "/issues")