For the complete documentation index, see llms.txt. This page is also available as Markdown.

Entities

Entity Definitions

get EntityInfo

get

Get all entities basic information.

Authorizations
AuthorizationstringRequired
Query parameters
orderByFieldstringOptional
filterRegexpstringOptional
masterEntitiesOnlybooleanOptional
excludeViewEntitiesbooleanOptional
Responses
200

Success

application/json
entityInfoListobject[]Optional
get/entities
GET /rest/s1/admin/entities HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
  "entityInfoList": [
    {}
  ]
}

get EntityDefinition

get

Get Entity definition.

Authorizations
AuthorizationstringRequired
Path parameters
entityNamestringRequired
Query parameters
excludeAutoReversebooleanOptional
Responses
200

Success

application/json
entityDefinitionobjectOptional
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?