Fetch List of Attached Files in a BP

GET /ws/rest/service/v1/bp/record/file/list/P-0001?input={"bpname" : "Purchase Orders","record_no" : "PO-0104"}

Where "P-0104" is the project number. If the project number is specified, then the record will be fetched from that project, if the project number is not specified then the record will be fetched from company-level BP.

Purpose

This web service enables the external application to fetch a list of attachments in a specific BP record in a:

Shell or project, based on the shell or project number.
Company, if the shell or project number is not available or has not been provided.

If there is a revision performed on any attached files, the list API returns the latest revised file details.

If any of the attached files are revised (at the record level, or at the line item level), the API list will contain all those revised files.

Note: By design, there are no web services available for the Request for Bid (RFB) business process.

JSON input provides many options for fetching the data.

Input

All parameters should be URL encoded.

Path Parameter

project_number

Specify the project number for the project that contains the BP records. If you do not specify the project number, then the system will fetch the BP records at company level.

filter_condition

input= {

"bpname" : "Purchase Orders",

"record_no" : "PO-0104"

}

Request parameters have to be added with the above parameters.

You must add the request parameters to the parameters listed above.

The "bpname" and "record_no" are mandatory.

Output

JSON object containing 'status', 'data', 'message'

The system will display a message if the status is not 200; otherwise, the operation is "success".

Get BP Record Attachment list Sample Response

{

"data": [

{

"bpname": "Purchase Orders",

"attachments": [

{

"issue_date": null,

"revision_no": null,

"file_name": "abc - Copy (3).txt",

"file_id": 13392,

"tab_name": "",

"publication_no": 8,

"title": null,

"file_size": 5

},

{

"issue_date": null,

"revision_no": null,

"file_name": "abc - Copy (4).txt",

"file_id": 13393,

"tab_name": "",

"publication_no": 12,

"title": null,

"file_size": 5

}

],

"detailTabs": [

{

"attachments": [

{

"issue_date": null,

"revision_no": null,

"file_name": "abc - Copy (5).txt",

"file_id": 13394,

"tab_name": "Line Items",

"publication_no": 11,

"title": null,

"file_size": 5

},

{

"issue_date": null,

"revision_no": null,

"file_name": "abc - Copy (6).txt",

"file_id": 13395,

"tab_name": "Line Items",

"publication_no": 11,

"title": null,

"file_size": 5

},

{

"issue_date": null,

"revision_no": null,

"file_name": "abc - Copy (7).txt",

"file_id": 13396,

"tab_name": "Line Items",

"publication_no": 11,

"title": null,

"file_size": 5

},

{

"issue_date": null,

"revision_no": null,

"file_name": "abc - Copy (8).txt",

"file_id": 13397,

"tab_name": "Line Items",

"publication_no": 8,

"title": null,

"file_size": 5

}

],

"tab_name": "Line Items"

}

],

"record_no": "PO-0104"

}

],

"message": [

"success"

],

"status": 200

}

Purpose

Input

Output

Related Topics