Skip to main content

Sammlungsendpunkte

Sammlung-Endpunkte und Parameter

Eine Sammlung erstellen

Einen Benutzer einer Sammlung hinzufügen

Ein Insight einer Sammlung hinzufügen

Einen Zeitplan einer Sammlung hinzufügen

Einen Workflow einer Sammlung hinzufügen

Benutzer oder Gruppe einer Sammlung hinzufügen

Einen Datensatz einer Sammlung abrufen

Datensätze aller Sammlungen abrufen

Einen vorhandenen Workflow aktualisieren

Benutzerberechtigungen einer Sammlung aktualisieren

Benutzergruppenberechtigungen einer Sammlung aktualisieren

Einen Benutzer aus einer Sammlung entfernen

Einen Workflow aus einer Sammlung entfernen

Ein Insight aus einer Sammlung entfernen

Einen Zeitplan aus einer Sammlung entfernen

Einen Benutzer oder eine Gruppe aus einer Sammlung entfernen

Eine Sammlung löschen

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.

Eine Sammlung erstellen

Um einen neuen Workflow hochzuladen, verwenden Sie den Endpunkt POST {baseURL}/v3/workflows.

Parameter

  • Vertrag (Text): Um eine Sammlung zu erstellen, ist der Vertragsparameter erforderlich. Geben Sie Folgendes an, um eine Sammlung zu erstellen:

    • name (Zeichenfolge): Erforderlich. Legen Sie einen Feldnamen fest.

Anforderungsbeispiel: cURL

Curl --location --Request POST 'http://localhost/webapi//v3/collections' \ --Header 'Content-Type: Application/x-www-Form-urlencoded' \ --Header 'Autorisierung: Bearer BearerTokenGoesHere' \ --Data-urlencode 'Name=Accounting'

Einen Benutzer einer Sammlung hinzufügen

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

