Repository

Overview

Repository requests can be used to retrieve Repository information, such as directories or paths, using the GET request type. Repository requests can also be used for adding history entries for jobs, Workers or the repository using the POST request type. PUT 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.

Requests and Responses

List of possible requests for the Repository.

Get Root Directory

URL: http://hostname:portnumber/api/repository?Directory=root

Request Type: GET

Message Body: N/A

Response: JSON Object containing the root directory, or a message stating that the directory is not set.

Possible Errors:
  • 400 Bad Request: Must provide a Directory or an Auxiliary Path to find.
  • 404 Not Found: Requested Directory could not be found.

Get Bin Directory

URL: http://hostname:portnumber/api/repository?Directory=bin

Request Type: GET

Message Body: N/A

Response: JSON Object containing the bin directory, or a message stating that the directory is not set.

Possible Errors:
  • 400 Bad Request: Must provide a Directory or an Auxiliary Path to find.
  • 404 Not Found: Requested Directory could not be found.

Get Settings Directory

URL: http://hostname:portnumber/api/repository?Directory=settings

Request Type: GET

Message Body: N/A

Response: JSON Object containing the settings directory, or a message stating that the directory is not set.

Possible Errors:
  • 400 Bad Request: Must provide a Directory or an Auxiliary Path to find.
  • 404 Not Found: Requested Directory could not be found.

Get Events Directory

URL: http://hostname:portnumber/api/repository?Directory=events

Request Type: GET

Message Body: N/A

Response: JSON Object containing the events directory, or a message stating that the directory is not set.

Possible Errors:
  • 400 Bad Request: Must provide a Directory or an Auxiliary Path to find.
  • 404 Not Found: Requested Directory could not be found.

Get Custom Events Directory

URL: http://hostname:portnumber/api/repository?Directory=customevents

Request Type: GET

Message Body: N/A

Response: JSON Object containing the custom events directory, or a message stating that the directory is not set.

Possible Errors:
  • 400 Bad Request: Must provide a Directory or an Auxiliary Path to find.
  • 404 Not Found: Requested Directory could not be found.

Get Plugins Directory

URL: http://hostname:portnumber/api/repository?Directory=plugins

Request Type: GET

Message Body: N/A

Response: JSON Object containing the plugins directory, or a message stating that the directory is not set.

Possible Errors:
  • 400 Bad Request: Must provide a Directory or an Auxiliary Path to find.
  • 404 Not Found: Requested Directory could not be found.

Get Custom Plugins Directory

URL: http://hostname:portnumber/api/repository?Directory=customplugins

Request Type: GET

Message Body: N/A

Response: JSON Object containing the custom plugins directory, or a message stating that the directory is not set.

Possible Errors:
  • 400 Bad Request: Must provide a Directory or an Auxiliary Path to find.
  • 404 Not Found: Requested Directory could not be found.

Get Scripts Directory

URL: http://hostname:portnumber/api/repository?Directory=scripts

Request Type: GET

Message Body: N/A

Response: JSON Object containing the scripts directory, or a message stating that the directory is not set.

Possible Errors:
  • 400 Bad Request: Must provide a Directory or an Auxiliary Path to find.
  • 404 Not Found: Requested Directory could not be found.

Get Custom Scripts Directory

URL: http://hostname:portnumber/api/repository?Directory=customscripts

Request Type: GET

Message Body: N/A

Response: JSON Object containing the custom scripts directory, or a message stating that the directory is not set.

Possible Errors:
  • 400 Bad Request: Must provide a Directory or an Auxiliary Path to find.
  • 404 Not Found: Requested Directory could not be found.

Get Auxiliary Path

URL: http://hostname:portnumber/api/repository?AuxiliaryPath=job&JobID=validJobID

Request Type: GET

Message Body: N/A

Response: JSON Object containing the auxiliary path for the provided job id, or a message stating that the path is not set.

Possible Errors:
  • 400 Bad Request:
    • Must provide a Directory or an Auxiliary Path to find, or
    • Must provide a Job ID.
  • 404 Not Found:
    • Requested Directory could not be found, or
    • Job ID provided does not correspond to a Job in the repository.

Get Alternate Auxiliary Path

URL: http://hostname:portnumber/api/repository?AuxiliaryPath=alternate

Request Type: GET

Message Body: N/A

Response: JSON Object containing the alternate auxiliary path, or a message stating that the path is not set.

Possible Errors:
  • 400 Bad Request: Must provide a Directory or an Auxiliary Path to find.
  • 404 Not Found: Requested Directory could not be found.

Get Windows Alternate Auxiliary Path

URL: http://hostname:portnumber/api/repository?AuxiliaryPath=windowsalternate

Request Type: GET

Message Body: N/A

Response: JSON Object containing the windows alternate auxiliary path, or a message stating that the path is not set.

Possible Errors:
  • 400 Bad Request: Must provide a Directory or an Auxiliary Path to find.
  • 404 Not Found: Requested Directory could not be found.

Get Linux Alternate Auxiliary Path

URL: http://hostname:portnumber/api/repository?AuxiliaryPath=linuxalternate

Request Type: GET

Message Body: N/A

Response: JSON Object containing the linux alternate auxiliary path, or a message stating that the path is not set.

Possible Errors:
  • 400 Bad Request: Must provide a Directory or an Auxiliary Path to find.
  • 404 Not Found: Requested Directory could not be found.

Get Mac Alternate Auxiliary Path

URL: http://hostname:portnumber/api/repository?AuxiliaryPath=macalternate

Request Type: GET

Message Body: N/A

Response: JSON Object containing the mac alternate auxiliary path, or a message stating that the path is not set.

Possible Errors:
  • 400 Bad Request: Must provide a Directory or an Auxiliary Path to find.
  • 404 Not Found: Requested Directory could not be found.

Get Maximum Priority

URL: http://hostname:portnumber/api/maximumpriority

Request Type: GET

Message Body: N/A

Response: JSON Object containing the Maximum Priority.

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

Get Maximum Job Tasks

URL: http://hostname:portnumber/api/jobtasklimit

Request Type: GET

Message Body: N/A

Response: JSON Object containing the maximum number of tasks per job.

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

Path Mapping

URL: http://hostname:portnumber/api/mappedpaths

Request Type: POST

Message Body:
JSON object that must contain the following keys:
  • OS = Operating system (“Windows”, “Linux”, or “Mac”).
  • Paths = Array of paths to map.
  • Region = The region to be used for mapping paths (optional, defaults to “none”).

Response: JSON Object containing the updated paths.

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

Get Plugin Names

URL: http://hostname:portnumber/api/plugins

Request Type: GET

Message Body: N/A

Response: JSON Object containing the plugin names

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

Get Plugin Event Names

URL: http://hostname:portnumber/api/plugins?EventNames=true

Request Type: GET

Message Body: N/A

Response: JSON Object containing the plugin event names

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

Get Database Connection String

URL: http://hostname:portnumber/api/repository?DatabaseConnection=

Request Type: GET

Message Body: N/A

Response: The Database Connection string in the form of: (server:port,server:port…).

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

Add Job History Entry

URL: http://hostname:portnumber/api/repository

Request Type: POST

Message Body:
JSON object where the following keys are mandatory:
  • Command = jobhistoryentry
  • JobID = The job id string.
  • Entry = The entry string to be added.

Response: “Success”

Possible Errors:
  • 400 Bad Request:
    • JSON object was not provided in message body or,
    • The provided JSON object is missing some values.
  • 500 Internal Server Error: An exception occurred within the Deadline.

Add Worker History Entry

URL: http://hostname:portnumber/api/repository

Request Type: POST

Message Body:
JSON object where the following keys are mandatory:
  • Command = slavehistoryentry
  • SlaveName = The Worker name.
  • Entry = The entry string to be added.

Response: “Success”

Possible Errors:
  • 400 Bad Request:
    • JSON object was not provided in message body or,
    • The provided JSON object is missing some values.
  • 500 Internal Server Error: An exception occurred within the Deadline.

Add Repository History Entry

URL: http://hostname:portnumber/api/repository

Request Type: POST

Message Body:
JSON object where the following keys are mandatory:
  • Command = repositoryhistoryentry
  • Entry = The entry string to be added.

Response: “Success”

Possible Errors:
  • 400 Bad Request:
    • JSON object was not provided in message body or,
    • The provided JSON object is missing some values.
  • 500 Internal Server Error: An exception occurred within the Deadline.