Delete an Existing Snapshot for Cashflow Summary Curves

PUT /ws/rest/service/v2/cashflow/delete/snapshot

Purpose

Delete a snapshot for an existing cashflow detail curve in specific shell from different system.

Prerequisite

You must have Full Access and Update permissions.

Request Format

Send an API request as a JSON Map with the following structure:

{

"options":{

"project_number": "<value>",

"name": "<value>"

},

"data":["snapshotName1":"<value>", "snapshotName2":"<value>"]

}

Request Parameters

In the request, the following parameters can be included:

Parameter	Required?	Data Type	Description
project_number	Yes	String	A valid project number.
name	Yes	String	A valid cashflow curve name.
snapshot_name	Yes	String	Valid snapshot names.

Response Format

A JSON object is returned in the following format.

{

"data": [],

"message": [<list of messages>],

"status": <REST status code value>,

"rest_audit_id": <id from the audit table>

}

A successful response displays a status code 200.

A failed response displays a message with a status code.

Sample Request

This is a request to delete two snapshots, May 8th Snapshot, and April Snapshot.

{

"options" : {

"project_number" :1001,

"name" : "CashFlow By CBS"

},

"data":[ {"snapshot_name":["May8th Snapshot", "April Snapshot"] }

Sample Success Response

This is the response for a successful deletion of the above snapshots.

{

"data" : [ ],

"status" : 200,

"message": "success",

"rest_audit_id": 7800

}

Supported Validation Messages and Status Codes

The following messages and status codes can display in the response:

Field Name	Use-Case	Status	Message
project_number	Project number is not provided.	13001	Project/Shell number is mandatory and is missing in the input request.
project_number	Project number is invalid.	602	Project/Shell Number is not correct.
project_number	Project is not active.	1245 ( create/update - existing code)	Create/Update/Delete cannot be performed when project/shell status is Inactive or View-Only or On-Hold.
curve_name	Curve name is not provided.	13002	Cashflow curve name is mandatory and is missing in the input request.
curve_name	curve name no longer exists.	13003	Invalid curve name provided in input request.
curve_name	Provided curve name is a summary type.		The selected curve name is a summary type, and summary snapshots are not supported through integration.
snapshot_name	A few snapshot names do not exist in the selected cashflow curve.	13008	Snapshots <name1>, <name2> do not exist in the selected cash flow curve <curve name>. Snapshots <name3> ,<name4> deleted successfully.
snapshot_name	None of the snapshot names exist in the selected cashflow curve.	13004	Snapshots <name1>, <name2>, <name3> do not exist in the selected cash flow curve <curve name>