Get CBS Codes
POST /ws/rest/service/v1/cost/cbs/list/{project_number}
Purpose
Get a list of CBS codes for a specified project number.
The input JSON includes options for fetching the data.
Request Format
All parameters must be URL encoded.
POST body is in JSON format.
All the options specified are optional.
Path Parameter
project_num: (Required) Specify the project number in which the records exists.
If the hierarchy is not specified, the default value is false. Complete hierarchy of the CBS code is displayed if the value is true.
Note: POST call has input & output both as JSON in the body
Response Format
A JSON object is returned in the following format.
{
"data": [],
"message": [],
"status": <REST status code value>
}
A successful response displays a status code 200.
A failed response displays a message with a status code.
Note: Cost code attributes defined is sent in JSON format in the response.
Sample Request
The following is an example of a request for a full hierarchy of the CBS code.
{
"options":
{
"cost_type":"Capital",
"summary_detail":"true",
"status":"active",
"hierarchy":true
}
}
Sample Success Response
{
"data":[
{
"bitemid" : 24,
"code": "CostB",
"description": "Desc of CostB",
"item": " Cost Item",
"uResProgressAmount": 10,
"status": "Active",
"cost_type": "Food",
"parentid": "1",
"orderid": "1",
"budgetid": "6"
},
{
"bitemid" : 25,
"code": "CostB~~Cost1",
"description": "Desc of CostB~Cost1",
"item": " Cost Item",
"uResProgressAmount": 10,
"status": "Active",
"cost_type": "Food",
"parentid": "24",
"orderid": "2",
"budgetid": "6"
},
{
"bitemid" : 26,
"code": "Cost1",
"description": "Desc of Cost1",
"item": " Cost1 Item",
"uResProgressAmount": 10,
"status": "Active",
"cost_type": "Capital",
"parentid": "1",
"orderid": "0",
"budgetid": "6"
},
"codestructure": [
{
"treemode": true,
"segsize": 1,
"seperator": "-"
}
],
],
"message":[ "success"],
"status":200
}
See Also
Last Published Wednesday, April 9, 2025