Get Custom CAL Packages

post

/config/sim/v2/setup/cal/getCustomPackage

Gets Custom CAL Packages

Request

Supported Media Types
Body ()
The input body model that needs to be given.
Root Schema : schema
Type: object
Show Source
  • If specified, limits the data returned to these fields.
    Example: packageId, packageName, version
  • 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
  • If specified, limits translated strings returned
    Example: 1,2,3
  • If using paging, number of results returned in this page.
    Example: 100
  • Starting resource record index.
    Example: 0
  • Sorts the response by the specified field name and sort order. Allowed fields are packageId, packageName, folderName, platformType, deploymentOrder, limitOptions, and version.
    Example: packageId:asc
  • If specified, returns records that match the criteria. Allowed fields are packageId, packageName, folderName, platformType, deploymentOrder, limitOptions, and version.
    Example: where equals(packageId, 101)
Back to Top

Response

Supported Media Types

200 Response

A collection of Custom CAL Packages.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Array of Custom CAL Package objects.
Show Source
Nested Schema : CustomCALPackage
Type: object
Custom CAL Package record
Show Source
Nested Schema : limitOptionsExt
Type: object
An object containing the descriptive service host list where the Custom CAL Package can be deployed.
Example:
{
    "checkAndPosting":false,
    "checkAndPostingBackup":false,
    "creditCard":false,
    "interface":false,
    "kdsController":false,
    "kdsControllerBackup":false,
    "sim":false,
    "workstation":false
}
Back to Top