Get Custom Content
post
/content/sim/v1/setup/getCustomContent
Gets all the custom content
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : CustomContentGetRequest
Type:
Show Source
object-
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 -
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 Custom Content objects
Root Schema : CustomContentGetResponse
Type:
Show Source
object-
count(required):
integer
Current response recount count.Example:
9 -
hasMore(required):
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items(required):
array items
Array of Custom Content objects of the organization.
-
limit(required):
integer
Server page sizeExample:
10 -
offset(required):
integer
Starting resource record indexExample:
0 -
totalResults(required):
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : CustomContent
Type:
Show Source
object-
description(required):
object TranslatedString_description
Additional Properties Allowed: additionalPropertiesA group of string objects representing the description of custom content in configured languages
-
filename:
string
The name of the custom content file with extensionExample:
ImageSpoons.jpg -
filenameOrigin:
string
the content file origin.Example:
C:\Program Files\Oracle Hospitality\EMCClient\OPIPayment.dll -
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
hierUnitName:
object TranslatedString_HierUnitName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the hierarchy unit configured languages
-
hierUnitObjNum:
integer
Hierarchy unit object numberExample:
1 -
id:
integer
Unique reference of the contentExample:
1 -
name(required):
string
The name of the content objectExample:
Image Spoons -
size:
integer
the size of the custom content in bytes.Example:
Size: 12 kb, png: 100 x 100 px -
target:
string
A string value of 0???s & 1???s representing the platforms where the content is targetedExample:
11111111111111111111111111111111 -
targetExt:
object CustomContent_targetExt
An object containing the descriptive platforms list where the content can be targeted
-
type(required):
integer
The file type for the custom contentExample:
9 -
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 : TranslatedString_description
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the description of custom content in configured languages
Example:
{
"en-US":"Image Spoons",
"de-DE":"Bild L??ffel",
"es-MX":"Cucharas de Imagen"
}Nested Schema : TranslatedString_HierUnitName
Type:
objectAdditional Properties Allowed
Show Source
A 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 : CustomContent_targetExt
Type:
objectAn object containing the descriptive platforms list where the content can be targeted
Show Source
-
android:
boolean
target the content on Android platformExample:
false -
androidMC40:
boolean
target the content on AndroidMC platformExample:
false -
androidMTablet:
boolean
target the content on AndroidMTablet platformExample:
false -
linux:
boolean
deploy package to KDS Controller related service host target the content on Linux platformExample:
false -
win32:
boolean
target the content on Win32 platformExample:
false
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