Sammlungsendpunkte

Sammlungsendpunkte und Parameter

Weitere Informationen zu Objektbeziehungen und deren Verwendung in der API finden Sie im Abschnitt Objektbeziehungen.

Weitere Informationen zu Sammlungen finden Sie auf der Hilfeseite Sammlungen.

Sammlung erstellen

Um eine Sammlung zu erstellen, verwenden Sie den Endpunkt POST {baseURL}/v3/collections.

Parameter

contract (Text): Um eine Sammlung zu erstellen, ist der Parameter „contract“ erforderlich. Geben Sie Folgendes an, um eine Sammlung zu erstellen:
- name (Zeichenfolge): erforderlich. Geben Sie einen Sammlungsnamen an.

Anforderungsbeispiel: cURL

curl --location --request POST 'http://localhost/webapi//v3/collections' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting'

Benutzer zu einer Sammlung hinzufügen

Um einen Benutzer zu einer Sammlung hinzuzufügen, verwenden Sie den Endpunkt POST {baseURL}/v3/collections/{collectionId}/users.

Parameter

collectionId (Zeichenfolge): erforderlich. Geben Sie eine Sammlungs-ID ein, um die Sammlung anzugeben, der ein Benutzer hinzugefügt werden soll.
addUsersContract (Text): erforderlich. Geben Sie Informationen zu den Benutzern und zu ihren Berechtigungen ein. Geben Sie Folgendes an, um Benutzer zu einer Sammlung hinzuzufügen:
- userId (Zeichenfolge): erforderlich. Geben Sie die ID eines Benutzers an, den Sie einer Sammlung hinzufügen möchten.
- expirationDate (Zeichenfolge): optional. Geben Sie das Ablaufdatum für den Benutzer an, der Teil dieser Sammlung sein soll. Geben Sie Datum und Uhrzeit im ISO8601-Format ein.
- collectionsPermissions (Text):
  - isAdmin (boolescher Wert): erforderlich. Geben Sie an, ob der Benutzer Administrator für diese Sammlung sein soll.
  - canAddAssets (boolescher Wert): erforderlich. Geben Sie an, ob der Benutzer Assets zur Sammlung hinzufügen kann.
  - canUpdateAssets (boolescher Wert): erforderlich. Geben Sie an, ob der Benutzer Assets in der Sammlung aktualisieren kann.
  - canRemoveAssets (boolescher Wert): erforderlich. Geben Sie an, ob der Benutzer Assets aus der Sammlung entfernen kann.
  - canAddUsers (boolescher Wert): optional. Geben Sie an, ob der Benutzer andere Benutzer zur Sammlung hinzufügen kann.
  - canRemoveUsers (boolescher Wert): optional. Geben Sie an, ob der Benutzer Benutzer aus der Sammlung entfernen kann.

Weitere Informationen zu Rollen und Berechtigungen finden Sie auf der Seite Benutzerrollen und -berechtigungen. Wenn keine Rolle ausgewählt ist, ist die Standardeinstellung die Standardrolle, die von einem Server-Administrator in der Admin-Oberfläche angegeben wurde.

Anforderungsbeispiel: cURL

curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/users' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'userId=61d80f862835728c94328082' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=true' \ --data-urlencode 'canRemoveAssets=true' \ --data-urlencode 'canUpdateAssets=true' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true' \ --data-urlencode 'expirationDate=2007-08-17T19:18:11.924Z'

Insight zu einer Sammlung hinzufügen

Um einer Sammlung ein Insight hinzuzufügen, verwenden Sie den Endpunkt POST {baseURL}/v3/collections/{collectionId}/insights.

Parameter

collectionId (Zeichenfolge): erforderlich. Geben Sie eine Sammlungs-ID ein, um die Sammlung anzugeben, der ein Insight hinzugefügt werden soll.
contract (Text): erforderlich. Geben Sie Informationen über das Insight ein. Geben Sie Folgendes an:
- insightId (Zeichenfolge): erforderlich. Geben Sie die Insight-ID an, die Sie der Sammlung hinzufügen möchten.

