Preditor sequences

>>>

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

Metadata

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

Params

Param name Description
id
required

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

Validations:

  • Must be a String
>>>

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

Metadata

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

Params

Param name Description
id
required

ID of the preditor_sequence

Validations:

  • Must be a String
>>>

PUT /api/v1/preditor_sequences/:id/teams
Update access rights of a team to a preditor_sequence.

Metadata

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

Params

Param name Description
id
required

ID of the preditor_sequence.

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 preditor_sequence should be read/write or read-only. Default: false

Validations:

  • Must be a String
>>>

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

Metadata

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

Params

Param name Description
id
required

ID of the preditor_sequence.

Validations:

  • Must be a String
team_id
required

ID of the team.

Validations:

  • Must be a String
>>>

PUT /api/v1/preditor_sequences/:id/update_teams
Bulk update access rights for a preditor_sequence.

Metadata

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

Params

Param name Description
id
required

ID of the preditor_sequence.

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 preditor_sequence

Validations:

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

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

Validations:

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

PUT /api/v1/preditor_sequences/update_teams/:team_id
Bulk update access rights for a preditor_sequences 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 preditor_sequence.

Validations:

  • Must be a String
revoke
optional

Revoke all access rights to the preditor_sequence

Validations:

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

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

Validations:

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

GET /api/v1/preditor_sequences
Display all sequences.

Metadata

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

POST /api/v1/preditor_sequences
Create a new sequence.

Metadata

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

Params

Param name Description
sequence
optional , nil allowed

Validations:

  • Must be a Hash
sequence[name]
required

Name of the sequence

Validations:

  • Must be a String
sequence[json]
required

JSON representation of the sequence.

Validations:

  • Must be a String
>>>

PUT /api/v1/preditor_sequences/:id
Update a sequence.

Metadata

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

Params

Param name Description
id
required

ID of the sequence to be updated.

Validations:

  • Must be a String
sequence
optional , nil allowed

Validations:

  • Must be a Hash
sequence[name]
optional

Name of the sequence

Validations:

  • Must be a String
sequence[json]
optional

JSON representation of the sequence.

Validations:

  • Must be a String
>>>

DELETE /api/v1/preditor_sequences/:id
Delete a sequence.

Metadata

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

Params

Param name Description
id
required

ID of the sequence to be destroyed.

Validations:

  • Must be a String
>>>

GET /api/v1/preditor_sequences/:id/download
Download sequence as XML or AAF.

Metadata

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

Params

Param name Description
id
required

ID of the sequence to download.

Validations:

  • Must be a String
format
required

Download format for the sequence

Validations:

  • Must be a String
>>>

PUT /api/v1/preditor_sequences/:id/open
Open a sequence in the preditor.

Metadata

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

Params

Param name Description
id
required

ID of the sequence to open.

Validations:

  • Must be a String
>>>

DELETE /api/v1/preditor_sequences/:id/close
Close a sequence in the preditor.

Metadata

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

Params

Param name Description
id
required

ID of the sequence to close.

Validations:

  • Must be a String
>>>

POST /api/v1/preditor_sequences/:id/addasset
Add an asset to a sequence.

Metadata

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

Params

Param name Description
id
required

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

Validations:

  • Must be a String
asset_id
required

ID of the asset to be added.

Validations:

  • Must be a String