Get Enterprise Parameters
post
/config/sim/v2/setup/getEnterpriseParameters
Gets Enterprise Parameters.
Request
Supported Media Types
- multipart/form-data
- application/json
The input body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, name, defaultDateTimeFormat -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed -
langIds:
string
If specified, limits translated strings returned.Example:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.Example:
0
Response
Supported Media Types
- application/json
200 Response
A collection of Enterprise Parameters.
Root Schema : EnterpriseParametersGetResponse
Type:
Show Source
object-
count:
integer
Number of records returned on this pageExample:
1 -
hasMore:
boolean
Indicates whether there are additional pages of recordsExample:
false -
items:
array items
Enterprise Parameters records
-
limit:
integer
The maximum number of records returned on a pageExample:
100 -
offset:
integer
The page number of this data. Starts at 0.Example:
0 -
totalResults:
integer
Total number of records in the data setExample:
1
Nested Schema : items
Type:
arrayEnterprise Parameters records
Show Source
-
Array of:
object EnterpriseParameters
Model for Enterprise Parameters object
Nested Schema : EnterpriseParameters
Type:
objectModel for Enterprise Parameters object
Show Source
-
contentAndConfigurationAPI:
string
Read-only Content and Configuration API URL.Example:
https://configapi.example -
defaultDateTimeFormat:
string
Default date and time format used.
Value Type Value Default Value null Supported Value yyyy-MM-dd HH:mm:ss.fff Supported Value yyyy-MM-dd hh:mm:ss.fff tt Supported Value yyyy-MM-dd Supported Value yyyy/MM/dd HH:mm:ss.fff Supported Value yyyy/MM/dd hh:mm:ss.fff tt Supported Value yyyy/MM/dd Supported Value dd-MM-yy HH:mm:ss.fff Supported Value dd-MM-yy hh:mm:ss.fff tt Supported Value dd-MM-yy Supported Value dd/MM/yy HH:mm:ss.fff Supported Value dd/MM/yy hh:mm:ss.fff tt Supported Value dd/MM/yy Supported Value MM-dd-yyyy HH:mm:ss.fff Supported Value MM-dd-yyyy hh:mm:ss.fff tt Supported Value MM-dd-yyyy Supported Value MM/dd/yyyy HH:mm:ss.fff Supported Value MM/dd/yyyy hh:mm:ss.fff tt Supported Value MM/dd/yyyy Example:yyyy-MM-dd -
disabledEMCModules:
array disabledEMCModules
Array of disabled modules in EMC.
Module Name Value Allergen Names 2653 Application Text 2138 Autofire Check Offline Header 2646 Barcode Format Sets 1131 Barcodes 2104 Canadian GST 1146 Canadian PST 1147 Canadian Tax Trailers 2618 Cash Management Account 6005 Cash Management Cash Count Threshold 6011 Cash Management Cash Pull Threshold 6007 Cash Management Class 6003 Cash Management Class Behavior 6012 Cash Management Count Sheet 6002 Cash Management PAR Level 6008 Cash Management Parameters 6010 Cash Management Reason 6009 Cash Management Receptacle 6004 Cash Management Template 6001 Cash Management Vendor 6006 Cashiers 2116 Check Alert 2643 Check Headers - Default 2612 Check Headers - Order Type/Channel 7110 Check Summary Descriptors 2602 Check Trailers - Default 2613 Check Trailers - Order Type/Channel 7111 Components 2158 Condiment Group Names 2627 Condiment Sets 2128 Credit Card Headers 2616 Credit Card Trailers 2617 Currency 1113 Currency Availability 1144 Currency Conversions 1142 Currency Parameters 1145 Custom Browser 2657 Dietary Labels 7102 Discount Groups 2609 Discount Itemizers 2624 Discount SLU Names 2629 Family Groups 1125 Gift Card Provider 1175 Guest Information Prompts 2603 KDS Bump Bars 1129 KDS Controllers 1127 KDS Displays 1128 KDS Highlight Schemes 1137 KDS Status Bars 7112 KDS Tool Bars 1130 Kitchen Theme 1156 Kitchen Theme Period 2151 Languages 1115 Loan Reasons 2606 Locale 127 Loyalty Card Provider 1176 Major Groups 1124 Menu Item Groups 1133 Menu Item Master Group SLU Names 2652 Menu Item Master Groups 1138 Menu Item SLU Names 2631 Menu Level Sets 2127 NLU Names 2623 Nutrition Names 2654 Order Channel 7106 Order Channel Parameters 7107 Order Type Parameters 1141 Order Types 2622 Page Assignment 2135 Pages 2124 Payment Reasons 2605 PC Autosequence Schedules 114 PC Autosequences 113 Pickup Reasons 2607 POS Keyboard 2655 Print Logos 116 Production Item 2150 Property Merchant Groups 1134 Receipt Headers - Default 2614 Receipt Headers - Order Type/Channel 7113 Report Headers 7103 Report Trailers 7104 Reservation Periods 2153 RVC Type Names 2610 Sales Itemizers 2625 Seating Section Template 2147 Section 2148 Service Alert 2642 Service Charge Itemizers 2626 Service Charge SLU Names 2633 Service Total Reasons 2608 Serving Periods 2112 System Employees 506 Tables 2111 Tags 7100 Tax Classes 1118 Tax Parameters 1139 Tax Rates 1117 Tender/Media SLU Names 2635 Theme Assignment 2156 Time Periods 2113 TMS Parameters 2149 TMS Reasons 2644 Training Headers 2615 Void/Return/Waste Reason 2649 Wait Quote Configuration 2645 Waste Receipt Headers 2647 Waste Receipt Trailers 2648 -
emailConfiguration:
object EnterpriseEmailConfiguration
Enterprise email configuration
-
hierUnitId:
integer
Unique reference of the hierarchy unit where Enterprise Parameters are configured.Example:
765 -
kdsClientsLicense:
object EnterpriseLicenseCountInfo
License count information
-
name:
object name
Enterprise name.
-
openIdProvider:
string
Read-only OpenID provider URL.Example:
https://identity.example -
options:
string
A string value of 0s and 1s of length 128 representing the enablement or disablement of enterprise parameter options. The option bits that are not relevant,if set are ignored and kept disabled.Example:
00000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 -
optionsExt:
object EnterpriseParametersOptionsExt
An object containing the descriptive options list associated with the enterprise parameter option string.
-
propertyLaborManagement:
string
Read-only Property Labor Management URL.Example:
https://labor.example -
telemetryURL:
string
Read-only telemetry information URL.Example:
https://telemetry.example -
transactionServicesClientsLicense:
object EnterpriseLicenseCountInfo
License count information
-
transactionServicesGen2Hub:
string
Read-only Transaction Services Gen2 Hub URL.Example:
https://txnhub.example -
transactionServicesGen2Services:
string
Read-only Transaction Services Gen2 Services URL.Example:
https://txnservices.example -
workstationsLicense:
object EnterpriseLicenseCountInfo
License count information
Nested Schema : disabledEMCModules
Type:
arrayArray of disabled modules in EMC.
| Module Name | Value |
|---|---|
| Allergen Names | 2653 |
| Application Text | 2138 |
| Autofire Check Offline Header | 2646 |
| Barcode Format Sets | 1131 |
| Barcodes | 2104 |
| Canadian GST | 1146 |
| Canadian PST | 1147 |
| Canadian Tax Trailers | 2618 |
| Cash Management Account | 6005 |
| Cash Management Cash Count Threshold | 6011 |
| Cash Management Cash Pull Threshold | 6007 |
| Cash Management Class | 6003 |
| Cash Management Class Behavior | 6012 |
| Cash Management Count Sheet | 6002 |
| Cash Management PAR Level | 6008 |
| Cash Management Parameters | 6010 |
| Cash Management Reason | 6009 |
| Cash Management Receptacle | 6004 |
| Cash Management Template | 6001 |
| Cash Management Vendor | 6006 |
| Cashiers | 2116 |
| Check Alert | 2643 |
| Check Headers - Default | 2612 |
| Check Headers - Order Type/Channel | 7110 |
| Check Summary Descriptors | 2602 |
| Check Trailers - Default | 2613 |
| Check Trailers - Order Type/Channel | 7111 |
| Components | 2158 |
| Condiment Group Names | 2627 |
| Condiment Sets | 2128 |
| Credit Card Headers | 2616 |
| Credit Card Trailers | 2617 |
| Currency | 1113 |
| Currency Availability | 1144 |
| Currency Conversions | 1142 |
| Currency Parameters | 1145 |
| Custom Browser | 2657 |
| Dietary Labels | 7102 |
| Discount Groups | 2609 |
| Discount Itemizers | 2624 |
| Discount SLU Names | 2629 |
| Family Groups | 1125 |
| Gift Card Provider | 1175 |
| Guest Information Prompts | 2603 |
| KDS Bump Bars | 1129 |
| KDS Controllers | 1127 |
| KDS Displays | 1128 |
| KDS Highlight Schemes | 1137 |
| KDS Status Bars | 7112 |
| KDS Tool Bars | 1130 |
| Kitchen Theme | 1156 |
| Kitchen Theme Period | 2151 |
| Languages | 1115 |
| Loan Reasons | 2606 |
| Locale | 127 |
| Loyalty Card Provider | 1176 |
| Major Groups | 1124 |
| Menu Item Groups | 1133 |
| Menu Item Master Group SLU Names | 2652 |
| Menu Item Master Groups | 1138 |
| Menu Item SLU Names | 2631 |
| Menu Level Sets | 2127 |
| NLU Names | 2623 |
| Nutrition Names | 2654 |
| Order Channel | 7106 |
| Order Channel Parameters | 7107 |
| Order Type Parameters | 1141 |
| Order Types | 2622 |
| Page Assignment | 2135 |
| Pages | 2124 |
| Payment Reasons | 2605 |
| PC Autosequence Schedules | 114 |
| PC Autosequences | 113 |
| Pickup Reasons | 2607 |
| POS Keyboard | 2655 |
| Print Logos | 116 |
| Production Item | 2150 |
| Property Merchant Groups | 1134 |
| Receipt Headers - Default | 2614 |
| Receipt Headers - Order Type/Channel | 7113 |
| Report Headers | 7103 |
| Report Trailers | 7104 |
| Reservation Periods | 2153 |
| RVC Type Names | 2610 |
| Sales Itemizers | 2625 |
| Seating Section Template | 2147 |
| Section | 2148 |
| Service Alert | 2642 |
| Service Charge Itemizers | 2626 |
| Service Charge SLU Names | 2633 |
| Service Total Reasons | 2608 |
| Serving Periods | 2112 |
| System Employees | 506 |
| Tables | 2111 |
| Tags | 7100 |
| Tax Classes | 1118 |
| Tax Parameters | 1139 |
| Tax Rates | 1117 |
| Tender/Media SLU Names | 2635 |
| Theme Assignment | 2156 |
| Time Periods | 2113 |
| TMS Parameters | 2149 |
| TMS Reasons | 2644 |
| Training Headers | 2615 |
| Void/Return/Waste Reason | 2649 |
| Wait Quote Configuration | 2645 |
| Waste Receipt Headers | 2647 |
| Waste Receipt Trailers | 2648 |
Example:
[
2138,
2653
]Nested Schema : EnterpriseEmailConfiguration
Type:
objectEnterprise email configuration
Show Source
-
backupSMTPServer:
object EnterpriseSMTPServer
SMTP server details
-
htmlFormatting:
object EnterpriseEmailFormatting
Email formatting details
-
primarySMTPServer:
object EnterpriseSMTPServer
SMTP server details
-
sendHTMLEmail:
boolean
Indicates whether HTML email content is sent.Example:
true -
textFormatting:
object EnterpriseEmailFormatting
Email formatting details
Nested Schema : EnterpriseLicenseCountInfo
Type:
objectLicense count information
Show Source
-
licenseCount:
integer
License count. Valid range is [0,999999999]Example:
25 -
licenseCountRefInfo:
string
Reference information for the license count.Example:
WS-25
Nested Schema : name
Type:
objectEnterprise name.
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}Nested Schema : EnterpriseParametersOptionsExt
Type:
objectAn object containing the descriptive options list associated with the enterprise parameter option string.
Show Source
-
checkForDuplicateMenuItemNames:
boolean
Indicates whether duplicate menu item names are checked (option bit 14).Example:
false -
checkForDuplicateMenuItemObjectNumbers:
boolean
Indicates whether duplicate menu item object numbers are checked (option bit 15).Example:
false -
emailOneTimePassword:
boolean
Indicates whether one-time passwords are sent through email (option bit 92).Example:
false -
enableImportExportRestAPI:
boolean
Indicates whether the import/export REST API is enabled (option bit 19).Example:
false -
enableImportExportWebService:
boolean
Indicates whether the import/export web service is enabled (option bit 18).Example:
false -
enableMobileOrderAndPay:
boolean
Indicates whether Mobile Order and Pay is enabled (option bit 98).Example:
false -
hideRVCNodeForSingleRVCProperties:
boolean
Indicates whether the RVC node is hidden for properties with a single RVC (option bit 10).Example:
false -
sendSelectedTranslationsToRNA:
boolean
Indicates whether selected translations are sent to Reporting and Analytics (option bit 17).Example:
false
Nested Schema : EnterpriseSMTPServer
Type:
objectSMTP server details
Show Source
-
isSSL:
boolean
Indicates whether SSL is enabled for the server connection.Example:
true -
name:
string
Display name of the sender.Example:
Admin -
password:
string
SMTP password.Example:
secret -
port:
integer
SMTP server port.Example:
587 -
server:
string
SMTP server host name.Example:
smtp.mail.com -
sourceEmail:
string
Source email address used as the sender.Example:
admin@oracle.com -
userName:
string
SMTP user name.Example:
admin
Nested Schema : EnterpriseEmailFormatting
Type:
objectEmail formatting details
Show Source
-
emailBody:
string
Email body content.Example:
Body -
emailSubject:
string
Email subject line.Example:
Subject