Retrieve AttributeTypes
GET {{baseUrl}}/api/v3/attributeTypes?tql=&fields=<string>&fields=<string>&count=<string>&sorting=<string>
Returns a list of all AttributeTypes
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
tql | null | TQL query string for filtering response list | |
fields | string | AttributeType subentity fields to include in response (See OPTIONS endpoint for valid values) | |
fields | string | AttributeType subentity fields to include in response (See OPTIONS endpoint for valid values) | |
count | string | Boolean that denotes whether counts should be returned in the resultset | |
sorting | string | Sorting order for resultset |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"allowMarkdown":"\u003cboolean\u003e","attributeTypeMappings":[{"id":"\u003clong\u003e","maxAllowed":"\u003cinteger\u003e","ownerName":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"id":"\u003clong\u003e","maxAllowed":"\u003cinteger\u003e","ownerName":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"autoGenerated":"\u003cboolean\u003e","description":"\u003cstring\u003e","errorMessage":"\u003cstring\u003e","id":"\u003clong\u003e","maxSize":"\u003cinteger\u003e","name":"\u003cstring\u003e","settings":[{"associable":"\u003cboolean\u003e","displayed":"\u003cboolean\u003e","id":"\u003clong\u003e","message":"\u003cstring\u003e","ownerName":"\u003cstring\u003e","pinnedByDefault":"\u003cboolean\u003e","sortOrder":"\u003cinteger\u003e","typeName":"\u003cstring\u003e"},{"associable":"\u003cboolean\u003e","displayed":"\u003cboolean\u003e","id":"\u003clong\u003e","message":"\u003cstring\u003e","ownerName":"\u003cstring\u003e","pinnedByDefault":"\u003cboolean\u003e","sortOrder":"\u003cinteger\u003e","typeName":"\u003cstring\u003e"}],"validationRule":{"description":"\u003cstring\u003e","id":"\u003clong\u003e","name":"\u003cstring\u003e","text":"\u003cstring\u003e","type":"\u003cstring\u003e","version":"\u003cstring\u003e"}},{"allowMarkdown":"\u003cboolean\u003e","attributeTypeMappings":[{"id":"\u003clong\u003e","maxAllowed":"\u003cinteger\u003e","ownerName":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"id":"\u003clong\u003e","maxAllowed":"\u003cinteger\u003e","ownerName":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"autoGenerated":"\u003cboolean\u003e","description":"\u003cstring\u003e","errorMessage":"\u003cstring\u003e","id":"\u003clong\u003e","maxSize":"\u003cinteger\u003e","name":"\u003cstring\u003e","settings":[{"associable":"\u003cboolean\u003e","displayed":"\u003cboolean\u003e","id":"\u003clong\u003e","message":"\u003cstring\u003e","ownerName":"\u003cstring\u003e","pinnedByDefault":"\u003cboolean\u003e","sortOrder":"\u003cinteger\u003e","typeName":"\u003cstring\u003e"},{"associable":"\u003cboolean\u003e","displayed":"\u003cboolean\u003e","id":"\u003clong\u003e","message":"\u003cstring\u003e","ownerName":"\u003cstring\u003e","pinnedByDefault":"\u003cboolean\u003e","sortOrder":"\u003cinteger\u003e","typeName":"\u003cstring\u003e"}],"validationRule":{"description":"\u003cstring\u003e","id":"\u003clong\u003e","name":"\u003cstring\u003e","text":"\u003cstring\u003e","type":"\u003cstring\u003e","version":"\u003cstring\u003e"}}]