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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateDto:
    id: Optional[str] = None
    name: Optional[str] = None
    severity: Optional[str] = None
    """
    The severity of the vulnerability this update fixes (e.g. Critical, Important, Moderate, etc.)
    """

    published: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    The time the update was first published
    """

    classifications: Optional[List[str]] = None
    """
    Update classification/type (e.g. Critical Update, Definition Update, Security Update, etc.)
    """

    is_reboot_required: bool = False
    """
    Whether the update needs a reboot or not
    """

    ext_id: Optional[str] = None
    """
    In case of windows this is the KB id
    """

    version: Optional[str] = None
    """
    In case of linux this is the update package version
    """


# @Api(Description="Returns a single update by its id")
# @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(UpdateDto), StatusCode=200)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetUpdate(IBaseRequest, IHasId, IHasTenantName, IGet):
    """
    Returns a single update by its id
    """

    # @ApiMember(DataType="string", Description="The primary key of every config item", Format="guid", IsRequired=true, ParameterType="path")
    id: Optional[str] = None
    """
    The primary key of every config item
    """


    # @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
    # @Validate(Validator="NotEmpty")
    tenant_name: Optional[str] = None

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