list_data_classifications

DatasetsApi.list_data_classifications(role_id, projection_expression=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Gets list of data classifications

Returns the full list of data classifications available in the system. No pagination — all classifications are returned in a single response. Any authenticated user can access this endpoint. Usage examples: GET /datasets/dataclassifications — returns all fields for every classification. GET /datasets/dataclassifications?projectionExpression=DataClassificationName,DisplayName — returns only the specified fields.

Parameters:

  • role_id (str) – The active Amorphic role ID of the caller. (required)

  • projection_expression (str) – Comma-separated list of field names to include in each item. When omitted, all fields are returned.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

DataClassificationList

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /datasets/dataclassifications

Success (HTTP 200)

Returns the list of data classifications successfully.

Request / response example

{
  "dataclassifications": [
    {
      "DataClassificationName": "confidential",
      "DisplayName": "Confidential",
      "Description": "Sensitive business data",
      "CreatedBy": "user2",
      "LastModifiedBy": "user2",
      "LastModifiedTime": "2024-01-15T10:30:00Z"
    },
    {
      "DataClassificationName": "public",
      "DisplayName": "Public",
      "Description": "Data that can be freely shared",
      "CreatedBy": "user2",
      "LastModifiedBy": "user2",
      "LastModifiedTime": "2024-01-15T10:30:00Z"
    }
  ]
}

Errors

Documented error codes: GE-1008.

HTTP 500

Backend failure.

Request / response example

{
  "Message": "GE-1008 - Could not complete the request. Please try again."
}