Anforderungsbeispiel: cUrl

curl --location --request POST 'http://localhost/webapi//v3/collections/472dfff22086458d935d4edf348a1e2b/insights' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'insightId=61d80f33452835728c94328082'

Zeitplan zu einer Sammlung hinzufügen

Um einer Sammlung einen Zeitplan hinzuzufügen, verwenden Sie den Endpunkt POST {baseURL}/v3/collections/{collectionId}/schedules.

Parameter

collectionId (Zeichenfolge): erforderlich. Geben Sie eine Sammlungs-ID ein, um die Sammlung anzugeben, der ein Zeitplan hinzugefügt werden soll.
contract (Text): erforderlich. Geben Sie Informationen zum Zeitplan ein. Geben Sie Folgendes an:
- scheduleId (Zeichenfolge): erforderlich. Geben Sie die Zeitplan-ID an, die Sie der Sammlung hinzufügen möchten.

Anforderungsbeispiel: cURL

curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/schedules' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'scheduleId=61d80f334528377728c94328082'

Workflow zu einer Sammlung hinzufügen

Um einen Workflow zu einer Sammlung hinzuzufügen, verwenden Sie den Endpunkt POST {baseURL}/v3/collections/{collectionId}/workflows.

Parameter

collectionId (Zeichenfolge): erforderlich. Geben Sie eine Sammlungs-ID ein, um die Sammlung anzugeben, der ein Insight hinzugefügt werden soll.
contract (Text): erforderlich. Geben Sie Informationen zu den Benutzern und zu ihren Berechtigungen ein. Geben Sie Folgendes an:
- workflowId (Zeichenfolge): erforderlich. Geben Sie die Workflow-ID an, die Sie der Sammlung hinzufügen möchten.

Anforderungsbeispiel: cURL

curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/workflows' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'workflowId=61d80f334223377728c9432'

Benutzergruppe zu einer Sammlung hinzufügen

Um einer Sammlung eine Benutzergruppe hinzuzufügen, verwenden Sie den Endpunkt POST {baseURL}/v3/collections/{collectionId}/userGroups.

Parameter

collectionId (Zeichenfolge): erforderlich. Geben Sie eine Sammlungs-ID ein, um die Sammlung anzugeben, der eine Benutzergruppe hinzugefügt werden soll.
addUserGroupsContract (Text): erforderlich. Geben Sie Informationen über die Benutzergruppe und ihre Berechtigungen ein. Geben Sie Folgendes an:
- userGroupId (Zeichenfolge): erforderlich. Geben Sie die ID einer Benutzergruppe an, die Sie einer Sammlung hinzufügen möchten.
- expirationDate (Zeichenfolge): optional. Geben Sie das Ablaufdatum für die Benutzergruppe an, die Teil dieser Sammlung sein soll. Geben Sie im ISO8601-Format das Datum und die Uhrzeit ein, nach der der Workflow erstellt wurde.
- collectionsPermissions (Text): erforderlich.
  - isAdmin (boolescher Wert): optional. Geben Sie an, ob die Mitglieder der Benutzergruppe Administratoren für diese Sammlung sein sollen. Der Standardwert ist false.
  - canAddAssets (boolescher Wert): optional. Geben Sie an, ob die Mitglieder der Benutzergruppe der Sammlung Assets hinzufügen können. Der Standardwert ist false.
  - canRemoveAssets (boolescher Wert): optional. Geben Sie an, ob die Mitglieder der Benutzergruppe Assets aus der Sammlung entfernen können. Der Standardwert ist false.
  - canUpdateAssets (boolescher Wert): optional. Geben Sie an, ob die Mitglieder der Benutzergruppe Assets in der Sammlung aktualisieren können. Der Standardwert ist false.
  - canAddUsers (boolescher Wert): optional. Geben Sie an, ob die Mitglieder der Benutzergruppe andere Benutzer zur Sammlung hinzufügen können. Der Standardwert ist false.
  - canRemoveUsers (boolescher Wert): erforderlich. Geben Sie an, ob die Mitglieder der Benutzergruppe andere Benutzer aus der Sammlung entfernen können. Der Standardwert ist false.

