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
Get request body
Root Schema : GetDepScheduleRequestBody
Type:
objectThe input Body model that needs to be given for get request.
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:
integer
Sorts the response by the specified field name and sort order.
-
searchCriteria:
string
Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
A collection of CAL Deployment Schedules of the organization
Root Schema : DeploymentScheduleGetResponse
Type:
objectModel for CAL Deployment Schedule Object
Show Source
-
actionToTake(required):
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(required):
integer
Unique reference of the CAL deployment schedule.Example:
111 -
deploymentType(required):
integer
The Type of the deployment 1 ??? Property / Enterprise 2 ??? Specific Service HostExample:
1 -
effectiveFrom(required):
string
The start date when this package becomes active (also used to schedule upgrades).Example:
14-04-2022T13:00:00 -
effectiveTo(required):
string
The end date when this package becomes inactive (also used to schedule upgrades).Example:
14-04-2022T13:00:00 -
hierUnitId(required):
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(required):
integer
Unique reference of the CAL PackageExample:
101 -
packageName(required):
string
Name of the CAL deployment packageExample:
CAPSOnIIS.19.3.3 -
svcHostName(required):
object SvcHostNameTranslatedString
A group of strings representing the name of the service host or workstations in configured languages where the package is downloaded. Applicable only if deploymentType = 2
-
svcHostObjNum(required):
integer
Object number of the service host or workstations where the package is downloaded. Applicable only if deploymentType = 2Example:
141 -
version(required):
string
Version of the CAL deployment packageExample:
19.3.3
Nested Schema : SvcHostNameTranslatedString
Type:
objectA group of strings representing the name of the service host or workstations in configured languages where the package is downloaded. Applicable only if deploymentType = 2
Example:
{
"en-US":"SVC Host 1",
"sp-SP":"Host de servicio 1"
}400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse 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 problemExample:
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