| Requires the role: | TenantReader |
| 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 |
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CoreService.ServiceModel.Dtos.Patching.Crud
Imports CoreService.ServiceModel.Dtos.Patching.Responses
Imports CoreService.ServiceModel.Enums
Namespace Global
Namespace CoreService.ServiceModel.Dtos.Patching.Crud
'''<Summary>
'''Returns a single patching window by its id
'''</Summary>
<Api(Description:="Returns a single patching window by its id")>
<ApiResponse(Description:="Success", IsDefaultResponse:=true, ResponseType:=GetType(PatchingWindowDto), StatusCode:=200)>
Public Partial Class GetPatchingWindow
Implements IBaseRequest
Implements IHasId
Implements IHasTenantName
Implements IGet
'''<Summary>
'''The primary key of every config item
'''</Summary>
<ApiMember(DataType:="string", Description:="The primary key of every config item", Format:="guid", IsRequired:=true, ParameterType:="path")>
Public Overridable Property Id As Guid Implements IHasId.Id
<ApiMember(DataType:="string", IsRequired:=true, ParameterType:="header")>
<Validate(Validator:="NotEmpty")>
Public Overridable Property TenantName As String Implements IHasTenantName.TenantName
End Class
End Namespace
Namespace CoreService.ServiceModel.Dtos.Patching.Responses
Public Partial Class PatchingWindowDto
Public Overridable Property Id As Guid
Public Overridable Property Name As String
Public Overridable Property DayOfWeek As DayOfWeek
Public Overridable Property MonthlyOccurence As MonthlyDayOccurence
Public Overridable Property TimeOfDay As TimeOnly
Public Overridable Property Duration As TimeSpan
Public Overridable Property IsDefault As Boolean
End Class
End Namespace
Namespace CoreService.ServiceModel.Enums
Public Enum MonthlyDayOccurence
First = 1
Second = 2
Third = 3
Fourth = 4
End Enum
End Namespace
End Namespace
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
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}