REST interface for BPEL-related process resources - 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.

Sample method invocation

PUT /rest/bpm/bfm/v1/process/{piid}?action={string}[&deadline={string}][&duration={string}]

Parameters

Required Parameters

Name

Value Type

Description

action

string

Action to be performed for the specified process.

Value	Description
suspend	Suspend a process.

Optional Parameters

Name	Value Type	Description
deadline	string	A deadline (for example "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 (for example "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

Schema

{  "description": "Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description":"Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description":"Message text of the exception."
      },
      "errorMessageParameters": {"type": ["string"], "optional": true,
         "description":"Message text parameters 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:

Code	Description
200 OK	Success completion.
400 Bad Request	The parameters are not valid or they are missing.
401 Unauthorized	The caller is not authorized for this request.
404 Not Found	The process does not exist.
409 Conflict	A conflict exists with the current state of the resource.
500 Internal Server Error	A severe problem has occurred. Programmer's details are provided.

Available since

6.2

Parent topic: Process instance Resource