Update Dictionary

Updates a dictionary's name. This also automatically updates the version number.

Updates a dictionary

put

Updates the dictionary's basic metadata without content. This API cannot be used for creating a new dictionary. In case of update only "name" can be changed. Note: All related policies will also have versions updated.

Path parameters

dictIdstringRequired

Unique dictionary identifier

Header parameters

sessionTokenstringRequired

Session authentication token.

keyManagerTokenstringOptional

Key Manager authentication token.

Body

application/json

Dictionary's metadata (excluding content) to use for dictionary update operations.

namestringRequired

The name of dictionary

Responses

200

Success

application/json

Dictionary response containing dictionary metadata.

400

Client error, see response body for further details.

application/json

401

Unauthorized: Session tokens invalid.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

500

Server error, see response body for further details.

application/json

put

/v1/dlp/dictionaries/{dictId}

HTTPcURLJavaScriptPython

PUT /agent/v1/dlp/dictionaries/{dictId} HTTP/1.1
Host: youragentURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "data": {
    "creationDate": 1,
    "creatorId": "text",
    "dictRef": {
      "dictId": "text",
      "name": "text",
      "version": "text"
    },
    "lastUpdatedDate": 1,
    "type": "text"
  }
}

📘 Note

• You can’t create a new dictionary with this endpoint.

• All related policies will also have versions updated. (FIX)

🚧 Required Permissions

Calling this endpoint requires a Service User Account set with the Expression Filter Policy Management role. For more information about Service User accounts and their roles, see the Symphony Administration Guide.

See Bot Permissions for a list of roles and associated privileges.