Custom Data Type

Get Custom Data Type

Endpoint to retrieve a single Custom Data Type by ID

post/data-security-custom-data-type/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Custom Data Type to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "category": true,
    "sensitivity": true,
    "validator": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Example short text",
    "description": "This is an example of longer text content that might be stored in this field.",
    "category": "Contact and identity",
    "sensitivity": "Restricted",
    "pattern": "This is an example of longer text content that might be stored in this field.",
    "ignoreCase": true,
    "keywords": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "requiresKeyword": true,
    "nameHints": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "validator": "Example short text",
    "isEnabled": true,
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "deletedByUserId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.