Get SLU Consumer Facing Content
post
/content/sim/v1/setup/screenlookups/getconsumercontent
Gets a list of SLU Consumer Facing Content.
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : SLUConsumerFacingContentGetRequest
Type:
Show Source
object-
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
2 -
include:
string
Objects included in responseExample:
locations -
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 translated strings returnedExample:
en-US, de-DE, es-MX -
limit:
integer
If using paging, number of results returned in this page.Example:
10 -
objectNum(required):
integer
Object Number of the SLUExample:
1 -
offset:
integer
Starting resource record indexExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort orderExample:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field valueExample:
where equals(active,1)
Response
Supported Media Types
- application/json
200 Response
A collection of SLU Consumer Facing Content entities in an organization.
Root Schema : SLUConsumerFacingContentGetResponse
Type:
objectModel for Screen Lookup Consumer Facing Content Object Get Response
Show Source
-
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
2 -
hierUnitName(required):
object hierUnitName
A group of string objects representing the name of the hierarchy unit configured languages
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unitExample:
1 -
images(required):
array images
An array containing images of the Screen Lookup.
-
objectNum(required):
integer
Object Number of the Screen LookupExample:
1
Nested Schema : hierUnitName
Type:
objectA group of string objects representing the name of the hierarchy unit configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : items
Type:
Show Source
object-
description:
string
Description of the images.Example:
Image of Appetizers -
fileName:
string
The name of the image fileExample:
ImageAppetizers.jpg -
imageIndex:
integer
Number of the image. Values range from 1-10.Example:
1 -
imageUrl:
string
The object storage url of the uploaded image, this url can be used to download the uploaded image.Example:
https://objectstorage.oracle.com/xyz.jpg -
size:
string
The size of an imageExample:
Size: 12 kb, png: 100 x 100 px -
title:
string
Title of the imageExample:
Image of appetizers -
url:
object URL
The URL of the download API which needs to be used to download the actual content file. This is auto-generated and does not need to be provided during add/update calls.
Nested Schema : URL
Type:
objectThe URL of the download API which needs to be used to download the actual content file. This is auto-generated and does not need to be provided during add/update calls.
Show Source
-
endpoint:
string
Example:
https://abc.com/content/sim/v1/menuItems/downloadConsumerContent -
params:
object params
Nested Schema : params
Type:
Show Source
object-
defSeqNum:
integer
Sequence Number of the menu Item DefinitionExample:
1 -
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
2 -
imageNum:
integer
Number of the image. Values range from 1-10.Example:
1 -
objectNum:
integer
Object Number of the family groupExample:
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
404 Response
404 Requested resource not found