Jump to

• Request
• Response

Get SLUs

post

/config/sim/v1/setup/getscreenlookups

Gets a list of SLUs in a given organization

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-OrgShortName: string(string)
  Org Identifier

Body ()

A request body

Root Schema : SLUGetRequestBody

Type: object

The input Body model that needs to be given.

Show Source

• include(optional): string
  Objects included in response
• languages(optional): string
  If specified, limits translated strings returned
• limit(optional): integer
  If using paging, number of results returned in this page.
• offset(optional): integer
  Starting resource record index. Not required if paging parameters are not supported
• orderBy(optional): integer
  Sorts the response by the specified field name and sort order.
• searchCriteria(optional): 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"
        },
        "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":"integer",
            "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 : SLU

Type: object

Model for an SLU Object

Show Source

• deviceType(optional): integer
  Device Type of SLU

  Example: 1
• hierUnitId: integer
  Hierarchy Unit Id of the root node of the hierarchy

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

  A string that contains translations into multiple languages **Example** `{ "en-US": "Enterprise", "de-DE": "...", "ar-AR": "..." }`
• hierUnitObjNum(optional): integer
  Sequence Number of the Hierarchy Unit

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

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
• ObjectNum: integer
  Sequence Number of the SLU

  Example: 1
• type: integer
  Type of SLU

  Example: 1

{
    "description":"Model for an SLU Object",
    "type":"object",
    "required":[
        "hierUnitId",
        "ObjectNum",
        "name",
        "type"
    ],
    "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":"Type of SLU",
            "type":"integer",
            "example":1
        },
        "deviceType":{
            "description":"Device Type of SLU",
            "type":"integer",
            "example":1
        },
        "images":{
            "type":"array",
            "description":"An array of images associated with the menu item",
            "items":{
                "$ref":"#/definitions/MenuItem_image"
            }
        }
    }
}

Nested Schema : TranslatedStringHierUnit

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A string that contains translations into multiple languages\n\n**Example**\n`{ \"en-US\": \"Enterprise\", \"de-DE\": \"...\", \"ar-AR\": \"...\" }`\n",
    "type":"object",
    "example":{
        "en-US":"Enterprise",
        "de-DE":"...",
        "ar-AR":"..."
    },
    "additionalProperties":{
        "type":"string"
    }
}

A string that contains translations into multiple languages **Example** `{ "en-US": "Enterprise", "de-DE": "...", "ar-AR": "..." }`

Example:

{
    "en-US":"Enterprise",
    "de-DE":"...",
    "ar-AR":"..."
}

Nested Schema : images

Type: array

An array of images associated with the menu item

Show Source

• Array of: object MenuItem_image

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

Nested Schema : TranslatedString

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A string that contains translations into multiple languages\n\n**Example**\n`{ \"en-US\": \"coffee\", \"de-DE\": \"kaffee\", \"ar-AR\": \"????????\" }`\n",
    "type":"object",
    "example":{
        "en-US":"Coffee",
        "de-DE":"Kaffee",
        "ar-AR":"????????"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`

Example:

{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "ar-AR":"????????"
}

Nested Schema : MenuItem_image

Type: object

Show Source

• altText(optional): string
  The image alternative text of the menu item

  Example: pizza
• description(optional): string
  The description text of the menu item

  Example: pizza description
• imageIndex(optional): integer
  Image Number for reference

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

  Example: true
• size(optional): string
  The size of the image

  Example: 1
• url(optional): string
  The URL of the image of the menu item

  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 menu item"
        },
        "altText":{
            "type":"string",
            "example":"pizza",
            "description":"The image alternative text of the menu item"
        },
        "description":{
            "type":"string",
            "example":"pizza description",
            "description":"The description text of the menu item"
        },
        "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(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