ADAS Test

Get all document folders or one by name.

Version 2.0.0
download iconDownload spec

Endpoint

GET
undefined/document-folders

Returns all documentFolders in an array. When specifying a name, return just one (not in an array).

arrowRequest

Query Parameters

    Body Parameters

    Responses

    successful operation.

    arrowBody

    application/json

    REQUEST

    1
    2
    3
    curl --request GET \
         --url 'https://example.com/document-folders?name=contracts_folder' \
         --header 'accept: application/json'

    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
          }
        }
      ]
    }