WebSphere Process Server, Version 6.2.0.1 Operating Systems: AIX, HP-UX, Linux, Solaris, Windows, i5/OS, z/OS


Business Flow Manager REST Interface - Process Instance Resource - PUT (Suspend) Method

Use this method to suspend a process until a specified point in time, for a specified time period, or indefinitely.

Resource URI

PUT /v1/process/{piid}?{parameters}

Parameters

Required Parameters
NameValue TypeDescription
action string
Action to be performed for the specified process.
ValueDescription
suspend
Suspend a process.
Optional Parameters
NameValue TypeDescription
deadline string
A deadline (e.g. "2008-10-10T12:00:00") in ISO 8601 format - if a deadline is specified then a duration must not be specified.
duration string
A duration (e.g. "P14D") in ISO 8601 format - if a duration is specified then a deadline must not be specified.

Request Content

None.

Response Content

None.

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "BFM Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description":"Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description":"Message text of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description":"Additional, exception details, for example, a stack trace."
      }
   }
} 

Status Codes

The method returns one of the following status codes:
CodeDescription
200 OKSuccess completion.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
404 Not Found
The process does not exist.
409 ConflictA conflict exists with the current state of the resource.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Available Since

6.2

Parent Topic: Process Instance Resource