REST API: Schedules

Methods


TypeVer.Command parameterParameters
Getters
GET8+ getScheduleForm campaignId=<id>
Example of success:

GET8+ getScheduleSessions scheduleId=<id>
Example of success:

GET8+ getScheduleDetails scheduleId=<id>
(opt.) frozen=<true|false>
Example of success:

GET8+ getScheduleScheduling scheduleId=<id>
(opt.) frozen=<true|false>
Example of success:

GET8+ getScheduleOperator scheduleId=<id>
Example of success:

GET8+ getScheduleFollowers scheduleId=<id>
Example of success:

GET6+ getScheduleFollowerEmails scheduleId=<id>
Example of success:

GET8+ getScheduleSut scheduleId=<id>
Example of success:

GET6+ getScheduleAgents scheduleId=<id>
Example of success:

GET6+ getScheduleConfigurations scheduleId=<id>
Note: If the schedule does not have any configuration associated to one of its category:
- jarName and name are left empty
- id has the value 0

Example of success:

GET6+ getScheduleMonitoringConfiguration scheduleId=<id>
Example of success:

GET6+ getScheduleMonitoredServers scheduleId=<id>
Example of success:

GET6+ getScheduleExecutionOptions scheduleId=<id>
Example of success:

GET6+ getScheduleDynamicAttributes scheduleId=<id>
Example of success:

GET6+ getScheduleParams scheduleId=<id>
Example of success:

GET6+ getScheduledSessionTestAttributeValues sessionId=<id>
Example of success:

GET6+ getScheduledSessionTestcaseParamValues sessionId=<id>
Example of success:

Setters
POST8+createSchedule parentCampaignId=<id>
sutId=<id>
(opt.) parentFailedRule=<execution option>
(opt.) parentUnknownRule=<execution option>
(opt.) monitoringAgentId=<id>
(opt.) monitoringConfigurationId=<id>
(opt.) pick=<pick>
Content of the form with values
(see getScheduleForm)
must be passed in the request's body
as multi-part.
Example of success:

POST8+updateScheduleDetails Content of the form with values
(see getScheduleDetails)
must be passed in the request's body
as multi-part.
Example of success:

Example of failure:
POST8+updateScheduleScheduling scheduleId=<id>
Content of the form with values
(see getScheduleScheduling)
must be passed in the request's body
as multi-part.
Example of success:

Example of failure:
POST8+updateScheduleAgents scheduleId=<id>
agentIds=<id, id...>
(opt.) nbInstances=<number of instances>
(opt.) synchronizations=<id>
(opt.) anyAgent=<true|false>
Example of success:

Example of failure:
POST8+updateScheduleConfigurations scheduleId=<id>
categoryIds=<id, id...>
configurationIds=<id, id...>
Example of success:

Example of failure:
POST8+updateScheduleOperator scheduleId=<id>
operatorId=<id>
Example of success:

Example of failure:
POST8+updateScheduleSut scheduleId=<id>
sutId=<id>
Example of success:

Example of failure:
POST8+updateScheduleFollowers scheduleId=<id>
followerIds=<id, id, ...>
Example of success:

Example of failure:
POST11+updateSchedulesFollowers scheduleIds=<id, id, ...>
followerIds=<id, id, ...>
Example of success:

Example of failure:
POST11+addSchedulesFollower scheduleIds=<id, id, ...>
followerId=<id>
Example of success:

Example of failure:
POST11+removeSchedulesFollower scheduleIds=<id, id, ...>
followerId=<id>
Example of success:

Example of failure:
POST8+copySchedules scheduleIds=<id, id, ...>
scheduleNames=<name, name, ...>
destCampaignId=<id>
Example of success:

Example of failure:
POST8+deleteSchedules scheduleIds=<id, id, ...>
Example of success: