White Papers

/api/GroupService
6 MX7000 Deployment of Management Module Network using the LCD control panel |
Document ID
The Id for each device can further be used when performing certain actions on devices such as power control
operations, blink actions, firmware updates and more. Additional information on how the device ID is used to
run an action or ‘Job’ can be found in /api/JobService section.
The other URI’s within /api/DeviceService/ are useful to translate enumeration codes for certain attributes in
the /api/DeviceService/Devices URI.
When the state of a device is not healthy, the associated Fault (or error messages that explain why the health
state is either Critical or Warning) can be found under the SubSystemHealth link of the Device resource.
/api/GroupService
A group can be created containing different devices or subgroups. The group can be viewed, re-configured,
deleted, and user privileges can be set.
/api/JobService
This api provides a path to execute certain Actions on the Devices or Group of Devices. Each Action shall
have a Job ID allocated to it upon invocation and the status of the job can be monitored within
/api/JobService/Jobs(ID).
The different type of jobs that can be created can be seen using /api/JobService/JobTypes. Each job creation
requires a payload that includes the attributes Job Type, Target Type (Device or Group), Target ID (Device ID
or Group ID) (refer to /api/DeviceService/Devices & /api/GroupService/Groups section) and other attributes
specific to the Job Type.
Actions that can be executed on JobService are
1. Create
2. Stop
3. Delete
4. Enable
5. Disable
Example of Job Execution
Power Cycle Cold Boot – JobType DeviceAction_Task
The following information needs to be filled`
x Authorization type: Basic Auth
x Username and Password information
x JSON content with the link is in the picture below. Data should be raw with
‘JSON(application/json) applied. Line ‘Id”: 25015 is the device Id on which the user intends to
perform the operation.
x The Action next to the URI is ‘POST’
x Click ‘Send’ blue button
x Return code of the https RESTful job can be found in ‘Status’
x The HTTP Headers from the response shall contain an Id allocated for the Job. The Job can be
monitored within /api/JobService/Jobs(Id)