Method: Get entity type list
GET api/publicapi/getallentitytypes
Will return a list of all entity types. If you want to find out which fields exist on an entity type, use next method:
Method: Get entity type metadata
In order to find out which fields exist on an entity, call this method with entity name as parameter:
GET api/publicapi/getentitytypeinfo?entityType=Ticket
Response json for entity type “Ticket” – some fields have been removed for brevity:
{
"Data": {
"Namespace": "dbo",
"Id": 112,
"Name": "Ticket",
"DisplayName": "IT Request",
"Columns": [
{
"Id": 1,
"Name": "Type",
"DisplayName": "Type",
"DataType": "int",
"ReferenceType": "SysTable",
"IsReference": true,
"MaxLength": null
},
{
"Id": 3,
"Name": "Version",
"DisplayName": "Version",
"DataType": "int",
"ReferenceType": null,
"IsReference": false,
"MaxLength": null
},
{
"Id": 865,
"Name": "CreatedDate",
"DisplayName": "Created Date",
"DataType": "datetime",
"ReferenceType": null,
"IsReference": false,
"MaxLength": null
},
{
"Id": 1249,
"Name": "Priority",
"DisplayName": "Priority",
"DataType": "int",
"ReferenceType": "SysPriority",
"IsReference": true,
"MaxLength": null
},
{
"Id": 1250,
"Name": "Category",
"DisplayName": "Category",
"DataType": "int",
"ReferenceType": "SysDefCategory",
"IsReference": true,
"MaxLength": null
},
{
"Id": 858,
"Name": "BaseEndUser",
"DisplayName": "Requester",
"DataType": "int",
"ReferenceType": "Person",
"IsReference": true,
"MaxLength": null
},
{
"Id": 859,
"Name": "BaseAgent",
"DisplayName": "Assignee",
"DataType": "int",
"ReferenceType": "Person",
"IsReference": true,
"MaxLength": null
},
{
"Id": 860,
"Name": "BaseHeader",
"DisplayName": "Subject",
"DataType": "string",
"ReferenceType": null,
"IsReference": false,
"MaxLength": 500
},
{
"Id": 861,
"Name": "BaseDescription",
"DisplayName": "Description",
"DataType": "string",
"ReferenceType": null,
"IsReference": false,
"MaxLength": null
}
]
},
"Errors": null,
"IsError": false
}