Delete Snapshot from Cashflow Curve
PUT /ws/rest/service/v2/cashflow/delete/summary/snapshot
Purpose
Delete multiple snapshots in a single request.
Prerequisites
You must have Update permissions for cashflow services to process this request.
Request Format
Send an API request as a JSON Map with the following structure:
{
"options":{
"project_number": "<value>"
"summary_cashflow_name": "<value>"
},
"data":["snapshotName1":"<list of snapshot names to be deleted>"]
}
Request Parameters For Options and Data JSON Map
The following parameters must be specified in the request.
Request Parameter | Required? | Data Type | Description |
|---|---|---|---|
| Yes | String | A valid active project number. |
| Yes | String | The summary cashflow curve name for which the snapshot is created. |
| Yes | String | A list of snapshot names to be deleted. |
Response Format
The REST service returns a JSON Map in the following format:
{
"data": [
{
"summary_cashflow_name" : "<summary cashflow curve name>",
"snapshot_name" : ["<Snapshot name(s) list>"]
}
],
"message": [<list of messages>],
"status": <REST status code value>,
"rest_audit_id": <value>
}
A successful request returns a response with status 200. Otherwise a failed request returns a response with a status code and an error message
Sample Request
{
"options" : {
"project_number": "P-0002",
"summary_cashflow_name" : "New curve 5"
},
"data":[
{"snapshot_name":["snapshot 1", "snapshot 2"]
}
]
}
Sample Success Response
This is an example of successful response.
{
"data": [
{
"summary_cashflow_name": [
"New curve 5"
],
"snapshot_name": [
"snapshot 1",
"snapshot 2"
]
}
],
"message": [
"success"
],
"status": 200,
"rest_audit_id": 2383
}
Sample Failed Response
The following message and status is displayed for a snapshot that could not be deleted.
{
"data": [],
"message": ["Snapshot name specified does not exist in the summary cashflow 'New curve 5'"],
"status": 13007,
"rest_audit_id": 2384
}
Supported Validation Messages and Status Codes
The following error messages and status codes display in the response when incorrect values are provided in the request.
Field Name | Use-case Scenario | Status Code | Error Message |
|---|---|---|---|
| Project is not an active. | 13001 | Create/Update/Delete cannot be performed when project/shell status is Inactive or View-Only or On-Hold. |
| Project number is not provided. | 602 | Project/Shell number is mandatory and is missing in the input request. |
| Project number is Invalid. | 1245 ( create/update - existing code) | Create/Update/Delete cannot be performed when project/shell status is Inactive or View-Only or On-Hold. |
| Project number is Invalid. | 1219 ( get - existing code) | Project status is inactive. |
| Curve name is not provided | 13002 | cashflow curve name is mandatory and is missing in the input request. |
| Curve name provided no longer exists | 13003 | Invalid curve name provided in input request. |
|
| 13011 | Cashflow name provided in input request is not a summary curve. |
|
| 13012 | Selected summary cash flow is no longer active. |
| Snapshot name is not provided | 13004 | Provide a snapshot name. |
| Snapshot name already exists | 13005 | snapshot name already exists. |
|
| 13006 | snapshot name specified do not exist in the cashflow <name>. |
|
| 13010 | Cash Flow snapshot name cannot exceed 64 characters. |
Related Topics
Snapshots in Cashflow Summary Curves
Create Snapshot at the Summary Level Cashflow Worksheet
Get Snapshot Names for the Selected Cashflow
Last Published Wednesday, April 9, 2025