Update Dictionary

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

Updates a dictionary

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.

PUTyouragentURL.symphony.com/agent/v1/dlp/dictionaries/{dictId}

Path parameters

dictId*string

Unique dictionary identifier

Header parameters

Body

application/json

name*string

The name of dictionary

Response

200400401403500

Success

Body

application/json

data*V1DLPDictionaryMetadata (object)

Dictionary's metadata (excluding content)

Request

JavaScriptCurlPython

const response = await fetch('youragentURL.symphony.com/agent/v1/dlp/dictionaries/{dictId}', {
    method: 'PUT',
    headers: {
      "sessionToken": "text",
      "keyManagerToken": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

200400401403500

{
  "data": {
    "creatorId": "text",
    "dictRef": {
      "dictId": "text",
      "name": "text",
      "version": "text"
    },
    "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.