Workers¶

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

Overview
Requests and Responses
Worker Property Values

Overview ¶

Worker requests can be used to set or retrieve Worker information.

Worker requests support GET, PUT and DELETE request types.

POST is not supported and sending such a message 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.

For all PUT requests it is possible to return a 400 Bad Request Error message if there is no message body or if the command key is not set. PUT requests may also return a 500 Internal Server Error message if the command key is set to an invalid command.

Get Worker Names ¶

Gets all the Worker names.


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

Get Worker’s InfoSettings ¶

Gets the InfoSettings for every Worker name provided.


URL:	http://hostname:portnumber/api/slaves?Name=oneOrMoreSlaveNames&Data=infosettings
Request Type:	GET
Message Body:	N/A
Response:	JSON object containing the Worker InfoSettings for all the Worker names provided.
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code.

Get All Worker’s InfoSettings ¶

Gets the InfoSettings for every Worker.


URL:	http://hostname:portnumber/api/slaves?Data=infosettings
Request Type:	GET
Message Body:	N/A
Response:	JSON object containing the Worker InfoSettings for all the Workers.
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code.

Get Worker’s Information ¶

Gets the Worker Information for every Worker name provided.


URL:	http://hostname:portnumber/api/slaves?Name=oneOrMoreSlaveNames&Data=info
Request Type:	GET
Message Body:	N/A
Response:	JSON object containing the Worker Information for all the Worker names provided.
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code.

Get All Worker’s Information ¶

Gets the Worker Information for every Worker.


URL:	http://hostname:portnumber/api/slaves?Data=info
Request Type:	GET
Message Body:	N/A
Response:	JSON object containing the Worker Information for all the Workers.
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code.

Get Worker’s Settings ¶

Gets the Worker Settings for every Worker name provided.


URL:	http://hostname:portnumber/api/slaves?Name=oneOrMoreSlaveNames&Data=settings
Request Type:	GET
Message Body:	N/A
Response:	JSON object containing the Worker Settings for all the Worker names provided.
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code.

Get All Worker’s Settings ¶

Gets the Worker Settings for every Worker.


URL:	http://hostname:portnumber/api/slaves?Data=settings
Request Type:	GET
Message Body:	N/A
Response:	JSON object containing the Worker Settings for all the Workers.
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code.

Save Worker Information ¶

Saves the Worker Information provided.


URL:	http://hostname:portnumber/api/slaves
Request Type:	PUT
Message Body:	JSON object where the following keys are mandatory: Command = saveinfo SlaveInfo = JSON object containing the Worker information to save.
Response:	“Success”
Possible Errors:	400 Bad Request: JSON object containing Worker Information was not provided. 500 Internal Server Error: An exception occurred within the Deadline code.

Save Worker Settings ¶

Saves the Worker Settings provided.


URL:	http://hostname:portnumber/api/slaves
Request Type:	PUT
Message Body:	JSON object where the following keys are mandatory: Command = savesettings SlaveSettings = JSON object containing the Worker Settings to save.
Response:	“Success”
Possible Errors:	400 Bad Request: JSON object containing Worker Settings was not provided. 500 Internal Server Error: An exception occurred within the Deadline code.

Delete Workers ¶

Deletes every Worker that corresponds to a Worker name provided.


URL:	http://hostname:portnumber/api/slaves?Name=oneOrMoreSlaveNames
Request Type:	DELETE
Message Body:	N/A
Response:	“Success”
Possible Errors:	400 Bad Request: Need to provide at least one Worker name to delete. 500 Internal Server Error: An exception occurred within the Deadline code.

Get Worker’s Reports ¶

Gets all Worker Reports for all Worker names provided.


URL:	http://hostname:portnumber/api/slaves?Name=oneOrMoreSlaveNames&Data=reports
Request Type:	GET
Message Body:	N/A
Response:	JSON object containing all Worker Reports for all Worker names provided.
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code.

Get Worker Report Contents ¶

Gets the Worker report contents for all Worker reports.


URL:	http://hostname:portnumber/api/slaves?Data=reportcontents&Name=oneOrMoreSlaveNames
Request Type:	GET
Message Body:	N/A
Response:	JSON object containing an array of all Worker report contents.
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code.

Get Worker’s History ¶

Gets all Worker History Entries for all Worker names provided.


URL:	http://hostname:portnumber/api/slaves?Name=oneOrMoreSlaveNames&Data=history
Request Type:	GET
Message Body:	N/A
Response:	JSON object containing all Worker History Entries for all Worker names provided.
Possible Errors:	500 Internal Server Error: An exception occurred within the Deadline code.

Get Worker Names Rendering Job ¶

Gets all Worker names rendering Job that corresponds to Job ID provided.


URL:	http://hostname:portnumber/api/slavesrenderingjob?JobID=validJobID
Request Type:	GET
Message Body:	N/A
Response:	JSON object all the Worker names rendering the Job.
Possible Errors:	400 Bad Request: No Job ID was provided. 500 Internal Server Error: An exception occurred within the Deadline code, or Job ID provided does not correspond to a Job in the Repository.

Get Host Names of Machines Rendering Job ¶

Gets all machine host names for Workers rendering Job that corresponds to Job ID provided.


URL:	http://hostname:portnumber/api/machinesrenderingjob?JobID=validJobID
Request Type:	GET
Message Body:	N/A
Response:	JSON object containing all the host names.
Possible Errors:	400 Bad Request: No Job ID was provided. 500 Internal Server Error: An exception occurred within the Deadline code, or Job ID provided does not correspond to a Job in the Repository.

Get IP Address of Machines Rendering Job ¶

Gets all machine IP addresses for Workers rendering Job that corresponds to Job ID provided.


URL:	http://hostname:portnumber/api/machinesrenderingjob?JobID=validJobID&GetIpAddress=true
Request Type:	GET
Message Body:	N/A
Response:	JSON object containing all the IP addresses.
Possible Errors:	400 Bad Request: No Job ID was provided. 500 Internal Server Error: An exception occurred within the Deadline code, or Job ID provided does not correspond to a Job in the Repository.

Worker Property Values ¶

Values for some Worker Info, Settings, and Report properties are represented by numbers. Those properties and their possible values are listed below.

Stat (SlaveStatus)

0 = Unknown
1 = Rendering
2 = Idle
3 = Offline
4 = Stalled
8 = StartingJob

Type (ReportType)

0 = LogReport
1 = ErrorReport
2 = RequeueReport