Get BP Record With Attachments

GET /ws/rest/service/v1/bp/record/file/{project_number}

Purpose

Get a record detail and all the attachments in the record and its lineitem and general comments, based on input parameter, of a specific BP in a shell based on shell number or from company level if project/shell number is not provided.

The input JSON shall provide various options to be considered for fetching the data

Request Parameters

All parameters should be URL encoded.

Path Parameter

project_num: Specify the Project number in which the records exists; if not provided, records are fetched from Company Level.

GET URL Parameter

input =

{

"bpname":"Vendors",

"record_no":"VEN-0024",

"lineitem":"yes",

"lineitem_file":"yes",

"general_comments":"yes",

"attach_all_publications":"yes"

}

The "record_no" and "bpname" are mandatory input parameters.

The "lineitem" values "yes" or "no"; default is "yes", if not provided.

The "lineitem_file" values "yes" or "no"; default is "yes", but if "lineitem" is "no" then "lineitem_file" will be considered "no".

The "lineitem_file" input parameter is decided if lineitem attachments will be download or not.

The "general_comments" is for having general comment data in response along with its attachment; by default, it is "yes".

The "attach_all_publications" is for downloading all the publications/revisions for file attached; by default, it is "no".

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.

For general spends, payment application, or generic cost BPs, the following funding details are also included in the response:

unassigned_amount
fund information as a JSON array with the following values:
- code
- fund_balance
- assigned_amount

Record data will be part of response field "record_data", and record level attachments will always return in response.

Attachments will be part of response field "file_handler", which is base64 encoded zip file String and should be decoded with base64 decoder application or online decoder, for example: https://www.base64decode.org/

The file name is outermost "file_name" field in response.

If multiple revision or publication of file is attached, the attachment detail in response will contain all the publications; however, the file with latest publication will be part of downloaded attachment.

To download all the publication/revisions of file attached in record, set "attach_all_publications" in input JSON. It will get all publications from Record upper and detail forms only.

Output Folder structure

zip_file

|

+-- attachments

| |

| +-- files attached to record ( upper form )

| |

| +-- lineitem_<lineitem number>

| |

| +-- files attached to lineitem

|

+-- gc_attachments ( general comment attachments )

|

+-- comment_<comment number>

|

+-- files attached to comment

Output Folder structure when "attach_all_publications" is "yes"

zip_file

|

+-- attachments

| |

| +-- publication_<publication number>

| | |

| | +-- files attached to record which has same publication number as in parent folder suffix

| |

| +-- lineitem_<lineitem number>

| |

| +-- publication_<publication number>

| |

| +-- files attached to lineitem which has same publication number as in parent folder suffix

|

+-- gc_attachments ( general comment attachments )

|

+-- comment_<comment number>

|

+-- files attached to comment

Note: If Integration interface is defined for that BP, all fields defined in this interface will be sent in the response.

If the integration interface is not defined, all Custom defined Fields will be sent in response.

Sample Response

