AT&T DevEx

ADAS Test

Search all document groups or documentGroup by name.

Version 2.0.0
download iconDownload spec

Endpoint

GET
undefined/document-groups

Provides a list of all documentGroups existing in the system or a one documentGroup (not ina an array) when searched by an existing name.

arrowRequest

Query Parameters

    Body Parameters

    Responses

    successful operation.

    arrowBody

    application/json

    REQUEST

    1
2
3
    curl --request GET \
     --url 'https://example.com/document-groups?name=contracts' \
     --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
32
33
34
35
36
37
38
39
    {
  "groups": [
    {
      "id": "g1",
      "name": "contracts",
      "description": "Special Contracts",
      "forceAllMetadata": true,
      "creationDate": "2023-11-20",
      "lastUpdated": "2024-03-08",
      "retentionPeriod": 61,
      "legalHold": false,
      "legalHoldStartDate": "2020-12-30",
      "legalHoldEndDate": "2021-02-15",
      "retentionEoy": true,
      "fields": [
        {
          "name": "Language",
          "type": "string",
          "length": 10,
          "dateFormat": "string",
          "retention": false,
          "defaultValue": "FR",
          "loadNames": "string",
          "ignoreChars": "[]()-",
          "validValues": [
            {
              "key": "EN",
              "value": "English"
            },
            {
              "key": "FR",
              "value": "French"
            }
          ]
        }
      ]
    }
  ]
}