Pulse¶

REST Overview
Jobs	Job Reports	Groups	Pools	Limits	Repository	Pulse	Workers	Tasks	Task Reports	Users

Overview ¶

Pulse requests can be used to set and retrieve Pulse information using GET and PUT.

POST and DELETE are not supported and sending a message of either of these types will result in a 501 Not Implemented Error message.

For more about these request types and their uses see the Request Formats and Responses documentation.

List of possible requests for Pulse.

Gets all the Pulse names.


URL:	http://hostname:portnumber/api/pulse?NamesOnly=true
Request Type:	GET
Message Body:	N/A
Response:	JSON object containing all the Pulse names.
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code.

Gets the Pulse information for the Pulse names provided.


URL:	http://hostname:portnumber/api/pulse?Info=true&Names=oneOrMorePulseNames http://hostname:portnumber/api/pulse?Info=true&Name=onePulseName
Request Type:	GET
Message Body:	N/A
Response:	JSON object containing all the Pulse information for the requested Pulse names.
Possible Errors:	404 Not Found: Pulse name provided does not exist (can only occur if you use Name= ) 500 Internal Server Error: An exception occurred within the Deadline code.

Saves the Pulse information provided.


URL:	http://hostname:portnumber/api/pulse
Request Type:	PUT
Message Body:	JSON object where the following keys are mandatory: Command = saveinfo PulseInfo = JSON object containing all the Pulse information.
Response:	“Success”
Possible Errors:	400 Bad Request: Did not provide a Pulse Information JSON object 500 Internal Server Error: An exception occurred within the Deadline code.

Gets the Pulse settings for the Pulse names provided.


URL:	http://hostname:portnumber/api/pulse?Settings=true&Names=oneOrMorePulseNames http://hostname:portnumber/api/pulse?Settings=true&Name=onePulseName
Request Type:	GET
Message Body:	N/A
Response:	JSON object containing all the Pulse settings for the requested Pulse names.
Possible Errors:	404 Not Found: Pulse name provided does not exist (can only occur if you use Name= ) 500 Internal Server Error: An exception occurred within the Deadline code.

Saves the Pulse settings provided.


URL:	http://hostname:portnumber/api/pulse
Request Type:	PUT
Message Body:	JSON object where the following keys are mandatory: Command = savesettings PulseSettings = JSON object containing all the Pulse information.
Response:	“Success”
Possible Errors:	400 Bad Request: Did not provide a Pulse Information JSON object 500 Internal Server Error: An exception occurred within the Deadline code.

Gets the Pulse information and settings for the Pulse names provided.


URL:	http://hostname:portnumber/api/pulse?Names=oneOrMorePulseNames http://hostname:portnumber/api/pulse?Name=onePulseName
Request Type:	GET
Message Body:	N/A
Response:	JSON object containing all the Pulse information and settings for the requested Pulse names.
Possible Errors:	404 Not Found: Pulse name provided does not exist (can only occur if you use Name= ) 500 Internal Server Error: An exception occurred within the Deadline code.

Values for some Pulse properties are represented by numbers. Those properties and their possible values are listed below.

Stat (PulseStatus)