POST linked-asset

When accessed via a POST request this API method will create a new linked asset. Your HTTP body should consist of JSON similar to the following samples.

Each attribute type/value will be validated to ensure that the data is valid. See the section on errors for how errors are represented.

INPUT to create linked asset

As this method is accessed via a POST request the raw body must be set to JSON as described below. Note that this is sample input.


{
    "reference": "Linked Asset Reference",
    "description": "Sample Linked Asset",
    "frames": [
        9999999998,
        9999999999
    ]
}

The table below details the fields used in this example.

parameter type description
reference string Linked asset reference
description string (required) Description of the linked asset
frames array[int64] (required) Array of FrameIDs to associate with the linked asset

OUTPUT - JSON sample


{
    "data": [
        {
            "id": 3000000000,
            "reference": "Linked Asset Reference",
            "description": "Sample Linked Asset",
            "frameIDs": [
                9999999998,
                9999999999
            ]
        }
    ]
}

A "data" element that contains an array of linked assets defined as follows:

id - int64 - the unique identifier for the linked asset [min: 3000000000, max: 3999999999]

reference - string - Linked asset reference

description - string - Description of the linked asset

frameIDs - array[int64] - Array of FrameIDs to associate with the linked asset