GET api/attributemetadata/{id}
Get a AttributeMetaData by id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The primary key of the AttributeMetaData in the database. |
integer |
Required |
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
{
"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
}