Create new entity output file

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

Create a new output file linked to a specific entity. Output files are created when artists are satisfied with their working files. They track the source working file and require output type and task type for categorization. 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. The revision is automatically set.

Path parameters

  • entity_id string(uuid) Required

    Entity unique identifier

application/json

Body Required

  • name string

    Output file name

  • mode string

    Output file mode

    Default value is output.

  • output_type_id string(uuid) Required

    Output type identifier

  • task_type_id string(uuid) Required

    Task type identifier

  • person_id string(uuid)

    Person identifier

  • working_file_id string(uuid)

    Source working file identifier

  • file_status_id string(uuid)

    File status identifier

  • comment string

    Output file comment

  • extension string

    File extension

  • representation string

    File representation

  • revision integer

    File revision number

  • nb_elements integer

    Number of elements

    Default value is 1.

  • sep string

    Path separator

    Default value is /.

Responses

  • 201 application/json

    New output file created successfully

    Hide response attributes Show response attributes object
    • id string(uuid)

      Output file unique identifier

    • name string

      Output file name

    • path string

      Output file path

    • revision integer

      Output file revision

    • entity_id string(uuid)

      Entity identifier

    • created_at string(date-time)

      Creation timestamp

    • updated_at string(date-time)

      Last update timestamp
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 (201) 
{
  "id": "b35b7fb5-df86-5776-b181-68564193d36",
  "name": "main",
  "path": "/project/asset/output/main_v001.mp4",
  "revision": 1,
  "entity_id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:30:00Z"
}