Add CAL Deployment Schedules
post
/config/sim/v2/setup/cal/deploymentSchedules
Add a CAL Deployment Schedule to a specified organization
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string(string)
Detail that Identifies that who made the change
CAL Deployment Schedule Object
Root Schema : InsertDeploymentScheduleRequest
Type:
objectModel for Insert 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 -
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(required):
integer
Unique reference of the CAL PackageExample:
101 -
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
Response
Supported Media Types
- application/json
200 Response
Response Object consisting of the Deployment Id of the object added
Root Schema : ResponseObjectDeploymentSchedule
Type:
objectModel for CAL Deployment Schedule Response Object
Show Source
-
deploymentId(required):
integer
Unique reference of the CAL deployment schedule.Example:
111
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