Anforderungsbeispiel: cURL

curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/userGroups?addUserGroupsContract' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'userGroupId=61d83e2ef778247f14e8e6b6' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=false' \ --data-urlencode 'canRemoveAssets=true' \ --data-urlencode 'canUpdateAssets=false' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true'

Sammlungsdatensatz abrufen

Um Informationen über eine Sammlung abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/collections/{collectionId}.

Parameter

collectionId (Zeichenfolge): erforderlich. Geben Sie eine Sammlungs-ID ein, um die Informationen über die Sammlung abzurufen.

Anforderungsbeispiel: cURL

curl --location --request GET 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Datensätze aller Sammlungen abrufen

Um alle zugänglichen Sammlungsdatensätze abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/collections.

Parameter

view (Zeichenfolge): optional. Kann ohne Wert belassen werden. Sie können aus den folgenden Werten wählen: „Default“ und „Full“. Wenn dieser Parameter auf „Standard“ gesetzt ist, wird ein reduziertes Ansichtsobjekt zurückgegeben. Wenn keine Angaben gemacht werden, wird der Standardwert verwendet.

Anforderungsbeispiel: cURL

curl --location --request GET 'http://localhost/webapi/v3/collections?view=Full' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Vorhandene Sammlung aktualisieren

Um den Namen oder Besitzer einer Sammlung zu ändern, verwenden Sie den Endpunkt PUT {baseURL}/v3/collections/{collectionId}.

Parameter

collectionId (Zeichenfolge): erforderlich. Geben Sie eine Sammlungs-ID ein, um die Sammlung anzugeben, die Sie aktualisieren möchten.
updateCollectionContract (Text): erforderlich. Geben Sie Informationen zum Sammlungsbesitzer ein, den Sie ändern möchten. Geben Sie Folgendes an:
- name (Zeichenfolge): erforderlich. Geben Sie den neuen Namen der Sammlung ein.
- ownerId (Zeichenfolge): erforderlich. Geben Sie die ID des neuen Besitzers ein.

Anforderungsbeispiel: cURL

curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting' \ --data-urlencode 'ownerId=61db388fc565144387d45086'

Benutzerberechtigungen einer Sammlung aktualisieren

Um Benutzerberechtigungen für eine bestimmte Sammlung zu aktualisieren, verwenden Sie den Endpunkt PUT {baseURL}/v3/collections/{collectionId}/users/{userId}/permissions.

Parameter

collectionId (Zeichenfolge): erforderlich. Geben Sie eine Sammlungs-ID ein, um die Sammlung anzugeben, die Sie aktualisieren möchten.
userId (Zeichenfolge): erforderlich. Geben Sie eine Benutzer-ID ein, für die Sie die Berechtigungen ändern möchten.
updatePermissionsContract (Text): erforderlich. Geben Sie die Benutzer-ID ein, für die Sie Berechtigungen ändern möchten. Geben Sie Folgendes an:
- expirationDate (Datum): erforderlich. Geben Sie das Ablaufdatum eines Benutzers an.
- collectionsPermissions (Text): erforderlich. Geben Sie die Benutzer-ID des neuen Besitzers ein. Geben Sie Folgendes an:
  - isAdmin (boolescher Wert): erforderlich. Geben Sie an, ob der Benutzer Administrator für diese Sammlung sein soll.
  - canAddAssets (boolescher Wert): erforderlich. Geben Sie an, ob der Benutzer Assets zur Sammlung hinzufügen kann.
  - canRemoveAssets (boolescher Wert): erforderlich. Geben Sie an, ob der Benutzer Assets aus der Sammlung entfernen kann.
  - canUpdateAssets (boolescher Wert): erforderlich. Geben Sie an, ob der Benutzer Assets in der Sammlung aktualisieren kann.
  - canAddUsers (boolescher Wert): erforderlich. Geben Sie an, ob der Benutzer andere Benutzer zur Sammlung hinzufügen kann.
  - canRemoveUsers (boolescher Wert): erforderlich. Geben Sie an, ob der Benutzer andere Benutzer aus der Sammlung entfernen kann.

