FRAMES | NO FRAMES Description | Parameters | Examples | Response
URL http://<job-url>/holds
Supported Operations Create
Parent Resource Job
Child Resources Hold


Represents a list of all the holds for a job.

When reviewing the returned job holds, keep in mind that open (or active) holds will have a null release date.


Parameter Details
f Description: The response format. The default response format is html.

Values: html | json

Example Usage

Example 1: URL for the holds on job ID 5 in the "Workflow" service on sampleserver.


JSON Response Syntax

  "holds": [
      "id": <holdId1>,
      "type": <holdTypeId1>,
      "heldBy": "<userName11>",
      "holdDate": <holdDate1>,
      "holdComments": "<holdComments1>",
      "releasedBy": "<userName12>",
      "releaseDate": <releaseDate1>,
      "releaseComments": "<releaseComments1>"
      "id": <holdId2>,
      "type": <holdTypeId2>,
      "heldBy": "<userName21>",
      "holdDate": <holdDate2>,
      "holdComments": "<holdComments2>",
      "releasedBy": "<userName22>",
      "releaseDate": <releaseDate2>,
      "releaseComments": "<releaseComments2>"

JSON Response Example

  "holds": [
    // An example of an active hold:
      "id": 100,
      "type": 1,
      "heldBy": "amiller",
      "holdDate": 1230768000000,
      "holdComments": "Waiting for manager approval",
      "releasedBy": "",
      "releaseDate": null,
      "releaseComments": ""
    // An example of an inactive hold:
      "id": 101,
      "type": 3,
      "heldBy": "cjones",
      "holdDate": 1230768000000,
      "holdComments": "On hold due to budget shortage",
      "releasedBy": "amiller",
      "releaseDate": 1231372800000,
      "releaseComments": "Received additional funding"