Get Predefined Dicts

Get Predefined Dicts

Get all Predefined Dictionaries

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

Enterprise Logical ID

Query Parameters
fields
Optional

return fields

string
quickSearch
Optional

quick search string

number
limit
Optional

response data max count

string
prevPageLink
Optional

previous page link

string
nextPageLink
Optional

next page link

boolean
_count
Optional

return total count or not


Responses
200

All Predefined Dictionaries

Returns GetPredefinedDictsResponse of type(s) application/json
{
    "data": [
        {
            "fileUploadCount": 1,
            "userInputCount": 1,
            "logicalId": "ac611099-9872-4b29-bd87-8c2ba8b62c81",
            "dictId": "PostaladdressesGlobal",
            "createAt": 1611961646,
            "updatedAt": 1611961646,
            "name": "dictionary1",
            "description": "description",
            "quantity": 2,
            "quantityDesc": "description",
            "cclRegions": [
                "Australia"
            ],
            "cclTypes": [
                "Document classification"
            ]
        }
    ]
}
array of object
data
Optional

data


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