Anforderungsbeispiel: cURL

curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/users/61db388fc565144387d45086/permissions' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=true' \ --data-urlencode 'canRemoveAssets=true' \ --data-urlencode 'canUpdateAssets=true' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true'

Benutzergruppenberechtigungen einer Sammlung aktualisieren

Um Benutzergruppenberechtigungen für eine bestimmte Sammlung zu aktualisieren, verwenden Sie den Endpunkt PUT {baseURL}/v3/collections/{collectionId}/userGroups/{userGroupId}/permissions.

Parameter

collectionId (Zeichenfolge): erforderlich. Geben Sie eine Sammlungs-ID ein, um die Sammlung anzugeben, die Sie aktualisieren möchten.
userGroupId (Zeichenfolge): erforderlich. Geben Sie eine Benutzergruppen-ID ein, für die Sie die Berechtigungen ändern möchten.
updatePermissionsContract (Text): erforderlich. Geben Sie die Benutzergruppen-ID ein, für die Sie Berechtigungen ändern möchten. Geben Sie Folgendes an:
- expirationDate (Datum): optional. Geben Sie das Ablaufdatum für eine Benutzergruppe an.
- collectionsPermissions (Text): erforderlich. Geben Sie Folgendes an:
  - isAdmin (boolescher Wert): erforderlich. Geben Sie an, ob die Mitglieder der Benutzergruppe Administratoren für diese Sammlung sein sollen.
  - canAddAssets (boolescher Wert): erforderlich. Geben Sie an, ob die Mitglieder der Benutzergruppe der Sammlung Assets hinzufügen können.
  - canRemoveAssets (boolescher Wert): erforderlich. Geben Sie an, ob die Mitglieder der Benutzergruppe Assets aus der Sammlung entfernen können.
  - canUpdateAssets (boolescher Wert): erforderlich. Geben Sie an, ob die Mitglieder der Benutzergruppe Assets in der Sammlung aktualisieren können.
  - canAddUsers (boolescher Wert): erforderlich. Geben Sie an, ob die Mitglieder der Benutzergruppe andere Benutzer zur Sammlung hinzufügen können.
  - canRemoveUsers (boolescher Wert): erforderlich. Geben Sie an, ob die Mitglieder der Benutzergruppe Benutzer aus der Sammlung entfernen können.

Anforderungsbeispiel: cURL

curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/userGroups/61db38834tssrdrs4cc65144387d4508/permissions' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=true' \ --data-urlencode 'canRemoveAssets=false' \ --data-urlencode 'canUpdateAssets=true' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true'

Benutzer aus einer Sammlung entfernen

Um einen Benutzer aus einer Sammlung zu entfernen, verwenden Sie den Endpunkt DELETE {baseURL}/v3/collections/{collectionId}/users/{userId}.

Parameter

collectionId (Zeichenfolge): erforderlich. Geben Sie eine Sammlungs-ID ein, um die Sammlung anzugeben, die Sie aktualisieren möchten.
userId (Zeichenfolge): erforderlich. Geben Sie eine Benutzer-ID ein, die Sie aus der Sammlung entfernen möchten.

Anforderungsbeispiel: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/users/61db388fc565144387d45086' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Workflow aus einer Sammlung entfernen

Um einen Workflow aus einer Sammlung zu entfernen, verwenden Sie den Endpunkt DELETE {baseURL}/v3/collections/{collectionId}/workflows/{appId}.

Parameter

collectionId (Zeichenfolge): erforderlich. Geben Sie eine Sammlungs-ID ein, um die Sammlung anzugeben, die Sie aktualisieren möchten.
appId (Zeichenfolge): erforderlich. Geben Sie eine Workflow-ID ein, die Sie aus der Sammlung entfernen möchten.

Anforderungsbeispiel: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/workflows/61db388fc565144387d45086' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Insight aus einer Sammlung entfernen

