api_post() methode

Stuurt een POST-verzoek naar de HighBond API.

Syntaxis

hcl.api_post("Details HighBond API-aanvraag", gegevens = request_payload)

Parameters

Naam	Beschrijving
HighBond_API_request_URL	De verzoekgegevens voor de Diligent One-resource. hcl.api_post voorziet automatisch in de standaardgegevens van het verzoek op de achtergrond. U hoeft deze aanvraagelemente niet expliciet op te geven, tenzij u een standaardwaarde wilt overschrijven: hostinformatie Diligent One-regio Diligent One-instantie-ID (organisatie-ID) koptekstinformatie Voor de aanvraagsyntaxis voor een specifieke Diligent One-resource, raadpleeg de HighBond API-referentie. Opmerking Als u expliciet hostinformatie opgeeft, moet u het HTTPS-protocol gebruiken om verbinding te maken met de HighBond API. Bijvoorbeeld: https://apis-us.highbond.com
gegevens = request_payload	De gegevens die naar de Diligent One API-server moeten worden verzonden. De payload-gegevens moeten worden opgemaakt in JSON-formaat.

Naam

Beschrijving

HighBond_API_request_URL

De verzoekgegevens voor de Diligent One-resource.

hcl.api_post voorziet automatisch in de standaardgegevens van het verzoek op de achtergrond. U hoeft deze aanvraagelemente niet expliciet op te geven, tenzij u een standaardwaarde wilt overschrijven:

hostinformatie
Diligent One-regio
Diligent One-instantie-ID (organisatie-ID)
koptekstinformatie

Voor de aanvraagsyntaxis voor een specifieke Diligent One-resource, raadpleeg de HighBond API-referentie.

Opmerking

Als u expliciet hostinformatie opgeeft, moet u het HTTPS-protocol gebruiken om verbinding te maken met de HighBond API. Bijvoorbeeld: https://apis-us.highbond.com

gegevens = request_payload

De gegevens die naar de Diligent One API-server moeten worden verzonden.

De payload-gegevens moeten worden opgemaakt in JSON-formaat.

Retourneert

Antwoordobject van de HighBond API-server.

Voorbeelden

Een probleem maken in een Diligent One-project

U bouwt een aanvraagnuttige lading die JSON-opmaak gebruikt en wijst de nuttige lading toe aan de payload-variabele. U gebruikt vervolgens de hcl.api_post-methode en verwijst naar de payload-variabele in de methode om een probleem te maken in het project met ID 19756.

Tip

Om snel de payloadsyntaxis op te bouwen, kopieert u het juiste payloadsyntaxisblok uit de HighBond API-referentie. Na het kopiëren van het payload-blok kunt u de sleutel-waardeparen verwijderen die u leeg wilt laten.

payload = {"data":
        { 
            "type": "issues",
            "attributes": {
                "description": "Beschrijving van probleem",
                "owner": "Jane Sleaman",
                "deficiency_type": "Tekortkoming",
                "title": "Gegevensbewaring en back-up",
                "severity": "Hoog",
                "published": True,
                "identified_at": "2021-11-01T18:15:30Z"
                    }
                }
            }

hcl.api_post("projects/19756/issues", data = payload)

Opmerkingen

Authenticatie

Alle HighBond API-aanvragen vereisen authenticatie. U moet systeembeheerder zijn in ten minste één Diligent One-instantie om toegang te krijgen tot de API.

Om te authenticeren, gebruikt u Launchpad om een HighBond API-token voor uw account te maken. Het token is een tekenreeks die u authenticeert en u beveiligde toegang geeft tot de HighBond API. Voor hulp bij het maken van een token, zie Diligent One-toegangstokens aanmaken en beheren.

Een HighBond API-token gebruiken met HighBond API-methoden

Om een HighBond API-token te gebruiken met de HighBond API-methoden moet u het token toewijzen aan een HCL-variabele genaamd v_hb_token. Zodra de token is toegewezen, wordt deze automatisch op de achtergrond gebruikt voor authenticatie zonder dat deze expliciet in het Diligent One-script hoeft te worden gespecificeerd. Voor informatie over het toewijzen van het token aan de variabele, zie Gebruik het venster Variabelen om een HCL-variabele te definiëren.

Systeemgebruikerstoken

Klanten die specifieke Diligent One-toolkits hebben aangeschaft, hebben ook de mogelijkheid om te authenticeren met een generiek systeemgebruikerstoken in plaats van een token dat is gekoppeld aan een specifiek gebruikersaccount.

Geef alleen het unieke deel van de URL van de resource op

Wanneer u een HighBond API-methode gebruikt, hoeft u alleen het unieke gedeelte, of eindpunt, van de Diligent One resource-URL op te geven. U hoeft niet het gemeenschappelijke deel (basis-URL) of de ID van de Diligent One-instantie waarin u werkt op te geven. Deze informatie wordt automatisch op de achtergrond verstrekt.

Bijvoorbeeld: Als u werkt in een Diligent One-instantie met ID 1000236, retourneren deze beide API-aanvragen een identiek antwoord. Ze vermelden beide alle problemen in project 19756.

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

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

Raadpleeg de HighBond API-referentie

De aanvraagsyntaxis voor elke Diligent One-bron is beschikbaar in de HighBond API-referentie. Hier, bijvoorbeeld, is de opvraagsyntaxis voor het ophalen van de lijst met problemen in een project.

Als u een HCL-methode gebruikt om de aanvraag te doen, kunt u beginnen met het specificeren van de syntaxis bij projects/....

Als u de aanvraag van buiten Diligent One doet, moet u de volledige resource-URL opgeven, beginnend met het protocol ( https://... ).

Gebruik van een variabele in de resource-URL

In plaats van een letterlijk ID op te geven in een resource-URL, hebt u mogelijk code die het gebruik van een variabele in de URL vereist. De resource-URL is opgemaakt als een tekenreeks, dus om een variabele in de tekenreeks op te nemen, moet u een van de onderstaande Python-technieken gebruiken.

U kunt een Python f-string gebruiken:

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

U kunt Python-tekenreeksconcatenatie gebruiken:

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