Skip to main content

Get Upload Metadata

POST 
/api

Return URL and headers used to upload data for component_id.

The returned URL should be requested using HTTP PUT with the specified headers.

The component_id does not have to be persisted. In that case, file_name and file_size must be specified. They will be fetched from the component if not set.

The checksum is used as the Content-MD5 header and should contain the base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the checksum mechanism as an end-to-end integrity check.

Request​

Header Parameters

    Ftrack-Api-Options any
            Api options formatted as key value pairs separated by semicolon. 
            Suported values are:
             - denormalize
             - strict

             denormalize - data is not normalised before sent to client which means there is no need to merge entities client side. 
             Must also have strict option enabled.
             strict - only requested data is loaded and returned to the client

             Examples:

             denormalize=1;strict=1
             denormalize=False;strict=True
             denormalize=false;strict=false
    Ftrack-Api-Key any
            API key used to authenticate. API keys are created from Settings under the page API keys.
    Ftrack-User any
            Username used to authenticate.

Body

array

required

  • Array [

    • action Actionrequired

    Possible values: [get_upload_metadata]

    component_id uuidrequired

    parts

    object

    nullable

    anyOf

    integer

    file_name

    object

    nullable

    anyOf

    string

    file_size

    object

    nullable

    anyOf

    integer

    checksum

    object

    nullable

    anyOf

    string

    metadata

    object

    property name* any

  • ]

Responses​

Successful Response

Loading...