Build Version:
GET attributetypes
Gets a list of attribute types.
Request Information
» Filters
| Name | Description | Usage |
|---|---|---|
| isPrivate | This will filter the request by the is private flag. | GET attributetypes?filter=isprivate~{operator}~{value} |
| localeId | This will filter the request by locale ID. | GET attributetypes?filter=localeid~{operator}~{value} |
| name | This will filter the request by name. | GET attributetypes?filter=name~{operator}~{value} |
| portalId | This will filter the request by portal ID. | GET attributetypes?filter=portalid~{operator}~{value} |
» Sorting
| Name | Description | Usage |
|---|---|---|
| attributeTypeId | This will sort the response by attribute type ID. | GET attributetypes?sort=attributetypeid |
| displayOrder | This will sort the response by display order. | GET attributetypes?sort=displayorder |
| name | This will sort the response by name. | GET attributetypes?sort=name |
Response Information
» Response Body Formats
If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.
Sample:
{
"AttributeTypes": [
{
"AttributeTypeId": 1,
"Description": null,
"DisplayOrder": 5,
"IsPrivate": false,
"LocaleId": 43,
"Name": "Color",
"PortalId": null
}
],
"PageIndex": null,
"PageSize": null,
"TotalPages": null,
"TotalResults": null,
"ErrorCode": null,
"ErrorMessage": null,
"StackTrace": null,
"AllowHtmlResponse": false,
"HasError": false,
"StringResponse": null
}