BazeField Services

EventMetadataGetRequest

Configuration API

The following routes are available for this service:
GET	/api/configuration/domain/events
GET	/api/configuration/domain/{domainId}/events

**EventMetadataGetRequest** Parameters:
Name	Parameter	Data Type	Required	Description
DomainId	path	int	No

**EventMetadataGetResponse** Parameters:
Name	Parameter	Data Type	Required
Events	form	List<EventMetadata>	No
DomainID	form	int	No
DomainName	form	string	No

**EventMetadata** Parameters:
Name	Parameter	Data Type	Required
UniqueKey	form	string	No
Code	form	int	No
Parameter	form	int?	No
EventType	form	string	No
Name	form	string	No
Description	form	string	No
VendorAlarmId	form	int?	No
BrakeProgram	form	int	No
Type	form	int	No
IsOkAlarm	form	bool	No
ClearByOkAlarm	form	bool	No
IsAvailableOnAck	form	bool?	No
Remarks	form	string	No
Categories	form	Dictionary<string, AllocationCategory>	No

**AllocationCategory** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Color	form	string	No
Uncategorized	form	bool	No
Available	form	bool	No
TypeId	form	int	No
Group	form	string	No
SortIndex	form	byte	No
Priority	form	int	No
Enabled	form	bool	No
Performance	form	byte	No
Excluded	form	int	No
ParentCategoryId	form	int?	No
ParentCategoryName	form	string	No
Attributes	form	Dictionary<string, string>	No
AllocationType	form	AllocationType	No

**AllocationType** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Acronym	form	string	No
Version	form	string	No
Description	form	string	No
FactoryDefaultUrl	form	string	No
SortOrder	form	int	No
LinkedTypeId	form	int?	No
SubType	form	bool?	No
GroupName	form	string	No
DefaultVisible	form	bool	No
DomainId	form	int?	No
Disabled	form	bool	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/configuration/domain/events HTTP/1.1 
Host: mdn.bazefield.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"events":[{}],"domainID":0,"domainName":"String"}