Jump to

• Request
• Response

Update SLU Consumer Facing Content

post

/content/sim/v2/setup/screenLookups/updateConsumerContent

Updates the SLU Consumer Facing Content.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string
  Detail that identifies, who made the change.

Body ()

Request body

Root Schema : schema

Type: object

Model for Screen Lookup Consumer Facing Content Object

Show Source

• fileName: string
  The name of the image file

  Example: ImageAppetizers.jpg
• 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 Screen Lookup

  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 Screen Lookup Consumer 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 Screen Lookup",
            "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"
        },
        "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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

SLU Consumer Facing Content Updated or Added.

Body ()

Root Schema : schema

Type: object

Response object for Content related Objects

Show Source

• hierUnitId: integer
  Unique reference of the hierarchy unit

  Example: 1
• imageIndex: integer
  Image number of the SLU

  Example: 1
• objectNum: integer
  Object Number of the SLU

  Example: 1
• url: 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",
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit",
            "type":"integer",
            "example":1
        },
        "objectNum":{
            "description":"Object Number of the SLU",
            "type":"integer",
            "example":1
        },
        "imageIndex":{
            "description":"Image number of the SLU",
            "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"
        }
    }
}

Back to Top