Refresh Cash Flow Curves

POST /ws/rest/service/v1/cashflow/prop/refresh/{project_number}

Purpose:

Refresh selected cash flow properties.

The input JSON shall provide various options to be considered for refreshing Curves.

Input:

All parameters should be URL encoded.

project_number: (Required) 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"

}

}

Supported options properties

"property_name": "CBS CF"

"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.

Output:

JSON object containing 'status', 'data', 'message'

A message will be present if the status is not 200 otherwise it will be "success".

See Also

Cash Flow

Definitions or Values Used

Authorization

Response Error Codes (REST API Details in Cash Flow)

Create Cash Flow

Create Summary Curve

Create Rollup Cash Flows for Program or Company

Update Rollup Cash Flows for Program or Company

Delete Cash Flow

Delete Cash Flow - Summary Curves

Get Cash Flow Data

Get Summary Cash Flow Data

Get Rollup Status

Get Rollup Status - for Template Cash Flows

Update Rollup Status

Update Rollup Status - For Template Cash Flows

Refresh Cash Flow

Get Cash Flow Refresh Job Status

Get Cash Flow Properties

Get Summary Cash Flow Properties

Get Cash Flow Permissions

Update or Modify Cash Flow Permission

Create (Add User or Group) Cash Flow Permission

Delete (Remove User or Group) Cash Flow Permission

Update Cash Flow

Update Cash Flow Data

Create Distribution Profiles

Get Distribution Profiles

Update Distribution Profiles

Delete Distribution Profiles

Get Cash Flow Permissions

In This Section

Refresh Cash Flow Sample



Last Published Friday, December 13, 2024