Understanding Supported API Operations for Hierarchy Levels
The Configuration and Content REST API supports insert, delete, get, and update operations. The hierarchy level at which you call an endpoint determines which operations you can use for that endpoint. The following table lists supported operations by endpoint for hierarchy levels.
Important:
There is a known issue with fields marked as optional for update operations in this REST API document. If you exclude a field marked as optional from an update request, the corresponding field value is cleared and shows as blank in the EMC.Configuration REST API Operations
Endpoint | Enterprise | Zone | Location | Revenue Center |
---|---|---|---|---|
Cash Management Receptacle Template |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
CAL Packages |
Get |
No functions permitted at this level |
No functions permitted at this level |
No functions permitted at this level |
CAL Deployment Schedules |
Insert, Delete, Get, Update |
No functions permitted at this level |
Insert, Delete, Get, Update |
No functions permitted at this level |
Combo Meals |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Combo Meal Side Groups |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Combo Meal Side Group Prices |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Combo Side Groups |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Combo Side Group Item |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Combo Side Group Item Prices |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Currencies |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Currency Parameters |
Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Currency Availability |
Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Currency Conversions |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Headers, Trailers |
Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Order Type Names |
Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Discount |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Discount Award Groups |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Discount Trigger Groups |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Discount Itemizers |
Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Effectivity Groups |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Enable Effectivity Group |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Cashiers |
No functions permitted at this level |
No functions permitted at this level |
No functions permitted at this level |
Insert, Delete, Get, Update |
Employee Classes |
No functions permitted at this level |
No functions permitted at this level |
Insert, Delete, Get, Update |
No functions permitted at this level |
Employee Class Operators |
No functions permitted at this level |
No functions permitted at this level |
Insert, Delete, Get, Update |
No functions permitted at this level |
Employee EMC Visibility |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Employee Properties |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Employee Job Codes |
Get |
Get |
Get |
Get |
Employee Property Operators |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Employee Roles |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Employees |
Insert, Delete, Get, Update |
No functions permitted at this level |
No functions permitted at this level |
No functions permitted at this level |
KDS Display Controllers |
No functions permitted at this level |
No functions permitted at this level |
Insert, Delete, Get, Update |
No functions permitted at this level |
KDS Displays |
No functions permitted at this level |
No functions permitted at this level |
Insert, Delete, Get, Update |
No functions permitted at this level |
Languages |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Hierarchy |
Get |
Get |
Get |
Get |
Locations |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Delete, Get, Update |
No functions permitted at this level |
Location Parameters |
No functions permitted at this level |
No functions permitted at this level |
Insert, Delete, Get, Update |
No functions permitted at this level |
Revenue Centers |
Get |
Get |
Insert, Delete, Get, Update |
Delete, Get, Update |
Revenue Center Parameters |
No functions permitted at this level |
No functions permitted at this level |
No functions permitted at this level |
Insert, Delete, Get, Update |
Zones |
Get |
Get |
No functions permitted at this level |
No functions permitted at this level |
Screen Look Ups |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Auto Menu Levels |
Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Barcodes |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Condiment Groups |
Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Condiment Sets |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Condiment Set Items |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Default Condiments |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Family Groups |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Menu Items |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Major Groups |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Menu Item Class |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Menu Item Definitions |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Menu Item Groups |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Menu Item Group Details |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Menu Item Masters |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Menu Item Master Effectivity |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Menu Item Master Groups |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Menu Item Prices |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Menu Levels |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Menu Level Entries |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Order Channel |
Insert, Get, Update |
No functions permitted at this level |
No functions permitted at this level |
No functions permitted at this level |
Order Channel Config |
Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Order Devices |
No functions permitted at this level |
No functions permitted at this level |
No functions permitted at this level |
Get, Update |
Order Type Parameters |
Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Payment Driver Configurations |
Get, Update |
Get, Update |
Get, Update |
Get, Update |
Print Classes |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Printers |
No functions permitted at this level |
No functions permitted at this level |
Insert, Delete, Get, Update |
No functions permitted at this level |
Report Groups |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Roles |
Insert, Delete, Get, Update |
No functions permitted at this level |
No functions permitted at this level |
No functions permitted at this level |
Sales Itemizers |
Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Secure Auth User |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Service Charges |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Service Charge Groups |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Service Charge Group Details |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Service Charge Itemizers |
Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Data Extensions |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Locale |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Tag Groups |
Insert, Delete, Get, Update |
No functions permitted at this level |
No functions permitted at this level |
No functions permitted at this level |
Tag Item |
Insert, Delete, Get, Update |
No functions permitted at this level |
No functions permitted at this level |
No functions permitted at this level |
Tax Breakpoints |
Get, Update |
Get, Update |
Get, Update |
Get, Update |
Tax Classes |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Taxes |
Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Tax Parameters |
Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Tender Media |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
No functions permitted at this level |
Workstations |
No functions permitted at this level |
No functions permitted at this level |
Insert, Delete, Get, Update |
No functions permitted at this level |
Workstation Devices |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Family Group Consumer Facing Content |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Screen Look Up Consumer Facing Content |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Custom Content |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Menu Item Definition Consumer Facing Content |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Payment Drivers |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Print Logos |
Insert, Delete, Get, Update |
No functions permitted at this level |
No functions permitted at this level |
No functions permitted at this level |
SPI Client Certificate |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
SPI Client Certificate |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |
Insert, Delete, Get, Update |