Update Shell
PUT /ws/rest/service/v1/admin/shell
Note: As a best practice, delay invoking this REST call when reverse auto-population is configured in a business process.
This REST service also supports the Shell Manager Attribute Form
Request Format
Send an API request as a JSON Map with the following structure:
{
"options":{},
"data":[]
}
Response Format
The REST service returns a JSON Map in the following format:
{
"data": [],
"message": [],
"status": <REST status code value>
}
If all the shells are updated successfully, the response status code will be 200.
The response will have the input data sent in plus the _record_status to indicate if the shell update is a success or the respective error message.
Sample Request
{
"options" : { "shelltype" : "All Properties"},
"data" :[
{
"uPropertyNumber" : "RE00000",
"description" : "TEST35"
} ,
{
"uPropertyNumber" : "BLD0005",
"description" : "TEST35"
}
]
}
Sample Failed Response
{
"data":[ ],
"message":[
{
"_record_status":"SUCCESS",
"description":"TEST35",
"uPropertyNumber":"RE00000"
},
{
"_record_status":"Shell Number is not correct. ",
"description":"TEST35",
"uPropertyNumber":"BLD0005"
}
],
"status":3000
}
Related Topics
Last Published Tuesday, July 1, 2025