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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


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

    @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
    @Validate(Validator="NotEmpty")
    override var tenantName:String? = null
}

open class PatchingWindowDto
{
    open var id:UUID? = null
    open var name:String? = null
    open var dayOfWeek:DayOfWeek? = null
    open var monthlyOccurence:MonthlyDayOccurence? = null
    open var timeOfDay:TimeSpan? = null
    open var duration:TimeSpan? = null
    open var isDefault:Boolean? = null
}

enum class MonthlyDayOccurence(val value:Int)
{
    First(1),
    Second(2),
    Third(3),
    Fourth(4),
}

Kotlin 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}