Skip to main content

Points de terminaison des collections

Points de terminaison et paramètres de collections

Créer une nouvelle collection

Ajouter un utilisateur à une collection

Ajouter une planification à une collection

Ajouter un workflow à une collection

Ajouter un groupe d'utilisateurs à une collection

Récupérer un enregistrement de collection

Récupérer les enregistrements de toutes les collections

Mettre à jour une collection existante

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 planification d'une collection

Retirer un groupe d'utilisateurs 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 nouvelle collection

Pour créer une collection, utilisez le point de terminaison POST {baseURL}/v3/collections .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API. L'utilisateur authentifié de l'API doit avoir l'autorisation « Créer des collections » pour utiliser ce point de terminaison, sinon il recevra l'erreur 401 d'accès non autorisé.

Paramètres

  • contract (corps) : pour créer une collection, le paramètre « contract » est obligatoire. Indiquez les éléments suivants pour créer une collection :

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

Exemple de demande : 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'

Ajouter un utilisateur à une collection

Pour ajouter un utilisateur à une collection existante, utilisez le point de terminaison POST {baseURL}/v3/collections/{collectionId}/users .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

082A8515AB7ADDAAD5B04255CF2AE567.png

Paramètres

  • collectionId (chaîne) : obligatoire. Saisissez un ID de collection pour préciser la collection à laquelle ajouter un utilisateur.

  • addUsersContract (corps) : obligatoire. Saisissez une information sur les utilisateurs et leurs autorisations. Indiquez les éléments suivants pour ajouter des utilisateurs à une collection :

    • userId (chaîne) : obligatoire. Indiquez un ID d'utilisateur que vous souhaitez ajouter à une collection.

    • expirationDate (chaîne) : facultatif. Précisez la date jusqu'à laquelle l'utilisateur peut faire partie de cette collection. Saisissez la date et l'heure au format ISO8601.

    • collectionsPermissions (corps) :

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

      • canAddAssets (booléen) : obligatoire. Indiquez si l'utilisateur peut ajouter des ressources à la collection.

      • canUpdateAssets (booléen) : obligatoire. Indiquez si l'utilisateur peut mettre à jour les ressources de la collection.

      • canRemoveAssets (booléen) : obligatoire. Indiquez si l'utilisateur peut retirer des ressources de la collection.

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

      • canRemoveUsers (booléen) : facultatif. Indiquez si l'utilisateur peut retirer 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' \ --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'

Ajouter une planification à une collection

Pour ajouter une planification à une collection existante, utilisez le point de terminaison POST {baseURL}/v3/collections/{collectionId}/schedules .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

Paramètres

  • collectionId (chaîne) : obligatoire. Saisissez un ID de collection pour préciser la collection à laquelle ajouter une planification.

  • contract (corps) : obligatoire. Saisissez une information sur la planification. Indiquez les éléments suivants :

    • scheduleId (chaîne) : obligatoire. Indiquez l'ID de la 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: Bearer BearerTokenGoesHere' \ --data-urlencode 'scheduleId=61d80f334528377728c94328082'

Ajouter un workflow à une collection

Pour ajouter un workflow à une collection existante, utilisez le point de terminaison POST {baseURL}/v3/collections/{collectionId}/workflows .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

Paramètres

  • collectionId (chaîne) : obligatoire. Saisissez un ID de collection pour préciser la collection à laquelle ajouter une analyse.

  • contract (corps) : obligatoire. Saisissez une information sur les utilisateurs et leurs autorisations. Indiquez les éléments suivants :

    • workflowId (chaîne) : obligatoire. Indiquez l'ID du 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: Bearer BearerTokenGoesHere' \ --data-urlencode 'workflowId=61d80f334223377728c9432'

Ajouter un groupe d'utilisateurs à une collection

Pour ajouter un groupe d'utilisateurs à une collection existante, utilisez le point de terminaison POST {baseURL}/v3/collections/{collectionId}/userGroups .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

