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

Use this method to set the priority for multiple business categories.

Sample method invocation

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

Parameters

Required Parameters

Name

Value Type

Description

action

string

Action to be performed for the specified business category.

Value	Description
setPriority	Set the priority for multiple business categories.

Optional Parameters

Name	Value Type	Description
priority	integer	Business category priority. If this parameter is not specified then the priority is unset.

Request Content

List of IDs of business categories for which the priority is to be set.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Business Category Bulk Operation", 
   "type": "object",
   "properties":
   {  "bcids": {"type": ["string"],
         "description": "List of business category IDs the operation is performed for."
      }
   }
}

Response Content

Empty if all set operations succeed. For failed individual set operations, a report is returned.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Business Category Bulk Operation Response", 
   "type": "object",
   "properties":
   {  "failedOperations": 
      [
         {  "bcid": {"type": "string",
               "description": "ID of a business category where the operation has failed."
            },
            "errorNumber": {"type": "string",
               "description": "Message ID of the exception."
            },
            "errorMessage": {"type": "string",
               "description": "Message text of the exception."
            }
         }
      ]
   }
}

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	Successful completion. A detailed report is returned.
400 Bad Request	The parameters are not valid or they are missing.
406 Not Acceptable	The requested content type or content encoding is not supported.
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 Resource