Galleries

>>>

GET /api/v1/galleries/:id/teams
Display all teams and their access rights in regards to a gallery.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the gallery to serve as a base for finding related teams.

Validations:

  • Must be a String
>>>

GET /api/v1/galleries/:id/effective_access_rights
Show all users mapped to the teams that give them access rights to a gallery.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the gallery

Validations:

  • Must be a String
>>>

PUT /api/v1/galleries/:id/teams
Update access rights of a team to a gallery.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the gallery.

Validations:

  • Must be a String
team_id
required

ID of the team.

Validations:

  • Must be a String
write
optional
true | false

Indicates whether the access to the gallery should be read/write or read-only. Default: false

Validations:

  • Must be a String
>>>

DELETE /api/v1/galleries/:id/teams/:team_id
Remove access rights of a team to a gallery.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the gallery.

Validations:

  • Must be a String
team_id
required

ID of the team.

Validations:

  • Must be a String
>>>

PUT /api/v1/galleries/:id/update_teams
Bulk update access rights for a gallery.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the gallery.

Validations:

  • Must be a String
own_teams
required

Apply update to users (own teams) or normal teams.

Validations:

  • Must be one of: true, false.
revoke
optional

Revoke all access rights to the gallery

Validations:

  • Must be one of: true, false.
write
optional

Grant write access to the galleries (default is read only)

Validations:

  • Must be one of: true, false.
>>>

PUT /api/v1/galleries/update_teams/:team_id
Bulk update access rights for a galleries for a specific team id.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
team_id
required

ID of the gallery.

Validations:

  • Must be a String
revoke
optional

Revoke all access rights to the gallery

Validations:

  • Must be one of: true, false.
write
optional

Grant write access to the galleries (default is read only)

Validations:

  • Must be one of: true, false.
>>>

PUT /api/v1/galleries/:id/update_metadata
Update metadata of a galleries.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the gallery metadata of which will be updated.

Validations:

  • Must be a String
custom_metadata
required

A Hash of Hashes. First level keys are indices of the elements. Second level keys are ‘value’ and ‘custom_metadata_field’.

Validations:

  • Must be a Hash
>>>

GET /api/v1/galleries/:id/custom_metadata
Display metadata of a galleries.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the gallery metadata of which will be displayed.

Validations:

  • Must be a String
>>>

GET /api/v1/galleries
Get a list of gallery names.

Metadata

- Authentication: The user must be authenticated to perform this action.
>>>

GET /api/v1/galleries/:id
Display a gallery.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the gallery to be displayed.

Validations:

  • Must be a String
>>>

GET /api/v1/galleries/:id/assets
Display all assets related to the gallery.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the gallery’s assets which will be displayed.

Validations:

  • Must be a String
>>>

POST /api/v1/galleries
Create a new gallery.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
gallery
optional , nil allowed

Validations:

  • Must be a Hash
gallery[name]
required

Name of the gallery

Validations:

  • Must be a String
gallery[description]
required

Headline/description of the gallery.

Validations:

  • Must be a String
>>>

PUT /api/v1/galleries/:id
Update a gallery.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the gallery to be updated.

Validations:

  • Must be a String
gallery
optional , nil allowed

Validations:

  • Must be a Hash
gallery[name]
optional

Name of the gallery

Validations:

  • Must be a String
gallery[description]
optional

Headline/description of the gallery.

Validations:

  • Must be a String
>>>

DELETE /api/v1/galleries/:id
Delete a gallery.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the gallery to be destroyed.

Validations:

  • Must be a String
>>>

POST /api/v1/galleries/:id/addassets
Add assets to a gallery.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the gallery to which an asset should be added to.

Validations:

  • Must be a String
asset_ids
optional

List of IDs of assets

Validations:

  • Must be an array of any type
>>>

POST /api/v1/galleries/:id/inject_uploads
Inject uploaded files into a gallery.

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the gallery that the uploaded asset will be injected to.

Validations:

  • Must be a String
uids
required

TUS upload ids

Validations:

  • Must be an array of any type
prefix
required

Folder structure to store the files in

Validations:

  • Must be a String
>>>

PUT /api/v1/galleries/:id/share_via_email
Share the gallery with a user via email

Metadata

- Authentication: The user must be authenticated to perform this action.

Params

Param name Description
id
required

ID of the Gallery to be shared.

Validations:

  • Must be a String
email
required

E-Mail to share the Gallery with

Validations:

  • Must be a String
manage
optional

Invite user as a Gallery manager

Validations:

  • Must be one of: true, false.
>>>

PUT /api/v1/galleries/:id/create_folder
Create a new folder in the Gallery

Params

Param name Description
id
required

ID of the Gallery.

Validations:

  • Must be a String
storage
optional

The storage of the parent folder

Validations:

  • Must be a String
dirname
required

The dirname of the parent folder

Validations:

  • Must be a String
name
required

Name of the new folder to be created

Validations:

  • Must be a String
>>>

PUT /api/v1/galleries/:id/move_contents
Move contents of the Gallery between folders

Params

Param name Description
id
required

ID of the Gallery.

Validations:

  • Must be a String
target_folder
required

Target folder for the assets and folders

Validations:

  • Must be a Hash
target_folder[storage]
optional

Storage/media name of the folder

Validations:

  • Must be a String
target_folder[dirname]
required

Container relative path to the folder

Validations:

  • Must be a String
folders
optional

Array of Hashes for folders to be moved

Validations:

  • Must be an Array of nested elements
folders[container_id]
required

Container’ ID of the folder

Validations:

  • Must be a String
folders[storage]
optional

Storage/media name of the folder

Validations:

  • Must be a String
folders[dirname]
required

Container relative path to the folder

Validations:

  • Must be a String
asset_ids
optional

Array of asset ids to be moved

Validations:

  • Must be an array of any type
mode
optional

‘overwrite’ to replace existing folders or assets

Validations:

  • Must be a String
>>>

PUT /api/v1/galleries/:id/rename_folder
Rename a folder of a Gallery

Params

Param name Description
id
required

ID of the Gallery.

Validations:

  • Must be a String
folder
required

Folder to be renamed

Validations:

  • Must be a Hash
folder[storage]
optional

Storage/media name of the folder

Validations:

  • Must be a String
folder[dirname]
required

Container relative path to the folder

Validations:

  • Must be a String
name
required

New name of the folder

Validations:

  • Must be a String
>>>

PUT /api/v1/galleries/:id/rename_asset
Rename an asset of a Gallery

Params

Param name Description
id
required

ID of the Gallery.

Validations:

  • Must be a String
asset_id
optional

ID of the asset to be renamed

Validations:

  • Must be a String
name
required

New name of the asset

Validations:

  • Must be a String