GET api/attributemetadata/{id}/attributereferences?name={name}&nameContains={nameContains}&inactive={inactive}&offset={offset}&limit={limit}&returnTotal={returnTotal}

Get all AttributeReferences that are related to the supplied AttributeMetaData id.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The primary key of the AttributeMetaData record in the database.

integer

Required

name

Optional case-insensitive filter of the display name of the AttributeReference item.

string

None.

nameContains

Optional case-insensitive filter of a partial display name of the AttributeReference item.

string

None.

inactive

List inactive attribute references

boolean

Default value is False

offset

The position in the collection of AttributeReferences from which to start returning data from.

integer

Default value is 0

limit

The maximum amount of AttributeRefereces that can be returned in any one call. Maximum allowed is 100.

integer

Default value is 100

returnTotal

Whether to include the total amount of AttributeReferences that exist for the AttributeMetaData record in the database that match the filter specified.

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

AttributeReferenceDto
NameDescriptionTypeAdditional information
Id

The primary key of the record in the database.

integer

None.

Name

Name of the AttrbiteReference.

string

None.

Value

Value of the AttrbiteReference. The datatype of the value provided must conform to the datatype set in the AttributeMetaData. This value is ignored for updates.

Object

None.

Inactive

boolean

None.

SortOrder

An assigned numerical value to control the order of how the AttributeReference is displayed in a sorted list in an application.

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 2",
  "Value": {},
  "Inactive": true,
  "SortOrder": 1
}