CoreService

<back to all web services

CreatePatchingWindow

Patching - CRUD

Create a new patching window

Requires Authentication
Requires any of the roles:TenantReader, Admin, TenantAdmin
The following routes are available for this service:
POST/api/patching/windowsCreates a new patching window
POST/patching/windowsCreates a new patching window
import Foundation
import ServiceStack

/**
* Create a new patching window
*/
// @Api(Description="Create a new patching window")
// @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(PatchingWindowDto), StatusCode=201)
public class CreatePatchingWindow : IBaseRequest, IPost, IHasTenantName, Codable
{
    // @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
    // @Validate(Validator="NotEmpty")
    public var tenantName:String

    /**
    * Occurence of week day in the month
    */
    // @ApiMember(Description="Occurence of week day in the month", IsRequired=true)
    public var monthlyOccurence:MonthlyDayOccurence

    /**
    * The day of the week, when patching will happen
    */
    // @ApiMember(Description="The day of the week, when patching will happen", IsRequired=true)
    public var dayOfWeek:DayOfWeek

    /**
    * The time, when the patching window will start
    */
    // @ApiMember(DataType="string", Description="The time, when the patching window will start", Format="time", IsRequired=true, ParameterType="body")
    @TimeSpan public var timeOfDay:TimeInterval

    /**
    * The max duration (hours) of the window wherein patchings can be started
    */
    // @ApiMember(DataType="string", Description="The max duration (hours) of the window wherein patchings can be started", Format="time", ParameterType="body")
    @TimeSpan public var duration:TimeInterval?

    /**
    * It's the default patching window for new resource groups
    */
    // @ApiMember(DataType="boolean", Description="It's the default patching window for new resource groups", ParameterType="body")
    public var isDefault:Bool

    required public init(){}
}

public enum MonthlyDayOccurence : Int, Codable
{
    case First = 1
    case Second = 2
    case Third = 3
    case Fourth = 4
}

public class PatchingWindowDto : Codable
{
    public var id:String
    public var name:String
    public var dayOfWeek:DayOfWeek
    public var monthlyOccurence:MonthlyDayOccurence
    @TimeSpan public var timeOfDay:TimeInterval
    @TimeSpan public var duration:TimeInterval
    public var isDefault:Bool

    required public init(){}
}


Swift CreatePatchingWindow DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/patching/windows HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"tenantName":"String","monthlyOccurence":"First","dayOfWeek":"Sunday","timeOfDay":"00:00:00","duration":"00:00:00","isDefault":false,"txId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"id":"00000000-0000-0000-0000-000000000000","name":"String","dayOfWeek":"Sunday","monthlyOccurence":"First","timeOfDay":"00:00:00","duration":"00:00:00","isDefault":false}