TicketUserServices

<back to all web services

JobHeartbeatReportRequest

The following routes are available for this service:
POST/JobHeartbeat
JobHeartbeatReportRequest Parameters:
NameParameterData TypeRequiredDescription
JobNamebodystringNo
PhasebodystringNo
ExpectedIntervalMinutesbodyint?No
DescriptionbodystringNo
ItemsProcessedbodylong?No
ResultJsonbodystringNo
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 .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"}