POST /ws/rest/service/v1/cashflow/template/list/{project_number}
Purpose:
Get all list of CashFlow Templates with all curves types defined.
The input JSON shall provide various options to be considered for fetching the data
Input:
All parameters should be URL encoded.
Path Parameter
project_number: Specify the Project number in which the curve exists.
POST body is a JSON
Note: POST call has input & output both as JSON in the body.
{
"options":{
"property_name": "CBS CF"
}
}
{
"options":{
"names":[
"CBS CF"
]
}
}
Supported options properties
"property_name": "CBS CF"
“names": "CBS CF" for one cashflow
"names": ["cashflow_1", "cashflow_2" ] for one or more cashflows
"curve_name": << Name of The Curve>>,
"rollup_status"<<Active><Inactive>>
If rollup_status value provided is other than above mentioned values, invalid options message will be thrown.
"detail_level"<<Summary CBS>< CBS><Project / Shell><Commitment>>
If detail_levelvalue provided is other than above mentioned values,invalid options message will be thrown.
"include_curves":<< Yes/ No>> <!-- default is Yes if not provided→>
If include_curves value provided is other than above mentioned values, invalid options message will be thrown.
If no options provided service will return all templates along with cashflow curves from the project.
,
Output:
JSON object containing 'status', 'data', 'message'
A message will be present if the status is not 200 otherwise it will be "success".