minor changes to response on put operations

Author: ehrnst

SCOM API/Controllers/SCOMAlertController.cs

@@ -160,9 +160,10 @@ public IList<MonitoringAlert> GetAlertByMonitoringObjectId(Guid MonitoringObject
         /// 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>))]
+        [ResponseType(typeof(HttpResponseMessage))]
         [Route("Alerts/{Id:Guid}")]
-        public IList<MonitoringAlert> UpdateAlertById([FromUri()]Guid Id, [FromBody()] SCOMAlertUpdateModel Properties)
+        //public IList<MonitoringAlert> UpdateAlertById([FromUri()]Guid Id, [FromBody()] SCOMAlertUpdateModel Properties)
+        public IHttpActionResult UpdateAlertById([FromUri()]Guid Id, [FromBody()] SCOMAlertUpdateModel Properties)
         {
             if (Id == Guid.Empty)
             {
@@ -246,7 +247,8 @@ public IList<MonitoringAlert> UpdateAlertById([FromUri()]Guid Id, [FromBody()] S
                 }
 
             }
-            return alerts;
+            // creating OK response
+            return Ok(new { message = "Updated ticket", ticketId = Id.ToString() });
 
         }
 

SCOM API/Controllers/SCOMMaintenanceController.cs

@@ -16,6 +16,7 @@
 using System.Configuration;
 using System.Web.Http.Description;
 using Microsoft.EnterpriseManagement.Monitoring.MaintenanceSchedule;
+using Swashbuckle.Swagger.Annotations;
 
 namespace SCOM_API.Controllers
 {
@@ -59,7 +60,7 @@ public IHttpActionResult EnableComputerMaintenance(SCOMComputerMaintenanceModel
 
             List<SCOMComputerMaintenanceModel> MaintenanceComputers = new List<SCOMComputerMaintenanceModel>();
 
-            ///travers trough all classes to get monitoring objects
+            //travers trough all classes to get monitoring objects
             foreach (ManagementPackClass monClass in monClasses)
             {
                 monObjects.AddRange(mg.EntityObjects.GetObjectReader<MonitoringObject>(criteria, ObjectQueryOptions.Default));
@@ -111,8 +112,6 @@ public IHttpActionResult EnableComputerMaintenance(SCOMComputerMaintenanceModel
 
 
 
-
-
         /// <summary>
         /// Puts the specified monitoring object in maintenance mode.
         /// </summary>
@@ -190,14 +189,92 @@ public IHttpActionResult EnableObjectMaintenance(SCOMObjectMaintenanceModel Data
 
         }
 
+        /// <summary>
+        /// Updates or ends existing maintenance mode for object.
+        /// </summary>
+        /// <param name="Data">Json string with object id and new endTime</param>
+        /// <param name="EndNow">If true, maintenance will end</param>
+        /// <example>
+        /// {
+        ///     "id": "Guid",
+        ///     "EndTime": "2017-07-07T19:00:00.000Z"
+        /// }
+        /// </example>
+        /// <response code="200">Successfully updated maintenance mode</response>
+        /// <response code="400">Bad request. Check json input</response>
+        /// <response code="304">Object not in maintenance. Nothing to update</response>
+
+        [HttpPut]
+        [SwaggerResponse(HttpStatusCode.OK, "Object maintenance mode updated")]
+        [ResponseType(typeof(HttpResponseMessage))]
+        [Route("API/ObjectMaintenance")]
+        public IHttpActionResult UpdateObjectMaintenance(SCOMUpdateObjectMaintenanceModel Data, bool EndNow = false)
+        {
+            //Validate input
+            if (ModelState.IsValid)
+            {
+                //create a Guid from the json input
+                var ObjectId = new Guid(Data.id);
+                //get the monitoring object by Guid
+                var monObject = mg.EntityObjects.GetObject<MonitoringObject>(ObjectId, ObjectQueryOptions.Default);
+
+                //If object not in maintenance not modified
+                if (!monObject.InMaintenanceMode)
+                {
+                    {
+                        HttpResponseMessage res = new HttpResponseMessage(HttpStatusCode.NotModified);
+                        res.Content = new StringContent("Specified object not in maintenance mode. Nothing to update...");
+                        throw new HttpResponseException(res);
+                    }
+                }
+
+                //If object in maintenanance update
+                else
+                {
+                    //If endNow parameter validate true. End maintenance mode
+                    if (EndNow.Equals(true))
+                    {
+                        monObject.StopMaintenanceMode(DateTime.UtcNow, TraversalDepth.Recursive);
+
+                    }
+
+                    // Get the maintenance window
+                    MaintenanceWindow MaintenanceWindow = monObject.GetMaintenanceWindow();
+
+                    //If user specifies an end date
+                    if (Data.EndTime > DateTime.MinValue)
+                    {
+
+                        //Compare specified end time with current maintenance end time
+                        int TimeCompare = DateTime.Compare(Data.EndTime, MaintenanceWindow.ScheduledEndTime);
+                        //Update end time but use same reason and comment
+                        monObject.UpdateMaintenanceMode(Data.EndTime, MaintenanceWindow.Reason, MaintenanceWindow.Comments);
+                    }
+
+                }
+                // creating OK response
+                return Ok(new { message = "Updated maintenance mode", monitoringObjectId = Data.id });
+
+            }
+
+            // throw error message
+            else
+            {
+                HttpResponseMessage res = new HttpResponseMessage(HttpStatusCode.BadRequest);
+                res.Content = new StringContent("Please check request body");
+                throw new HttpResponseException(res);
+            }
+        }
+
+
         /// <summary>
         /// Creates a new maintenance schedule with the specified monitoring objects.
         /// </summary>
-        /// <param name="Data">Json string scheduleName, object ids, StartTime, EndTime, comment</param>
+        /// <param name="Data">scheduleName, object ids, StartTime, EndTime, comment are mandatory</param>
         /// <example>
         /// {
         ///     "scheduleName": "string",
-        ///     "id": "[monitoringObjectId]",
+        ///     "id": "[monitoringObjectId's]",
         ///     "StartTime": "2017-05-22T07:01:00.374Z",
         ///     "EndTime": "2017-05-22T08:01:00.374Z",
         ///     "comment": "doing maintenance"
@@ -233,7 +310,6 @@ public IHttpActionResult ScheduleObjectMaintenance(SCOMObjectSchedMaintenanceMod
 
                 ObjectList.Add(item);
             }
-            //
 
             //create a recurrencePattern this is 'sourced' from OmCommands.10.dll ( new-scommaintenanceSchedule CMDLET )
             //read more: https://docs.microsoft.com/en-us/powershell/systemcenter/systemcenter2016/operationsmanager/vlatest/new-scommaintenanceschedule
@@ -263,10 +339,11 @@ public IHttpActionResult ScheduleObjectMaintenance(SCOMObjectSchedMaintenanceMod
             var shed = MaintenanceSchedule.GetMaintenanceScheduleById(guid, mg);
             List<SCOMObjectSchedMaintenanceModel> MaintenanceScheduleList = new List<SCOMObjectSchedMaintenanceModel>();
             SCOMObjectSchedMaintenanceModel mSched = new SCOMObjectSchedMaintenanceModel();
+            mSched.scheduleId = guid;
+            mSched.scheduleName = shed.ScheduleName;
             mSched.id = array;
             mSched.StartTime = shed.ActiveStartTime;
             mSched.EndTime = shed.ScheduledEndTime;
-            mSched.scheduleName = shed.ScheduleName;
             mSched.comment = shed.Comments;
 
             MaintenanceScheduleList.Add(mSched);
@@ -276,5 +353,6 @@ public IHttpActionResult ScheduleObjectMaintenance(SCOMObjectSchedMaintenanceMod
 
         }
 
+
     }
 }//END

SCOM API/Models/SCOMObjectMaintenanceModel.cs

@@ -15,6 +15,7 @@ public class SCOMObjectMaintenanceModel
         public string id { get; set; }
 
         public string displayName { get; set; }
+
         /// <summary>
         /// Minutes to maintenance
         /// </summary>
@@ -27,4 +28,24 @@ public class SCOMObjectMaintenanceModel
         /// </summary>
         public string comment { get; set; }
     }
+
+    public class SCOMUpdateObjectMaintenanceModel
+    {
+        /// <summary>
+        /// Monitoring object id
+        /// </summary>
+        [Required(ErrorMessage = "Please provide object guid")]
+        public string id { get; set; }
+
+        /// <summary>
+        /// New endtime for the maintenance
+        /// </summary>
+        [Required(ErrorMessage = "End time is required")]
+        public DateTime EndTime { get; set; }
+
+        /// <summary>
+        /// comment for the maintenance
+        /// </summary>
+        public string comment { get; set; }
+    }
 }

SCOM API/Models/SCOMObjectScheduleMaintenanceModel.cs

@@ -8,30 +8,40 @@ namespace SCOM_API.Models
 {
     public class SCOMObjectSchedMaintenanceModel
     {
+        /// <summary>
+        /// Guid for the maintenance schedule
+        /// </summary>
+        /// remarks GUID will be created
+        public Guid scheduleId { get; set; }
+
         /// <summary>
         /// Name of the maintenance schedule
         /// </summary>
         [Required]
         public string scheduleName { get; set; }
-        [Required]
+
         /// <summary>
         /// Monitoring object ID(s)
         /// </summary>
-        public string[] id { get; set; }
         [Required]
+        public string[] id { get; set; }
+
         /// <summary>
         /// Start time and date
         /// </summary>
-        public DateTime StartTime { get; set; }
         [Required]
+        public DateTime StartTime { get; set; }
+
         /// <summary>
         /// End time and date
         /// </summary>
-        public DateTime EndTime { get; set; }
         [Required]
+        public DateTime EndTime { get; set; }
+
         /// <summary>
         /// Comment
         /// </summary>
+        [Required]
         public string comment { get; set; }
     }
 }