Create new instance output file

POST /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/new
Jwt authorization

Create a new output file linked to an asset instance for a specific shot. Output files track the source working file and require output type and task type for categorization.

Path parameters

  • asset_instance_id string(uuid) Required

    Asset instance unique identifier

  • temporal_entity_id string(uuid) Required

    Temporal entity unique identifier

application/json

Body Required

  • name string

    Output file name

    Default value is main.

  • 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

  • is_sequence boolean

    Whether file is a sequence

    Default value is false.

  • 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

    • asset_instance_id string(uuid)

      Asset instance identifier

    • temporal_entity_id string(uuid)

      Temporal entity identifier

    • created_at string(date-time)

      Creation timestamp

    • updated_at string(date-time)

      Last update timestamp
POST /data/asset-instances/{asset_instance_id}/entities/{temporal_entity_id}/output-files/new 
curl \
 --request POST 'http://api.example.com/data/asset-instances/a24a6ea4-ce75-4665-a070-57453082c25/entities/b35b7fb5-df86-5776-b181-68564193d36/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":"b35b7fb5-df86-5776-b181-68564193d36","person_id":"a24a6ea4-ce75-4665-a070-57453082c25","working_file_id":"a24a6ea4-ce75-4665-a070-57453082c25","file_status_id":"a24a6ea4-ce75-4665-a070-57453082c25","is_sequence":false,"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": "b35b7fb5-df86-5776-b181-68564193d36",
  "person_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "working_file_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "file_status_id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "is_sequence": false,
  "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/instance/output/main_v001.mp4",
  "revision": 1,
  "asset_instance_id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "temporal_entity_id": "d57d9hd7-fh08-7998-d403-80786315f58",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:30:00Z"
}