REST Interface for BPEL-related Task Resources - Work Basket Instance Resource - PUT (Remove As Distribution Target) Method

Sample method invocation

Parameters

Required Parameters

Name	Value Type	Description
action	string	Action to be performed for the specified work basket. Value Description removeAsDistributionTarget Remove work basket as distribution target.

Request Content

None

Response Content

The default content-type is application/json.

MIME Type: application/json

{  "description": "Remove As Distribution Target Result", 
   "type": "object",
   "properties":
   {  "identifier": {"type": "string"},
      "items": 
      [
         {
            "wbid": {"type": "string",
               "description": "ID of a work basket."
            },
            "name": {"type": "string",
               "description": "Name of a work basket."
            },
            "taskException": {"type": "string", "optional": true,
               "description": "The TaskException object that describes any error that occurred during processing."
            }
         }
      ]
   }
}

Error Response Content

The default content-type is application/json.

MIME Type: application/json

{  "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.
403 Forbidden	The caller is not allowed to complete this request.
404 Not Found	The work basket does not exist.
406 Not Acceptable	The requested content type or content encoding is not supported.
500 Internal Server Error	A severe problem has occurred. Programmer's details are provided.

Available since

7.0 Feature Pack

Parent topic: Work Basket Instance Resource