CoreService

<back to all web services

GetUpdate

Patching - CRUD

Returns a single update by its id

Requires Authentication
Requires the role:TenantReader
The following routes are available for this service:
GET/api/patching/updates/{Id}Returns a single update by its id
GET/patching/updates/{Id}Returns a single update by its id
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

    [<AllowNullLiteral>]
    type UpdateDto() = 
        member val Id:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        ///<summary>
        ///The severity of the vulnerability this update fixes (e.g. Critical, Important, Moderate, etc.)
        ///</summary>
        member val Severity:String = null with get,set

        ///<summary>
        ///The time the update was first published
        ///</summary>
        member val Published:DateTime = new DateTime() with get,set

        ///<summary>
        ///Update classification/type (e.g. Critical Update, Definition Update, Security Update, etc.)
        ///</summary>
        member val Classifications:ResizeArray<String> = null with get,set

        ///<summary>
        ///Whether the update needs a reboot or not
        ///</summary>
        member val IsRebootRequired:Boolean = new Boolean() with get,set

        ///<summary>
        ///In case of windows this is the KB id
        ///</summary>
        member val ExtId:String = null with get,set

        ///<summary>
        ///In case of linux this is the update package version
        ///</summary>
        member val Version:String = null with get,set

    ///<summary>
    ///Returns a single update by its id
    ///</summary>
    [<Api(Description="Returns a single update by its id")>]
    [<ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof<UpdateDto>, StatusCode=200)>]
    [<AllowNullLiteral>]
    type GetUpdate() = 
        interface 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")>]
        member val Id:Guid = new Guid() with get,set

        [<ApiMember(DataType="string", IsRequired=true, ParameterType="header")>]
        [<Validate(Validator="NotEmpty")>]
        member val TenantName:String = null with get,set

F# GetUpdate 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/updates/{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","severity":"String","published":"0001-01-01T00:00:00.0000000Z","classifications":["String"],"isRebootRequired":false,"extId":"String","version":"String"}