Paramètres

  • collectionId (chaîne) : obligatoire. Saisissez un ID de collection pour préciser la collection à laquelle ajouter un groupe d'utilisateurs.

  • addUserGroupsContract (corps) : obligatoire. Saisissez une information sur le groupe d'utilisateurs et ses autorisations. Indiquez les éléments suivants :

    • userGroupId (chaîne) : obligatoire. Indiquez un ID de groupe d'utilisateurs que vous souhaitez ajouter à une collection.

    • expirationDate (chaîne) : facultatif. Précisez la date jusqu'à laquelle le groupe d'utilisateurs peut faire partie de cette collection. Saisissez la date et l'heure après lesquelles l'utilisateur a été créé au format ISO8601.

    • collectionsPermissions (corps) : obligatoire.

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

      • canAddAssets (booléen) : facultatif. Indiquez si les membres du groupe d'utilisateurs peuvent ajouter des ressources à la collection. Valeur par défaut : false.

      • canRemoveAssets (booléen) : facultatif. Indiquez si les membres du groupe d'utilisateurs peuvent retirer des ressources de la collection. Valeur par défaut : false.

      • canUpdateAssets (booléen) : facultatif. Indiquez si les membres du groupe d'utilisateurs peuvent mettre à jour des ressources de la collection. Valeur par défaut : false.

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

      • canRemoveUsers (booléen) : obligatoire. Indiquez si les membres du groupe d'utilisateurs peuvent retirer 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-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'

Récupérer un enregistrement de collection

Pour récupérer des détails sur une collection existante, utilisez le point de terminaison GET {baseURL}/v3/collections/{collectionId} .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

Paramètres

  • collectionId (chaîne) : obligatoire. Saisissez un ID de collection pour obtenir les informations relatives à la collection.

Exemple de demande : cURL

curl --location --request GET 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c' \ --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 point de terminaison GET {baseURL}/v3/collections .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

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/collections?view=Full' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Mettre à jour une collection existante

Pour mettre à jour le nom et/ou le propriétaire d'une collection existante, utilisez le point de terminaison PUT {baseURL}/v3/collections/{collectionId} .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

Paramètres

  • collectionId (chaîne) : obligatoire. Saisissez un ID de collection pour préciser la collection à mettre à jour.

  • updateCollectionContract (corps) : obligatoire. Saisissez des informations sur le propriétaire de la collection à modifier. Indiquez les éléments suivants :

    • name (chaîne) : obligatoire. Saisissez le nouveau nom de la collection.

    • ownerId (chaîne) : obligatoire. Saisissez l'ID du nouveau 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: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting' \ --data-urlencode 'ownerId=61db388fc565144387d45086'

Mettre à jour les autorisations utilisateur d'une collection

Pour mettre à jour les autorisations de l'utilisateur dans une collection existante, utilisez le point de terminaison PUT {baseURL}/v3/collections/{collectionId}/users/{userId}/permissions .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API. Pour les instances Server configurées pour l'authentification Windows, indiquez le SID Active Directory pour le paramètre « userId ».

Paramètres

  • collectionId (chaîne) : obligatoire. Saisissez un ID de collection pour préciser la collection à mettre à jour.

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

  • updatePermissionsContract (corps) : obligatoire. Saisissez l'ID d'utilisateur pour lequel vous souhaitez modifier les autorisations. Indiquez les éléments suivants :

    • expirationDate (date) : obligatoire. Indiquez la date d'expiration d'un utilisateur.

    • collectionsPermissions (corps) : obligatoire. Saisissez l'ID d'utilisateur du nouveau propriétaire. Indiquez les éléments suivants :

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

      • canAddAssets (booléen) : obligatoire. Indiquez si l'utilisateur peut ajouter des ressources à la collection.

      • canRemoveAssets (booléen) : obligatoire. Indiquez si l'utilisateur peut retirer des ressources de la collection.

      • canUpdateAssets (booléen) : obligatoire. Indiquez si l'utilisateur peut mettre à jour les ressources de la collection.

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

      • canRemoveUsers (booléen) : obligatoire. Indiquez si l'utilisateur peut retirer 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: 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'

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

Pour mettre à jour les autorisations du groupe d'utilisateurs dans une collection existante, utilisez le point de terminaison PUT {baseURL}/v3/collections/{collectionId}/userGroups/{userGroupId}/permissions .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

