Get Predefined Dict

Get Predefined Dict

Get one Predefined Dictionary

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

Enterprise Logical ID

string
logicalId
Required

predefined dict logicalId

Query Parameters
fields
Optional

return fields


Responses
200

All Predefined Dictionaries

Returns GetPredefinedDictResponse of type(s) application/json
{
    "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"
    ]
}
number As float As float
fileUploadCount
Required

fileUploadCount

number As float As float
userInputCount
Required

userInputCount

string
logicalId
Required

logicalId

string
dictId
Required

dictId

number As float As float
createAt
Required

createAt

number As float As float
updatedAt
Required

updatedAt

string
name
Required

name

string
description
Required

description

number As float As float
quantity
Required

quantity

number As float As float
quantityDesc
Required

quantityDesc

array of string
cclRegions
Optional

cclRegions

array of string
cclTypes
Optional

cclTypes


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