Asset attributes

>>>

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

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

Validations:

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

Indicates whether the user is allowed to manage the gallery. Default: false

Validations:

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

Indicates whether the user is allowed to approve asset of the gallery. Default: false

Validations:

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

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/:gallery_id/asset_attributes/bulk_update
Bulk update Gallery Asset attributes.

Metadata

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

Params

Param name Description
asset_ids
optional

Asset ids to be updated.

Validations:

  • Must be an array of any type
released
optional

Marks the asset as released/unreleased.

Validations:

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

Whether the attributes should be applied recursively for the given folder.

Validations:

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

Folders with their attributes (dirname, storage, container_id) used to target to target contained assets for update

Validations:

  • Must be an array of any type
valid_until
optional

Date until which the Asset is visible.

Validations:

  • Must be a String
can_be_shared
optional

Determines if the Asset can be re-shared via email.

Validations:

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

Determines if the Asset can be downloaded as Proxy.

Validations:

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

Determines if the Asset can be downloaded as Original.

Validations:

  • Must be one of: true, false.