FRAMES | NO FRAMES Description | Parameters | Examples | Response
Create Hold (Operation)
URL http://<holds-url>/create
Parent Resource Holds


Creates a hold for the job.


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

Values: html | json
user Required
Description: The username of the client.
type Required
Description: An integer value representing the hold type to be placed on the job.

The available hold types and associated ID values can be acquired from the Workflow Manager Service resource.
comments Description: Reason or more detailed information regarding why the hold is being added.

Example Usage

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


JSON Response Syntax

  "holdId": <holdId>

JSON Response Example

  "holdId": 5