082A8515AB7ADDAAD5B04255CF2AE567.png

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Sammlungs-ID ein, um die Sammlung anzugeben, zu der ein Benutzer hinzugefügt werden soll.

  • updateWorkflowContract (Haupttext): Erforderlich. Geben Sie Informationen zu den Benutzern und deren Berechtigungen ein. Geben Sie Folgendes an, um Benutzer zu einer Sammlung hinzuzufügen:

    • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie die ID eines Benutzers an, den Sie einer Sammlung hinzufügen möchten.

    • versionId (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.

    • Collectionsberechtigungen (Body):

      • isPublic (boolescher Wert): Erforderlich. Geben Sie an, ob der Benutzer Admin 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.

      • makePublished (boolescher Wert): Erforderlich. Geben Sie an, ob der Benutzer Assets aus der Sammlung entfernen kann.

      • hasPrivateDataExemption (boolescher Wert): Optional. Geben Sie an, ob der Benutzer andere Benutzer zur Sammlung hinzufügen kann.

      • force (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 2007' \ --Data-urlencode 'isAdmin=true 924' \

Ein Insight einer Sammlung hinzufügen

Um einer Sammlung einen Einblick hinzuzufügen, verwenden Sie den {baseURL}{collectionId} Endpunkt POST /v3/Collections/ /Insights.

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Sammlungs-ID ein, um die Sammlung anzugeben, der ein Insight hinzugefügt werden soll.

  • Vertrag (Körper): Erforderlich. Geben Sie Informationen über die Einsicht ein. Geben Sie Folgendes an:

    • workflowCredentialType (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 'Autorisierung: Bearer BearerTokenGoesHere' \ --Data-urlencode 'insightId=61d80f3452835728c94328082'

Einen Zeitplan einer Sammlung hinzufügen

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

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Sammlungs-ID ein, um die Sammlung anzugeben, der ein Zeitplan hinzugefügt werden soll.

  • Vertrag (Körper): Erforderlich. Geben Sie Informationen zum Zeitplan ein. Geben Sie Folgendes an:

    • workflowCredentialType (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=61d80f3452837728c94328082'

Einen Workflow einer Sammlung hinzufügen

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

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Sammlungs-ID ein, um die Sammlung anzugeben, der ein Insight hinzugefügt werden soll.

  • Vertrag (Körper): Erforderlich. Geben Sie Informationen zu den Benutzern und deren 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 'Autorisierung: Bearer BearerTokenGoesHere' \ --Data-urlencode 'workflowId=61d80f33422337728c9432'

Benutzer oder Gruppe einer Sammlung hinzufügen

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

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Sammlungs-ID ein, um die Sammlung anzugeben, der eine Benutzergruppe hinzugefügt werden soll.

  • updateWorkflowContract (Haupttext): Erforderlich. Geben Sie Informationen über die Benutzergruppe und ihre Berechtigungen ein. Geben Sie Folgendes an:

    • versionId (Zeichenfolge): Erforderlich. Geben Sie die ID einer Benutzergruppe an, die Sie einer Sammlung hinzufügen möchten.

    • versionId (Zeichenfolge): Optional. Geben Sie das Ablaufdatum für die Benutzergruppe an, die Teil dieser Sammlung sein soll. Geben Sie das Datum und die Uhrzeit ein, wonach der Workflow erstellt wurde.

    • CollectionsPermissions (Body): Erforderlich.

      • hasPrivateDataExemption (boolescher Wert): Optional. Geben Sie an, ob die Mitglieder der Benutzergruppe Administratoren für diese Sammlung sein sollen. Der Standardwert ist false.

      • hasPrivateDataExemption (boolescher Wert): Optional. Geben Sie an, ob die Mitglieder der Benutzergruppe der Sammlung Assets hinzufügen können. Der Standardwert ist false.

      • hasPrivateDataExemption (boolescher Wert): Optional. Geben Sie an, ob die Mitglieder der Benutzergruppe Assets aus der Sammlung entfernen können. Der Standardwert ist false.

      • hasPrivateDataExemption (boolescher Wert): Optional. Geben Sie an, ob die Mitglieder der Benutzergruppe Assets in der Sammlung aktualisieren können. Der Standardwert ist false.

      • hasPrivateDataExemption (boolescher Wert): Optional. Geben Sie an, ob die Mitglieder der Benutzergruppe weitere Benutzer zur Sammlung hinzufügen können. Der Standardwert ist false.

      • makePublished (boolescher Wert): Erforderlich. Geben Sie an, ob die Mitglieder der Benutzergruppe andere Benutzer aus der Sammlung entfernen können. Der Standardwert ist false.

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/userGroups?addUserGroupsContract' \ --Header 'Content-Type: Application/x-www-Form-urlencoded' \ --Header 'Authorization: Bearer BearerTokenGoesHere' \ --Data-urlencode 'userGroupId=61d83e2ef78247f14e8e6b6' \ --Data-urlencode 'isAdmin=true' \ - Adlencode-Assets' 'Remocanecanecanecanecanecode=true'

Einen Datensatz einer Sammlung abrufen

TUm Informationen über einen spezifischen Workflow abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/workflows/{collectionId} .

Parameter

  • workflowCredentialType (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/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Datensätze aller Sammlungen abrufen

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

Parameter

  • view (Zeichenfolge): Optional. Kann ohne Wert belassen werden. Sie können aus den folgenden Werten wählen: „Standard“ und „Vollständig“. 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/workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Einen vorhandenen Workflow aktualisieren

Um den Namen oder Eigentümer einer Sammlung zu ändern, verwenden Sie PUT {baseURL}/v3/Collections/{collectionId} Endpoint.

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie die ID des Workflows ein, den Sie aktualisieren möchten.

  • updateWorkflowContract (Haupttext): Erforderlich. Geben Sie Informationen zum Eigentümer der Sammlung ein, den Sie ändern möchten. Geben Sie Folgendes an:

    • name (Zeichenfolge): Erforderlich. Klicken Sie auf den Namen der Sammlung.

    • ownerid (Zeichenfolge): Erforderlich. Geben Sie die ID des 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 {baseURL}{collectionId}{userId} Endpunkt PUT /v3/Collections/ /users/ /permissions.

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie die ID des Workflows ein, den Sie aktualisieren möchten.

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Benutzer-ID ein, für die Sie die Berechtigungen ändern möchten.

  • updateWorkflowContract (Haupttext): Erforderlich. Geben Sie die Benutzer-ID ein, für die Sie Berechtigungen ändern möchten. Geben Sie Folgendes an:

    • Ablaufdatum (Datum): Erforderlich. Geben Sie das Ablaufdatum eines Benutzers an.

    • CollectionsPermissions (Body): Erforderlich. Geben Sie die ID des Besitzers ein. Geben Sie Folgendes an:

      • isPublic (boolescher Wert): Erforderlich. Geben Sie an, ob der Benutzer Admin für diese Sammlung sein soll.

      • CanAddAssets (boolescher Wert): Erforderlich. Geben Sie an, ob der Benutzer Assets zur Sammlung hinzufügen kann.

      • makePublished (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.

      • makePublished (boolescher Wert): Erforderlich. Geben Sie an, ob der Benutzer andere 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 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' \ \'Users-true'

Benutzergruppenberechtigungen einer Sammlung aktualisieren

Verwenden Sie zum Aktualisieren von Benutzergruppenberechtigungen für eine bestimmte Sammlung den {baseURL}{collectionId}{userGroupId} Endpunkt PUT /v3/Collections/ /usergroups/ /permissions.

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie die ID des Workflows ein, den Sie aktualisieren möchten.

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Benutzergruppen-ID ein, für die Sie die Berechtigungen ändern möchten.

  • updateWorkflowContract (Haupttext): Erforderlich. Geben Sie die Benutzergruppen-ID ein, für die Sie Berechtigungen ändern möchten. Geben Sie Folgendes an:

    • Ablaufdatum (Datum): Optional. Geben Sie das Ablaufdatum für eine Benutzergruppe an.

    • CollectionsPermissions (Body): Erforderlich. Geben Sie Folgendes an:

      • isPublic (boolescher Wert): Erforderlich. Geben Sie an, ob die Mitglieder der Benutzergruppe Admin 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.

      • makePublished (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 weitere Benutzer zur Sammlung hinzufügen können.

      • makePublished (boolescher Wert): Erforderlich. Geben Sie an, ob die Mitglieder der Benutzergruppe Benutzer aus der Sammlung entfernen können.

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 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' \ \'Users-true'

Einen Benutzer aus einer Sammlung entfernen

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

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie die ID des Workflows ein, den Sie aktualisieren möchten.

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Benutzer-ID ein, die Sie aus der Sammlung entfernen möchten.

Anforderungsbeispiel: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Einen Workflow aus einer Sammlung entfernen

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

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie die ID des Workflows ein, den Sie aktualisieren möchten.

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Workflow-ID ein, die Sie aus der Sammlung entfernen möchten.

Anforderungsbeispiel: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Ein Insight aus einer Sammlung entfernen

Um einen Einblick aus einer Sammlung zu entfernen, verwenden Sie den {baseURL}{collectionId}{insightId} Endpunkt DELETE /v3/Collections/ /Insights/.

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie die ID des Workflows ein, den Sie aktualisieren möchten.

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Insight ID ein, die Sie aus der Sammlung entfernen möchten.

Anforderungsbeispiel: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Einen Zeitplan aus einer Sammlung entfernen

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

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie die ID des Workflows ein, den Sie aktualisieren möchten.

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Plan-ID ein, die Sie aus der Sammlung entfernen möchten.

Anforderungsbeispiel: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Einen Benutzer oder eine Gruppe aus einer Sammlung entfernen

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

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie die ID des Workflows ein, den Sie aktualisieren möchten.

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Benutzergruppen-ID ein, die Sie aus der Sammlung entfernen möchten.

Anforderungsbeispiel: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Eine Sammlung löschen

Um einen spezifischen Workflow zu löschen, verwenden Sie den Endpunkt DELETE {baseURL}/v3/workflows/{collectionId}.

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie die ID des Workflows ein, den Sie aktualisieren möchten.

  • hasPrivateDataExemption (boolescher Wert): Optional. Wählen Sie, ob Sie das Löschen einer Sammlung erzwingen möchten, falls diese Sammlung Links zu anderen Objekten enthält, wie Benutzern, Gruppen, Workflows, Einblicken und Zeitplänen. Wenn die Sammlung gelöscht und alle Links bereinigt werden sollen, setzen Sie den Parameter forceDelete auf True. Wenn Sie diese Option nicht ausgewählt haben, lautet der Standardwert „false“. Dieser Parameter dient zum Schutz vor einem fehlerhaften Aufruf.

Anforderungsbeispiel: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Objektbeziehungen

Wenn Sie einen Workflow hochladen, können Sie erstellte Objekte wie folgt verwenden:

Objekt erstellt: "workflowId" (z. B. "id": "7917969784f84bd0942f66996ecb8f3")

Sie können sie wie folgt verwenden:

Beispiele für eine Postman-Anforderung

POST /v3/Collections

Use POST /v3/collections endpoint.

GET /v3/Collections/

Use GET /v3/collections endpoint.

PUT /v3/Collections/{collectionId}

Use PUT /v3/collections/{collectionId} endpoint.

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

In diesem Abschnitt: