Configuration and Content API Guide

Update Family Group Consumer Facing Content

post

/content/sim/v1/menuitems/familyGroups/updateConsumerContent

Updates the Family Group Consumer Facing Content. If Family Group Consumer Facing Content is not found it creates a new entry for Family Group Consumer Facing Content.

Request

Supported Media Types

application/json
multipart/form-data

Header Parameters

Simphony-AuditTrailRef: string

Detail that identifies, who made the change.

Family Group Consumer Facing Content object of the organization

Root Schema : FamilyGroupConsumerFacingContentCUDRequestBody

Type: object

Model for Family Group Facing Content Object

Show Source

comments: string

Comment of the images.

Example: Image of Appetizers
hierUnitId(required): integer

Unique reference of the hierarchy unit

Example: 2
imageIndex(required): integer

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

Example: 1
objectNum(required): integer

Object Number of the Family Group

Example: 1
size: string

The size of an image

Example: Size: 12 kb, png: 100 x 100 px
title: string

Title of the image

Example: Image of appetizers

{
    "description":"Model for Family Group Facing Content Object",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "imageIndex"
    ],
    "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
        },
        "title":{
            "description":"Title of the image",
            "type":"string",
            "example":"Image of appetizers"
        },
        "comments":{
            "description":"Comment 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"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Family Group Consumer Facing Content of the organization

Root Schema : FamilyGroupConsumerFacingContentUpdateResponse

Type: object

Response object for Content related Objects

Show Source

hierUnitId(required): integer

Unique reference of the hierarchy unit

Example: 1
imageIndex(required): integer

Image number of the family group

Example: 1
objectNum(required): integer

Object Number of the menu item

Example: 1
url(required): string

Object storage url of the uploaded image, can be used for downloading the uploaded image.

Example: https://objectstorage.oracle.com/xyz.jpg

{
    "description":"Response object for Content related Objects",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "imageIndex",
        "url"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit",
            "type":"integer",
            "example":1
        },
        "objectNum":{
            "description":"Object Number of the menu item",
            "type":"integer",
            "example":1
        },
        "imageIndex":{
            "description":"Image number of the family group",
            "type":"integer",
            "example":1
        },
        "url":{
            "description":"Object storage url of the uploaded image, can be used for downloading the uploaded image.",
            "type":"string",
            "example":"https://objectstorage.oracle.com/xyz.jpg"
        }
    }
}

400 Response

400 Bad Request

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

detail(required): string

A short, human-readable summary of the problem.

Example: Specified Data is invalid
errorDetails(required): string

A human-readable explanation specific to this occurrence of the problem.

Example: Entity Does Not Exist
o:errorCode(required): integer

Error code of the problem

Example: 55223
status(required): integer

HTTP status code.

Example: 400
title(required): string

A short, human-readable summary of the problem type.

Example: VALIDATION ERROR
type(required): 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",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "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"
        }
    }
}