Skip to main content

Points de terminaison des collections

Points de terminaison et paramètres de collections

Créer une collection

Ajouter un utilisateur à une collection

Ajouter une analyse à une collection

Ajouter une planification à une collection

Ajouter un workflow à une collection

Comment ajouter un utilisateur ou un groupe à une collection

Récupérer un enregistrement de collection

Récupérer les enregistrements de toutes les collections

Mettre à jour un workflow existant

Mettre à jour les autorisations utilisateur d'une collection

Mettre à jour les autorisations de groupe d'utilisateurs d'une collection

Retirer un utilisateur d'une collection

Retirer un workflow d'une collection

Retirer une analyse d'une collection

Retirer une planification d'une collection

Comment retirer un utilisateur ou un groupe d'une collection

Supprimer une collection

Pour en savoir plus sur les relations d'objets et sur leur utilisation dans l'API, consultez la section Relations d'objets.

Pour plus d'informations à propos des collections, consultez la page d'aide Collections.

Créer une collection

Pour créer une collection, utilisez le {baseURL} noeud final POST /v3/collections.

Paramètres

  • Contrat (corps) : pour créer une collection, le paramètre de contrat est requis. Spécifiez les éléments suivants pour créer une collection :

    • name (chaîne) : obligatoire. Indiquez un nom de champ.

Exemple de demande : cURL

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

Ajouter un utilisateur à une collection

Pour ajouter un utilisateur à une collection, utilisez le {baseURL}{collectionId} noeud final POST /v3/collections/ /users.

082A8515AB7ADDAAD5B04255CF2AE567.png

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Entrez un ID de collection pour spécifier la collection à laquelle ajouter un utilisateur.

  • updateWorkflowContract (corps) : obligatoire. Saisissez des informations sur les utilisateurs et leurs autorisations. Spécifiez les éléments suivants pour ajouter des utilisateurs à une collection :

    • workflowCredentialType (chaîne) : obligatoire. Spécifiez l'ID d'un utilisateur que vous souhaitez ajouter à une collection.

    • versionId (chaîne) : facultatif. Spécifiez la date d'expiration pour que l'utilisateur fasse partie de cette collection. Saisissez la date et l'heure au format ISO8601.

    • CollectionsPermissions (corps):

      • isPublic (booléen) : obligatoire. Spécifiez si l'utilisateur doit être administrateur pour cette collection.

      • CanAddAssets (booléen) : obligatoire. Spécifiez si l'utilisateur peut ajouter des actifs à la collection.

      • CanUpdateAssets (booléen) : obligatoire. Spécifiez si l'utilisateur peut mettre à jour les actifs de la collection.

      • makePublished (booléen) : obligatoire. Spécifiez si l'utilisateur peut supprimer des actifs de la collection.

      • hasPrivateDataExemption (booléen) : facultatif. Spécifiez si l'utilisateur peut ajouter d'autres utilisateurs à la collection.

      • force (booléen) : facultatif. Spécifiez si l'utilisateur peut supprimer des utilisateurs de la collection.

Pour plus d'informations sur les rôles et les autorisations, consultez la page Rôles et autorisations des utilisateurs. Lorsqu'aucun rôle n'est sélectionné, le rôle par défaut est celui indiqué par un administrateur Server dans l'interface Administrateur.

Exemple de demande : cURL

Curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/users' 2007 18 \ --header 'Content-Type : application/x-www-form-urlencoded' \ --header 'Authorization : BearerTokenGoesHere' \ --data-urlencode 'userid=61d80f862835728c94328082' \ 08 11 924

Ajouter une analyse à une collection

Pour ajouter un aperçu à une collection, utilisez le {baseURL}{collectionId} point de terminaison POST /v3/collections/ /insights.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Entrez un ID de collection pour spécifier la collection à laquelle ajouter un aperçu.

  • Contrat (corps) : obligatoire. Saisissez des informations sur l'aperçu. Spécifiez les éléments suivants :

    • workflowCredentialType (chaîne) : obligatoire. Spécifiez l'ID Insight que vous souhaitez ajouter à la collection.

Exemple de demande : cUrl

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

Ajouter une planification à une collection

