TicketUserServices

<back to all web services

JobHeartbeatReportRequest

The following routes are available for this service:
POST/JobHeartbeat

export class JobHeartbeat
{
    // @StringLength(100)
    public jobName?: string;

    // @StringLength(400)
    public description?: string;

    public expectedIntervalMinutes?: number;
    public lastRunAt?: string;
    public lastOkAt?: string;
    // @StringLength(2147483647)
    public lastResultJson?: string;

    public itemsProcessed?: number;
    public consecutiveFailures?: number;
    public enabled?: boolean;
    public updatedAt?: string;

    public constructor(init?: Partial<JobHeartbeat>) { (Object as any).assign(this, init); }
}

export class JobHeartbeatResult
{
    public item?: JobHeartbeat;
    public statusCode?: number;
    public message?: string;

    public constructor(init?: Partial<JobHeartbeatResult>) { (Object as any).assign(this, init); }
}

export class JobHeartbeatReportRequest
{
    public jobName?: string;
    public phase?: string;
    public expectedIntervalMinutes?: number;
    public description?: string;
    public itemsProcessed?: number;
    public resultJson?: string;

    public constructor(init?: Partial<JobHeartbeatReportRequest>) { (Object as any).assign(this, init); }
}

TypeScript JobHeartbeatReportRequest 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.

POST /JobHeartbeat HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"jobName":"String","phase":"String","expectedIntervalMinutes":0,"description":"String","itemsProcessed":0,"resultJson":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"item":{"jobName":"String","description":"String","expectedIntervalMinutes":0,"lastRunAt":"0001-01-01T00:00:00.0000000","lastOkAt":"0001-01-01T00:00:00.0000000","lastResultJson":"String","itemsProcessed":0,"consecutiveFailures":0,"enabled":false,"updatedAt":"0001-01-01T00:00:00.0000000"},"statusCode":0,"message":"String"}