Add Screen Look Ups
post
/config/sim/v2/setup/screenLookups
Add SLU object
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string(string)
Detail that Identifies that who made the change
A CUD request body
Root Schema : SLUInsertRequestBodyv2
Type:
objectModel for an SLU CUD Request
Show Source
-
hierUnitId(required):
integer
Hierarchy Unit Id of the root node of the hierarchyExample:
1 -
images:
array images
An array of images associated with the SLU
-
name(required):
object name
SLU Name
-
objectNum(required):
integer
Sequence Number of the SLUExample:
1 -
type(required):
integer
Slu Type Number assigned to the SLU | Slu Type | SLU Name | Allowed Hierarchy Level | Allowed objectNum | |------------|-----------------------------------|--------------------------------|-------------------| | 1 | Discount SLU | Zone/Location | 1-64 | | 2 | Service Charges SLU | Zone/Location | 1-64 | | 3 | Tender Media SLU | Zone/Location | 1-64 | | 6 | Menu Items SLU | Enterprise/Zone/Location/RVC | 1-999999999 | | 7 | Menu Item Master Group SLU | Zone/Location | 1-32 |Example:
1
Nested Schema : name
Type:
objectSLU Name
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}Nested Schema : SLU_image
Type:
Show Source
object-
altText:
string
The image alternative text of the SLUExample:
SLU 1 -
description:
string
The description text of the SLUExample:
SLU description -
imageIndex:
integer
Image Number for referenceExample:
1 -
isCloudImage:
boolean
Flag indicating if the image is stored on the CloudExample:
true -
size:
string
The size of the imageExample:
1 -
url:
string
The URL of the image of the SLUExample:
https://oracleObjectStore.com/images/coffee822815.jpg
Response
Supported Media Types
- application/json
200 Response
Added SLU object.
Root Schema : SLUDeleteRequestBody
Type:
Show Source
object-
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
objectNum(required):
integer
Object number of the SLUExample:
1 -
type(required):
integer
Slu Type Number assigned to the SLU | Slu Type | SLU Name | Allowed Hierarchy Level | Allowed objectNum | |------------|-------------------------------|-------------------------------|-------------------| | 1 | Discount SLU | Zone/Location | 1-64 | | 2 | Service Charges SLU | Zone/Location | 1-64 | | 3 | Tender Media SLU | Zone/Location | 1-64 | | 6 | Menu Items SLU | Enterprise/Zone/Location/RVC | 1-999999999 | | 7 | Menu Item Master Group SLU | Zone/Location | 1-32 |Example:
1
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html