Groups

Overview

Group requests can be used to set and retrieve information for one or many Groups. Group requests support GET, PUT, POST and DELETE request types. For more about these request types and their uses see the Request Formats and Responses documentation.

Requests and Responses

List of possible requests for Groups

Get Group Names

Gets Group Names.

URL: http://hostname:portnumber/api/groups

Request Type: GET

Message Body: N/A

Response: JSON object containing all the Group names.

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Get Workers For Groups

Gets all the Worker names for the provided Group names.

URL: http://hostname:portnumber/api/groups?Group=oneOrMoreGroupNames

Request Type: GET

Message Body: N/A

Response: JSON object containing all Worker names that are in the provided Groups.

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Add Groups

Creates new Groups using the provided Group names.

URL: http://hostname:portnumber/api/groups

Request Type: POST

Message Body:
JSON object that must contain the following keys:
  • Group = group name/s (May be an Array)

Response: “Success”

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Set Groups

Removes all groups not provided and creates any provided groups that did not exist.

URL: http://hostname:portnumber/api/groups

Request Type: POST

Message Body:
JSON object that must contain the following keys:
  • Group = group name/s (May be an Array)
  • OverWrite = true

Response: “Success”

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Add Groups to Workers

Adds the provided Groups to the assigned groups for each provided Worker. For both Groups and Workers, only the names are required.

URL: http://hostname:portnumber/api/groups

Request Type: PUT

Message Body:
JSON object that must contain the following keys:
  • Slave = Worker name/s (May be an Array)
  • Group = group name/s (May be an Array)

Response: “Success”

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Set Groups for Workers

Sets provided Groups as the assigned groups for each provided Worker. For both Groups and Workers, only the names are required.

URL: http://hostname:portnumber/api/groups

Request Type: PUT

Message Body:
JSON object that must contain the following keys:
  • Slave = Worker name/s (May be an Array)
  • Group = group name/s (May be an Array)
  • OverWrite = true

Response: “Success”

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Purge Groups

Purges all obsolete groups using the provided replacement group.

URL: http://hostname:portnumber/api/groups

Request Type: PUT

Message Body:
JSON object that must contain the following keys:
  • OverWrite = true
  • ReplacementGroup = group name to replace the groups being purged

Response: “Success”

Possible Errors:
  • 500 Internal Server Error: An exception occurred within the Deadline code, or
  • Replacement Group name provided does not exist.
Set and Purge Groups

Sets the list of groups to the provided list of group names, creating them if necessary. Purges all the obsolete groups using the provided replacement group.

URL: http://hostname:portnumber/api/groups

Request Type: PUT

Message Body:
JSON object that must contain the following keys:
  • OverWrite = true
  • ReplacementGroup = group name to replace the groups being purged
  • Group = the group/s provided for setting, the replacement group must be in this group list or must be “none” (May be an Array)

Response: “Success”

Possible Errors:
  • 500 Internal Server Error: An exception occurred within the Deadline code, or
  • Replacement Group name provided does not exist.
Add and Purge Groups

Adds the list of provided groups, creating them if necessary. Purges all the obsolete groups using the provided replacement group.

URL: http://hostname:portnumber/api/groups

Request Type: PUT

Message Body:
JSON object that must contain the following keys:
  • OverWrite = true
  • ReplacementGroup = group name to replace the groups being purged
  • Group = the group/s provided for adding (May be an Array)

Response: “Success”

Possible Errors:
  • 500 Internal Server Error: An exception occurred within the Deadline code, or
  • Replacement Group name provided does not exist.
Delete Groups

Deletes all Groups with the provided Group names.

URL: http://hostname:portnumber/api/groups?Group=oneOrMoreGroupNames

Request Type: DELETE

Message Body: N/A

Response: “Success”

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.

Delete Groups From Workers

Deletes all Groups from the Worker’s list of groups.

URL: http://hostname:portnumber/api/groups?Group=oneOrMoreGroupNames&Slaves=oneOrMoreSlaveNames

Request Type: DELETE

Message Body: N/A

Response: “Success”

Possible Errors: 500 Internal Server Error: An exception occurred within the Deadline code.