GET api/attributemetadata?name={name}&nameContains={nameContains}&attributeCategoryId={attributeCategoryId}&domainCode={domainCode}&inactive={inactive}&offset={offset}&limit={limit}&returnTotal={returnTotal}

Get all AttributeMetaData optionally filtered by any of the arguments specified in the query string.

Request Information

URI Parameters

Name	Description	Type	Additional information
name	Optional case-insensitive filter on AttributeMetaData with a name that matches the provided value.	string	None.
nameContains	Optional case-insensitive filter on AttributeMetaData with a name containing the provided value.	string	None.
attributeCategoryId	Optional filter on AttributeMetaData with a attributeCategoryId that matches the provided value.	integer	None.
domainCode	Optional filter on AttributeMetaData with a domainCode that matches the provided value.	integer	None.
inactive	Filter indicating whether to retrieve active or inactive records.	boolean	Default value is False
offset	The position in the collection of Tags from which to start returning data from.	integer	Default value is 0
limit	The maximum amount of Tags that can be returned in any one call. Maximum allowed is 250.	integer	Default value is 50
returnTotal	Whether to include the total amount of Tags in the database that match the filter specified.	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

AttributeMetaDataDto

Name	Description	Type	Additional information
Id	The primary key of the AttributeMetaData record.	integer	None.
Name	Name of the AttributeMetaData.	string	None.
AttributeCategoryId	A reference to the primary key of the AttributeCategory record that is associated with this record.	integer	None.
AttributeCategoryName	The category name (AttributeCategory) that the attribute belongs to.	string	None.
LabelText	The label configured for the attribute. The label is used for displaying in user interfaces.	string	None.
IsNullable	Determines if Null values are acceptable for fact records created or updated for this attribute.	boolean	None.
RegexMask	Validates the value supplied for the fact record against the regular expression mask configured for the attribute.	string	None.
DataType	Describes the Data Type that has been configured for the attribute. Fact records for the attribute must provide values that conform to the type.	string	None.
MinValue	Minimum value allowed for the fact value relating to the attribute.	string	None.
MaxValue	Maximum value allowed for the fact value relating to the attribute.	string	None.
DefaultValue	The default value that is applied to the fact if the supplied value is null or empty.	string	None.
IsMutable	Determines if the value of a fact record for the attribute can be updated if it already exists or if the value is null when IsMutable=True	boolean	None.
IsDeletable	Specifies whether a fact record for the attribute can be deleted.	boolean	None.
IsHistorical	Allows multiple instances of a fact record to be inserted to support storing historical or multiple values for an attribute.	boolean	None.
IsReferenceData	The attribute is configured to only accept fact records containing AttributeReferences instead of a value.	boolean	None.
IsMultipleRefsAllowed	The attribute is configure to accept fact records containing multiple AttributeReferences if true, otherwise only one attribute reference can be supplied.	boolean	None.
Inactive		boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Name": "sample string 2",
  "AttributeCategoryId": 3,
  "AttributeCategoryName": "sample string 4",
  "LabelText": "sample string 5",
  "IsNullable": true,
  "RegexMask": "sample string 7",
  "DataType": "sample string 8",
  "MinValue": "sample string 9",
  "MaxValue": "sample string 10",
  "DefaultValue": "sample string 11",
  "IsMutable": true,
  "IsDeletable": true,
  "IsHistorical": true,
  "IsReferenceData": true,
  "IsMultipleRefsAllowed": true,
  "Inactive": true
}