Read

docuflow 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 seperate calls) { "tab" "examples", "url" "https //localhost 82/scrud/read", "name" "read (metadata)", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "cmsname", "type" "string", "description" "name of the box system configured in docuflow " }, { "kind" "required", "name" "type", "type" "string", "description" "name of metadata template in box " }, { "kind" "required", "name" "id", "type" "string", "description" "unique id of box file or folder " }, { "kind" "required", "name" "selectedcms", "type" "string", "description" "value should always be set to \\"box\\" to let docuflow know which configured content system to search " }, { "kind" "optional", "name" "getcontent", "type" "boolean", "description" "true/false (will retrieve binary of file)" } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "aqtbyivnqaalpoappmcnz", "code" "{\n\t\\"contentelements\\" \\"demo1 txt#dflow#text/plain#dflow#2111\\",\n\t\\"comment count\\" \\"0\\",\n\t\\"companycode\\" \\"\\",\n\t\\"content created at\\" \\"10/12/2021 12 48 52 p m pdt\\",\n\t\\"content modified at\\" \\"10/12/2021 12 48 52 p m pdt\\",\n\t\\"created at\\" \\"12/20/2021 07 29 31 a m pst\\",\n\t\\"created by\\" \\"bhavani singetam\\",\n\t\\"description\\" \\"\\",\n\t\\"docuflowsaplinkenabled\\" \\"\\",\n\t\\"docuflowtimestamp\\" \\"\\",\n\t\\"docuflowusername\\" \\"\\",\n\t\\"docuflowtaskid\\" \\"15103846926\\",\n\t\\"docuflowtaskstatus\\" \\"in process\\",\n\t\\"docuflowworkflowid\\" \\"\\",\n\t\\"embed1\\" \\"https //versafile 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\\",\n\t\\"embed2\\" \\"kne3s4qbndftal8dohzoq7qssndf9p aznmofy lznz0bk8oek5qcgf nchmzkpyngat6 rsgwhmnggh7huunmnodak5 xs bzanve68dtqwwbqwwg6kgydnzcu8upg7jczeuwihvo8o 5yzvmt6rq7 ffnnfeyolx41cjnqz3mmnk6ibw18fqhheku2r pmoy4ft6 nf0d48elhc2wxd1piy9q6zl4qhnhfdimsk tbwr0cd9lanr6gfh9h2ggh7awfq k126tegy5jd2nc\\",\n\t\\"etag\\" \\"1\\",\n\t\\"expiring embed link\\" \\"https //versafile 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\\",\n\t\\"extension\\" \\"txt\\",\n\t\\"fileversion\\" \\"967518965567\\",\n\t\\"file version\\" \\"967518965567\\",\n\t\\"has collaborations\\" \\"true\\",\n\t\\"id\\" \\"897859484481\\",\n\t\\"is package\\" \\"false\\",\n\t\\"item status\\" \\"active\\",\n\t\\"lastupdated\\" \\"1640195853\\",\n\t\\"linkedtosap\\" \\"\\",\n\t\\"lock\\" \\"\\",\n\t\\"modified at\\" \\"12/22/2021 09 57 30 a m pst\\",\n\t\\"modified by\\" \\"someone\\",\n\t\\"name\\" \\"demo1 txt\\",\n\t\\"owned by\\" \\"docuflow demo\\",\n\t\\"parent\\" \\"1474026705828\\",\n\t\\"path collection\\" \\"/test\\",\n\t\\"paymentterm\\" \\"\\",\n\t\\"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\\",\n\t\\"ponumber\\" \\"5900\\",\n\t\\"postatus\\" \\"\\",\n\t\\"purged at\\" \\"\\",\n\t\\"sequence id\\" \\"1\\",\n\t\\"sha1\\" \\"013efd1020dea4fcdc4f9118433acc8ded3bf895\\",\n\t\\"shared link\\" \\"\\",\n\t\\"size\\" \\"2111\\",\n\t\\"tags\\" \\"\\",\n\t\\"trashed at\\" \\"\\",\n\t\\"type\\" \\"file\\",\n\t\\"vendorname\\" \\"\\",\n\t\\"vendornumber\\" \\"\\",\n\t\\"version number\\" \\"2\\"\n}", "language" "200" }, { "id" "xsgvy8yv1kfaoeknqvzyo", "code" "", "language" "500" } ], "selectedlanguageid" "aqtbyivnqaalpoappmcnz" }, "examples" { "languages" \[ { "id" "tcwwzopbzuyostbg6mhf6", "code" "{\r\n \\"cmsname\\" \\"insertproductionsystemname (located in docuflow gui)\\",\r\n \\"type\\" \\"insertmetadatatemplatename\\",\r\n \\"id\\" \\"unique box id specfic to folder/id\\",\r\n\t\\"selectedcms\\" \\"box\\"\r\n\t\r\n}", "language" "json" } ], "selectedlanguageid" "tcwwzopbzuyostbg6mhf6" }, "description" "retrieve a file or folders metadata by using its unique box identifier ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } { "tab" "examples", "url" "https //localhost 82/scrud/read", "name" "read (binary content)", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "cmsname", "type" "string", "description" "name of the box system configured in docuflow " }, { "kind" "required", "name" "type", "type" "string", "description" "name of metadata template in box " }, { "kind" "required", "name" "id", "type" "string", "description" "unique id of box file or folder " }, { "kind" "required", "name" "selectedcms", "type" "string", "description" "value should always be set to \\"box\\" to let docuflow know which configured content system to search " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "6nop6h9uzjcwnitxenbl ", "code" " binary", "language" "200" }, { "id" "51nldtxmlxjiljk3a5kn2", "code" "", "language" "500" } ], "selectedlanguageid" "6nop6h9uzjcwnitxenbl " }, "examples" { "languages" \[ { "id" "w57rhgj7sfc mocpal2gg", "code" "{\r\n \\"cmsname\\" \\"insertproductionsystemname (located in docuflow gui)\\",\r\n \\"type\\" \\"insertmetadatatemplatename\\",\r\n \\"id\\" \\"unique box id specfic to folder/id\\",\r\n \\"selectedcms\\" \\"box\\",\r\n \\"getcontent\\"\ true\r\n\t\r\n}", "language" "json" }, { "id" "9rv4vdz 6yxs1dhppxns3", "code" "< http/1 1 200 ok\r\n< filename demo1 txt\r\n< size 2111\r\n< transfer encoding chunked", "language" "none", "customlabel" "headers response (200)" } ], "selectedlanguageid" "w57rhgj7sfc mocpal2gg" }, "description" "retrieve a files binary by using its unique box identifier ", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } }