Configuration and Content API Guide

Get Custom Content

post

/content/sim/v1/setup/getCustomContent

Gets all the custom content

Request

Supported Media Types

application/json
multipart/form-data

The input Body model that needs to be given.

Root Schema : schema

Type: object

Show Source

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)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(objectNum,1)",
            "description":"Search criteria to filter results based on field value."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId",
            "description":"Objects included in the response."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n"
        },
        "languages":{
            "type":"string",
            "example":"en-US, es-ES, es-MX",
            "description":"If specified, limits the translated strings returned."
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index. Not required if paging parameters are not supported."
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"string",
            "example":"objectNum:asc",
            "description":"Sorts the response by the specified field name and sort order."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A Collection of Custom Content objects

Root Schema : CustomContentGetResponsev1

Type: object

Show Source

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 Custom Content objects of the organization.
limit: integer

Server page size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of rows (excluding the paging parameters)

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Custom Content objects of the organization.",
            "items":{
                "$ref":"#/definitions/CustomContent"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of Custom Content objects of the organization.

Show Source

Array of: object CustomContent

{
    "type":"array",
    "description":"Array of Custom Content objects of the organization.",
    "items":{
        "$ref":"#/definitions/CustomContent"
    }
}

Nested Schema : CustomContent

Type: object

Show Source

description: object description

Description
filename: string

The name of the custom content file with extension

Example: ImageSpoons.jpg
filenameOrigin: string

the content file origin.

Example: C:\Program Files\Oracle Hospitality\EMCClient\OPIPayment.dll
hierUnitId: integer

Unique hierarchy unit value

Example: 1
hierUnitName: object hierUnitName

Hier Unit Name
hierUnitObjNum: integer

Hierarchy unit object number

Example: 1
id: integer

Unique reference of the content

Example: 1
name: string

The name of the content object

Example: 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 targeted

Example: 11111111111111111111111111111111
targetExt: object CustomContent_targetExt

An object containing the descriptive platforms list where the content can be targeted
type: integer

The file type for the custom content

Example: 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.

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"Hierarchy unit object number"
        },
        "hierUnitName":{
            "type":"object",
            "description":"Hier Unit Name",
            "example":{
                "en-US":"Enterprise",
                "de-DE":"Unternehmen",
                "es-MX":"Empresa"
            }
        },
        "id":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the content"
        },
        "name":{
            "type":"string",
            "example":"Image Spoons",
            "description":"The name of the content object"
        },
        "description":{
            "type":"object",
            "description":"Description",
            "example":{
                "en-US":"Image Spoons",
                "de-DE":"Bild L??ffel",
                "es-MX":"Cucharas de Imagen"
            }
        },
        "size":{
            "type":"integer",
            "example":"Size: 12 kb, png: 100 x 100 px",
            "description":"the size of the custom content in bytes."
        },
        "type":{
            "type":"integer",
            "example":9,
            "description":"The file type for the custom content"
        },
        "filenameOrigin":{
            "type":"string",
            "example":"C:\\Program Files\\Oracle Hospitality\\EMCClient\\OPIPayment.dll",
            "description":"the content file origin."
        },
        "target":{
            "type":"string",
            "example":"11111111111111111111111111111111",
            "description":"A string value of 0's & 1's representing the platforms where the content is targeted"
        },
        "targetExt":{
            "$ref":"#/definitions/CustomContent_targetExt"
        },
        "filename":{
            "type":"string",
            "example":"ImageSpoons.jpg",
            "description":"The name of the custom content file with extension"
        },
        "url":{
            "$ref":"#/definitions/URL"
        }
    }
}

Nested Schema : description

Type: object

Description

Example:

{
    "en-US":"Image Spoons",
    "de-DE":"Bild L??ffel",
    "es-MX":"Cucharas de Imagen"
}

Nested Schema : hierUnitName

Type: object

Hier Unit Name

Example:

{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}

Nested Schema : CustomContent_targetExt

Type: object

An object containing the descriptive platforms list where the content can be targeted

Show Source

android: boolean

target the content on Android platform

Example: false
androidMC40: boolean

target the content on AndroidMC platform

Example: false
androidMTablet: boolean

target the content on AndroidMTablet platform

Example: false
linux: boolean

deploy package to KDS Controller related service host target the content on Linux platform

Example: false
win32: boolean

target the content on Win32 platform

Example: false

{
    "type":"object",
    "description":"An object containing the descriptive platforms list where the content can be targeted",
    "properties":{
        "win32":{
            "type":"boolean",
            "example":false,
            "description":"target the content on Win32 platform"
        },
        "androidMC40":{
            "type":"boolean",
            "example":false,
            "description":"target the content on AndroidMC platform"
        },
        "android":{
            "type":"boolean",
            "example":false,
            "description":"target the content on Android platform"
        },
        "androidMTablet":{
            "type":"boolean",
            "example":false,
            "description":"target the content on AndroidMTablet platform"
        },
        "linux":{
            "type":"boolean",
            "example":false,
            "description":"deploy package to KDS Controller related service host target the content on Linux platform"
        }
    }
}

Nested Schema : URL

Type: object

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.

Show Source

endpoint: string

Example: https://abc.com/content/sim/v1/menuItems/downloadConsumerContent
params: object params

{
    "type":"object",
    "description":"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.",
    "properties":{
        "params":{
            "$ref":"#/definitions/params"
        },
        "endpoint":{
            "type":"string",
            "example":"https://abc.com/content/sim/v1/menuItems/downloadConsumerContent"
        }
    }
}

Nested Schema : params

Type: object

Show Source

hierUnitId: integer

Unique reference of the hierarchy unit

Example: 2
imageIndex: integer

Number of the image. Values range from 1-10.

Example: 1
objectNum: integer

Object Number of the family group

Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit",
            "type":"integer",
            "example":2
        },
        "objectNum":{
            "description":"Object Number of the family group",
            "type":"integer",
            "example":1
        },
        "imageIndex":{
            "description":"Number of the image. Values range from 1-10.",
            "type":"integer",
            "example":1
        }
    }
}