Create Snapshot at the Summary Level Cashflow Worksheet
POST /ws/rest/service/v2/cashflow/summary/snapshot
Purpose
Create a snapshot for an existing cashflow summary curve in a specific shell from a different system. A successful REST API call creates a snapshot with the specified name in the curve with an entry in the snapshot log. Only one snapshot can be created with each request.
Prerequisites
To create and delete snapshots in summary curves, you must have Full Access or Update permissions for cashflow REST services.
Request Format
Send an API request with the following structure:
{
"options":{
"project_number": "<value>",
"summary_cashflow_name": "<value>"
},
"data":["snapshotName1":"<value>", "snapshotName2":"<value>"]
}
Request Parameters For Options and Data Objects
The following parameters must be specified in the request.
Request Parameter | Required? | Data Type | Description |
|---|---|---|---|
| Yes |
| A valid project number |
| Yes | String | A valid summary cashflow name. |
| Yes | String | A valid snapshot name. Alphanumeric values are allowed. |
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
{
"options" :
{
"project_number" :1001,
"summary_cashflow_name" : "CashFlow By CBS"
},
"data":[
{
"snapshot_name":"May8th snapshot"
}
]
}
Sample Success Response
{
"data": [
{
"summary_cashflow_name": [
"New curve 5"
],
"snapshot_name": [
"Rest snapshot 289"
]
}
],
"message": [
"success"
],
"status": 200,
"rest_audit_id": 2377
}
Sample Failed Response
{
"data": [],
"message": [
"Cashflow curve name is mandatory and is missing in the input request"
],
"status": 13003,
"rest_audit_id": 2378
}
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. |
| Cashflow name provided in not summary type | 13011 | Cashflow name provided in input request is not a summary curve. |
| Summary curve status in inactive. | 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. |
| Snapshot name do not exist for selected curve. | 13006 | snapshot name specified do not exist in the cashflow <name>. |
| Snapshot names exceeds 64 characters. | 13010 | Cash Flow snapshot name cannot exceed 64 characters. |
Related Topics
Snapshots in Cashflow Summary Curves
Delete Snapshot from Cashflow Curve
Get Snapshot Names for the Selected Cashflow
Last Published Wednesday, April 9, 2025