Entities
Entity Definitions
Get all entities basic information.
Authorizations
AuthorizationstringRequired
Query parameters
orderByFieldstringOptional
filterRegexpstringOptional
masterEntitiesOnlybooleanOptional
excludeViewEntitiesbooleanOptional
Responses
200
Success
application/json
entityInfoListobject[]Optional
401
Authentication required
403
Access Forbidden (no authz)
429
Too Many Requests (tarpit)
500
General Error
get/entities
GET /rest/s1/admin/entities HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"entityInfoList": [
{}
]
}Get Entity definition.
Authorizations
AuthorizationstringRequired
Path parameters
entityNamestringRequired
Query parameters
excludeAutoReversebooleanOptional
Responses
200
Success
application/json
entityDefinitionobjectOptional
401
Authentication required
403
Access Forbidden (no authz)
429
Too Many Requests (tarpit)
500
General Error
get/entities/{entityName}/definition
GET /rest/s1/admin/entities/{entityName}/definition HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"entityDefinition": {}
}Last updated
Was this helpful?