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


/**
* Returns a single update by its id
*/
@Api(Description="Returns a single update by its id")
@ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=UpdateDto::class, StatusCode=200)
open class GetUpdate : 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 UpdateDto
{
    open var id:UUID? = null
    open var name:String? = null
    /**
    * The severity of the vulnerability this update fixes (e.g. Critical, Important, Moderate, etc.)
    */
    open var severity:String? = null
    /**
    * The time the update was first published
    */
    open var published:Date? = null
    /**
    * Update classification/type (e.g. Critical Update, Definition Update, Security Update, etc.)
    */
    open var classifications:ArrayList<String>? = null
    /**
    * Whether the update needs a reboot or not
    */
    open var isRebootRequired:Boolean? = null
    /**
    * In case of windows this is the KB id
    */
    open var extId:String? = null
    /**
    * In case of linux this is the update package version
    */
    open var version:String? = null
}

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