Get Screen Look Ups
post
/config/sim/v1/setup/getscreenlookups
Gets a list of SLUs in a given organization
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
Objects included in the response.Example:
hierUnitId -
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits the translated strings returned.Example:
en-US, es-ES, es-MX -
limit:
integer
If using paging, number of results returned in this page.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A Collection of Screen Look Ups.
Root Schema : SLUGetResponsev1
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of SLU objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of SLU objects of the organization.
Show Source
-
Array of:
object SLUv1
Model for an SLU Object
Nested Schema : SLUv1
Type:
objectModel for an SLU Object
Show Source
-
hierUnitId:
integer
Hierarchy Unit Id of the root node of the hierarchyExample:
1 -
hierUnitname:
object hierUnitname
Hier Unit Name
-
hierUnitObjNum:
integer
Sequence Number of the Hierarchy UnitExample:
1 -
images:
array images
An array of images associated with the SLU
-
name:
object name
Name
-
objectNum:
integer
Sequence Number of the SLUExample:
1 -
type:
integer
Slu Type Number assigned to the SLU | Slu Type | SLU Name | |------------|-------------------------------| | 1 | Discount SLU | | 2 | Service Charges SLU | | 3 | Tender Media SLU | | 6 | Menu Items SLU | | 7 | Menu Item Master Group SLU |Example:
1
Nested Schema : hierUnitname
Type:
objectHier Unit Name
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : name
Type:
objectName
Example:
{
"en-US":"Coffee",
"de-DE":"Kaffee",
"es-MX":"Cafe"
}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