Get SLU Consumer Facing Content
post
/content/sim/v2/setup/screenLookups/getConsumerContent
Gets a list of SLU Consumer Facing Content.
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : schema
Type:
Show Source
object-
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
2 -
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum -
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 returnedExample:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
objectNum(required):
integer
Object Number of the SLUExample:
1 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
A Collection of SLU Consumer Facing Content entities.
Root Schema : schema
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 Consumer Facing Content 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 Consumer Facing Content objects of the organization.
Show Source
-
Array of:
object SLUConsumerFacingContentv2
Model for Screen Lookup Consumer Facing Content Object Get Response
Nested Schema : SLUConsumerFacingContentv2
Type:
objectModel for Screen Lookup Consumer Facing Content Object Get Response
Show Source
-
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
2 -
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
images:
array images
An array containing images of the Screen Lookup.
-
objectNum:
integer
Object Number of the Screen LookupExample:
1
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-
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
2 -
imageIndex:
integer
Number of the image. Values range from 1-10.Example:
1 -
objectNum:
integer
Object Number of the family groupExample:
1