CoreService

<back to all web services

GetJobEvent

JobEvent - CRUD

Get jobevent

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/jobevents/{Id}Returns the jobevent
GET/jobevents/{Id}Returns the jobevent
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get jobevent
*/
@Api(Description="Get jobevent")
@ApiResponse(Description="The request endend successful", IsDefaultResponse=true, ResponseType=JobEventDto::class, StatusCode=200)
open class GetJobEvent : IGetSingleRequest, IHasTenantName, IGet
{
    @ApiMember(DataType="string", Format="guid", IsRequired=true, ParameterType="path")
    @Validate(Validator="NotEmpty")
    open var id:UUID? = null

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

    /**
    * If true, also soft deleted items will be returned
    */
    @ApiMember(Description="If true, also soft deleted items will be returned", ParameterType="query")
    override var includeDeleted:Boolean? = null

    /**
    * Returns all referenced object
    */
    @ApiMember(Description="Returns all referenced object", ParameterType="query")
    override var includeReferencedObjects:Boolean? = null
}

open class JobEventDto : IHasIdName, IHasTenantId, IHasObjectType
{
    /**
    * The id of the job
    */
    open var id:UUID? = null
    /**
    * The id of the the tenant
    */
    override var tenantId:UUID? = null
    /**
    * The id of the parent job
    */
    open var jobId:UUID? = null
    /**
    * The name of the event. Events will be grouped on the name
    */
    override var name:String? = null
    override var objectType:ObjectTypes? = null
    /**
    * The current state of the event
    */
    open var state:JobEventStates? = null
    /**
    * Start time of the event
    */
    open var startTime:Date? = null
    /**
    * End time of the event (optional)
    */
    open var endTime:Date? = null
    /**
    * A message with details to the current state
    */
    open var message:String? = null
    /**
    * Api link pointing to this object
    */
    open var selfLink:String? = null
    /**
    * The duration (in seconds) of the job event
    */
    open var duration:Int? = null
}

enum class ObjectTypes
{
    None,
    ConfigItem,
    Tenant,
    Collection,
    Resource,
    ComputeNode,
    VirtualMachine,
    PhysicalMachine,
    Disk,
    Subnet,
    IpAddress,
    Job,
    JobEvent,
    FreezePeriod,
    ResourceGroup,
    Deployment,
    ResourceGroupTemplate,
    DeploymentTemplate,
    ResourceProvider,
    GenericResource,
    Role,
    Permission,
    User,
    PatchingWindow,
    Update,
    ReportDefinition,
    TimeSeries,
    DataPoint,
    Action,
    ActionAssignment,
    UserNote,
}

enum class JobEventStates
{
    Started,
    Skipped,
    Completed,
    Failed,
}

Kotlin GetJobEvent 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/jobevents/{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","tenantId":"00000000-0000-0000-0000-000000000000","jobId":"00000000-0000-0000-0000-000000000000","name":"String","objectType":"JobEvent","state":"Started","startTime":"0001-01-01T00:00:00.0000000Z","endTime":"0001-01-01T00:00:00.0000000Z","message":"String","selfLink":"String","duration":0}