CoreService

<back to all web services

GetPatchingWindow

Patching - CRUD

Returns a single patching window by its id

Requires Authentication
Requires the role:TenantReader
The following routes are available for this service:
GET/api/patching/windows/{Id}Returns a single patching window by its id
GET/patching/windows/{Id}Returns a single patching window by its id
import Foundation
import ServiceStack

/**
* Returns a single patching window by its id
*/
// @Api(Description="Returns a single patching window by its id")
// @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(PatchingWindowDto), StatusCode=200)
public class GetPatchingWindow : IBaseRequest, IHasId, IHasTenantName, IGet, Codable
{
    /**
    * The primary key of every config item
    */
    // @ApiMember(DataType="string", Description="The primary key of every config item", Format="guid", IsRequired=true, ParameterType="path")
    public var id:String

    // @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
    // @Validate(Validator="NotEmpty")
    public var tenantName:String

    required public init(){}
}

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(){}
}

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


Swift GetPatchingWindow 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.

GET /api/patching/windows/{Id} HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
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}