Agnostic Guides
...
Box Endpoints
Create
4 min
link enterprise 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 link enterprise 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 vzfozygcxsopbwzdx0yew code language 200 id vqkvxqfkvkg x3yyvkcwc code language 500 selectedlanguageid vzfozygcxsopbwzdx0yew examples languages id cxpum3dlkeh5ctlxe mjb code r n cmsname name of the box system configured in link enterpri 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 cxpum3dlkeh5ctlxe mjb 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 link enterprise 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 0imkcf4s ykchraaxwjq3 code language 200 id idjmyl woawfo4s5k3 bg code language 500 selectedlanguageid 0imkcf4s ykchraaxwjq3 examples languages id yykmw0eact jck9 cgjjs code r n cmsname name of the box system configured in link enterprise 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 gimmal inc r n r n t t r n language json selectedlanguageid yykmw0eact jck9 cgjjs 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 link enterprise know which configured content system to search kind required name cmsname type string description name of the box system configured in link enterprise kind required name custom1 type string description name of the folder you would like to create formdataparameters results languages id 59h a2k0zonjiesyswrxe code language 200 id cfsyxvo ljjekethbmed code language 500 selectedlanguageid 59h a2k0zonjiesyswrxe examples languages id r7afh lq7ej9kyrx6 sdw code r n cmsname name of the box system configured in link enterprise 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 r7afh lq7ej9kyrx6 sdw 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 link enterprise know which configured content system to search kind required name cmsname type string description name of the box system configured in link enterprise 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 ecfzj0cyeeurqk6 xyi w code language 200 id lxcnvel7gh2nxd xcils3 code language 500 selectedlanguageid ecfzj0cyeeurqk6 xyi w examples languages id 9wxksomg0n4vqqcvfqncy code r n cmsname name of the box system configured in 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 gimmal inc r n r n t t r n custom1 foldername r n metadatafolderflag true r n language json selectedlanguageid 9wxksomg0n4vqqcvfqncy 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 link enterprise know which configured content system to search kind required name cmsname type string description name of the box system configured in link enterprise 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 1p4dxmaxpscwhcaijsf w code language 200 id yfjvjp7jqiuudivziep9b code language 500 selectedlanguageid 1p4dxmaxpscwhcaijsf w examples languages id uewifobfukx7uxgdl9xbi code r n cmsname name of the box system configured in link enterprise 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 gimmal 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 uewifobfukx7uxgdl9xbi 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 link enterprise know which configured content system to search kind required name cmsname type string description name of the box system configured in link enterprise 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 eznsiycqgduwgzvhvcpc code language 200 id n2nerzspkxazhkqm jwrv code language 500 selectedlanguageid eznsiycqgduwgzvhvcpc examples languages id bgcmlquzsw5m7cmhh8kbv code r n cmsname name of the box system configured in link enterpris 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 gimmal 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 bgcmlquzsw5m7cmhh8kbv 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 link enterprise know which configured content system to search kind required name cmsname type string description name of the box system configured in link enterprise 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 vo9jnepriajj6wvw4sip code language 200 id l4o7oo2z1fbfxmqca pgy code language 500 selectedlanguageid vo9jnepriajj6wvw4sip examples languages id m 86xorhlr5rl 54vrddu code r n cmsname name of the box system configured in link enterprise 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 m 86xorhlr5rl 54vrddu description create a folder with metadata currentnewparameter label body parameter value bodydataparameters