Collection Shares

A CollectionShare is a Collection that has been made accessible to anyone with the id or slug of the Collection.

Searching allows you to find CollectionShare resources in your Dash matching specific criteria.

A list of sorts can also be provided to control the order in the which the results are returned.

Operations

Create a collection share

Request

Create a new CollectionShare, making a Collection available to anyone who has one of the CollectionShare.slugs.

Security

bearerToken

Bodyapplication/jsonrequired

collectionIdstringrequired

The unique ID of the Collection to be shared

Example:"a52b5315-15b8-417f-b742-d6902108bac1"

expirystring or null, (date-time)

The datetime the share will expire and no longer be accessible in ISO datetime format. If the expiry is null, the share will never expire.

Default:null

Example:"2021-02-17T09:24:01.417Z"

assetPermittedActionsstring

Permissions users have on assets they are viewing

Default:"VIEW_AND_DOWNLOAD"

Enum:"VIEW""VIEW_AND_DOWNLOAD"

Example:"VIEW"

curl -i -X POST \
  https://api-v2.dash.app/collection-shares \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "collectionId": "a52b5315-15b8-417f-b742-d6902108bac1",
    "expiry": "2021-02-17T09:24:01.417Z",
    "assetPermittedActions": "VIEW"
  }'

Responses

Success

Bodyapplication/json

resultobjectrequired

permittedActionsArray of objectsrequired

Response

{
  "result": {
    "id": "4517a7ba-a482-4211-b97e-f4256f53fd32",
    "accountId": "cfb665ca-ce35-4418-b9d5-70ee815db4bd",
    "collectionId": "a52b5315-15b8-417f-b742-d6902108bac1",
    "collectionName": "Folders",
    "currentSlug": "EW7DT/folders",
    "slugs": [ … ],
    "expiry": "2021-02-17T09:24:01.417Z",
    "assetPermittedActions": "VIEW"
  },
  "permittedActions": [
    { … }
  ]
}