PUT linked-asset

When accessed via a PUT request this API method will update an existing linked asset. The array of frame_id's must be the complete listing that makes up the linked asset (i.e include any additions or deletions-- changing this array will trigger creation of 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 PUT request the raw body must be set to JSON as described below. Note that this is sample input.


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

The table below details the fields used in this example.

parameter type description
id int64 (required) Identifier of the linked asset to update [min: 3000000000, max: 3999999999]
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. The array of frame_id's must be
the complete listing that makes up the linked asset (i.e include any additions or deletions).

OUTPUT - JSON sample


{
    "data": [
        {
            "id": 3000000000,
            "reference": "Linked Asset Reference",
            "description": "Sample Linked Asset",
            "frameIDs": [
                9999999997,
                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