PUT restricted-asset

When accessed via a PUT request this API method will update an existing restricted asset. The array of frame_id's must be the complete listing that makes up the restricted asset (i.e include any additions or deletions). 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 restricted 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": 4000000000,
    "reference": "Restricted Asset reference",
    "description": "Sample Restricted Asset",
    "frames": [
        9999999997,
        9999999998,
        9999999999
    ]
}

The table below details the fields used in this example.

parameter type description
id int64 (required) Identifier of the restricted asset to update [min: 4000000000, max: 4999999999]
reference string Restricted asset reference
description string (required) Description of the restricted asset
frames array[int64] Array of FrameIDs to associate with the restricted asset. The array of frame_id's must be
the complete listing that makes up the restricted asset (i.e include any additions or deletions).

OUTPUT - JSON sample


{
    "data": [
        {
            "id": 4000000000,
            "reference": "Restricted Asset reference",
            "description": "Sample Restricted Asset",
            "frameIDs": [
                9999999997,
                9999999998,
                9999999999
            ]
        }
    ]
}

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

id - int64 - the unique identifier for the restricted asset [min: 4000000000, max: 4999999999]

reference - string - Restricted asset reference

description - string - Description of the restricted asset

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