Get Custom CAL Packages
post
/config/sim/v2/setup/cal/getCustomPackage
Gets Custom CAL Packages
Request
Supported Media Types
- multipart/form-data
- application/json
The input body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
packageId, packageName, version -
includeAll:
string
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 -
langIds:
string
If specified, limits translated strings returnedExample:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index.Example:
0 -
orderBy:
string
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 -
searchCriteria:
string
If specified, returns records that match the criteria. Allowed fields are packageId, packageName, folderName, platformType, deploymentOrder, limitOptions, and version.Example:
where equals(packageId, 101)
Response
Supported Media Types
- application/json
200 Response
A collection of Custom CAL Packages.
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
10 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Custom CAL Package objects.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rowsExample:
100
Nested Schema : items
Type:
arrayArray of Custom CAL Package objects.
Show Source
-
Array of:
object CustomCALPackage
Custom CAL Package record
Nested Schema : CustomCALPackage
Type:
objectCustom CAL Package record
Show Source
-
deploymentOrder:
integer
Deployment order of the Custom CAL Package.Example:
1000 -
folderName:
string
Folder name of the Custom CAL Package.Example:
CustomCALPackage -
limitOptions:
string
A string value of 0s and 1s of length 8 representing the service host types where the Custom CAL Package can be deployed.Example:
00000000 -
limitOptionsExt:
object limitOptionsExt
An object containing the descriptive service host list where the Custom CAL Package can be deployed.
-
packageId:
integer
Unique reference of the Custom CAL Package.Example:
101 -
packageName:
string
Name of the Custom CAL Package.Example:
CustomCALPackage -
platformType:
integer
Platform that receives the Custom CAL Package.Example:
50 -
version:
string
Version of the Custom CAL Package.Example:
2.0.0.2
Nested Schema : limitOptionsExt
Type:
objectAn 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
}