Read

1 min

Link Enterprise provides a web service endpoint that will allow you to retrieve a file or folders metadata or binary content of a file.

Included below are examples of reading a files metadata and it's binary content. (Two separate calls)

Read (metadata)

Retrieve a file or folders metadata by using its unique box identifier.

POST

https://localhost:82/scrud/read

Body Parameters

cmsNamestringrequired
Description
Name of the box system configured in Link Enterprise .
typeStringrequired
Description
Name of metadata template in box.
idstringrequired
Description
Unique id of box file or folder.
selectedCMSstringrequired
Description
Value should always be set to "box" to let Link Enterprise know which configured content system to search.
getContentBoolean
Description
true/false (will retrieve binary of file)

json

{
   "cmsName":"insertProductionSystemName (located in Link Enterprise gui)",
   "type":"insertMetaDataTemplateName",
   "id":"unique box id specfic to folder/id",
	"selectedCMS":"box"
	
}

200

{
	"ContentElements": "demo1.txt#DFLOW#text/plain#DFLOW#2111",
	"comment_count": "0",
	"companyCode": "",
	"content_created_at": "10/12/2021 12:48:52 p.m. PDT",
	"content_modified_at": "10/12/2021 12:48:52 p.m. PDT",
	"created_at": "12/20/2021 07:29:31 a.m. PST",
	"created_by": "Bhavani Singetam",
	"description": "",
	"LinkEnterpriseSaplinkEnabled": "",
	"LinkEnterpriseTimestamp": "",
	"LinkEnterpriseUsername": "",
	"LinkEnterprisetaskid": "15103846926",
	"LinkEnterprisetaskstatus": "in-process",
	"LinkEnterpriseworkflowid": "",
	"embed1": "https://gimmal-box.app.box.com/preview/expiring_embed/gvoct6FE!hc4EhSwuz8Zl-y-Sf8ObT25vPUi0lkTN3P_G1lELtgvcTHI4XYWYP-XZhZWcK5z5CI4u9e7c3_RoAfYB20tZMuFl0x2V7fSwClu8AhnPutLbNP1FtCxFafNsqjCtAHvpS_se8df5J8GEz9i-tcBi4b1opVcVAGLMDiZ4KX2GroXLuGTzx4aMT80hFSHoR-NCXUOkX-ybyMNUp78Tsk8L3Ka1O3mji4NA1uUuA7UPluNXgai7tpzUd-ZNvnLJdAXlrxhYftkAIDGEKAhq4CEFk4nyQ7gvU_WueSQiyHzSbwAY8VofPHTPcyrR8S7Mr7Bm-51RkzeL6SHhgIDkP-GeFLI3aHbpVKRlK5jKx74E9mJ8jbp3ll6W-9sFaKJj_UQgfcxObiNS-uT2ens9z8HzNxdLY4G-XuEzY3zFyDUdGzDKWIF8kUrC-UUMnJbE8ZjJx_Ae4Hv8kygHHJAmaU3SbHUekHLNMssnAp_jkPXg2zJupr-hjimdAldrxYV6owh-ak3op7a22qzUqmsGad7sDjsPDTm5NxP7Ea87N-T6Rrqirgrg9sxUjc1jeVCueysT-xL6ekW70oh_WM2ZFJNnf_qSDWisSyrtMGFSSNUAxySNwMZA-YRBgaKHwBHp3C942PvhLyFtxtCZ3tLA1n1acf9ow3RKmgEoV65hih6Tlaq2gfdy6wbgIRfwsKYmrP2xH67YMibfKn22xI0Isgw49Vo1VvDLFqsJ5OCUcsucG-ouuB3j4kAcwvoQa-rWdLL-Tym-04Xzp4ZmzAXZIZ0AQSfS-ifcqGPoXuL79WMYN7QAc9RgALvtq6qmkMvHaHKAbPI4G0Mnkisyiy-1xYKiAUQZlsJ4UXVhtc6qK3w78rmO8b7xVyE2lLDTQVg0McmrWk9csdNNGjVZS9vQ5Wj6SFcVFw1rw3r6r0epOH-ryN8FRy2BU4b-rV1qX1_UO1",
	"embed2": "Kne3s4qBnDfTAL8DoHZoq7qssnDf9P-aznmofY-lZNz0Bk8oek5Qcgf_NChMzkPyNgAT6_RSgwhMNgGh7hUuNMNOdak5_xs-bZANve68DtQWwBqwwG6kGydnZcu8Upg7JczEuwIhVO8O-5YZvMt6rq7_fFnnFeyOLx41cjNQZ3MmnK6IBw18FQhhEKU2r_pMoy4ft6-NF0D48Elhc2WxD1PIy9q6ZL4qhNHFdIMSK-tbWR0cD9lanR6GFh9h2Ggh7AWFq-K126TEgY5jD2NC",
	"etag": "1",
	"expiring_embed_link": "https://gimmal-box.app.box.com/preview/expiring_embed/gvoct6FE!hc4EhSwuz8Zl-y-Sf8ObT25vPUi0lkTN3P_G1lELtgvcTHI4XYWYP-XZhZWcK5z5CI4u9e7c3_RoAfYB20tZMuFl0x2V7fSwClu8AhnPutLbNP1FtCxFafNsqjCtAHvpS_se8df5J8GEz9i-tcBi4b1opVcVAGLMDiZ4KX2GroXLuGTzx4aMT80hFSHoR-NCXUOkX-ybyMNUp78Tsk8L3Ka1O3mji4NA1uUuA7UPluNXgai7tpzUd-ZNvnLJdAXlrxhYftkAIDGEKAhq4CEFk4nyQ7gvU_WueSQiyHzSbwAY8VofPHTPcyrR8S7Mr7Bm-51RkzeL6SHhgIDkP-GeFLI3aHbpVKRlK5jKx74E9mJ8jbp3ll6W-9sFaKJj_UQgfcxObiNS-uT2ens9z8HzNxdLY4G-XuEzY3zFyDUdGzDKWIF8kUrC-UUMnJbE8ZjJx_Ae4Hv8kygHHJAmaU3SbHUekHLNMssnAp_jkPXg2zJupr-hjimdAldrxYV6owh-ak3op7a22qzUqmsGad7sDjsPDTm5NxP7Ea87N-T6Rrqirgrg9sxUjc1jeVCueysT-xL6ekW70oh_WM2ZFJNnf_qSDWisSyrtMGFSSNUAxySNwMZA-YRBgaKHwBHp3C942PvhLyFtxtCZ3tLA1n1acf9ow3RKmgEoV65hih6Tlaq2gfdy6wbgIRfwsKYmrP2xH67YMibfKn22xI0Isgw49Vo1VvDLFqJ5OCUcsucG-ouuB3j4kAcwvoQa-rWdLL-Tym-04Xzp4ZmzAXZIZ0AQSfS-ifcqGPoXuL79WMYN7QAc9RgALvtq6qmkMvHaHKAbPI4G0Mnkisyiy-1xYKiAUQZlsJ4UXVhtc6qK3w78rmO8b7xVyE2lLDTQVg0McmrWk9csdNNGjVZS9vQ5Wj6SFcVFw1rw3r6r0epOH-ryN8FRy2BU4b-rV1qX1_UO1Kne34qBnDfTAL8DoHZoq7qssnDf9P-aznmofY-lZNz0Bk8oek5Qcgf_NChMzkPyNgAT6_RSgwhMNgGh7hUuNMNOdak5_xs-bZANve68DtQWwBqwwG6kGydnZcu8Upg7JczEuwIhVO8O-5YZvMt6rq7_fFnnFeyOLx41cjNQZ3MmnK6IBw18FQhhEKU2r_pMoy4ft6-NF0D48Elhc2WxD1PIy9q6ZL4qhNHFdIMSK-tbWR0cD9lanR6GFh9h2Gghs7AWFq-K126TEgY5jD2NC",
	"extension": "txt",
	"fileVersion": "967518965567",
	"file_version": "967518965567",
	"has_collaborations": "true",
	"id": "897859484481",
	"is_package": "false",
	"item_status": "active",
	"lastUpdated": "1640195853",
	"linkedToSap": "",
	"lock": "",
	"modified_at": "12/22/2021 09:57:30 a.m. PST",
	"modified_by": "someone",
	"name": "demo1.txt",
	"owned_by": "Link Enterprise Demo",
	"parent": "1474026705828",
	"path_collection": "/test",
	"paymentTerm": "",
	"permissions": "can_download:true,can_preview:true,can_upload:true,can_comment:true,can_rename:true,can_delete:true,can_share:true,can_set_share_access:true",
	"poNumber": "5900",
	"poStatus": "",
	"purged_at": "",
	"sequence_id": "1",
	"sha1": "013efd1020dea4fcdc4f9118433acc8ded3bf895",
	"shared_link": "",
	"size": "2111",
	"tags": "",
	"trashed_at": "",
	"type": "file",
	"vendorName": "",
	"vendorNumber": "",
	"version_number": "2"
}

500

Read (Binary content)

Retrieve a files binary by using its unique box identifier.

POST

https://localhost:82/scrud/read

Body Parameters

cmsNamestringrequired
Description
Name of the box system configured in Link Enterprise.
typestringrequired
Description
Name of metadata template in box.
idstringrequired
Description
Unique id of box file or folder.
selectedCMSstringrequired
Description
Value should always be set to "box" to let Link Enterprise know which configured content system to search.

json

{
   "cmsName":"insertProductionSystemName (located in Link Enterprise gui)",
   "type":"insertMetaDataTemplateName",
   "id":"unique box id specfic to folder/id",
   "selectedCMS":"box",
   "getContent":true
	
}

Headers Response (200)

< HTTP/1.1 200 OK
< filename: demo1.txt
< size: 2111
< transfer-encoding: chunked

200

...binary

500