Generate working file path

POST /data/tasks/{task_id}/working-file-path
Jwt authorization

Generate a working file path from file tree template based on task parameters. Revision can be computed automatically if not provided.

Path parameters

  • task_id string(uuid) Required

    Task unique identifier

application/json

Body Required

  • name string

    File name

    Default value is main.

  • mode string

    File mode

    Default value is working.

  • software_id string(uuid)

    Software identifier

  • comment string

    File comment

  • revision integer

    File revision number

  • separator string

    Path separator

    Default value is /.

Responses

  • 200 application/json

    Working file path generated successfully

    Hide response attributes Show response attributes object
    • path string

      Generated file path

    • name string

      Generated file name
  • 400

    Malformed file tree

POST /data/tasks/{task_id}/working-file-path 
curl \
 --request POST 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25/working-file-path' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"main","mode":"working","software_id":"a24a6ea4-ce75-4665-a070-57453082c25","comment":"Updated lighting","revision":1,"separator":"/"}'
Request examples 
{
  "name": "main",
  "mode": "working",
  "software_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "comment": "Updated lighting",
  "revision": 1,
  "separator": "/"
}
Response examples (200) 
{
  "path": "/project/asset/working/main_v001.blend",
  "name": "main_v001.blend"
}