Pour ajouter une planification à une collection, utilisez le {baseURL}{collectionId} noeud final POST /v3/collections/ /schedules.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Entrez un ID de collection pour spécifier la collection à laquelle ajouter un planning.

  • Contrat (corps) : obligatoire. Saisissez des informations sur le planning. Spécifiez les éléments suivants :

    • workflowCredentialType (chaîne) : obligatoire. Spécifiez l'ID de planification que vous souhaitez ajouter à la collection.

Exemple de demande : cURL

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

Ajouter un workflow à une collection

Pour ajouter un Workflow à une collection, utilisez le {baseURL}{collectionId} noeud final POST /v3/collections/ /workflows.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Entrez un ID de collection pour spécifier la collection à laquelle ajouter un aperçu.

  • Contrat (corps) : obligatoire. Saisissez des informations sur les utilisateurs et leurs autorisations. Spécifiez les éléments suivants :

    • workflowId (chaîne) : obligatoire. Spécifiez l'ID Workflow que vous souhaitez ajouter à la collection.

Exemple de demande : cURL

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

Comment ajouter un utilisateur ou un groupe à une collection

Pour ajouter un groupe d'utilisateurs à une collection, utilisez le {baseURL}{collectionId} noeud final POST /v3/collections/ /usergroups.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Entrez un ID de collection pour spécifier la collection à laquelle ajouter un groupe d'utilisateurs.

  • updateWorkflowContract (corps) : obligatoire. Saisissez des informations sur le groupe d'utilisateurs et ses autorisations. Spécifiez les éléments suivants :

    • versionId (chaîne) : obligatoire. Spécifiez l'ID d'un groupe d'utilisateurs à ajouter à une collection.

    • versionId (chaîne) : facultatif. Spécifiez la date d'expiration du groupe d'utilisateurs qui doit faire partie de cette collection. Saisissez la date et l'heure après laquelle le workflow a été créé.

    • CollectionsPermissions (corps) : obligatoire.

      • hasPrivateDataExemption (booléen) : facultatif. Spécifiez si les membres du groupe d'utilisateurs doivent être des administrateurs pour cette collection. Valeur par défaut : false.

      • hasPrivateDataExemption (booléen) : facultatif. Spécifiez si les membres du groupe d'utilisateurs peuvent ajouter des actifs à la collection. Valeur par défaut : false.

      • hasPrivateDataExemption (booléen) : facultatif. Spécifiez si les membres du groupe d'utilisateurs peuvent supprimer des actifs de la collection. Valeur par défaut : false.

      • hasPrivateDataExemption (booléen) : facultatif. Spécifiez si les membres du groupe d'utilisateurs peuvent mettre à jour les actifs de la collection. Valeur par défaut : false.

      • hasPrivateDataExemption (booléen) : facultatif. Spécifiez si les membres du groupe d'utilisateurs peuvent ajouter d'autres utilisateurs à la collection. Valeur par défaut : false.

      • makePublished (booléen) : obligatoire. Spécifiez si les membres du groupe d'utilisateurs peuvent supprimer d'autres utilisateurs de la collection. Valeur par défaut : false.

Pour plus d'informations sur les rôles et les autorisations, consultez la page Rôles et autorisations des utilisateurs. Lorsqu'aucun rôle n'est sélectionné, le rôle par défaut est celui indiqué par un administrateur Server dans l'interface Administrateur.

Exemple de demande : cURL

Curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/userGroups?addUserGroupsContract' \ --header 'Content-Type : application/x-www-form-urlencodés' \ --header 'Authorization : BearerTokenGoesHere' \ --data-urlencode 'userGroupId=61d83e2ef778247f14e8e6b6' \ - Ad

Récupérer un enregistrement de collection

Pour obtenir des informations sur un workflow spécifique, utilisez le point de terminaison GET {baseURL}/v3/workflows/{collectionId} .

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Entrez un ID de collection pour obtenir les informations sur la collection.

Exemple de demande : cURL

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

Récupérer les enregistrements de toutes les collections

Pour récupérer tous les enregistrements de collection accessibles, utilisez le {baseURL} noeud final GET /v3/collections.

Paramètres

  • view (chaîne) : facultatif. Peut être laissé sans valeur. Vous pouvez choisir parmi les valeurs suivantes : « Default » et « Full ». Si ce paramètre est défini sur « Default », un objet de vue réduite est renvoyé. Lorsqu'elle n'est pas spécifiée, la valeur « Default » est utilisée.

Exemple de demande : cURL

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

Mettre à jour un workflow existant

