Jump to

• Request
• Response

Add Custom Content

post

/content/sim/v1/setup/customContent

Add the custom content to the specified organization.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string
  Detail that identifies, who made the change.
• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

Request body

Root Schema : CustomContent

Type: object

Show Source

• description(optional): object TranslatedString_description
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the description of custom content in configured languages
• filename(optional): string
  The name of the custom content file with extension

  Example: ImageSpoons.jpg
• filenameOrigin(optional): string
  the content file origin.

  Example: C:\Program Files\Oracle Hospitality\EMCClient\OPIPayment.dll
• hierUnitId: integer
  Unique hierarchy unit value

  Example: 1
• hierUnitName(optional): object TranslatedString_HierUnitName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the hierarchy unit configured languages
• hierUnitObjNum(optional): integer
  Hierarchy unit object number

  Example: 1
• id(optional): integer
  Unique reference of the content

  Example: 1
• name: string
  The name of the content object

  Example: Image Spoons
• size(optional): integer
  the size of the custom content in bytes.

  Example: Size: 12 kb, png: 100 x 100 px
• target(optional): string
  A string value of 0???s & 1???s representing the platforms where the content is targeted

  Example: 11111111111111111111111111111111
• targetExt(optional): object CustomContent_targetExt
  An object containing the descriptive platforms list where the content can be targeted
• type(optional): integer
  The file type for the custom content

  Example: 9
• url(optional): 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",
    "required":[
        "hierUnitId",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"Hierarchy unit object number"
        },
        "hierUnitName":{
            "$ref":"#/definitions/TranslatedString_HierUnitName"
        },
        "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":{
            "$ref":"#/definitions/TranslatedString_description"
        },
        "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 : TranslatedString_description

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A group of string objects representing the description of custom content in configured languages",
    "type":"object",
    "example":{
        "en-US":"Image Spoons",
        "es-SS":"cucharas de imagen",
        "lt=LT":"Vaizdo ??auk??tai"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the description of custom content in configured languages

Example:

{
    "en-US":"Image Spoons",
    "es-SS":"cucharas de imagen",
    "lt=LT":"Vaizdo ??auk??tai"
}

Nested Schema : TranslatedString_HierUnitName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A group of string objects representing the name of the hierarchy unit configured languages",
    "example":{
        "en-US":"Enterprise",
        "es-SS":"Empresa",
        "lt=LT":"??mon??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the hierarchy unit configured languages

Example:

{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}

Nested Schema : CustomContent_targetExt

Type: object

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

Show Source

• android(optional): boolean
  target the content on Android platform

  Example: false
• androidMC40(optional): boolean
  target the content on AndroidMC platform

  Example: false
• androidMTablet(optional): boolean
  target the content on AndroidMTablet platform

  Example: false
• linux(optional): boolean
  deploy package to KDS Controller related service host target the content on Linux platform

  Example: false
• win32(optional): 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(optional): string
  Example: https://abc.com/content/sim/v1/menuItems/downloadConsumerContent
• params(optional): 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

• defSeqNum(optional): integer
  Sequence Number of the menu Item Definition

  Example: 1
• hierUnitId(optional): integer
  Unique reference of the hierarchy unit

  Example: 2
• imageNum(optional): integer
  Number of the image. Values range from 1-10.

  Example: 1
• objectNum(optional): 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
        },
        "defSeqNum":{
            "description":"Sequence Number of the menu Item Definition",
            "type":"integer",
            "example":1
        },
        "imageNum":{
            "description":"Number of the image. Values range from 1-10.",
            "type":"integer",
            "example":1
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response object

Body ()

Root Schema : CustomContentResponse

Type: object

Show Source

• hierUnitId: integer
  Unique hierarchy unit value.

  Example: 1
• id: integer
  Unique reference of the content

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "id"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value."
        },
        "id":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the content"
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(optional): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(optional): integer
  Error code of the problem

  Example: 55223
• status(optional): integer
  HTTP status code.

  Example: 400
• title(optional): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(optional): 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

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top