Paramètres

  • collectionId (chaîne) : obligatoire. Saisissez un ID de collection pour préciser la collection à mettre à jour.

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

  • updatePermissionsContract (corps) : obligatoire. Saisissez l'ID de groupe d'utilisateurs pour lequel vous souhaitez modifier les autorisations. Indiquez les éléments suivants :

    • expirationDate (date) : facultatif. Indiquez la date d'expiration d'un groupe d'utilisateurs.

    • collectionsPermissions (corps) : obligatoire. Indiquez les éléments suivants :

      • isAdmin (booléen) : obligatoire. Indiquez si les membres du groupe d'utilisateurs doivent être administrateurs pour cette collection.

      • canAddAssets (booléen) : obligatoire. Indiquez si les membres du groupe d'utilisateurs peuvent ajouter des ressources à la collection.

      • canRemoveAssets (booléen) : obligatoire. Indiquez si les membres du groupe d'utilisateurs peuvent retirer des ressources de la collection.

      • canUpdateAssets (booléen) : obligatoire. Indiquez si les membres du groupe d'utilisateurs peuvent mettre à jour des ressources de la collection.

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

      • canRemoveUsers (booléen) : obligatoire. Indiquez si les membres du groupe d'utilisateurs peuvent retirer 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: 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'

Retirer un utilisateur d'une collection

Pour retirer un utilisateur d'une collection existante, utilisez le point de terminaison DELETE {baseURL}/v3/collections/{collectionId}/users/{userId} .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

Paramètres

  • collectionId (chaîne) : obligatoire. Saisissez un ID de collection pour préciser la collection à mettre à jour.

  • userId (chaîne) : obligatoire. Saisissez un ID d'utilisateur que vous souhaitez retirer de la collection.

Exemple de demande : cURL

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

Retirer un workflow d'une collection

Pour retirer un workflow d'une collection existante, utilisez le point de terminaison DELETE {baseURL}/v3/collections/{collectionId}/workflows/{appId} .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

Paramètres

  • collectionId (chaîne) : obligatoire. Saisissez un ID de collection pour préciser la collection à mettre à jour.

  • appId (chaîne) : obligatoire. Saisissez un ID de workflow que vous souhaitez retirer de la collection.

Exemple de demande : cURL

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

Retirer une planification d'une collection

Pour retirer une planification d'une collection existante, utilisez le point de terminaison DELETE {baseURL}/v3/collections/{collectionId}/schedules/{scheduleId} .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

Paramètres

  • collectionId (chaîne) : obligatoire. Saisissez un ID de collection pour préciser la collection à mettre à jour.

  • scheduleId (chaîne) : obligatoire. Saisissez un ID de planification que vous souhaitez retirer de la collection.

Exemple de demande : cURL

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

Retirer un groupe d'utilisateurs d'une collection

Pour retirer un groupe d'utilisateurs d'une collection existante, utilisez le point de terminaison DELETE {baseURL}/v3/collections/{collectionId}/userGroups/{userGroupId} .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

Paramètres

  • collectionId (chaîne) : obligatoire. Saisissez un ID de collection pour préciser la collection à mettre à jour.

  • userGroupId (chaîne) : obligatoire. Saisissez un ID de groupe d'utilisateurs que vous souhaitez retirer de la collection.

Exemple de demande : cURL

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

Supprimer une collection

Pour supprimer une collection, utilisez le point de terminaison DELETE {baseURL}/v3/collections/{collectionId} .

Note

Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.

Paramètres

  • collectionId (chaîne) : obligatoire. Saisissez un ID de collection pour préciser la collection à mettre à jour.

  • forceDelete (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 workflows, des analyses et des planifications. Si vous voulez supprimer la collection et nettoyer tous les liens, définissez le paramètre « forceDelete » sur « vrai ». Lorsque cette option n'est pas sélectionnée, la valeur par défaut est « faux ». Ce paramètre vous protège des appels erronés.

Exemple de demande : cURL

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

Relations d'objets

Si vous créez une collection, vous pouvez utiliser les objets créés comme suit :

Objet créé : «  id  » (par exemple, « id » : « 7917969784f84bd09442f66996ecb8f3 »)

Vous pouvez l'utiliser comme :

Exemples de demandes Postman

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.

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

Dans cette section​: