Get Snapshot Names for the Selected Cashflow
GET /ws/rest/service/v2/cashflow/summary/snapshot?project_number={project number}&name={cashflow name}
Purpose
Get snapshot names for a summary cashflow curve. Only one curve can be processed with each request.
Prerequisites
You must have GET permissions for cashflow services to process this request.
Request Format
Send an API request with the query parameters in the following format:
http://<localhost>:<port>/ws/rest/service/v2/cashflow/summary/snapshot?project_number='<value>'& name='<value>'
Request Parameters
The following parameters can be specified in the request.
Request Parameter | Required? | Data Type | Description |
---|---|---|---|
| Yes | String | A valid active shell number. |
| Yes | String | The name of the cashflow curve for which snapshot names are to be returned. |
Response Format
The REST service returns a JSON Map in the following format:
{
"data": [
{
"Name" : "<summary cashflow curve name>",
"snapshot_name" : ["<list of snapshot names>"]
}
],
"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 Success Response
This is an example of a successful response.
{
"data": [
{
"Name": ["New curve 5"],
"snapshot
_name": ["Rest snapshot 1"]
}
],
"messa
ge": ["success"],
"statu
s": 200
,
"rest_audit_i
d": 2385
}
Sample Failed Response
The following response is returned when the cashflow curve name is not specified in the request.
{
"data": [],
"message": ["Cashflow curve name is mandatory and is missing in the input request"],
"status": 13003,
"rest_audit_id": 2386
}
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 number is not provided. | 13001 | Project/Shell number is mandatory and is missing in the input request |
| Project number is invalid. | 602 | Project/Shell Number is not correct. |
| 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 a 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. |
Related Topics
Snapshots in Cashflow Summary Curves
Create Snapshot at the Summary Level Cashflow Worksheet
Delete Snapshot from Cashflow Curve
Last Published Tuesday, July 1, 2025