Get Fund Columns

GET /ws/rest/service/v1/fund/column/{project_number}

Purpose

Get the funding column data. This API can be used to get the fund balance as user can use a formula column to calculate the balance.

Request Format

All parameters should be URL encoded.

Path Parameter

project_number: (Optional) Specify the project/shell number to get the project/shell funding data or empty to get the company data.

url parameter -

filter=

{

"column_names":["Manual Funding by Project" ,"Project Funding"],

"codes":["Fund0","Fund1","Fund2"]

}

Note:

• Filter can be used to filter on column name and the fund code to get the data.
• For funding sheets with tree as display mode, if parent fund code is given in filter condition, error will be thrown.
• If with given filter column name, multiple columns exists in the funding sheet then validation error will be thrown.

Response Format

A JSON object is returned in the following format.

{

"data": [],

"message": [],

"status": <REST status code value>

}

A successful response displays a status code 200.

A failed response displays a message with a status code.

Note:

If no columns are defined in the fund sheet then the REST service returns an empty data array in the response.

Sample Response

{

"data":[

{

"Project Funding":{

"Data Source" : "Project_Funding",

"Funds":{

"fund0":101.00,

"fund1":100.2,

"fund2":100.3

}

}

},

{

"Manual Funding by Project":{

"Data Source" : "Manual_Funding",

"Funds":{

"fund0":101.00,

"fund1":100.2,

"fund2":100.3

}

}

}

],

"message":[

"success"

],

"status":"200"

}

Partial get is not allowed; that is, if one of the filter conditions fails, only an error message will be returned.