Create new working file

POST /data/tasks/{task_id}/working-files/new
Jwt authorization

Create a new working file for a task. Working files are versioned files used by artists to produce output files. Each file requires a comment and generates a path based on file tree template.

Path parameters

  • task_id string(uuid) Required

    Task unique identifier

application/json

Body Required

  • name string Required

    Working file name

  • mode string

    Working file mode

    Default value is working.

  • description string

    Working file description

  • comment string

    Working file comment

  • person_id string(uuid)

    Person identifier

  • software_id string(uuid)

    Software identifier

  • revision integer

    Working file revision

  • sep string

    Path separator

    Default value is /.

Responses

  • 201 application/json

    New working file created successfully

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

      Working file unique identifier

    • name string

      Working file name

    • path string

      Working file path

    • revision integer

      Working file revision

    • task_id string(uuid)

      Task identifier

    • created_at string(date-time)

      Creation timestamp

    • updated_at string(date-time)

      Last update timestamp
POST /data/tasks/{task_id}/working-files/new 
curl \
 --request POST 'http://api.example.com/data/tasks/a24a6ea4-ce75-4665-a070-57453082c25/working-files/new' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"main","mode":"working","description":"Main character model","comment":"Updated lighting and materials","person_id":"a24a6ea4-ce75-4665-a070-57453082c25","software_id":"a24a6ea4-ce75-4665-a070-57453082c25","revision":1,"sep":"/"}'
Request examples 
{
  "name": "main",
  "mode": "working",
  "description": "Main character model",
  "comment": "Updated lighting and materials",
  "person_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "software_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "revision": 1,
  "sep": "/"
}
Response examples (201) 
{
  "id": "b35b7fb5-df86-5776-b181-68564193d36",
  "name": "main",
  "path": "/project/asset/working/main_v001.blend",
  "revision": 1,
  "task_id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:30:00Z"
}