Review request

>>>

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.
>>>

PATCH /api/v1/assets/:asset_id/review_request
Updates the approval status of the given asset for the current user.

Metadata

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

Params

Param name Description
asset_id
optional

ID of the asset.

Validations:

  • Must be a Integer
status
optional

Approval status, either pending, approved or needs_revision.

Validations:

  • Must be a Integer
>>>

DELETE /api/v1/assets/:asset_id/review_request
Cancels the approval request for the given asset.

Metadata

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

Params

Param name Description
asset_id
optional

ID of the asset.

Validations:

  • Must be a Integer
>>>

POST /api/v1/galleries/:gallery_id/review_request
Requests approval for the assets and/or folders from users which are approvers.

Metadata

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

Params

Param name Description
asset_ids
optional

Asset ids requested for review

Validations:

  • Must be an array of any type
folders
optional

Folders with their attributes including the dirname attribute

Validations:

  • Must be an array of any type
recursive
optional

Whether the review should be requested recursively for the given folder.

Validations:

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

Whether to dry-run the operation and return the number of assets that would be requested for review.

Validations:

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

PUT /api/v1/galleries/:gallery_id/review_request
Forcefully approves the assets and/or folders, deleting all previous approval requests.

Metadata

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

Params

Param name Description
asset_ids
optional

Asset ids requested for review

Validations:

  • Must be an array of any type
folders
optional

Folders with their attributes including the dirname attribute

Validations:

  • Must be an array of any type
recursive
optional

Whether the review should be canceled recursively for the given folder.

Validations:

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

Whether to dry-run the operation and return the number of assets that would have their reviews enforced.

Validations:

  • Must be one of: true, false.