GET restricted-asset

A lookup call to retrieve information about a restricted asset.


As this method is accessed via a GET request there is no HTTP body so options can be specified via the URL.

parameter type description
id int64 (required) a restricted asset id to restrict results to [min: 4000000000, max: 4999999999]

OUTPUT - JSON sample

If accessing GET /api/restricted-asset?id=4000000000 the following JSON would be returned:

    "data": [
            "id": 4000000000,
            "reference": "Restricted Asset reference",
            "description": "Sample Restricted Asset",
            "frameIDs": [

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