Configuration and Content API Guide

Get Menu Item Defintion Consumer Facing Content

post

/content/sim/v2/menuItems/menuItemDefinition/getConsumerContent

Gets a list of Menu Item Consumer Facing Content.

Request

Supported Media Types

application/json
multipart/form-data

Request body

Root Schema : schema

Type: object

Show Source

defSeqNum(required): integer

Sequence Number of the menu item definition

Example: 1
hierUnitId(required): integer

Unique reference of the hierarchy unit where the Menu Item definition is configured.

Example: 2
include: string

If specified, limits the data returned to these fields.

Example: hierUnitId, objectNum, name
includeAll: string

If this value is specified, the include parameter is ignored.

Value Description

basic Forces the response to include all fields except option string details

detailed Forces the response to include all fields including option string details

Example: detailed
langIds: string

If specified, limits translated strings returned

Example: 1,2,3
limit: integer

If using paging, number of results returned in this page.

Example: 100
objectNum(required): integer

Object Number of the menu item master.

Example: 1
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: hierUnitId:asc
searchCriteria: string

If specified, returns records that match the criteria.

Example: where equals(hierUnitId, 7)

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "defSeqNum"
    ],
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(hierUnitId, 7)",
            "description":"If specified, returns records that match the criteria."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId, objectNum, name",
            "description":"If specified, limits the data returned to these fields."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"If this value is specified, the include parameter is ignored.\n<table>\n<tr>\n  <td><b>Value</b></td>\n  <td><b>Description</b></td>\n</tr>\n<tr>\n  <td>basic</td>\n  <td>Forces the response to include all fields except option string details</td>\n</tr>\n<tr>\n  <td>detailed</td>\n  <td>Forces the response to include all fields including option string details</td>\n</tr>\n</table>\n"
        },
        "langIds":{
            "type":"string",
            "description":"If specified, limits translated strings returned",
            "example":"1,2,3"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported",
            "example":0
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page.",
            "example":100
        },
        "orderBy":{
            "type":"string",
            "description":"Sorts the response by the specified field name and sort order.",
            "example":"hierUnitId:asc"
        },
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit where the Menu Item definition is configured.",
            "type":"integer",
            "example":2
        },
        "objectNum":{
            "description":"Object Number of the menu item master.",
            "type":"integer",
            "example":1
        },
        "defSeqNum":{
            "description":"Sequence Number of the menu item definition",
            "type":"integer",
            "example":1
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A collection of Menu Item Consumer Facing Content.

Root Schema : schema

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 Menu Item Definition Consumer Facing 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 Menu Item Definition Consumer Facing Content objects of the organization.",
            "items":{
                "$ref":"#/definitions/MenuItemConsumerFacingContentv2"
            }
        },
        "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 Menu Item Definition Consumer Facing Content objects of the organization.

Show Source

Array of: object MenuItemConsumerFacingContentv2

Model for Menu Item Consumer Facing Content Object

{
    "type":"array",
    "description":"Array of Menu Item Definition Consumer Facing Content objects of the organization.",
    "items":{
        "$ref":"#/definitions/MenuItemConsumerFacingContentv2"
    }
}

Nested Schema : MenuItemConsumerFacingContentv2

Type: object

Model for Menu Item Consumer Facing Content Object

Show Source

defSeqNum: integer

Sequence Number of the menu item definition

Example: 1
hierUnitId: integer

Unique reference of the hierarchy unit where the Menu Item definition is configured.

Example: 2
hierUnitObjNum: integer

Object number of the hierarchy unit

Example: 1
images: array images

An array containing images of the Menu Item Definition.
objectNum: integer

Object Number of the menu item master.

Example: 1

{
    "description":"Model for Menu Item Consumer Facing Content Object",
    "type":"object",
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit where the Menu Item definition is configured.",
            "type":"integer",
            "example":2
        },
        "hierUnitObjNum":{
            "description":"Object number of the hierarchy unit",
            "type":"integer",
            "example":1
        },
        "objectNum":{
            "description":"Object Number of the menu item master.",
            "type":"integer",
            "example":1
        },
        "defSeqNum":{
            "description":"Sequence Number of the menu item definition",
            "type":"integer",
            "example":1
        },
        "images":{
            "type":"array",
            "description":"An array containing images of the Menu Item Definition.",
            "items":{
                "type":"object",
                "properties":{
                    "imageIndex":{
                        "description":"Number of the image. Values range from 1-10.",
                        "type":"integer",
                        "example":1
                    },
                    "altText":{
                        "description":"altText 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 : images

Type: array

An array containing images of the Menu Item Definition.

Show Source

Array of: object items

{
    "type":"array",
    "description":"An array containing images of the Menu Item Definition.",
    "items":{
        "type":"object",
        "properties":{
            "imageIndex":{
                "description":"Number of the image. Values range from 1-10.",
                "type":"integer",
                "example":1
            },
            "altText":{
                "description":"altText 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 : items

Type: object

Show Source

altText: string

altText of the image

Example: Image of appetizers
description: string

Description of the images.

Example: Image of Appetizers
fileName: string

The name of the image file

Example: ImageAppetizers.jpg
imageIndex: integer

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

Example: 1
imageUrl: 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
size: string

The size of an image

Example: Size: 12 kb, png: 100 x 100 px
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":{
        "imageIndex":{
            "description":"Number of the image. Values range from 1-10.",
            "type":"integer",
            "example":1
        },
        "altText":{
            "description":"altText 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 : 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
        }
    }
}

Value	Description
basic	Forces the response to include all fields except option string details
detailed	Forces the response to include all fields including option string details