[en] Collection Endpoints

[en] Collection Endpoints and Parameters

[en] To learn more about the objects relations and how to use them in the API, go to the Object Relations section.

[en] For more information about collections, visit the Collections help page.

[en] Create a Collection

[en] To create a collection, use the POST {baseURL}/v3/collections endpoint.

[en] Parameters

[en] contract (body): To create a collection, the contract parameter is required. Specify the following to create a collection:
- [en] name (string): Required. Specify a collection name.

[en] Request Example: cURL

[en] 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'

[en] Add a User to a Collection

[en] To add a user to a collection, use the POST {baseURL}/v3/collections/{collectionId}/users endpoint.

[en] Parameters

[en] collectionId (string): Required. Enter a collection ID to specify the collection to add a user to.
[en] addUsersContract (body): Required. Enter an information about the users and their permissions. Specify the following to add users to a collection:
- [en] userId (string): Required. Specify the ID of a user you want to add to a collection.
- [en] expirationDate (string): Optional. Specify the expiration date for the user to be part of this collection. Enter the date and time in ISO8601 format.
- [en] collectionsPermissions (body):
  - [en] isAdmin (boolean): Required. Specify whether the user should be admin for this collection.
  - [en] canAddAssets (boolean): Required. Specify whether the user can add assets to the collection.
  - [en] canUpdateAssets (boolean): Required. Specify whether the user can update assets in the collection.
  - [en] canRemoveAssets (boolean): Required. Specify whether the user can remove assets from the collection.
  - [en] canAddUsers (boolean): Optional. Specify whether the user can add other users to the collection.
  - [en] canRemoveUsers (boolean): Optional. Specify whether the user can remove users from the collection.

[en] For more information about roles and permissions, visit the User Roles and Permissions page. When no role is selected, the default is the default role as specified by a Server administrator in the Admin interface.

[en] Request Example: cURL

[en] 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'

[en] Back to Collection Endpoints overview.

[en] Add an Insight to a Collection

[en] To add an insight to a collection, use the POST {baseURL}/v3/collections/{collectionId}/insights endpoint.

[en] Parameters

[en] collectionId (string): Required. Enter a collection ID to specify the collection to add an insight to.
[en] contract (body): Required. Enter an information about the insight. Specify the following:
- [en] insightId (string): Required. Specify the insight ID you want to add to the collection.

[en] Request Example: cUrl

[en] 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'

[en] Back to Collection Endpoints overview.

[en] Add a Schedule to a Collection

[en] To add a schedule to a collection, use the POST {baseURL}/v3/collections/{collectionId}/schedules endpoint.

[en] Parameters

[en] collectionId (string): Required. Enter a collection ID to specify the collection to add a schedule to.
[en] contract (body): Required. Enter an information about the schedule. Specify the following:
- [en] scheduleId (string): Required. Specify the schedule ID you want to add to the collection.

[en] Request Example: cURL

[en] 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'

[en] Back to Collection Endpoints overview.

[en] Add a Workflow to a Collection

[en] To add a workflow to a collection, use the POST {baseURL}/v3/collections/{collectionId}/workflows endpoint.

[en] Parameters

[en] collectionId (string): Required. Enter a collection ID to specify the collection to add an insight to.
[en] contract (body): Required. Enter an information about the users and their permissions. Specify the following:
- [en] workflowId (string): Required. Specify the workflow ID you want to add to the collection.

[en] Request Example: cURL

[en] 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'

[en] Back to Collection Endpoints overview.

[en] Add a User Group to a Collection

[en] To add a user group to a collection, use the POST {baseURL}/v3/collections/{collectionId}/userGroups endpoint.

[en] Parameters

