AT&T DevEx

ADAS Test

Update a document group.

download iconDownload spec

Endpoint

PUT
undefined/document-groups/{id}

Allows to update all documentGroup's data except for its ID or Name. Must send all data on every call.

arrowRequest

update an existing documentGroup.

Path Parameters

    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
38
39
40
41
    curl --request PUT \
     --url https://example.com/document-groups/g1 \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "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"
        }
      ]
    }
  ]
}
'

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