Create Dictionary

Creates a dictionary with basic metadata and without content.

Create a dictionary

post

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

Header parameters

sessionTokenstringRequired

Session authentication token.

keyManagerTokenstringOptional

Key Manager authentication token.

Body

application/json

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

namestringRequired

The name of dictionary

typestringRequired

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

Responses

200

Success

application/json

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

post

/v1/dlp/dictionaries

HTTPcURLJavaScriptPython

POST /agent/v1/dlp/dictionaries HTTP/1.1
Host: youragentURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "name": "text",
  "type": "text"
}

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