Get BPs in Shell or Company
GET /ws/rest/service/v1/admin/bps/project_number
Purpose
This GET service results all the Business Processes available (BP set ups) in shell:
- If project_number in URL is provided, or
- The company Level, if project_number is left empty.
Sample Success Response
When project number is provided, for example: /ws/rest/service/v1/admin/bps/B-0001, the response returns all the shell-level BPs available in that project/shell.
When project number is not provided, for example: /ws/rest/service/v1/admin/bps, the response returns all the company-level BPs available in that Company Level.
{
"data":
[
{
"bp_model_name":"uab",
"bp_name":"Annual Budget",
"studio_source":"cost",
"studio_type":"other",
"no_workflow":false
},
{
"bp_model_name":"uatc",
"bp_name":"Assets Creator",
"studio_source":"simple",
"studio_type":null,
"no_workflow":false
},
{
"bp_model_name":"ubcfm",
"bp_name":"Budget Changes-FM",
"studio_source":"cost",
"studio_type":"other",
"no_workflow":false
}
],
"message": [""],
"status":200
}
Sample Failed Response
When incorrect shell number is provided, the Result would be error response with status 602 and message: "Project/Shell Number is not correct.," as shown below.
{
"data": [ ],
"message": [ "Project/Shell Number is not correct."],
"status":602
}
Related Topics
Last Published Wednesday, April 9, 2025