Jump to

• Request
• Response

Get Screen Look Ups

post

/config/sim/v1/setup/getscreenlookups

Gets a list of SLUs in a given organization

Request

Supported Media Types

• application/json
• multipart/form-data

Body ()

A request body

Root Schema : SLUGetRequestBody

Type: object

The input Body model that needs to be given.

Show Source

• include: string
  Objects included in response
• includeAll: string
  This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.

  Example: detailed
• languages: string
  If specified, limits translated strings returned
• limit: integer
  If using paging, number of results returned in this page.
• offset: integer
  Starting resource record index. Not required if paging parameters are not supported
• orderBy: string
  Sorts the response by the specified field name and sort order.
• searchCriteria: string
  Search criteria to filter results based on field value

{
    "description":"The input Body model that needs to be given.",
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "description":"Objects included in response"
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n"
        },
        "languages":{
            "type":"string",
            "description":"If specified, limits translated strings returned"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"string",
            "description":"Sorts the response by the specified field name and sort order."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of SLUs in organization.

Body ()

Root Schema : SLUGetResponse

Type: object

Model for an SLU Object

Show Source

• hierUnitId(required): integer
  Hierarchy Unit Id of the root node of the hierarchy

  Example: 1
• hierUnitname(required): object TranslatedStringHierUnit
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages
• hierUnitObjNum(required): integer
  Sequence Number of the Hierarchy Unit

  Example: 1
• images(required): array images
  An array of images associated with the SLU
• name(required): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages
• objectNum(required): integer
  Sequence Number of the SLU

  Example: 1
• type(required): integer
  Slu Type Number assigned to the SLU | Slu Type | SLU Name | |------------|-------------------------------| | 1 | Discount SLU | | 2 | Service Charges SLU | | 3 | Tender Media SLU | | 6 | Menu Items SLU | | 7 | Menu Item Master Group SLU |

  Example: 1

{
    "description":"Model for an SLU Object",
    "type":"object",
    "required":[
        "hierUnitId",
        "hierUnitObjNum",
        "hierUnitname",
        "objectNum",
        "name",
        "type",
        "images"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Hierarchy Unit Id of the root node of the hierarchy",
            "type":"integer",
            "example":1
        },
        "hierUnitObjNum":{
            "description":"Sequence Number of the Hierarchy Unit",
            "type":"integer",
            "example":1
        },
        "hierUnitname":{
            "$ref":"#/definitions/TranslatedStringHierUnit"
        },
        "objectNum":{
            "description":"Sequence Number of the SLU",
            "type":"integer",
            "example":1
        },
        "name":{
            "$ref":"#/definitions/TranslatedString"
        },
        "type":{
            "description":"Slu Type Number assigned to the SLU\n\n| Slu Type   | SLU Name                      |\n|------------|-------------------------------|\n|       1    | Discount SLU                  |\n|       2    | Service Charges SLU           |\n|       3    | Tender Media SLU              |\n|       6    | Menu Items SLU                |\n|       7    | Menu Item Master Group SLU    |\n",
            "type":"integer",
            "example":1
        },
        "images":{
            "type":"array",
            "description":"An array of images associated with the SLU",
            "items":{
                "$ref":"#/definitions/SLU_image"
            }
        }
    }
}

Nested Schema : TranslatedStringHierUnit

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A string that contains translations into multiple languages\n",
    "type":"object",
    "example":{
        "en-US":"Enterprise",
        "de-DE":"Unternehmen",
        "es-MX":"Empresa"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A string that contains translations into multiple languages

Example:

{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}

Nested Schema : images

Type: array

An array of images associated with the SLU

Show Source

• Array of: object SLU_image

{
    "type":"array",
    "description":"An array of images associated with the SLU",
    "items":{
        "$ref":"#/definitions/SLU_image"
    }
}

Nested Schema : TranslatedString

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A string that contains translations into multiple languages",
    "example":{
        "en-US":"Coffee",
        "de-DE":"Kaffee",
        "es-MX":"Cafe"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A string that contains translations into multiple languages

Example:

{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "es-MX":"Cafe"
}

Nested Schema : SLU_image

Type: object

Show Source

• altText: string
  The image alternative text of the SLU

  Example: SLU 1
• description: string
  The description text of the SLU

  Example: SLU description
• imageIndex: integer
  Image Number for reference

  Example: 1
• isCloudImage: boolean
  Flag indicating if the image is stored on the Cloud

  Example: true
• size: string
  The size of the image

  Example: 1
• url: string
  The URL of the image of the SLU

  Example: https://oracleObjectStore.com/images/coffee822815.jpg

{
    "type":"object",
    "properties":{
        "imageIndex":{
            "type":"integer",
            "example":1,
            "description":"Image Number for reference"
        },
        "url":{
            "type":"string",
            "example":"https://oracleObjectStore.com/images/coffee822815.jpg",
            "description":"The URL of the image of the SLU"
        },
        "altText":{
            "type":"string",
            "example":"SLU 1",
            "description":"The image alternative text of the SLU"
        },
        "description":{
            "type":"string",
            "example":"SLU description",
            "description":"The description text of the SLU"
        },
        "isCloudImage":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if the image is stored on the Cloud"
        },
        "size":{
            "type":"string",
            "example":"1",
            "description":"The size of the image"
        }
    }
}

400 Response

400 Bad Request

Body ()

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

404 Response

404 Requested resource not found

Back to Top