Agnostic Guides
...
Box Endpoints
Create
4 min
docuflow provides a web service endpoint that will allow you to create a document or folder the following endpoint allows the following capabilities create a file create a file with metadata create a folder create a folder with metadata create a nested folder structure (with parent obtaining metadata) create a single level tree structure (with parent obtaining metadata) tab examples url https localhost 82 scrud create name create a file method post request pathparameters queryparameters headerparameters bodydataparameters kind required name type type string description metdata template name in box kind required name location type string description folder id where the file will be located in box 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 required name cmsname type string description name of the box system configured in docuflow formdataparameters results languages id qy6 5apagjwnv1yokfjlh code language 200 id plh7o5ecp7uov1vgzxb4v code language 500 selectedlanguageid qy6 5apagjwnv1yokfjlh examples languages id t0iv7ht9sxkd jdtscjfz code r n cmsname name of the box system configured in docuflow r n filelocation c somefolder somefile txt r n type null r n location insert unique box folder id r n selectedcms box r n language json selectedlanguageid t0iv7ht9sxkd jdtscjfz description create a file with no metadata currentnewparameter label body parameter value bodydataparameters tab examples url http localhost 82 scrud create name create a file metadata method post request pathparameters queryparameters headerparameters bodydataparameters kind required name type type string description metdata template name in box kind required name location type string description folder id where the file will be located in box 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 required name cmsname type string description name of the box system configured in docuflow kind required name mdarray type array description a json array where each index is a json object with the keys md1 and md2 where md1 is the column name and md2 is the value to be inserted in that column formdataparameters results languages id 1cba2f6sfzetrikzok9gy code language 200 id u4te0pgo igkcns fcu5f code language 500 selectedlanguageid 1cba2f6sfzetrikzok9gy examples languages id zpcvsjje70evgxirz9io6 code r n cmsname name of the box system configured in docuflow r n filelocation c somefolder somefile txt r n type insertmetadatatemplate r n location insert unique box folder id r n selectedcms box r n mdarray r n r n md1 insertcolumnname r n md2 insertvalue r n r n r n md1 somevendor r n md2 versafile inc r n r n t t r n language json selectedlanguageid zpcvsjje70evgxirz9io6 description create a file with metadata currentnewparameter label body parameter value bodydataparameters tab examples url https localhost 82 scrud create name create a folder method post request pathparameters queryparameters headerparameters bodydataparameters kind required name type type string description metdata template name in box kind required name location type string description folder id where the file will be located in box 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 required name cmsname type string description name of the box system configured in docuflow kind required name custom1 type string description name of the folder you would like to create formdataparameters results languages id 5qkbbr19cokl70ls1pxf2 code language 200 id ijhckvarl84itan3pv6w9 code language 500 selectedlanguageid 5qkbbr19cokl70ls1pxf2 examples languages id nevlnbjbw2qpwrrwuwjoe code r n cmsname name of the box system configured in docuflow r n type null r n location insert unique box folder id r n selectedcms box r n custom1 insert folder name r n language json selectedlanguageid nevlnbjbw2qpwrrwuwjoe description create a folder with no metadata currentnewparameter label body parameter value bodydataparameters tab examples url https localhost 82 scrud create name create a folder metadata method post request pathparameters queryparameters headerparameters bodydataparameters kind required name type type string description metdata template name in box kind required name location type string description folder id where the file will be located in box 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 required name cmsname type string description name of the box system configured in docuflow kind required name custom1 type string description name of the folder you would like to create kind required name mdarray type array description a json array where each index is a json object with the keys md1 and md2 where md1 is the column name and md2 is the value to be inserted in that column kind required name metadatafolderflag type boolean description true if setting metadata for folders nfalse if not setting metadata for folders formdataparameters results languages id j4jbmcuon32 xmy7qobw5 code language 200 id xnls3q42 c9cqsy bxnrg code language 500 selectedlanguageid j4jbmcuon32 xmy7qobw5 examples languages id da o059gxjgcbko54azbg code r n cmsname name of the box system configured in docuflow r n filelocation c somefolder somefile txt r n type insertmetadatatemplate r n location insert unique box folder id r n selectedcms box r n mdarray r n r n md1 insertcolumnname r n md2 insertvalue r n r n r n md1 somevendor r n md2 versafile inc r n r n t t r n custom1 foldername r n metadatafolderflag true r n language json selectedlanguageid da o059gxjgcbko54azbg description create a folder with metadata currentnewparameter label body parameter value bodydataparameters tab examples url https localhost 82 scrud create name create a folder metadata and nested method post request pathparameters queryparameters headerparameters bodydataparameters kind required name type type string description metdata template name in box kind required name location type string description folder id where the file will be located in box 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 required name cmsname type string description name of the box system configured in docuflow kind required name custom1 type string description name of the folder you would like to create if using nested the delimiter is dflow kind required name mdarray type array description a json array where each index is a json object with the keys md1 and md2 where md1 is the column name and md2 is the value to be inserted in that column kind required name enablenested type boolean description true if wanting each folder to have one child in a nested manner n nfalse if all children are located under the first folder name kind required name metadatafolderflag type boolean description true if setting metadata for folders nfalse if not setting metadata for folders formdataparameters results languages id ys7bdjdt95knojd3mo ts code language 200 id w rsvemaqh63d1pe6203q code language 500 selectedlanguageid ys7bdjdt95knojd3mo ts examples languages id 3 nqpfviu8kl s bha0re code r n cmsname name of the box system configured in docuflow r n filelocation c somefolder somefile txt r n type insertmetadatatemplate r n location insert unique box folder id r n selectedcms box r n mdarray r n r n md1 insertcolumnname r n md2 insertvalue r n r n r n md1 somevendor r n md2 versafile inc r n r n t t r n custom1 foldername dflow foldername2 dflow foldername3 r n metadatafolderflag true r n enablenested true r n language json selectedlanguageid 3 nqpfviu8kl s bha0re description create a folder with metadata currentnewparameter label body parameter value bodydataparameters tab examples url https localhost 82 scrud create name create a folder metadata and nested false method post request pathparameters queryparameters headerparameters bodydataparameters kind required name type type string description metdata template name in box kind required name location type string description folder id where the file will be located in box 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 required name cmsname type string description name of the box system configured in docuflow kind required name custom1 type string description name of the folder you would like to create if using nested the delimiter is dflow kind required name mdarray type array description a json array where each index is a json object with the keys md1 and md2 where md1 is the column name and md2 is the value to be inserted in that column kind required name enablenested type boolean description true if wanting each folder to have one child in a nested manner n nfalse if all children are located under the first folder name kind required name metadatafolderflag type boolean description true if setting metadata for folders nfalse if not setting metadata for folders formdataparameters results languages id 8li 8rqvt1280crdvia4m code language 200 id hqzevvt5xbsr q 3w8pv code language 500 selectedlanguageid 8li 8rqvt1280crdvia4m examples languages id jvoaln50ovcf 9rzrzsu code r n cmsname name of the box system configured in docuflow r n filelocation c somefolder somefile txt r n type insertmetadatatemplate r n location insert unique box folder id r n selectedcms box r n mdarray r n r n md1 insertcolumnname r n md2 insertvalue r n r n r n md1 somevendor r n md2 versafile inc r n r n t t r n custom1 foldername dflow foldername2 dflow foldername3 r n metadatafolderflag true r n enablenested false r n language json selectedlanguageid jvoaln50ovcf 9rzrzsu description create a folder with metadata currentnewparameter label body parameter value bodydataparameters tab examples url https localhost 82 scrud create name create a folder no metadata and nested false method post request pathparameters queryparameters headerparameters bodydataparameters kind required name type type string description metdata template name in box kind required name location type string description folder id where the file will be located in box 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 required name cmsname type string description name of the box system configured in docuflow kind required name custom1 type string description name of the folder you would like to create if using nested the delimiter is dflow kind required name mdarray type array description a json array where each index is a json object with the keys md1 and md2 where md1 is the column name and md2 is the value to be inserted in that column kind required name enablenested type boolean description true if wanting each folder to have one child in a nested manner n nfalse if all children are located under the first folder name kind required name metadatafolderflag type boolean description true if setting metadata for folders nfalse if not setting metadata for folders formdataparameters results languages id pmc3rv yahrbsgjvgunzh code language 200 id uyqpeq8m7bpu1wynqurat code language 500 selectedlanguageid pmc3rv yahrbsgjvgunzh examples languages id jyzcnzh5dm82k7jndypzt code r n cmsname name of the box system configured in docuflow r n filelocation c somefolder somefile txt r n type null r n location insert unique box folder id r n selectedcms box r n custom1 foldername dflow foldername2 dflow foldername3 r n metadatafolderflag false r n enablenested false r n language json selectedlanguageid jyzcnzh5dm82k7jndypzt description create a folder with metadata currentnewparameter label body parameter value bodydataparameters