Jump to

• Request
• Response

Get Menu Item Defintion Consumer Facing Content

post

/content/sim/v1/menuitems/menuitemdefinition/getConsumerContent

Gets a list of Menu Item Consumer Facing Content.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

Request body

Root Schema : MenuItemConsumerFacingContentGetRequest

Type: object

Show Source

• defSeqNum: integer
  Sequence Number of the menu Item Definition

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

  Example: 2
• include(optional): string
  Objects included in response

  Example: locations
• languages(optional): string
  If specified, limits translated strings returned

  Example: en-US,es-SS,lt-LT
• limit(optional): integer
  If using paging, number of results returned in this page.

  Example: 10
• objectNum: integer
  Object Number of the menu item

  Example: 1
• offset(optional): integer
  Starting resource record index

  Example: 0
• orderBy(optional): string
  Sorts the response by the specified field name and sort order

  Example: objectNum:asc
• searchCriteria(optional): string
  Search criteria to filter results based on field value

  Example: where equals(active,1)

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "defSeqNum",
        "imageNum"
    ],
    "properties":{
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "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"
        },
        "searchCriteria":{
            "type":"string",
            "example":"where equals(active,1)",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "example":"locations",
            "description":"Objects included in response"
        },
        "languages":{
            "type":"string",
            "example":"en-US,es-SS,lt-LT",
            "description":"If specified, limits translated strings returned"
        },
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit",
            "type":"integer",
            "example":2
        },
        "objectNum":{
            "description":"Object Number of the menu item",
            "type":"integer",
            "example":1
        },
        "defSeqNum":{
            "description":"Sequence Number of the menu Item Definition",
            "type":"integer",
            "example":1
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of Menu Item Consumer Facing Content entities in an organization.

Body ()

Root Schema : MenuItemConsumerFacingContent

Type: object

Model for Menu Item Consumer Facing Content Object

Show Source

• defSeqNum: integer
  Sequence Number of the menu Item Definition

  Example: 1
• description(optional): string
  Description of the images.

  Example: Image of Appetizers
• fileName(optional): string
  The name of the image file

  Example: ImageAppetizers.jpg
• hierUnitId: integer
  Unique reference of the hierarchy unit

  Example: 2
• 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
  Object number of the hierarchy unit

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

  Example: 1
• imageUrl(optional): 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
• objectNum: integer
  Object Number of the family group

  Example: 1
• size(optional): string
  The size of an image

  Example: Size: 12 kb, png: 100 x 100 px
• title(optional): string
  Title of the image

  Example: Image of appetizers
• 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.

{
    "description":"Model for Menu Item Consumer Facing Content Object",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "defSeqNum",
        "imageNum"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit",
            "type":"integer",
            "example":2
        },
        "hierUnitObjNum":{
            "description":"Object number of the hierarchy unit",
            "type":"integer",
            "example":1
        },
        "hierUnitName":{
            "$ref":"#/definitions/TranslatedString_HierUnitName"
        },
        "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
        },
        "title":{
            "description":"Title of the image",
            "type":"string",
            "example":"Image of appetizers"
        },
        "description":{
            "description":"Description of the images.",
            "type":"string",
            "example":"Image of Appetizers"
        },
        "size":{
            "description":"The size of an image",
            "type":"string",
            "example":"Size: 12 kb, png: 100 x 100 px"
        },
        "fileName":{
            "description":"The name of the image file",
            "type":"string",
            "example":"ImageAppetizers.jpg"
        },
        "url":{
            "$ref":"#/definitions/URL"
        },
        "imageUrl":{
            "description":"The object storage URL of the uploaded image. This URL can be used to download the uploaded image.",
            "type":"string",
            "example":"https://objectstorage.oracle.com/xyz.jpg"
        }
    }
}

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 : 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
        }
    }
}

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"
        }
    }
}

404 Response

404 Requested resource not found

Back to Top