| Required role: | TenantReader |
| GET | /api/jobevents/{Id} | Returns the jobevent | |
|---|---|---|---|
| GET | /jobevents/{Id} | Returns the jobevent |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | string | Yes | |
| TenantName | header | string | Yes | |
| IncludeDeleted | query | bool? | No | If true, also soft deleted items will be returned |
| IncludeReferencedObjects | query | bool? | No | Returns all referenced object |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | The id of the job |
| TenantId | form | Guid | No | The id of the the tenant |
| JobId | form | Guid | No | The id of the parent job |
| Name | form | string | Yes | The name of the event. Events will be grouped on the name |
| ObjectType | form | ObjectTypes | No | |
| State | form | JobEventStates | No | The current state of the event |
| StartTime | form | DateTime | No | Start time of the event |
| EndTime | form | DateTime? | No | End time of the event (optional) |
| Message | form | string | Yes | A message with details to the current state |
| SelfLink | form | string | Yes | Api link pointing to this object |
| Duration | form | int | No | The duration (in seconds) of the job event |
| 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 |
| 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
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}