TicketUserServices

<back to all web services

JobHeartbeatConfigureRequest

The following routes are available for this service:
PUT/JobHeartbeat/{JobName}

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 JobHeartbeatConfigureRequest
{
    public jobName?: string;
    public expectedIntervalMinutes?: number;
    public description?: string;
    public enabled?: boolean;

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

TypeScript JobHeartbeatConfigureRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /JobHeartbeat/{JobName} HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	jobName: String,
	expectedIntervalMinutes: 0,
	description: String,
	enabled: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	item: 
	{
		jobName: String,
		description: String,
		expectedIntervalMinutes: 0,
		lastRunAt: 0001-01-01,
		lastOkAt: 0001-01-01,
		lastResultJson: String,
		itemsProcessed: 0,
		consecutiveFailures: 0,
		enabled: False,
		updatedAt: 0001-01-01
	},
	statusCode: 0,
	message: String
}