[en] collectionId (string): Required. Enter a collection ID to specify the collection to add a user group to.
[en] addUserGroupsContract (body): Required. Enter an information about the user group and its permissions. Specify the following:
- [en] userGroupId (string): Required. Specify the ID of a user group you want to add to a collection.
- [en] expirationDate (string): Optional. Specify the expiration date for the user group to be part of this collection. Enter the date and time after which the user was created in ISO8601 format.
- [en] collectionsPermissions (body): Required.
  - [en] isAdmin (boolean): Optional. Specify whether the user group members should be admins for this collection. Default is false.
  - [en] canAddAssets (boolean): Optional. Specify whether the user group members can add assets to the collection. Default is false.
  - [en] canRemoveAssets (boolean): Optional. Specify whether the user group members can remove assets from the collection. Default is false.
  - [en] canUpdateAssets (boolean): Optional. Specify whether the user group members can update assets in the collection. Default is false.
  - [en] canAddUsers (boolean): Optional. Specify whether the user group members can add other users to the collection. Default is false.
  - [en] canRemoveUsers (boolean): Required. Specify whether the user group members can remove other users from the collection. Default is false.

[en] Request Example: cURL

[en] 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'

[en] Back to Collection Endpoints overview.

[en] Retrieve a Collection Record

[en] To retrieve information about a collection, use the GET {baseURL}/v3/collections/{collectionId} endpoint.

[en] Parameters

[en] collectionId (string): Required. Enter a collection ID to get the information about the collection.

[en] Request Example: cURL

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

[en] Back to Collection Endpoints overview.

[en] Retrieve Records of All Collections

[en] To retrieve all accessible collection records, use the GET {baseURL}/v3/collections endpoint.

[en] Parameters

[en] view (string): Optional. Can be left without a value. You can choose from the following values: ‘Default’ and ‘Full’. If this parameter is set to 'Default’, then a reduced view object will be returned. When not specified, the ‘Default’ value is used.

[en] Request Example: cURL

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

[en] Back to Collection Endpoints overview.

[en] Update an Existing Collection

[en] To change the name or owner of a collection, use the PUT {baseURL}/v3/collections/{collectionId} endpoint.

[en] Parameters

[en] collectionId (string): Required. Enter a collection ID to specify the collection you want to update.
[en] updateCollectionContract (body): Required. Enter information about the collection owner you want to change. Specify the following:
- [en] name (string): Required. Enter the new name of the collection.
- [en] ownerId (string): Required. Enter the ID of the new owner.

[en] Request Example: cURL

[en] 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'

[en] Back to Collection Endpoints overview.

[en] Update User Permissions of a Collection

[en] To update user permissions for a certain collection, use the PUT {baseURL}/v3/collections/{collectionId}/users/{userId}/permissions endpoint.

[en] Parameters

[en] collectionId (string): Required. Enter a collection ID to specify the collection you want to update.
[en] userId (string): Required. Enter a user ID you want to change the permissions for.
[en] updatePermissionsContract (body): Required. Enter the user ID for which you want to change permissions. Specify the following:
- [en] expirationDate (date): Required. Specify the expiration date of a user.
- [en] collectionsPermissions (body): Required. Enter the user ID of the new owner. Specify the following:
  - [en] isAdmin (boolean): Required. Specify whether the user should be admin for this collection.
  - [en] canAddAssets (boolean): Required. Specify whether the user can add assets to the collection.
  - [en] canRemoveAssets (boolean): Required. Specify whether the user can remove assets from the collection.
  - [en] canUpdateAssets (boolean): Required. Specify whether the user can update assets in the collection.
  - [en] canAddUsers (boolean): Required. Specify whether the user can add other users to the collection.
  - [en] canRemoveUsers (boolean): Required. Specify whether the user can remove other users from the collection.

[en] Request Example: cURL

[en] 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'

[en] Back to Collection Endpoints overview.

[en] Update User Group Permissions of a Collection

[en] To update user group permissions for a certain collection, use the PUT {baseURL}/v3/collections/{collectionId}/userGroups/{userGroupId}/permissions endpoint.

[en] Parameters

