Dit artikel is vertaald met behulp van AI en kan kleine onnauwkeurigheden bevatten. Raadpleeg de Engelse versie voor volledige nauwkeurigheid.
Dit artikel beschrijft de stappen voor het bijwerken van een abonnement in BlueDolphin.
HTTP response status code | Interpretatie |
200 OK | Abonnement succesvol bijgewerkt |
400 Bad Request | Abonnement kon niet worden bijgewerkt omdat een ongeldige tenant is opgegeven |
500 Internal Server Error | De abonnementen konden niet worden bijgewerkt door een serverfout |
Doe een PATCH-verzoek naar /subscriptions/{id}
Het verzoek moet het volgende bevatten:
De header voor je API-verzoek
De {tenant} moet worden vervangen door de naam van de tenant
De ID moet worden vervangen door de ID van het op te halen abonnement
De request body, die minimaal het volgende moet bevatten:
Parameter | Vereist | Type | Beschrijving |
url | Optioneel | string | De externe URL waarnaar berichten worden gestuurd voor het bluedolphin_event. |
object_definition_id | Optioneel | string | Unieke identificatie van een objectdefinitie. Bijvoorbeeld, 000000000000000000000002 |
workspace_id | Optioneel | string | De workspace waarin het event plaatsvindt. Bijvoorbeeld, 000000000000000000000001. |
bluedolphin_event | Optioneel | string | Het eventonderwerp waarvoor een listener wordt aangemaakt met het abonnement. |
lifecycle_state | Optioneel | Enum | De Lifecycle State waarop dit abonnement moet filteren. Toegestane waarden zijn:
|
status | optioneel | boolean | De Status van het abonnement. Standaard worden abonnementen aangemaakt met Status 0 (uitgeschakeld). Toegestane statussen zijn,
|
headers | Optioneel | Dataverzameling<string, string> | Eventuele headers die nodig zijn voor autorisatie bij de opgegeven externe URL |
http_verb | optioneel | string | Het Type verzoek dat moet worden gedaan naar de opgegeven externe URL. Toegestane waarden zijn Standaard worden POST-verzoeken gedaan |
Voorbeeld API-verzoek
curl --location --request PATCH 'https://public-api.eu.bluedolphin.app/v1/subscriptions/{id}’ \
--header 'tenant: tenantName’ \
--header 'Content-Type: application/json' \
--data '{
“url": “some external url“,
"bluedolphin_event": "event name",
"object_definition_id": "000000000000000000000001",
"workspace_id": "000000000000000000000001",
"lifecycle_state": "All"
"HEADERS": {
"custom_header": "custom_value"
},
"status": 1
}Antwoord
Een geslaagde call geeft een antwoord met een 200 OK HTTP-statuscode en de volgende body:
{
"data":
{
"id": "Unieke identificatie",
"last_updated_by": "Unieke identificatie",
"url": "Unieke opgegeven URL",
"bluedolphin_event": "Eventnaam",
"object_definition_id": "000000000000000000000001",
"workspace_id": "000000000000000000000001",
"lifecycle_state": "All"
"headers": {},
"status": 0,
"http_verb": "POST"
}
}
Antwoordeigenschappen
Eigenschap | Type | Beschrijving |
id | string | Unieke identificatie voor het abonnement |
last_updated_by | string | Unieke identificatie van de gebruiker die het abonnement als laatste heeft bijgewerkt |
bluedolphin_event | string | De eventnaam waarvoor het abonnement is aangemaakt |
object_definition_id | string | Unieke identificatie van de objectdefinitie waarop het object is gebaseerd |
workspace_id | string | Unieke identificatie van de workspace waar het event zich bevindt |
lifecycle_state | Enum | De Lifecycle State waarop het abonnement moet filteren. Waarden zijn:
|
status | boolean | running state (1 = actief) |
url | string | De externe URL waarnaar berichten worden gestuurd |
headers | Dataverzameling<string, string> | Eventuele headers die nodig zijn voor autorisatie bij de opgegeven URL |
http_verb | string | Het Type verzoek dat moet worden gedaan naar de opgegeven URL. |