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
namespace CoreService.ServiceModel.Dtos.Patching.Crud

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type MonthlyDayOccurence =
        | First = 1
        | Second = 2
        | Third = 3
        | Fourth = 4

    [<AllowNullLiteral>]
    type PatchingWindowDto() = 
        member val Id:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val DayOfWeek:DayOfWeek = new DayOfWeek() with get,set
        member val MonthlyOccurence:MonthlyDayOccurence = new MonthlyDayOccurence() with get,set
        member val TimeOfDay:TimeOnly = new TimeOnly() with get,set
        member val Duration:TimeSpan = new TimeSpan() with get,set
        member val IsDefault:Boolean = new Boolean() with get,set

    ///<summary>
    ///Create a new patching window
    ///</summary>
    [<Api(Description="Create a new patching window")>]
    [<ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof<PatchingWindowDto>, StatusCode=201)>]
    [<AllowNullLiteral>]
    type CreatePatchingWindow() = 
        interface IPost
        [<ApiMember(DataType="string", IsRequired=true, ParameterType="header")>]
        [<Validate(Validator="NotEmpty")>]
        member val TenantName:String = null with get,set

        ///<summary>
        ///Occurence of week day in the month
        ///</summary>
        [<ApiMember(Description="Occurence of week day in the month", IsRequired=true)>]
        member val MonthlyOccurence:MonthlyDayOccurence = new MonthlyDayOccurence() with get,set

        ///<summary>
        ///The day of the week, when patching will happen
        ///</summary>
        [<ApiMember(Description="The day of the week, when patching will happen", IsRequired=true)>]
        member val DayOfWeek:DayOfWeek = new DayOfWeek() with get,set

        ///<summary>
        ///The time, when the patching window will start
        ///</summary>
        [<ApiMember(DataType="string", Description="The time, when the patching window will start", Format="time", IsRequired=true, ParameterType="body")>]
        member val TimeOfDay:TimeOnly = new TimeOnly() with get,set

        ///<summary>
        ///The max duration (hours) of the window wherein patchings can be started
        ///</summary>
        [<ApiMember(DataType="string", Description="The max duration (hours) of the window wherein patchings can be started", Format="time", ParameterType="body")>]
        member val Duration:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set

        ///<summary>
        ///It's the default patching window for new resource groups
        ///</summary>
        [<ApiMember(DataType="boolean", Description="It's the default patching window for new resource groups", ParameterType="body")>]
        member val IsDefault:Boolean = new Boolean() with get,set

F# 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}