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

Use this method to update the properties of a business category.

Sample method invocation

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

Parameters

Required Parameters

Name

Value Type

Description

action

string

Action to be performed for the specified business category.

Value	Description
update	Change business category properties.

Optional Parameters

Name	Value Type	Description
locale	string	Locale for description and displayName. Valid values are either standard language, country and variant specifications (for example `"en"`, `"en-US"`, `"en-US-WIN"`) or the constant `"default"`. If this parameter is omitted then the setting from the HTTP request header is used.

Request Content

Business category details to be updated.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Business Category Update", 
   "type": "object",
   "properties":
   {
      "customText1": {"type": "string", "optional": true, 
         "description": "The custom text specified as custom text one."
      },
      "customText2": {"type": "string", "optional": true, 
         "description": "The custom text specified as custom text two."
      },
      "customText3": {"type": "string", "optional": true, 
         "description": "The custom text specified as custom text three."
      },
      "customText4": {"type": "string", "optional": true, 
         "description": "The custom text specified as custom text four."
      },
      "customText5": {"type": "string", "optional": true, 
         "description": "The custom text specified as custom text five."
      },
      "customText6": {"type": "string", "optional": true, 
         "description": "The custom text specified as custom text six."
      },
      "customText7": {"type": "string", "optional": true, 
         "description": "The custom text specified as custom text seven."
      },
      "customText8": {"type": "string", "optional": true, 
         "description": "The custom text specified as custom text eight."
      },
      "defaultQueryTable": {"type": "string", "optional": true,
         "description": "Default Query Table for business categories."
      },
      "description": {"type": "string", "optional": true,
         "description": "Description of the business category."
      },
      "displayName": {"type": "string", "optional": true,
         "description": "Display name of the business category."
      },
      "jndiNameOfStaffPluginProvider": {"type": "string", "optional": true,
         "description": "JNDI name of a user-defined people directory configuration."
      },
      "peopleAssignment": {"type":
         [
            {  "assignmentReason": {"type": "string",
                  "description": "The reason for the assignment. Each element in this array replaces the people assignment for a given assignment reason. If both users and groups are not provided then a previously existing assignment reason is deleted.",
                  "enum":
                  [
                     "REASON_READER"                           
                  ]
               },
               "assignmentType": {"type": "string",
                  "description": "Type of the people assignment.",
                  "enum":
                  [
                    "TYPE_GROUP_MEMBERS_AND_USERS",
                    "TYPE_ORGANIZATIONAL_ENTITY",
                    "TYPE_EVERYBODY"
                  ]
               },
               "users": {"type": ["string"], "optional": true,
                  "description": "List of assigned users."
               },
               "groups": {"type": ["string"], "optional": true,
                  "description": "List of assigned groups."
               }
            }
         ], "optional": true
      },
      "priority": {"type": "integer", "optional": true,  
         "description": "The priority of the business category."
      }, 
      "substitutionPolicy": {"type": "string", "optional": true, 
         "description": "The substitution policy that takes place when people assignments are performed.",
         "enum":
         [
            "SUBSTITUTION_POLICY_NO_SUBSTITUTION",
            "SUBSTITUTION_POLICY_SUBSTITUTE_IF_ABSENT",
            "SUBSTITUTION_POLICY_SELECT_USER_IF_PRESENT"
         ]
      }
   }
}

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.
403 Forbidden	The caller is not allowed to complete this request.
404 Not Found	The business category does not exist.
415 Unsupported Media Type	The content type or content encoding of the request 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: Business Category Instance Resource