Get Custom Content

post

/content/sim/v1/setup/getCustomContent

Gets all the custom content

Request

Supported Media Types
Body ()
The input Body model that needs to be given.
Root Schema : schema
Type: object
Show Source
  • Objects included in the response.
    Example: hierUnitId
  • 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
  • If specified, limits the translated strings returned.
    Example: en-US, es-ES, es-MX
  • If using paging, number of results returned in this page.
    Example: 10
  • Starting resource record index. Not required if paging parameters are not supported.
    Example: 0
  • Sorts the response by the specified field name and sort order.
    Example: objectNum:asc
  • Search criteria to filter results based on field value.
    Example: where equals(objectNum,1)
Back to Top

Response

Supported Media Types

200 Response

A Collection of Custom Content objects
Body ()
Root Schema : CustomContentGetResponsev1
Type: object
Show Source
Nested Schema : items
Type: array
Array of Custom Content objects of the organization.
Show Source
Nested Schema : CustomContent
Type: object
Show Source
  • description
    Description
  • The name of the custom content file with extension
    Example: ImageSpoons.jpg
  • the content file origin.
    Example: C:\Program Files\Oracle Hospitality\EMCClient\OPIPayment.dll
  • Unique hierarchy unit value
    Example: 1
  • hierUnitName
    Hier Unit Name
  • Hierarchy unit object number
    Example: 1
  • Unique reference of the content
    Example: 1
  • The name of the content object. The name must be unique within the hierarchy unit.
    Example: Image Spoons
  • A string value of 0's & 1's representing the platforms where the content is targeted
    Example: 11111111111111111111111111111111
  • CustomContent_targetExt
    An object containing the descriptive platforms list where the content can be targeted
  • The file type for the custom content.
    ValueDescription
    1LooseXaml
    2String
    3DLL
    4PrecompiledClassName
    5TranslatedText
    6ResourceDictionary
    7PythonScript
    8Image_BMP
    9Image_JPG
    10Image_TIFF
    11Image_GIF
    12Image_PNG
    13Icon
    14Resource_Generic
    15Resource_Style
    16Resource_Brush
    17Resource_Font
    19SimScript
    21CSS
    22Javascript
    23Text
    24Binary
    25BinaryCert
    26EncryptedDllConfiguration
    27Package.
    Example: 9
  • customContentURL
    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 : 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
Nested Schema : customContentURL
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
Nested Schema : customContentParams
Type: object
Show Source
Back to Top