Agnostic Guides
...
docuflow SCRUD Web Services
Box Endpoints

Create

4min

Docuflow provides a web service endpoint that will allow you to create a document or folder.

The following endpoint allows the following capabilities.

  1. Create a File
  2. Create a File with metadata
  3. Create a folder
  4. Create a folder with metadata
  5. Create a nested folder structure (with parent obtaining metadata)
  6. Create a single level tree structure (with parent obtaining metadata)



Create a file with no metadata
POST
Request
Body Parameters
type
String
required
Metdata template name in box.
location
String
required
Folder id where the file will be located in box.
selectedCMS
String
required
Value should always be set to "box" to let docuflow know which configured content system to search.
cmsName
String
required
Name of the box system configured in docuflow.

Create a file with metadata
POST
Request
Body Parameters
type
String
required
Metdata template name in box.
location
String
required
Folder id where the file will be located in box.
selectedCMS
String
required
Value should always be set to "box" to let docuflow know which configured content system to search.
cmsName
String
required
Name of the box system configured in docuflow.
mdArray
Array
required
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.

Create a folder with no metadata
POST
Request
Body Parameters
type
String
required
Metdata template name in box.
location
String
required
Folder id where the file will be located in box.
selectedCMS
String
required
Value should always be set to "box" to let docuflow know which configured content system to search.
cmsName
String
required
Name of the box system configured in docuflow.
custom1
String
required
Name of the folder you would like to create.

Create a Folder with metadata
POST
Request
Body Parameters
type
String
required
Metdata template name in box.
location
String
required
Folder id where the file will be located in box.
selectedCMS
String
required
Value should always be set to "box" to let docuflow know which configured content system to search.
cmsName
String
required
Name of the box system configured in docuflow.
custom1
String
required
Name of the folder you would like to create.
mdArray
Array
required
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.
metaDataFolderFlag
Boolean
required
true if setting metadata for folders false if not setting metadata for folders

Create a Folder with metadata
POST
Request
Body Parameters
type
String
required
Metdata template name in box.
location
String
required
Folder id where the file will be located in box.
selectedCMS
String
required
Value should always be set to "box" to let docuflow know which configured content system to search.
cmsName
String
required
Name of the box system configured in docuflow.
custom1
String
required
Name of the folder you would like to create. If using nested the delimiter is #DFLOW#
mdArray
Array
required
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.
enableNested
Boolean
required
true (if wanting each folder to have one child in a nested manner) false (if all children are located under the first folder name)
metaDataFolderFlag
Boolean
required
true if setting metadata for folders false if not setting metadata for folders

Create a Folder with metadata
POST
Request
Body Parameters
type
String
required
Metdata template name in box.
location
String
required
Folder id where the file will be located in box.
selectedCMS
String
required
Value should always be set to "box" to let docuflow know which configured content system to search.
cmsName
String
required
Name of the box system configured in docuflow.
custom1
String
required
Name of the folder you would like to create. If using nested the delimiter is #DFLOW#
mdArray
Array
required
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.
enableNested
Boolean
required
true (if wanting each folder to have one child in a nested manner) false (if all children are located under the first folder name)
metaDataFolderFlag
Boolean
required
true if setting metadata for folders false if not setting metadata for folders

Create a Folder with metadata
POST
Request
Body Parameters
type
String
required
Metdata template name in box.
location
String
required
Folder id where the file will be located in box.
selectedCMS
String
required
Value should always be set to "box" to let docuflow know which configured content system to search.
cmsName
String
required
Name of the box system configured in docuflow.
custom1
String
required
Name of the folder you would like to create. If using nested the delimiter is #DFLOW#
mdArray
Array
required
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.
enableNested
Boolean
required
true (if wanting each folder to have one child in a nested manner) false (if all children are located under the first folder name)
metaDataFolderFlag
Boolean
required
true if setting metadata for folders false if not setting metadata for folders




Updated 03 Mar 2023
Doc contributor
Did this page help you?
PREVIOUS
Search
NEXT
Read
Docs powered by Archbee