Edits

>>>

GET /api/v1/edits
Display a list of all registered edits with an SMB password.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.
>>>

POST /api/v1/edits
Create a new edit

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
name
required

Name of the edit.

Validations:

  • Must be a String
>>>

PUT /api/v1/edits/:id
Update an edit. Updating [:edit][:name] and [:edit][:password] is not allowed.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the edit to be updated.

Validations:

  • Must be a String
edit
optional , nil allowed

Validations:

  • Must be a Hash
edit[name]
optional , nil allowed

Name of the edit. Should NOT BE PASSED. Not allowed to be updated.

Validations:

  • Must be a String
edit[password]
optional , nil allowed

Edit’s password. Should NOT BE PASSED. Not allowed to be updated.

Validations:

  • Must be a String
edit[comment]
optional , nil allowed

Comment about the edit.

Validations:

  • Must be a String
>>>

DELETE /api/v1/edits/:id
Delete an edit.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the edit to be deleted.

Validations:

  • Must be a String
>>>

PUT /api/v1/edits/:id/unlock
Unlocks an edit by closing all their projects, clearing it and ensuring the edits job status is reset.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the edit to be deleted.

Validations:

  • Must be a String