Generate an output file path from file tree template

POST /data/entities/{entity_id}/output-file-path
Jwt authorization

Generate file path based on several parameters entity, output type, task type, revision, mode, name and separator. Revision can be computed automatically as next revision if not given.

Path parameters

  • entity_id string(uuid) Required
application/json

Body Required

  • name string

    Default value is main.

  • mode string

    Default value is output.

  • output_type_id string(uuid) Required
  • task_type_id string(uuid) Required
  • extension string
  • representation string
  • revision integer
  • separator string

    Default value is /.

Responses

  • 200 application/json

    Output file path generated

    Hide response attribute Show response attribute object
    • path string
  • 400

    Malformed file tree

POST /data/entities/{entity_id}/output-file-path 
curl \
 --request POST 'http://api.example.com/data/entities/a24a6ea4-ce75-4665-a070-57453082c25/output-file-path' \
 --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","extension":".mp4","representation":"mp4","revision":1,"separator":"/"}'
Request examples 
{
  "name": "main",
  "mode": "output",
  "output_type_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "task_type_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "extension": ".mp4",
  "representation": "mp4",
  "revision": 1,
  "separator": "/"
}
Response examples (200) 
{
  "path": "/project/asset/output/main_v001.mp4"
}