Pour modifier le nom ou le propriétaire d'une collection, utilisez le {baseURL}{collectionId} noeud final PUT /v3/collections/.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez l'ID du workflow que vous souhaitez mettre à jour.

  • updateWorkflowContract (corps) : obligatoire. Saisissez les informations sur le propriétaire de la collection que vous souhaitez modifier. Spécifiez les éléments suivants :

    • name (chaîne) : obligatoire. Cliquez sur le nom de la collection.

    • ownerId (chaîne) : obligatoire. Saisissez l'ID du propriétaire.

Exemple de demande : cURL

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

Mettre à jour les autorisations utilisateur d'une collection

Pour mettre à jour les autorisations utilisateur pour une collection donnée, utilisez le {baseURL}{collectionId}{userId} noeud final PUT /v3/collections/ /users/ /permissions.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez l'ID du workflow que vous souhaitez mettre à jour.

  • workflowCredentialType (chaîne) : obligatoire. Saisissez un ID utilisateur dont vous souhaitez modifier les autorisations.

  • updateWorkflowContract (corps) : obligatoire. Saisissez l'ID utilisateur pour lequel vous souhaitez modifier les autorisations. Spécifiez les éléments suivants :

    • Date d'expiration (date) : obligatoire. Spécifiez la date d'expiration d'un utilisateur.

    • CollectionsPermissions (corps) : obligatoire. Saisissez l'ID du propriétaire. Spécifiez les éléments suivants :

      • isPublic (booléen) : obligatoire. Spécifiez si l'utilisateur doit être administrateur pour cette collection.

      • CanAddAssets (booléen) : obligatoire. Spécifiez si l'utilisateur peut ajouter des actifs à la collection.

      • makePublished (booléen) : obligatoire. Spécifiez si l'utilisateur peut supprimer des actifs de la collection.

      • CanUpdateAssets (booléen) : obligatoire. Spécifiez si l'utilisateur peut mettre à jour les actifs de la collection.

      • CanAddUsers (booléen) : obligatoire. Spécifiez si l'utilisateur peut ajouter d'autres utilisateurs à la collection.

      • makePublished (booléen) : obligatoire. Spécifiez si l'utilisateur peut supprimer d'autres utilisateurs de la collection.

Pour plus d'informations sur les rôles et les autorisations, consultez la page Rôles et autorisations des utilisateurs. Lorsqu'aucun rôle n'est sélectionné, le rôle par défaut est celui indiqué par un administrateur Server dans l'interface Administrateur.

Exemple de demande : cURL

Curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/users/61db388fc565144387d45086/permissions' \ --header 'Content-Type : application/x-www-form-urlencoded' \ --header 'Authorization : BearerTokenGoesHere' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'cansers' - Uveascanlensers=true \ - Uvescode'

Mettre à jour les autorisations de groupe d'utilisateurs d'une collection

Pour mettre à jour les autorisations de groupe d'utilisateurs pour une collection donnée, utilisez le {baseURL}{collectionId}{userGroupId} noeud final PUT /v3/collections/ /usergroups/ /permissions.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez l'ID du workflow que vous souhaitez mettre à jour.

  • workflowCredentialType (chaîne) : obligatoire. Entrez un ID de groupe d'utilisateurs dont vous souhaitez modifier les autorisations.

  • updateWorkflowContract (corps) : obligatoire. Saisissez l'ID du groupe d'utilisateurs pour lequel vous souhaitez modifier les autorisations. Spécifiez les éléments suivants :

    • ExpirationDate (date) : facultatif. Spécifiez la date d'expiration d'un groupe d'utilisateurs.

    • CollectionsPermissions (corps) : obligatoire. Spécifiez les éléments suivants :

      • isPublic (booléen) : obligatoire. Spécifiez si les membres du groupe d'utilisateurs doivent être admin pour cette collection.

      • CanAddAssets (booléen) : obligatoire. Spécifiez si les membres du groupe d'utilisateurs peuvent ajouter des actifs à la collection.

      • makePublished (booléen) : obligatoire. Spécifiez si les membres du groupe d'utilisateurs peuvent supprimer des actifs de la collection.

      • CanUpdateAssets (booléen) : obligatoire. Spécifiez si les membres du groupe d'utilisateurs peuvent mettre à jour les actifs de la collection.

      • CanAddUsers (booléen) : obligatoire. Spécifiez si les membres du groupe d'utilisateurs peuvent ajouter d'autres utilisateurs à la collection.

      • makePublished (booléen) : obligatoire. Spécifiez si les membres du groupe d'utilisateurs peuvent supprimer des utilisateurs de la collection.

