Create a document folder.

Version 3.0.0
download iconDownload spec

Endpoint

POST
undefined/document-folders

Create a single documentFolder.

arrowRequest

Create a new documentFolder.

Body Parameters

Responses

Successful operation.

arrowBody

application/json

REQUEST

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
curl --request POST \
     --url https://example.com/document-folders \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "id": "f1",
  "name": "contracts_folder",
  "description": "Customer Contracts",
  "creationDate": "2023-11-20",
  "lastUpdated": "2024-03-08",
  "fields": [
    {
      "searchName": "Bill Date",
      "sortLevel": 1,
      "sortAscDesc": "D",
      "searchDateFormat": "MM/DD/YYYY",
      "resultDateFormat": "MM/DD/YYYY",
      "creationDate": "2023-11-20",
      "lastUpdated": "2024-03-08",
      "documentGroupMapping": [
        {
          "groupId": "g2",
          "fieldName": "bill_date"
        }
      ],
      "documentFolderDisplay": {
        "searchPresentationOrder": 1,
        "searchDefaultWildcard": "Append",
        "searchDefaultOperator": "Greater Than Or Equal To",
        "searchDefaultValue": "Last 3 Months",
        "resultsPresentationOrder": 1
      }
    }
  ]
}
'

RESPONSE

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
  "id": "f1",
  "name": "contracts_folder",
  "description": "Customer Contracts",
  "creationDate": "2023-11-20",
  "lastUpdated": "2024-03-08",
  "fields": [
    {
      "searchName": "Bill Date",
      "sortLevel": 1,
      "sortAscDesc": "D",
      "searchDateFormat": "MM/DD/YYYY",
      "resultDateFormat": "MM/DD/YYYY",
      "creationDate": "2023-11-20",
      "lastUpdated": "2024-03-08",
      "documentGroupMapping": [
        {
          "groupId": "g2",
          "fieldName": "bill_date"
        }
      ],
      "documentFolderDisplay": {
        "searchPresentationOrder": 1,
        "searchDefaultWildcard": "Append",
        "searchDefaultOperator": "Greater Than Or Equal To",
        "searchDefaultValue": "Last 3 Months",
        "resultsPresentationOrder": 1
      }
    }
  ]
}