Merge pull request #12 from ehrnst/dev

Dev

Author: ehrnst

README.md

@@ -22,8 +22,9 @@ Bringing SCOM in to the 21. century with a Restful Web API.
 | ------ | ------ |
 | [GET] API/Alerts | Gets all open alerts |
 | [GET] API/Alert/{id} | Get a single alert |
-| [PUT] API/Alert | Update the specified alert with resolution state, TicketId |
-| [GET] API/Alert/{ComputerName} | Get all alert from specific computer, use IncClosed=true to include open and closed alerts |
+| [PUT] API/Alerts/{id} | Update the specified alert with common properties and resolution state |
+| [GET] API/Alert/Computer/{ComputerName} | Get all alert from specific computer, use IncClosed=true to include open and closed alerts |
+| [GET] API/Alert/MonitoringObject/{MonitoringObjectId} | Get all alert from specific monitoring object, use IncClosed=true to include open and closed alerts |
 
 ### Computer
 
@@ -50,6 +51,7 @@ Bringing SCOM in to the 21. century with a Restful Web API.
 | Route | Description |
 | ------ | ------ |
 | [GET] API/MonitoringObject/{id} | Get a monitoring object and all child object |
+| [GET] API/MonitoringObject/class/{classId} | Get all objects of a class. Limited properties returned. |
 
 
 ### Installation
@@ -59,3 +61,6 @@ Bringing SCOM in to the 21. century with a Restful Web API.
 - Set your application pool to use Network Service
 - Enable windows authentication (basic if needed)
 - Copy SCOM specific .dll's to the BIN folder where you extracted the .Zip
+
+### Remarks
+- Please note that versioning isn't implemented and current version have breaking changes to Alert endpoints. Please review the changes to get an understanding on how this affects your application. For first time users this is not a problem.

SCOM API/App_Start/WebApiConfig.cs

@@ -13,12 +13,14 @@ public static void Register(HttpConfiguration config)
             // Web API routes
             config.MapHttpAttributeRoutes();
 
+            
             config.Routes.MapHttpRoute(
                 name: "System Center Operations Manager API",
                 routeTemplate: "API/{controller}/{action}/{id}",
                 defaults: new { id = RouteParameter.Optional }
                 );
 
+
             // Web API configuration and services
             config.Filters.Add(new AuthorizeAttribute());
 

SCOM API/Controllers/SCOMAlertController.cs

@@ -14,6 +14,7 @@
 using System.Collections.ObjectModel;
 using Swashbuckle.AspNetCore.SwaggerGen;
 using System.Web.Http.Description;
+using SCOM_API.Models;
 
 namespace SCOM_API.Controllers
 {
@@ -79,7 +80,7 @@ public IList<MonitoringAlert> GetAlertById(Guid Id)
         /// <param name="ComputerName">FQDN of the windows computer</param>
         /// <param name="IncClosed">if true closed alert is also returned. Default is 'false'</param>
         [HttpGet]
-        [Route("Alerts/{ComputerName}")]
+        [Route("Alerts/Computer/{ComputerName}")]
         public IList<MonitoringAlert> GetAlertByComputerName(string ComputerName, bool? IncClosed = false)
         {
             if (string.IsNullOrEmpty(ComputerName))
@@ -93,7 +94,7 @@ public IList<MonitoringAlert> GetAlertByComputerName(string ComputerName, bool?
             {
                 //Set alert criteria
                 var Criteria = string.Format("MonitoringObjectPath = '{0}'", ComputerName);
-                ///Get alerts
+                //Get alerts
                 MonitoringAlertCriteria alertCriteria = new MonitoringAlertCriteria(Criteria);
                 var Alert = mg.OperationalData.GetMonitoringAlerts(alertCriteria, default(DateTime));
 
@@ -113,31 +114,74 @@ public IList<MonitoringAlert> GetAlertByComputerName(string ComputerName, bool?
         }
 
         /// <summary>
-        /// Updates the specified alert.
+        /// Get all alerts related to the specific monitoring object.
         /// </summary>
-        /// <param name="ResolutionState">If specified as 255 (closed) and alert is raised by monitor. The corresponding monitor will be reset</param>
-        /// <param name="TicketId">set if you want to update alert with a ticket id</param>
-        /// <param name="Id">the alert GUID</param>
+        /// <param name="MonitoringObjectId">SCOM GUID of the monitoring object</param>
+        /// <param name="IncClosed">if true closed alert is also returned. Default is 'false'</param>
+        [HttpGet]
+        [Route("Alerts/MonitoringObject/{MonitoringObjectId:Guid}")]
+        public IList<MonitoringAlert> GetAlertByMonitoringObjectId(Guid MonitoringObjectId, bool? IncClosed = false)
+        {
+            if (MonitoringObjectId == Guid.Empty)
+            {
+                throw new HttpResponseException(Request
+                .CreateResponse(HttpStatusCode.BadRequest));
+            }
+
+            //If include closed alerts
+            if (IncClosed == true)
+            {
+                //Set alert criteria
+                var Criteria = string.Format("MonitoringObjectId = '{0}'", MonitoringObjectId);
+                ///Get alerts
+                MonitoringAlertCriteria alertCriteria = new MonitoringAlertCriteria(Criteria);
+                var Alert = mg.OperationalData.GetMonitoringAlerts(alertCriteria, default(DateTime));
+
+                return Alert;
+            }
+
+            else
+            {
+                //set alert criteria
+                var Criteria = string.Format("MonitoringObjectId = '{0}' AND ResolutionState = 0", MonitoringObjectId);
+                //Get alerts
+                MonitoringAlertCriteria alertCriteria = new MonitoringAlertCriteria(Criteria);
+                var Alert = mg.OperationalData.GetMonitoringAlerts(alertCriteria, default(DateTime));
+
+                return Alert;
+            }
+        }
+
+        /// <summary>
+        /// Updates the specific alert.
+        /// </summary>
+        /// <param name="Properties">Json object to update alert properties.
+        /// All set properties are available.
+        /// For more information please see technet documentation "http://bit.ly/2zblZLh"</param>
+        /// <param name="Id">Specify alert guid you want to update</param>
         [HttpPut]
         [ResponseType(typeof(IEnumerable<MonitoringAlert>))]
-        [Route("Alerts")]
-        public IList<MonitoringAlert> UpdateAlertById(Guid Id, byte ResolutionState, string TicketId = "")
+        [Route("Alerts/{Id:Guid}")]
+        public IList<MonitoringAlert> UpdateAlertById([FromUri()]Guid Id, [FromBody()] SCOMAlertUpdateModel Properties)
         {
-            if (string.IsNullOrEmpty(ResolutionState.ToString()))
+            if (Id == Guid.Empty)
             {
                 throw new HttpResponseException(Request
                 .CreateResponse(HttpStatusCode.BadRequest));
             }
 
+            // Declare variables
+            var ResolutionState = Properties.resolutionState;
 
             //alert criteria
             var Criteria = string.Format("Id = '{0}'", Id);
             MonitoringAlertCriteria alertCriteria = new MonitoringAlertCriteria(Criteria);
             var alerts = mg.OperationalData.GetMonitoringAlerts(alertCriteria, default(DateTime));
+
             foreach (MonitoringAlert a in alerts)
             {
                 //If resolution state is set to closed and alert is raised by a monitor. Reset the monitor
-                if (a.IsMonitorAlert & ResolutionState.ToString() == "255")
+                if (a.IsMonitorAlert & ResolutionState == "255")
                 {
                     //Get object and monitor that raised the alert
                     Guid monitoringObjectId = a.MonitoringObjectId;
@@ -146,27 +190,59 @@ public IList<MonitoringAlert> UpdateAlertById(Guid Id, byte ResolutionState, str
                     var monObject = mg.EntityObjects.GetObject<MonitoringObject>(monitoringObjectId, ObjectQueryOptions.Default);
                     //reset the monitor to 'close' the alert
                     monObject.ResetMonitoringState(monitor);
-                    
+
                 }
+
+
                 else
                 {
-                    
-                    if (string.IsNullOrWhiteSpace(TicketId))
+
+                    if (string.IsNullOrEmpty(ResolutionState))
                     {
-                        a.ResolutionState = ResolutionState;
-                        string comment = "Changed resolution state (API)";
+                        a.TfsWorkItemId = Properties.tfsWorkItemId;
+                        a.TfsWorkItemOwner = Properties.tfsWorkItemOwner;
+                        a.Owner = Properties.owner;
+                        a.CustomField1 = Properties.customField1;
+                        a.CustomField2 = Properties.customField2;
+                        a.CustomField3 = Properties.customField3;
+                        a.CustomField4 = Properties.customField4;
+                        a.CustomField5 = Properties.customField5;
+                        a.CustomField6 = Properties.customField6;
+                        a.CustomField7 = Properties.customField7;
+                        a.CustomField8 = Properties.customField8;
+                        a.CustomField9 = Properties.customField9;
+                        a.CustomField10 = Properties.customField10;
+
+                        string comment = "Alert properties updated";
                         a.Update(comment);
 
                     }
-                    //If ticket id is specified.
+                    //If resolution state is specified
                     else
                     {
-                        a.ResolutionState = ResolutionState;
-                        a.TicketId = TicketId;
-                        string comment = "Changed resolution state and ticket id (API)";
+                        a.TfsWorkItemId = Properties.tfsWorkItemId;
+                        a.TfsWorkItemOwner = Properties.tfsWorkItemOwner;
+                        a.Owner = Properties.owner;
+                        a.CustomField1 = Properties.customField1;
+                        a.CustomField2 = Properties.customField2;
+                        a.CustomField3 = Properties.customField3;
+                        a.CustomField4 = Properties.customField4;
+                        a.CustomField5 = Properties.customField5;
+                        a.CustomField6 = Properties.customField6;
+                        a.CustomField7 = Properties.customField7;
+                        a.CustomField8 = Properties.customField8;
+                        a.CustomField9 = Properties.customField9;
+                        a.CustomField10 = Properties.customField10;
+
+                        //Convert string resolution state to byte type
+                        var Res = Convert.ToByte(ResolutionState);
+                        a.ResolutionState = Res;
+                        a.TicketId = Properties.ticketId;
+                        var comments = $"Updated and changed resolution state: {ResolutionState}";
+                        string comment = comments;
                         a.Update(comment);
                     }
-                    
+
                 }
 
             }

SCOM API/Controllers/SCOMObjectController.cs

@@ -14,9 +14,11 @@
 using System.Collections.ObjectModel;
 using SCOM_API.Models;
 using System.Configuration;
+using System.Web.Http.Description;
 
 namespace SCOM_API.Controllers
 {
+    [RoutePrefix("API/MonitoringObject")]
     public class SCOMObjectController : ApiController
     {
         ManagementGroup mg = null;
@@ -38,7 +40,7 @@ public SCOMObjectController()
         /// <response code="400">Bad request check Id</response>
         /// <response code="404">Object not found</response>
         [HttpGet]
-        [Route("API/MonitoringObject/{id}")]
+        [Route("{id}")]
         public IHttpActionResult GetMonitoringObject(Guid Id)
         {
             //Check if guid is not empty
@@ -53,11 +55,11 @@ public IHttpActionResult GetMonitoringObject(Guid Id)
 
             List<SCOMMonitoringObjectModel> MonitoringObject = new List<SCOMMonitoringObjectModel>();
 
-            if (monObject !=null)
+            if (monObject != null)
             {
                 //Get related objects
                 ReadOnlyCollection<PartialMonitoringObject> RelatedObjects = monObject.GetRelatedPartialMonitoringObjects();
-                
+
                 //Add properties
                 SCOMMonitoringObjectModel mObject = new SCOMMonitoringObjectModel();
                 mObject.id = monObject.Id;
@@ -86,20 +88,84 @@ public IHttpActionResult GetMonitoringObject(Guid Id)
                 mObject.relatedObjects = SCOMMonitoringObjectChildObjects;
 
                 MonitoringObject.Add(mObject);
-                
+
                 //Return object
                 return Json(MonitoringObject);
             }
 
             //If no object found return error code
             else
-            { 
-           
+            {
+
                 HttpResponseMessage message = new HttpResponseMessage(HttpStatusCode.NotFound);
                 message.Content = new StringContent("Monitoring object not found");
                 throw new HttpResponseException(message);
             }
         }
 
+        /// <summary>
+        ///Gets all monitoring objects of specified class
+        ///Limited properties returned. Use MonitoringObject/Id endpoint for more details
+        /// </summary>
+        ///<param name="classId">Your class guid</param>
+        /// <response code="200">OK: returns member of class</response>
+        /// <response code="204">class found but no objects / no members exist</response>
+        /// <response code="400">Bad request check classId</response>
+        /// <response code="404">No such class</response>
+
+        [Route("class/{classId}")]
+        [HttpGet]
+        [ResponseType(typeof(IEnumerable<SCOMClassObjectModel>))]
+        public IHttpActionResult GetClassPartialMonitoringObject(Guid classId)
+        {
+
+            if (classId == Guid.Empty)
+            {
+                throw new HttpResponseException(Request
+                .CreateResponse(HttpStatusCode.BadRequest));
+            }
+
+            //Use the input class id to create a criteria for our query
+            ManagementPackClassCriteria classCriteria = new ManagementPackClassCriteria(string.Format("Id = '{0}'", classId.ToString()));
+            IList<ManagementPackClass> monitoringClasses = mg.EntityTypes.GetClasses(classCriteria);
+
+
+            List<PartialMonitoringObject> inputClassObjects = new List<PartialMonitoringObject>();
+
+            IObjectReader<PartialMonitoringObject> reader = mg.EntityObjects.GetObjectReader<PartialMonitoringObject>(monitoringClasses[0], ObjectQueryOptions.Default);
+
+            inputClassObjects.AddRange(reader);
+
+            List<SCOMClassObjectModel> classObjects = new List<SCOMClassObjectModel>();
+
+            //If objects are found add them to list and return
+            if (inputClassObjects.Count > 0)
+            {
+
+                foreach (PartialMonitoringObject classObject in inputClassObjects)
+                {
+                    SCOMClassObjectModel inputClassObject = new SCOMClassObjectModel();
+                    inputClassObject.id = classObject.Id;
+                    inputClassObject.displayName = classObject.DisplayName;
+                    inputClassObject.healthState = classObject.HealthState.ToString();
+                    inputClassObject.path = classObject.Path;
+
+                    classObjects.Add(inputClassObject);
+                }
+
+                return Json(classObjects);
+            }
+
+            //if class does not have any monitoring objects return 'no content'
+            else
+            {
+                HttpResponseMessage message = new HttpResponseMessage(HttpStatusCode.NoContent);
+                message.Content = new StringContent("Class found but no object exist");
+                throw new HttpResponseException(message);
+            }
+
+        }
     }
-}//END
+
+}
+//END