Pour plus d'informations sur les rôles et les autorisations, consultez la page Rôles et autorisations des utilisateurs. Lorsqu'aucun rôle n'est sélectionné, le rôle par défaut est celui indiqué par un administrateur Server dans l'interface Administrateur.

Exemple de demande : cURL

Curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/userGroups/61db38834tssrdrs4cc65144387d4508/permissions' \ --header 'Content-Type : application/x-www-form-urlencoded' \ --header 'Authorization : BearerTokenGoesHere' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'cansers' - Uveascanlensers-data'=true \ - Uvescode 'canlensers 'candelencode'

Retirer un utilisateur d'une collection

Pour supprimer un utilisateur d'une collection, utilisez le{baseURL}{collectionId}{userId} noeud final DELETE /v3/collections/ /users/.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez l'ID du workflow que vous souhaitez mettre à jour.

  • workflowCredentialType (chaîne) : obligatoire. Saisissez un ID utilisateur à supprimer de la collection.

Exemple de demande : cURL

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

Retirer un workflow d'une collection

Pour supprimer un Workflow d'une collection, utilisez le {baseURL}{collectionId}{appId} noeud final DELETE /v3/collections/ /workflows/.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez l'ID du workflow que vous souhaitez mettre à jour.

  • workflowCredentialType (chaîne) : obligatoire. Saisissez un ID Workflow que vous souhaitez supprimer de la collection.

Exemple de demande : cURL

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

Retirer une analyse d'une collection

Pour supprimer un aperçu d'une collection, utilisez le {baseURL}{collectionId}{insightId} noeud final DELETE /v3/collections/ /insights/.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez l'ID du workflow que vous souhaitez mettre à jour.

  • workflowCredentialType (chaîne) : obligatoire. Saisissez un ID Insight que vous souhaitez supprimer de la collection.

Exemple de demande : cURL

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

Retirer une planification d'une collection

Pour supprimer une planification d'une collection, utilisez le {baseURL}{collectionId}{scheduleId} noeud final DELETE /v3/collections/ /schedules/.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez l'ID du workflow que vous souhaitez mettre à jour.

  • workflowCredentialType (chaîne) : obligatoire. Saisissez un ID d'horaire que vous souhaitez supprimer de la collection.

Exemple de demande : cURL

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

Comment retirer un utilisateur ou un groupe d'une collection

Pour supprimer un groupe d'utilisateurs d'une collection, utilisez le {baseURL}{collectionId}{userGroupId} noeud final DELETE /v3/collections/ /usergroups/.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez l'ID du workflow que vous souhaitez mettre à jour.

  • workflowCredentialType (chaîne) : obligatoire. Saisissez un ID de groupe d'utilisateurs à supprimer de la collection.

Exemple de demande : cURL

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

Supprimer une collection

Pour supprimer un workflow spécifique, utilisez le point de terminaison DELETE {baseURL}/v3/workflows/{collectionId}.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez l'ID du workflow que vous souhaitez mettre à jour.

  • hasPrivateDataExemption (booléen) : facultatif. Indiquez si vous souhaitez forcer la suppression d'une collection au cas où cette collection contiendrait des liens vers d'autres objets, tels que des utilisateurs, des groupes, des flux de travail, des aperçus et des plannings. Si vous voulez supprimer la collection et nettoyer tous les liens, définissez le paramètre forceDelete sur true. Lorsque cette option n'est pas sélectionnée, la valeur par défaut est « false ». Ce paramètre est utilisé pour protéger contre un appel errant.

Exemple de demande : cURL

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

Relations d'objets

Si vous chargez un workflow, vous pouvez utiliser les objets créés comme suit :

Objet créé : "workflowId" (par exemple, "id" : "7917969784f84bd09442f66996ecb8f3")

Vous pouvez l'utiliser comme :

Exemples de demandes Postman

PUBLIER /v3/collections

Use POST /v3/collections endpoint.

RÉCUPÉREZ /v3/collections/

Use GET /v3/collections endpoint.

METTEZ /v3/collections/{collectionId}

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

Pour en savoir plus sur les demandes Postman, consultez la page d'aide Comment utiliser Postman.

Dans cette section​: