Create new output file linked to a given entity.

POST /data/entities/{entity_id}/output-files/new
Jwt authorization

Output files are linked to entities. Each time a CG artist is satisfied by what he did on a working file, he can create an output file that will be linked to a target entity (an asset, a shot, a sequence, ...). It keeps track of the working file at the origin of the output file. An output type is required for better categorization (textures, caches, ...). A task type can be set too to give the department related to the output file. Revision is automatically set.

Path parameters

  • entity_id string(uuid) Required
application/json

Body Required

  • name string
  • mode string

    Default value is output.

  • output_type_id string(uuid) Required
  • task_type_id string(uuid) Required
  • person_id string(uuid)
  • working_file_id string(uuid)
  • file_status_id string(uuid)
  • comment string
  • extension string
  • representation string
  • revision integer
  • nb_elements integer

    Default value is 1.

  • sep string

    Default value is /.

Responses

  • 200 application/json

    New output file created

    Hide response attributes Show response attributes object
    • id string(uuid)
    • name string
    • path string
    • revision integer
    • entity_id string(uuid)
  • 400

    Given output file already exists, Given person not found, or Given output type not found

POST /data/entities/{entity_id}/output-files/new 
curl \
 --request POST 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-files/new' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"main","mode":"output","output_type_id":"a24a6ea4-ce75-4665-a070-57453082c25","task_type_id":"a24a6ea4-ce75-4665-a070-57453082c25","person_id":"a24a6ea4-ce75-4665-a070-57453082c25","working_file_id":"a24a6ea4-ce75-4665-a070-57453082c25","file_status_id":"a24a6ea4-ce75-4665-a070-57453082c25","comment":"Final render","extension":".mp4","representation":"mp4","revision":1,"nb_elements":1,"sep":"/"}'
Request examples 
{
  "name": "main",
  "mode": "output",
  "output_type_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "task_type_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "person_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "working_file_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "file_status_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "comment": "Final render",
  "extension": ".mp4",
  "representation": "mp4",
  "revision": 1,
  "nb_elements": 1,
  "sep": "/"
}
Response examples (200) 
{
  "id": "string",
  "name": "string",
  "path": "string",
  "revision": 42,
  "entity_id": "string"
}