Data Class

List All Data Classes

GET /v1/data-catalog/data-class

Retrieve a paginated list of all available data classes with optional sorting and filtering.

Query Parameters:

pageSize (integer, optional): Number of items to return per page (1-100, default: 50)
pageNumber (integer, optional): Page number to return (one-based, default: 1)
sortField (string, optional): Field to sort results by (default: id)
sortDirection (string, optional): Direction to sort results (ASC, DESC, default: ASC)

Response (200 OK):

{
  "content": [
    {
      "id": "dc_001",
      "name": "Personal Identifier",
      "description": "Fields containing personally identifiable information such as names, emails, or phone numbers",
      "category": "Personal Data",
      "organizationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "version": "1.0.0",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    },
    {
      "id": "dc_002", 
      "name": "Financial Data",
      "description": "Fields containing financial information such as account numbers, transaction amounts, or payment details",
      "category": "Financial",
      "organizationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "version": "1.0.0",
      "createdAt": "2024-01-16T14:20:00Z",
      "updatedAt": "2024-01-16T14:20:00Z"
    }
  ],
  "page": {
    "size": 2,
    "pageSize": 50,
    "currentPage": 0,
    "number": 0,
    "totalElements": 2,
    "totalPages": 1
  }
}

Get Data Class by ID

GET /v1/data-catalog/data-class/{id}

Retrieve detailed information about a specific data class.

Path Parameters:

id (string, required): Unique identifier of the data class to retrieve

Response (200 OK):

{
  "id": "dc_001",
  "name": "Personal Identifier",
  "description": "Fields containing personally identifiable information such as names, emails, or phone numbers",
  "category": "Personal Data",
  "organizationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "version": "1.0.0",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Error Responses:

Response (404 Not Found):

{
  "code": "DATA_CLASS_NOT_FOUND",
  "title": "Data Class Not Found",
  "detail": "No data class found with the specified ID",
  "traceId": "req_12345678-abcd-4321-9876-fedcba098765"
}