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

get

Path parameters

guidstringRequired

guid of specified asset definition

Query parameters

partner.idstringRequired

Your partner ID - you should have gotten them from AB Support or when you signed up for a sandbox account.

auth.signaturestringRequired

Signature for the request authorization.

auth.expiresstringRequired

Expiration timestamp for the authorization.

fields[asset_definitions]stringOptional

comma separated list of field names

Responses

200

OK

application/json

400

Bad Request

application/json

401

Authentication Error

application/json

404

Entity not found

application/json

get

/asset_definitions/{guid}

HTTPcURLJavaScriptPython

GET /rest/v4.1/asset_definitions/{guid}?partner.id=text&auth.signature=text&auth.expires=text HTTP/1.1
Host: api.abconnect.instructure.com
Accept: */*

{
  "links": {
    "self": "text"
  },
  "meta": {
    "took": 1
  },
  "data": {
    "id": "text",
    "type": "asset_definitions",
    "attributes": {
      "type": "text",
      "asset_type": "text",
      "properties": [
        {
          "filterable": "text",
          "seq": 1,
          "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

get

Query parameters

partner.idstringRequired

Your partner ID - you should have gotten them from AB Support or when you signed up for a sandbox account.

auth.signaturestringRequired

Signature for the request authorization.

auth.expiresstringRequired

Expiration timestamp for the authorization.

fields[asset_definitions]stringOptional

comma separated list of field names

filter[asset_definitions]stringOptional

an ODATA-like query string used to filter

sort[asset_definitions]stringOptional

a comma separated list of property names specifying the sort order of the returned results

limitnumberOptional

The page size for the response dataset. limit must be 100 or less.

offsetnumberOptional

How far into the dataset you are paging

Responses

200

OK

application/json

400

Bad Request

application/json

401

Authentication Error

application/json

get

/asset_definitions

HTTPcURLJavaScriptPython

GET /rest/v4.1/asset_definitions?partner.id=text&auth.signature=text&auth.expires=text HTTP/1.1
Host: api.abconnect.instructure.com
Accept: */*

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