Um ein Insight aus einer Sammlung zu entfernen, verwenden Sie den Endpunkt DELETE {baseURL}/v3/collections/{collectionId}/insights/{insightId}.

Parameter

collectionId (Zeichenfolge): erforderlich. Geben Sie eine Sammlungs-ID ein, um die Sammlung anzugeben, die Sie aktualisieren möchten.
insightId (Zeichenfolge): erforderlich. Geben Sie eine Insight-ID ein, die Sie aus der Sammlung entfernen möchten.

Anforderungsbeispiel: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/insights/61db388fc565144387d450867' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Zeitplan aus einer Sammlung entfernen

Um einen Zeitplan aus einer Sammlung zu entfernen, verwenden Sie den Endpunkt DELETE {baseURL}/v3/collections/{collectionId}/schedules/{scheduleId}.

Parameter

collectionId (Zeichenfolge): erforderlich. Geben Sie eine Sammlungs-ID ein, um die Sammlung anzugeben, die Sie aktualisieren möchten.
scheduleId (Zeichenfolge): erforderlich. Geben Sie eine Zeitplan-ID ein, die Sie aus der Sammlung entfernen möchten.

Anforderungsbeispiel: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/schedules/61db3777c565144387d450867' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Benutzergruppe aus einer Sammlung entfernen

Um eine Benutzergruppe aus einer Sammlung zu entfernen, verwenden Sie den Endpunkt DELETE {baseURL}/v3/collections/{collectionId}/userGroups/{userGroupId}.

Parameter

collectionId (Zeichenfolge): erforderlich. Geben Sie eine Sammlungs-ID ein, um die Sammlung anzugeben, die Sie aktualisieren möchten.
userGroupId (Zeichenfolge): erforderlich. Geben Sie eine Benutzergruppen-ID ein, die Sie aus der Sammlung entfernen möchten.

Anforderungsbeispiel: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/userGroups/61dc063d9938fe43b5e8fc80' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Sammlung löschen

Um eine Sammlung zu löschen, verwenden Sie den Endpunkt DELETE {baseURL}/v3/collections/{collectionId}.

Parameter

collectionId (Zeichenfolge): erforderlich. Geben Sie eine Sammlungs-ID ein, um die Sammlung anzugeben, die Sie aktualisieren möchten.
forceDelete (boolescher Wert): optional. Wählen Sie aus, ob Sie das Löschen einer Sammlung erzwingen möchten, falls diese Sammlung Verknüpfungen zu anderen Objekten wie Benutzern, Gruppen, Workflows, Insights und Zeitplänen enthält. Wenn die Sammlung gelöscht und alle Verknüpfungen bereinigt werden sollen, setzen Sie den Parameter „forceDelete“ auf „true“. Wenn Sie nichts auswählen, lautet der Standardwert „false“. Dieser Parameter dient zum Schutz vor einem fehlerhaften Aufruf.

Anforderungsbeispiel: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/253fcf0b10204dc085f07bdf1b40e759?forceDelete=true' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Objektbeziehungen

Wenn Sie eine Sammlung erstellen, können Sie erstellte Objekte wie folgt verwenden:

Erstelltes Objekt: „id“ (z. B. "id": "7917969784f84bd09442f66996ecb8f3")

Sie können sie wie folgt verwenden:

collectionId, wenn Sie nach einer bestimmten Sammlung suchen.
collectionId, wenn Sie Benutzer, Benutzergruppen, Workflows, Insights oder Zeitpläne zu einer Sammlung hinzufügen.
collectionId, wenn Sie eine vorhandene Sammlung aktualisieren.
collectionId, wenn Sie eine bestimmte Sammlung löschen möchten.

Beispiele für eine Postman-Anforderung

POST /V3/collections

GET /v3/collections/

PUT /v3/collections/{collectionId}

Weitere Informationen zu Postman-Anforderungen finden Sie auf der Hilfeseite Postman verwenden.

In diesem Abschnitt:

Sammlungsendpunkte