Create Dictionary

Creates a dictionary with basic metadata and without content.

Create a dictionary

Creates a dictionary with basic metadata and no content. Only "name" and "type" field is used to create a new dictionary entry.

POSTyouragentURL.symphony.com/agent/v1/dlp/dictionaries

Header parameters

Body

application/json

name*string

The name of dictionary

type*string

The type of dictionary, which specify the content is a list of words or a list of regexes. By default set to "Word" if not specified. Possible values - Word, Regex

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', {
    method: 'POST',
    headers: {
      "sessionToken": "text",
      "keyManagerToken": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "type": "text"
    }),
});
const data = await response.json();

Response

200400401403500

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

Call this endpoint to create a new dictionary without any terms, then call Upload Dictionary Content upload an associated dictionary file.

🚧 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.