Asset Definitions

The Asset Definition endpoint provides direct access to the properties on Assets. Asset type is an attribute on an Asset.

The Asset Definitions resource can be used to access different asset types for setting up a browse and filter experience on the Asset resource. See the documentation on the Asset endpoint for details.

All calls against the Asset Definitions resource must be implemented as HTTP GET requests, and must include proper Partner Authentication Credentials.

Retrieving Asset Definitions

In its simplest form, you are able to retrieve the details of a specific Asset Definitions resource by appending the AB GUID to the path portion of the URL.

Asset Definitions Fetching

GEThttps://api.abconnect.instructure.com/rest/v4.1/asset_definitions/{guid}

Path parameters

guid*string

guid of specified asset definition

Query parameters

Response

200400401404

OK

Body

application/json

linksSelfLink (object)

metaSimpleMetadata (object)

dataAssetDefinition (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.abconnect.instructure.com/rest/v4.1/asset_definitions/{guid}?partner.id=text&auth.signature=text&auth.expires=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401404

{
  "links": {
    "self": "text"
  },
  "meta": {
    "took": 0
  },
  "data": {
    "id": "text",
    "type": "asset_definitions",
    "attributes": {
      "type": "text",
      "asset_type": "text",
      "properties": [
        {
          "filterable": "text",
          "seq": 0,
          "label": "text",
          "field": {
            "id": "text",
            "name": "text"
          },
          "facet": {
            "id": "text",
            "name": "text"
          }
        }
      ],
      "guid": "text"
    }
  }
}

Searching for Asset Definitions

Using filterings, it is possible to retrieve sets of Asset Definitions that match specific criteria. These Asset Definitions are returned in an array of Asset Definitions objects. See the Introduction for an explanation on filtering.

Finding Sets of Assets Definitions

GEThttps://api.abconnect.instructure.com/rest/v4.1/asset_definitions

Query parameters

Response

200400401

OK

Body

application/json

linksLinks (all of)

metaPageMetadata (all of)

dataarray of AssetDefinition (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.abconnect.instructure.com/rest/v4.1/asset_definitions?partner.id=text&auth.signature=text&auth.expires=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401

{
  "links": {
    "self": "text",
    "first": "text",
    "last": "text",
    "next": "text",
    "prev": "text"
  },
  "meta": {
    "took": 0,
    "limit": 0,
    "count": 0,
    "offset": 0
  },
  "data": [
    {
      "id": "text",
      "type": "asset_definitions",
      "attributes": {
        "type": "text",
        "asset_type": "text",
        "properties": [
          {
            "filterable": "text",
            "seq": 0,
            "label": "text",
            "field": {
              "id": "text",
              "name": "text"
            },
            "facet": {
              "id": "text",
              "name": "text"
            }
          }
        ],
        "guid": "text"
      }
    }
  ]
}