Get CAL Deployment Schedules
post
/config/sim/v1/setup/cal/getDeploymentSchedules
Gets all the CAL Deployment Schedules configured
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
Objects included in the response.Example:
hierUnitId -
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 the translated strings returned.Example:
en-US, es-ES, es-MX -
limit:
integer
If using paging, number of results returned in this page.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A collection of CAL Deployment Schedules
Root Schema : DeploymentScheduleGetResponsev1
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Deployment Schedule objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Deployment Schedule objects of the organization.
Show Source
-
Array of:
object DeploymentScheduleResponsev1
Model for CAL Deployment Schedule Object
Nested Schema : DeploymentScheduleResponsev1
Type:
objectModel for CAL Deployment Schedule Object
Show Source
-
actionToTake:
integer
Action to take while downloading the package Select 0 for installations to proceed, Select 1 to Skip to prevent downloading a packageExample:
0 -
deploymentId:
integer
Unique reference of the CAL deployment schedule.Example:
111 -
deploymentType:
integer
The Type of the deployment 1 - Property / Enterprise 2 - Specific Service HostExample:
1 -
effectiveFrom:
string
The start date when this package becomes active (also used to schedule upgrades).Example:
14-04-2022T13:00:00 -
effectiveTo:
string
The end date when this package becomes inactive (also used to schedule upgrades).Example:
14-04-2022T13:00:00 -
hierUnitId:
integer
Unique reference of hierarchy unit where the CAL package is to be downloaded. This could either the property where the package downloads or the Enterprise. Applicable only if the deploymentType = 1Example:
3588 -
packageId:
integer
Unique reference of the CAL PackageExample:
101 -
packageName:
string
Name of the CAL deployment packageExample:
CAPSOnIIS.19.3.3 -
svcHostName:
object svcHostName
SVC Host Name
-
svcHostObjNum:
integer
Object number of the service host or workstations where the package is downloaded. Applicable only if deploymentType = 2Example:
141 -
version:
string
Version of the CAL deployment packageExample:
19.3.3
Nested Schema : svcHostName
Type:
objectSVC Host Name
Example:
{
"en-US":"SVC Host 1",
"sp-SP":"Host de servicio 1"
}