REST Interface for BPEL-related Task Resources - Business Category Instance Resource - PUT (Set Parent) Method

Use this method to set the parent business category for a business category.

Sample method invocation

PUT /rest/bpm/htm/v1/businessCategory/{bcid}?action={string}[&parentBusinessCategory={string}]

Parameters

Required Parameters
NameValue TypeDescription
action string
Action to be performed for the specified business category.
ValueDescription
setParent
Set the parent business category for a business category.
Optional Parameters
NameValue TypeDescription
parentBusinessCategory string
Parent business category ID. If this parameter is not specified then the parent business category is unset.

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:
CodeDescription
200 OKSuccess completion.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
403 ForbiddenThe caller is not allowed to complete this request.
404 Not Found
The business category does not exist.
409 Conflict
Setting the parent business category would lead to a circular parent relationship.
500 Internal Server ErrorA severe problem has occurred. Programmer's details are provided.

Available since

7.0 Feature Pack

Parent topic: Business Category Instance Resource