Create Summary Curve
POST /ws/rest/service/v1/cashflow/summary/{project_number}
Purpose
Create Cashflow summary curves.
Request Format
All parameters should be URL encoded.
Path Parameter
project_number: Specify the project/shell number.
Note:
POST call has input & output both as JSON in the body
In the input request:
- "name"
- "status": (Optional) If not specified then the summary curve will be active.
- "description": (Optional) If no value is specified, the summary curve will be created with no description.
- "curves": (Optional) List of cash flow curve names, which has to be part of the summary curve. If no value is specified, the summary curve will be created without any cash flow curve.
Response Format
A JSON object is returned in the following format.
{
"data": [],
"message": [],
"status": <REST status code value>
}
The data will contain the name and the id of the summary curve which was created successfully. The message will contain the status of the curve creation for all the input data.
A successful response displays a status code 200.
A failed response displays a message with a status code.
Sample Request
{
"data":[
{
"name":"summary curve 1",
"status":"active",
"description":"This summary curve is created from REST API",
"curves":[
"CF For buildings",
"Curve 1"
]
},
{
"name":"summary curve 2",
"status":"active",
"description":"This summary curve is created from REST API",
"curves":[
"Manual curve 0120",
"cashflow for bridge 20"
]
}
]
}
Sample Success Request
{
"data":[
{
"name":"summary curve 1",
"id":31
}
],
"message":[
{
"name":"summary curve 1",
"status":"200",
"message":"success" },
{
"name":"summary curve 2",
"status":"1308",
"message":"Summary name already exists" }
],
"status":3000
}