Weitere Informationen zu den Objektbeziehungen finden Sie im Abschnitt Objektbeziehungen.
Weitere Informationen zu Zeitplänen finden Sie auf der Abonnements (Studios).
Um ein neues Abonnement zu erstellen, verwenden Sie den Endpunkt POST {baseURL}/v3/subscriptions.
Anmerkung
Dieser Endpunkt ist nur für Administrator:innen (Server-Admins) bestimmt.
contract (Text): Um ein neues Abonnement zu erstellen, ist der Parameter „contract“ erforderlich. Geben Sie die folgenden Parameter an:
name (Zeichenfolge): Erforderlich. Geben Sie einen Namen für das neue Abonnement ein.
CanShareSchedule (boolesch): Erforderlich. Geben Sie an, ob freigegebene Zeitpläne für das Abonnement aktiviert werden, das Sie erstellen.
credentialId (Zeichenfolge): Erforderlich. Dieser Parameter bezieht sich auf die eindeutige ID von Anmeldedaten, die dem/der Benutzer:in standardmäßig zugewiesen sind. Wenn keine Angabe gemacht wird, lautet die Standardeinstellung "".
curl -X 'POST' \
'http://localhost/webapi/v3/subscriptions' \
-H 'accept: application/json' \
-H 'authorization: Bearer BearerTokenGoesHere' \
-H 'Content-Type: application/json' \
-d '{
"name": "New Studio",
"canShareSchedule": true,
"credentialId": ""
}'200: OK
201: Erstellt
{ "name": "string", "apiKey": "string", "apiSecret": "string", "active": true, "expirationDate": "string", "expDate": "2024-09-19T13:13:44.245Z", "dateUpdated": "2024-09-19T13:13:44.245Z", "apiEnabled": true, "canShareSchedules": true, "credentialId": "string", "credentials": [ { "credentialId": "string", "id": "string" } ], "dataConnections": [ { "dataConnectionId": "string", "id": "string" } ], "id": "string" }400: Ungültige Anforderung
401: Keine Berechtigung
404: Nicht gefunden
Um Details über alle Abonnements abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/subscriptions. Verwenden Sie verschiedene Parameter als Filter für die Suche nach Abonnements.
Anmerkung
Dieser Endpunkt ist nur für Administrator:innen (Server-Admins) bestimmt.
name (Zeichenfolge): Optional. Um nach einem bestimmten Abonnement zu suchen, geben Sie den Namen dieses Abonnements ein.
CanShareSchedules (boolesch): Optional. Wählen Sie aus, ob freigegebene Zeitpläne für die Abonnements aktiviert sind, nach denen Sie suchen.
DefaultWorkflowCredentialId (Zeichenfolge): Optional. Geben Sie eine Standard-Workflow-Anmeldedaten-ID für die Abonnements ein, nach denen Sie suchen.
UserCountGreaterThanEquals (int32): Geben Sie an, wie viele Benutzer:innen in dem von Ihnen gesuchten Abonnement enthalten sein sollen, größer oder gleich der angegebenen Anzahl.
WorkflowCountGreaterThanEquals (int32): Geben Sie an, wie viele Workflows in dem von Ihnen gesuchten Abonnement enthalten sein sollen, größer oder gleich der angegebenen Anzahl.
WorkflowCountLessThanEquals (int32): Geben Sie an, wie viele Workflows in dem von Ihnen gesuchten Abonnement enthalten sein sollen, kleiner oder gleich der angegebenen Anzahl.
curl -X 'GET' \
'http://localhost/webapi/v3/subscriptions?userCountGreaterThanEquals=1&workflowCountGreaterThanEquals=3' \
-H 'accept: application/json' \
-H 'authorization: Bearer BearerTokenGoesHere'200: OK
[ { "userCount": 0, "workflowCount": 0, "id": "string", "name": "string", "credentialId": "string", "canShareSchedules": true } ]401: Keine Berechtigung
Um nach einem bestimmten Abonnement zu suchen, verwenden Sie den Endpunkt GET {baseURL}/v3/subscriptions/{subscriptionId}.
Anmerkung
Dieser Endpunkt ist nur für Administrator:innen (Server-Admins) bestimmt.
subscriptionsId (Zeichenfolge): Erforderlich. Geben Sie eine Abonnement-ID ein, um Informationen über dieses Abonnement abzurufen.
curl -X 'GET' \
'http://localhost/webapi/v3/subscriptions/66ebd0896e52ae73b495106f' \
-H 'accept: application/json' \
-H 'authorization: Bearer BearerTokenGoesHere'200: OK
"users": [ { "id": "string", "name": "string" } ], "workflows": [ { "id": "string", "name": "string" } ], "id": "string", "name": "string", "credentialId": "string", "canShareSchedules": true }401: Keine Berechtigung
404: Nicht gefunden
Um ein vorhandenes Abonnement zu aktualisieren, verwenden Sie den Endpunkt PUT {baseURL}/v3/subscription/{subscriptionId}.
Anmerkung
Dieser Endpunkt ist nur für Administrator:innen (Server-Admins) bestimmt.
subscriptionId (Zeichenfolge): Erforderlich. Geben Sie eine Abonnement-ID ein, um dieses Abonnement zu aktualisieren.
subscription (Textkörper): Erforderlich. Um ein Abonnement zu aktualisieren, ist der Parameter „updateContract“ erforderlich. Geben Sie Folgendes an:
name (Zeichenfolge): Erforderlich. Geben Sie einen neuen Namen für das Abonnement ein.
credentialId (Zeichenfolge): Erforderlich. Dieser Parameter bezieht sich auf die eindeutige ID von Anmeldedaten, die dem/der Benutzer:in standardmäßig zugewiesen sind. Wenn keine Angabe gemacht wird, lautet die Standardeinstellung "".
CanShareSchedules (boolesch): Erforderlich. Geben Sie an, ob freigegebene Zeitpläne für das Abonnement aktiviert werden, das Sie aktualisieren.
curl -X 'PUT' \
'http://localhost/webapi/v3/subscriptions/66ebd0896e52ae73b495106f' \
-H 'accept: application/json' \
-H 'authorization: Bearer BearerTokenGoesHere' \
-H 'Content-Type: application/json' \
-d '{
"name": "Doe'\''s Studio",
"credentialId": "",
"canShareSchedules": false
}'200: OK
{ "id": "string", "name": "string", "credentialId": "string", "canShareSchedules": true }400: Ungültige Anforderung
401: Keine Berechtigung
404: Nicht gefunden
Um ein bestimmtes Abonnement aus dem System zu löschen, verwenden Sie den Endpunkt DELETE {baseURL}/v3/subscriptions.
Anmerkung
Dieser Endpunkt ist nur für Administrator:innen (Server-Admins) bestimmt.
subscriptionId (Zeichenfolge): Erforderlich. Geben Sie die Abonnement -ID ein, die Sie löschen möchten.
curl -X 'DELETE' \
'http://localhost/webapi/v3/subscriptions?subscriptionId=66ec22e86e52ae73b49510a1' \
-H 'accept: application/json' \
-H 'authorization: Bearer BearerTokenGoesHere'200: OK
400: Ungültige Anforderung
401: Keine Berechtigung
404: Nicht gefunden
Um einen/eine Benutzer:in (oder mehrere Benutzer:innen) von einem Abonnement in ein anderes zu verschieben, verwenden Sie den Endpunkt PUT {baseURL}/v3/subscriptions/{subscriptionId}/users.
Anmerkung
Dieser Endpunkt ist nur für Administrator:innen (Server-Admins) bestimmt.
subscriptionId (Zeichenfolge): Erforderlich. Geben Sie eine vorhandene Abonnement-ID ein, zu der Sie den/die Benutzer:in verschieben möchten.
contract (Text):
userIds (Zeichenfolge): Geben Sie die Benutzer-IDs ein, die unter die angegebene Abonnement-ID verschoben werden sollen.
curl -X 'PUT' \
'http://localhost/webapi/v3/subscriptions/66ffbb75125b93320a8bb5c7/users' \
-H 'accept: application/json' \
-H 'authorization: Bearer BearerTokenGoesHere' \
-H 'Content-Type: application/json' \
-d '{
"userIds": [
"66ffbb4b125b93320a8bb5bd"
]
}'200: OK
400: Ungültige Anforderung
401: Keine Berechtigung
404: Nicht gefunden
Wenn Sie ein Abonnement erstellen, können Sie erstellte Objekte wie folgt verwenden:
Erstelltes Objekt: „subscriptionId“ (z. B. „subscriptionId“: „619158e57e607d0011ac3009“)
Sie können sie wie folgt verwenden:
subscriptionId, wenn Sie Details zu einem bestehenden Abonnement abrufen möchten.
subscriptionId, wenn Sie ein bestehendes Abonnement aktualisieren möchten.
subscriptionId , wenn Sie ein bestehendes Abonnement löschen möchten.
subscriptionId , wenn Sie einen/eine Benutzer:in oder mehrere Benutzer:innen von einem Abonnement in ein anderes verschieben möchten.
GET {baseURL}/v3/subscriptions/{subscriptionId}
GET {baseURL}/v3/subscriptions
Weitere Informationen zu Postman-Anforderungen finden Sie auf der Hilfeseite Postman verwenden.