TicketUserServices

<back to all web services

JobHeartbeatConfigureRequest

The following routes are available for this service:
PUT/JobHeartbeat/{JobName}
JobHeartbeatConfigureRequest Parameters:
NameParameterData TypeRequiredDescription
JobNamepathstringNo
ExpectedIntervalMinutesbodyint?No
DescriptionbodystringNo
Enabledbodybool?No
JobHeartbeatResult Parameters:
NameParameterData TypeRequiredDescription
ItemformJobHeartbeatNo
StatusCodeformintNo
MessageformstringNo
JobHeartbeat Parameters:
NameParameterData TypeRequiredDescription
JobNameformstringNo
DescriptionformstringNo
ExpectedIntervalMinutesformintNo
LastRunAtformDateTime?No
LastOkAtformDateTime?No
LastResultJsonformstringNo
ItemsProcessedformlong?No
ConsecutiveFailuresformintNo
EnabledformboolNo
UpdatedAtformDateTimeNo

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
}