Get Dlp Custom Dict By Id

Get Dlp Custom Dict By Id

Get the Custom Dictionary by Id

Request
URI
GET
https://{api_host}/api/cws/v1/enterprises/{enterpriseLogicalId}/dlp/dictionaries/custom/{dictId}
COPY
Path Parameters
string
enterpriseLogicalId
Required

Enterprise Logical ID

string
dictId
Required

Dictionary ID

Query Parameters
fields
Optional

filter fields


Responses
200

The Custom Dictionary

Returns getDlpCustomDictResponse of type(s) application/json
{
    "name": "dictionary1",
    "region": "string",
    "category": "string",
    "description": "description",
    "criteria": [
        {
            "caseSensitive": false,
            "count": 1,
            "criteriaType": "string",
            "criteriaValue": "test"
        }
    ],
    "_href": "/enterprises/1/cwsPolicies",
    "logicalId": "ac611099-9872-4b29-bd87-8c2ba8b62c81",
    "createdAt": 1611961646,
    "updatedAt": 1611961646
}
string
name
Required

name

string
region
Required

region

Possible values are : Australia, Belgium, Brazil, Canada, Denmark, Finland, France, Germany, Global, Hong Kong, India, Indonesia, Ireland, Italy, Japan, Malaysia, Netherlands, New York, New Zealand, Norway, Other, Poland, Singapore, South Africa, Spain, Sweden, Switzerland, UK, USA,
string
category
Required

category

Possible values are : Canadian Health Service, Document classification, Financial Data, HIPAA, HIPAA, Health Care, Health Care, Item identifiers, Other, PCI DSS, Personally Identifiable Information, UK National Health Service,
string
description
Required

description

array of object
criteria
Required

criteria

string
_href
Required

_href

string
logicalId
Required

logicalId

number As float As float
createdAt
Optional

createdAt

number As float As float
updatedAt
Optional

updatedAt


400

Invalid Input

Returns httpResponseError of type(s) application/json
{
    "code": "error code",
    "errors": [
        {
            "message": "error message",
            "path": "object.path"
        }
    ]
}
string
code
Required

code

Possible values are : INTERNAL_ERROR, INVALID_PARAMS, INVALID_QUERY_PARAMS, INVALID_LICENSE,
array of object
errors
Required

errors


500

Internal Server Error

Returns httpResponseError of type(s) application/json
{
    "code": "error code",
    "errors": [
        {
            "message": "error message",
            "path": "object.path"
        }
    ]
}
string
code
Required

code

Possible values are : INTERNAL_ERROR, INVALID_PARAMS, INVALID_QUERY_PARAMS, INVALID_LICENSE,
array of object
errors
Required

errors