Create new working file.

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

A working file is a file used to produce output files. It is the file the CG artist is working on. It is versioned, tied to a task and a software and requires a comment each time it is created. A path is generated for each file created. The path format is defined in the file tree template file.

Path parameters

  • task_id string(uuid) Required
application/json

Body Required

  • name string Required
  • mode string

    Default value is working.

  • description string
  • comment string
  • person_id string(uuid)
  • software_id string(uuid)
  • revision integer
  • sep string

    Default value is /.

Responses

  • 201 application/json

    New working file created

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

    Given working file already exists

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": "string",
  "name": "string",
  "path": "string",
  "revision": 42,
  "task_id": "string"
}