White Papers

OpenManage Essentials-Specific Resource Model
45 REST API Guide–OpenManage Essentials
A sample XML that would comprise the payload when initiating a POST operation to create a LED control task
is as follows:
<RESTLEDControlTask>
<Id>0</Id>
<Name>Blink LED</Name>
<Description>Start blinking LED of 1,2,3</Description>
<Schedule>-1</Schedule>
<ControlType>1</ControlType>
<Devices>
<int>1</int>
<int>2</int>
<int>3</int>
</Devices>
<UserName>username</UserName>
<Password>password</Password>
</RESTLEDControlTask>
The attributes associated with the LED control type enumeration are defined in the following table.
Enum
Value
Description
0
Stop blinking LED
1
Start blinking LED
2.12.3 Task Start Time consideration
If the schedule field is set as part of the payload, then particular attention needs to be paid to the repeating time
field of the schedule. For example, if the schedule is specified as 46 22 */1 * * *, it would translate as follows:
46 : minute
22 : hour
*/1 : day of month
* : weekly
* : monthly
* : yearly
Therefore, the example translates to executing the task every day at 22:46 UTC. What this means is that
particular attention needs to be paid to the locale where this REST command is executed and the necessary
conversion to the hour field needs to be performed (conversion to UTC according to the locale) so that the right
execution hour is persisted in the database.
2.12.4 Task status and progress Information
<SPECIFIC_TASK_URI> =<BASE_URI>/Tasks/<SPECIFIC_TASK_ID>
The following resource URI can be used to query the task execution summary:
<SPECIFIC_TASK_URI>/ExecutionSummary
Operations supported: GET