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
"use strict";
/** @typedef {'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'} */
export var ObjectTypes;
(function (ObjectTypes) {
    ObjectTypes["None"] = "None"
    ObjectTypes["ConfigItem"] = "ConfigItem"
    ObjectTypes["Tenant"] = "Tenant"
    ObjectTypes["Collection"] = "Collection"
    ObjectTypes["Resource"] = "Resource"
    ObjectTypes["ComputeNode"] = "ComputeNode"
    ObjectTypes["VirtualMachine"] = "VirtualMachine"
    ObjectTypes["PhysicalMachine"] = "PhysicalMachine"
    ObjectTypes["Disk"] = "Disk"
    ObjectTypes["Subnet"] = "Subnet"
    ObjectTypes["IPAddress"] = "IPAddress"
    ObjectTypes["Job"] = "Job"
    ObjectTypes["JobEvent"] = "JobEvent"
    ObjectTypes["FreezePeriod"] = "FreezePeriod"
    ObjectTypes["ResourceGroup"] = "ResourceGroup"
    ObjectTypes["Deployment"] = "Deployment"
    ObjectTypes["ResourceGroupTemplate"] = "ResourceGroupTemplate"
    ObjectTypes["DeploymentTemplate"] = "DeploymentTemplate"
    ObjectTypes["ResourceProvider"] = "ResourceProvider"
    ObjectTypes["GenericResource"] = "GenericResource"
    ObjectTypes["Role"] = "Role"
    ObjectTypes["Permission"] = "Permission"
    ObjectTypes["User"] = "User"
    ObjectTypes["PatchingWindow"] = "PatchingWindow"
    ObjectTypes["Update"] = "Update"
    ObjectTypes["ReportDefinition"] = "ReportDefinition"
    ObjectTypes["TimeSeries"] = "TimeSeries"
    ObjectTypes["DataPoint"] = "DataPoint"
    ObjectTypes["Action"] = "Action"
    ObjectTypes["ActionAssignment"] = "ActionAssignment"
    ObjectTypes["UserNote"] = "UserNote"
})(ObjectTypes || (ObjectTypes = {}));
/** @typedef {'Started'|'Skipped'|'Completed'|'Failed'} */
export var JobEventStates;
(function (JobEventStates) {
    JobEventStates["Started"] = "Started"
    JobEventStates["Skipped"] = "Skipped"
    JobEventStates["Completed"] = "Completed"
    JobEventStates["Failed"] = "Failed"
})(JobEventStates || (JobEventStates = {}));
export class JobEventDto {
    /** @param {{id?:string,tenantId?:string,jobId?:string,name?:string,objectType?:ObjectTypes,state?:JobEventStates,startTime?:string,endTime?:string,message?:string,selfLink?:string,duration?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The id of the job */
    id;
    /**
     * @type {string}
     * @description The id of the the tenant */
    tenantId;
    /**
     * @type {string}
     * @description The id of the parent job */
    jobId;
    /**
     * @type {string}
     * @description The name of the event. Events will be grouped on the name */
    name;
    /** @type {ObjectTypes} */
    objectType;
    /**
     * @type {JobEventStates}
     * @description The current state of the event */
    state;
    /**
     * @type {string}
     * @description Start time of the event */
    startTime;
    /**
     * @type {?string}
     * @description End time of the event (optional) */
    endTime;
    /**
     * @type {string}
     * @description A message with details to the current state */
    message;
    /**
     * @type {string}
     * @description Api link pointing to this object */
    selfLink;
    /**
     * @type {number}
     * @description The duration (in seconds) of the job event */
    duration;
}
export class GetJobEvent {
    /** @param {{id?:string,tenantName?:string,includeDeleted?:boolean,includeReferencedObjects?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    tenantName;
    /**
     * @type {?boolean}
     * @description If true, also soft deleted items will be returned */
    includeDeleted;
    /**
     * @type {?boolean}
     * @description Returns all referenced object */
    includeReferencedObjects;
}

JavaScript 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}