[en] collectionId (string): Required. Enter a collection ID to specify the collection you want to update.
[en] userGroupId (string): Required. Enter a user group ID you want to change the permissions for.
[en] updatePermissionsContract (body): Required. Enter the user group ID for which you want to change permissions. Specify the following:
- [en] expirationDate (date): Optional. Specify the expiration date for a user group.
- [en] collectionsPermissions (body): Required. Specify the following:
  - [en] isAdmin (boolean): Required. Specify whether the user group members should be admin for this collection.
  - [en] canAddAssets (boolean): Required. Specify whether the user group members can add assets to the collection.
  - [en] canRemoveAssets (boolean): Required. Specify whether the user group members can remove assets from the collection.
  - [en] canUpdateAssets (boolean): Required. Specify whether the user group members can update assets in the collection.
  - [en] canAddUsers (boolean): Required. Specify whether the user group members can add other users to the collection.
  - [en] canRemoveUsers (boolean): Required. Specify whether the user group members can remove users to the collection.

[en] Request Example: cURL

[en] 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'

[en] Back to Collection Endpoints overview.

[en] Remove a User from a Collection

[en] To remove a user from a collection, use the DELETE {baseURL}/v3/collections/{collectionId}/users/{userId} endpoint.

[en] Parameters

[en] collectionId (string): Required. Enter a collection ID to specify the collection you want to update.
[en] userId (string): Required. Enter a user ID you want to remove from the collection.

[en] Request Example: cURL

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

[en] Back to Collection Endpoints overview.

[en] Remove a Workflow from a Collection

[en] To remove a workflow from a collection, use the DELETE {baseURL}/v3/collections/{collectionId}/workflows/{appId} endpoint.

[en] Parameters

[en] collectionId (string): Required. Enter a collection ID to specify the collection you want to update.
[en] appId (string): Required. Enter a workflow ID you want to remove from the collection.

[en] Request Example: cURL

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

[en] Back to Collection Endpoints overview.

[en] Remove an Insight from a Collection

[en] To remove an insight from a collection, use the DELETE {baseURL}/v3/collections/{collectionId}/insights/{insightId} endpoint.

[en] Parameters

[en] collectionId (string): Required. Enter a collection ID to specify the collection you want to update.
[en] insightId (string): Required. Enter an insight ID you want to remove from the collection.

[en] Request Example: cURL

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

[en] Back to Collection Endpoints overview.

[en] Remove a Schedule from a Collection

[en] To remove a schedule from a collection, use the DELETE {baseURL}/v3/collections/{collectionId}/schedules/{scheduleId} endpoint.

[en] Parameters

[en] collectionId (string): Required. Enter a collection ID to specify the collection you want to update.
[en] scheduleId (string): Required. Enter a schedule ID you want to remove from the collection.

[en] Request Example: cURL

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

[en] Back to Collection Endpoints overview.

[en] Remove a User Group from a Collection

[en] To remove a user group from a collection, use the DELETE {baseURL}/v3/collections/{collectionId}/userGroups/{userGroupId} endpoint.

[en] Parameters

[en] collectionId (string): Required. Enter a collection ID to specify the collection you want to update.
[en] userGroupId (string): Required. Enter a user group ID you want to remove from the collection.

[en] Request Example: cURL

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

[en] Back to Collection Endpoints overview.

[en] Delete a Collection

[en] To delete a collection, use the DELETE {baseURL}/v3/collections/{collectionId} endpoint.

[en] Parameters

[en] collectionId (string): Required. Enter a collection ID to specify the collection you want to update.
[en] forceDelete (boolean): Optional. Select whether you want to force the deletion of a collection in case this collection has links to other objects, such as users, groups, workflows, insights and schedules. If you want the collection deleted and all links cleaned up, set the forceDelete parameter to true. When not selected, the default value is false. This parameter is used in order to protect against an errant call.

[en] Request Example: cURL

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

[en] Back to Collection Endpoints overview.