{

"data":[

{

"record_data":{

"uuu_user_id":"a@abc.com",

"uuu_record_last_update_date":"2018/05/28 04:34",

"uveFaxTB16":null,

"uveCertificateNoTB64":null,

"uvePrimaryContactTB64":"a",

"title":"v-00024",

"uveLicenseNoTB16":null,

"_general_comments":[

{

"firstname":"Company",

"comment_state":"Active",

"create_date_iso":"2018-05-28T04:34",

"page_num":"0",

"lastmodified_iso":"2018-05-28T04:34",

"shortname":"idc",

"content":"\nNew attach comment",

"has_annotation":"0",

"lastname":"Administrator",

"attachment":{

"issue_date":null,

"revision_no":null,

"file_name":"27362157.jpg",

"publication_no":1,

"title":null,

"file_size":201571

},

"companyname":"idc",

"attachment_id":"0",

"fullname":"Company Administrator",

"create_date":[

"05-28-2018 04:34:55",

"05-28-2018 04:34:55"

],

"attachment_count":"1"

},

{

"firstname":"Company",

"comment_state":"Active",

"create_date_iso":"2018-05-28T04:07",

"page_num":"0",

"lastmodified_iso":"2018-05-28T04:07",

"shortname":"idc",

"content":"\nThis is a wonderful general comment",

"has_annotation":"0",

"lastname":"Administrator",

"companyname":"idc",

"attachment_id":"0",

"fullname":"Company Administrator",

"create_date":[

"05-28-2018 04:07:03",

"05-28-2018 04:07:03"

],

"attachment_count":"0"

}

],

"uuu_contact_company":"v-00024",

"uveCOIAmoutCA":0.0,

"_bp_lineitems":[

{

"uirCntctFstNmTB":"a",

"uuu_user_workphone":null,

"uuu_tab_id":"List of Contacts",

"title":"t",

"ugenAddress1TXT120":null,

"attachment":[

{

"reference":"NO",

"issue_date":null,

"revision_no":null,

"file_name":"sample_upload_1.pdf",

"publication_no":1,

"title":null,

"create_date":"2018/05/21 19:39",

"file_size":83768

}

],

"ugenAddress2TXT120":null,

"ugenCountryPD":null,

"ugenCityTXT50":null,

"short_desc":"Vendor Contact",

"li_num":1,

"uriCntctLstNmTB":"b",

"ugenStatePD":null,

"ugenZipCodeTXT16":null,

"uveEmailTB120":null,

"ugenAddress3TXT120":null

},

{

"uirCntctFstNmTB":"a",

"uuu_user_workphone":null,

"uuu_tab_id":"List of Contacts",

"title":"t",

"ugenAddress1TXT120":null,

"attachment":[

{

"reference":"NO",

"issue_date":null,

"revision_no":null,

"file_name":"sample_upload_1.pdf",

"publication_no":0,

"title":null,

"create_date":"2018/05/21 19:39",

"file_size":83768

},

{

"reference":"NO",

"issue_date":null,

"revision_no":null,

"file_name":"sample_upload_2.pdf",

"publication_no":1,

"title":null,

"create_date":"2018/05/21 19:39",

"file_size":83768

}

],

"ugenAddress2TXT120":null,

"ugenCountryPD":null,

"ugenCityTXT50":null,

"short_desc":"Vendor Contact",

"li_num":2,

"uriCntctLstNmTB":"b",

"ugenStatePD":null,

"ugenZipCodeTXT16":null,

"uveEmailTB120":null,

"ugenAddress3TXT120":null

}

],

"attachment":[

{

"reference":"NO",

"issue_date":null,

"revision_no":null,

"file_name":"sample_upload_3.pdf",

"publication_no":1,

"title":null,

"create_date":"2018/05/21 19:39",

"file_size":83768

},

{

"reference":"NO",

"issue_date":null,

"revision_no":null,

"file_name":"sample_upload_3.pdf",

"publication_no":2,

"title":null,

"create_date":"2018/05/27 23:55",

"file_size":83768

}

],

"uvePolicyNoTB32":null,

"record_no":"VEN-0024",

"uveVendorTypePD":"Architect",

"ugenCityTXT50":null,

"uveCoiExpDOP":null,

"uuu_dm_publish_path":"v_path",

"uuu_contact_last_name":"b",

"ugenZipCodeTXT16":null,

"uveEmailTB120":"a@abc.com",

"ugenAddress3TXT120":null,

"uveReferenceIdTB16":null,

"uuu_creation_date":"2018/04/19 02:13",

"ugenRemarksTB4000":null,

"uvePhoneTB64":null,

"uveTaxIDTB16":null,

"uveMinorityBusCB":0,

"uveInsuranceCoTB32":null,

"ugenExpirationDateDOP":null,

"uveWomanOwnedCB":0,

"uveVendorNameTB50":"v-00024",

"ugenAddress1TXT120":null,

"uveDisadvantagedBusCB":0,

"ugenDiscipline":null,

"creator_id":"Company Administrator",

"ugenAddress2TXT120":null,

"ugenCountryPD":null,

"uveVendorIDTB16":"v-00024",

"ugenStatePD":null,

"uuu_contact_first_name":"a",

"status":"Active"

},

"file_name":"uv_VEN-0024_0_attachments.zip",

"file_handler":" base64 encoded zip file "

}

],

"message":[ "success" ],

"status":200

}

Purpose

Request Parameters

Response Format

Sample Response

Related Topics