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
GetJobEvent Parameters:
NameParameterData TypeRequiredDescription
IdpathstringYes
TenantNameheaderstringYes
IncludeDeletedquerybool?NoIf true, also soft deleted items will be returned
IncludeReferencedObjectsquerybool?NoReturns all referenced object
JobEventDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNoThe id of the job
TenantIdformGuidNoThe id of the the tenant
JobIdformGuidNoThe id of the parent job
NameformstringYesThe name of the event. Events will be grouped on the name
ObjectTypeformObjectTypesNo
StateformJobEventStatesNoThe current state of the event
StartTimeformDateTimeNoStart time of the event
EndTimeformDateTime?NoEnd time of the event (optional)
MessageformstringYesA message with details to the current state
SelfLinkformstringYesApi link pointing to this object
DurationformintNoThe duration (in seconds) of the job event
ObjectTypes Enum:
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
JobEventStates Enum:
Started
Skipped
Completed
Failed

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}