Data Collections

Create one or more Data Collections

post

Creates one or multiple data collections with provided metadata and attributes

Authorizations

bearerAuth

AuthorizationstringRequired

Insert the JWT token here

Body

application/json

one ofOptional

or

Responses

201

Default Response

application/json

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

post

/api/public/v1/data-collections

HTTPcURLJavaScriptPython

POST /api/public/v1/data-collections HTTP/1.1
Host: hostname
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "name": "Collection 1",
  "type": "category"
}

Single collection creation - CategorySingle collection creation - CollectionSingle collection creation - Data ProductMultiple collections creation

{
  "status": 201,
  "data": [
    {
      "_id": "123e4567-e89b-12d3-a456-426614174000",
      "_index": "text",
      "name": "text",
      "type": "category",
      "parentId": "123e4567-e89b-12d3-a456-426614174000",
      "rootId": "123e4567-e89b-12d3-a456-426614174000",
      "attributes": {
        "info": {
          "definition": "text",
          "description": "text",
          "purpose": "text",
          "abbreviation": "text",
          "domain": "text",
          "owner": "text",
          "custodian": "text",
          "businessSteward": "text",
          "status": "text"
        },
        "features": {
          "sensitivity": "text",
          "rating": {
            "value": 1,
            "users": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "qualityScore": 1,
          "trustScore": 1,
          "isCriticalDataElement": true,
          "isLineageVerified": true
        },
        "customProperties": [
          {
            "id": "text",
            "value": "text"
          }
        ],
        "tags": [
          {
            "name": "text",
            "type": "text"
          }
        ],
        "businessTerms": [
          {
            "id": "text",
            "glossaryId": "text",
            "name": "text"
          }
        ],
        "policies": [
          {
            "id": "text"
          }
        ],
        "applications": [
          {
            "id": "text"
          }
        ],
        "physicalAssets": [
          {
            "id": "text"
          }
        ],
        "objectAccess": [
          {
            "id": "text",
            "type": "text",
            "accessType": "text"
          }
        ],
        "originalType": "category",
        "predecessorId": "text",
        "isDuplicated": true
      },
      "system": {
        "aggregatedAt": "text"
      },
      "metadata": {
        "column": {
          "ordinalPosition": "text",
          "dataType": "text",
          "sqlDataType": "text",
          "typeName": "text",
          "reference": {
            "sourceDataType": "text",
            "scopeCatalog": "text",
            "scopeSchema": "text",
            "scopeTable": true
          },
          "isNullable": true,
          "isAutoIncrement": true,
          "isGeneratedColumn": true,
          "isPrimaryKey": true,
          "isForeignKey": true,
          "columnDefault": true,
          "columnSize": 1,
          "bufferLength": 1,
          "decimalDigits": 1,
          "numPrecRadix": 1,
          "charOctetLength": 1,
          "sqlDateTimeSub": 1,
          "remarks": "text",
          "extended": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        },
        "stats": {
          "rowCount": 1,
          "sizeInBytes": 1,
          "schemas": 1,
          "tables": 1,
          "columns": 1,
          "rows": 1,
          "bytes": 1,
          "nulls": 1,
          "blanks": 1,
          "zeros": 1,
          "cardinality": 1,
          "minValue": 1,
          "maxValue": 1,
          "avgValue": 1,
          "stdevValue": 1,
          "minLength": 1,
          "maxLength": 1,
          "avgLength": 1,
          "stdevLength": 1
        },
        "status": {
          "aggregation": "text"
        }
      },
      "createdAt": "2025-12-07T01:55:47.991Z",
      "updatedAt": "2025-12-07T01:55:47.991Z",
      "createdBy": "text",
      "updatedBy": "text"
    }
  ]
}

Get Data Collection by ID

get

Returns metadata and attribute information for a single data collection by its ID

Authorizations

bearerAuth

AuthorizationstringRequired

Insert the JWT token here

Path parameters

idstring · uuidRequired

Data Collection ID

Responses

200

Default Response

application/json

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

get

/api/public/v1/data-collections/{id}

HTTPcURLJavaScriptPython

GET /api/public/v1/data-collections/{id} HTTP/1.1
Host: hostname
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": 200,
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "_index": "text",
    "name": "text",
    "type": "category",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "rootId": "123e4567-e89b-12d3-a456-426614174000",
    "attributes": {
      "info": {
        "definition": "text",
        "description": "text",
        "purpose": "text",
        "abbreviation": "text",
        "domain": "text",
        "owner": "text",
        "custodian": "text",
        "businessSteward": "text",
        "status": "text"
      },
      "features": {
        "sensitivity": "text",
        "rating": {
          "value": 1,
          "users": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        },
        "qualityScore": 1,
        "trustScore": 1,
        "isCriticalDataElement": true,
        "isLineageVerified": true
      },
      "customProperties": [
        {
          "id": "text",
          "value": "text"
        }
      ],
      "tags": [
        {
          "name": "text",
          "type": "text"
        }
      ],
      "businessTerms": [
        {
          "id": "text",
          "glossaryId": "text",
          "name": "text"
        }
      ],
      "policies": [
        {
          "id": "text"
        }
      ],
      "applications": [
        {
          "id": "text"
        }
      ],
      "physicalAssets": [
        {
          "id": "text"
        }
      ],
      "objectAccess": [
        {
          "id": "text",
          "type": "text",
          "accessType": "text"
        }
      ],
      "originalType": "category",
      "predecessorId": "text",
      "isDuplicated": true
    },
    "system": {
      "aggregatedAt": "text"
    },
    "metadata": {
      "column": {
        "ordinalPosition": "text",
        "dataType": "text",
        "sqlDataType": "text",
        "typeName": "text",
        "reference": {
          "sourceDataType": "text",
          "scopeCatalog": "text",
          "scopeSchema": "text",
          "scopeTable": true
        },
        "isNullable": true,
        "isAutoIncrement": true,
        "isGeneratedColumn": true,
        "isPrimaryKey": true,
        "isForeignKey": true,
        "columnDefault": true,
        "columnSize": 1,
        "bufferLength": 1,
        "decimalDigits": 1,
        "numPrecRadix": 1,
        "charOctetLength": 1,
        "sqlDateTimeSub": 1,
        "remarks": "text",
        "extended": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "stats": {
        "rowCount": 1,
        "sizeInBytes": 1,
        "schemas": 1,
        "tables": 1,
        "columns": 1,
        "rows": 1,
        "bytes": 1,
        "nulls": 1,
        "blanks": 1,
        "zeros": 1,
        "cardinality": 1,
        "minValue": 1,
        "maxValue": 1,
        "avgValue": 1,
        "stdevValue": 1,
        "minLength": 1,
        "maxLength": 1,
        "avgLength": 1,
        "stdevLength": 1
      },
      "status": {
        "aggregation": "text"
      }
    },
    "createdAt": "2025-12-07T01:55:47.991Z",
    "updatedAt": "2025-12-07T01:55:47.991Z",
    "createdBy": "text",
    "updatedBy": "text"
  }
}

Delete a Data Collection

delete

Deletes a data collection by its ID

Authorizations

bearerAuth

AuthorizationstringRequired

Insert the JWT token here

Path parameters

idstring · uuidRequired

UUID of the data collection to delete

Responses

200

Successfully deleted the collection

application/json

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

delete

/api/public/v1/data-collections/{id}

HTTPcURLJavaScriptPython

DELETE /api/public/v1/data-collections/{id} HTTP/1.1
Host: hostname
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": 200,
  "data": {
    "deletedCount": 1,
    "deletedIDs": [
      "7a768677-d05a-40c9-a7f0-563053b070f8"
    ]
  },
  "message": "Data collection deleted successfully"
}

Update a Data Collection

patch

Updates metadata or attributes for an existing data collection by ID

Authorizations

bearerAuth

AuthorizationstringRequired

Insert the JWT token here

Path parameters

idstring · uuidRequired

Data Collection ID

Body

application/json

namestringOptional

Name of the data collection

typestring · enumOptional

Type of the data collection (e.g., COLLECTION, DATASET)

Possible values:

parentIdstring · uuidOptional

Parent collection UUID

rootIdstring · uuidOptional

Root collection UUID

Responses

200

Default Response

application/json

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

patch

/api/public/v1/data-collections/{id}

HTTPcURLJavaScriptPython

PATCH /api/public/v1/data-collections/{id} HTTP/1.1
Host: hostname
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "attributes": {
    "features": {
      "rating": {
        "value": 5
      },
      "sensitivity": "HIGH"
    }
  }
}

{
  "status": 200,
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "_index": "text",
    "name": "text",
    "type": "category",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "rootId": "123e4567-e89b-12d3-a456-426614174000",
    "attributes": {
      "info": {
        "definition": "text",
        "description": "text",
        "purpose": "text",
        "abbreviation": "text",
        "domain": "text",
        "owner": "text",
        "custodian": "text",
        "businessSteward": "text",
        "status": "text"
      },
      "features": {
        "sensitivity": "text",
        "rating": {
          "value": 1,
          "users": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        },
        "qualityScore": 1,
        "trustScore": 1,
        "isCriticalDataElement": true,
        "isLineageVerified": true
      },
      "customProperties": [
        {
          "id": "text",
          "value": "text"
        }
      ],
      "tags": [
        {
          "name": "text",
          "type": "text"
        }
      ],
      "businessTerms": [
        {
          "id": "text",
          "glossaryId": "text",
          "name": "text"
        }
      ],
      "policies": [
        {
          "id": "text"
        }
      ],
      "applications": [
        {
          "id": "text"
        }
      ],
      "physicalAssets": [
        {
          "id": "text"
        }
      ],
      "objectAccess": [
        {
          "id": "text",
          "type": "text",
          "accessType": "text"
        }
      ],
      "originalType": "category",
      "predecessorId": "text",
      "isDuplicated": true
    },
    "system": {
      "aggregatedAt": "text"
    },
    "metadata": {
      "column": {
        "ordinalPosition": "text",
        "dataType": "text",
        "sqlDataType": "text",
        "typeName": "text",
        "reference": {
          "sourceDataType": "text",
          "scopeCatalog": "text",
          "scopeSchema": "text",
          "scopeTable": true
        },
        "isNullable": true,
        "isAutoIncrement": true,
        "isGeneratedColumn": true,
        "isPrimaryKey": true,
        "isForeignKey": true,
        "columnDefault": true,
        "columnSize": 1,
        "bufferLength": 1,
        "decimalDigits": 1,
        "numPrecRadix": 1,
        "charOctetLength": 1,
        "sqlDateTimeSub": 1,
        "remarks": "text",
        "extended": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "stats": {
        "rowCount": 1,
        "sizeInBytes": 1,
        "schemas": 1,
        "tables": 1,
        "columns": 1,
        "rows": 1,
        "bytes": 1,
        "nulls": 1,
        "blanks": 1,
        "zeros": 1,
        "cardinality": 1,
        "minValue": 1,
        "maxValue": 1,
        "avgValue": 1,
        "stdevValue": 1,
        "minLength": 1,
        "maxLength": 1,
        "avgLength": 1,
        "stdevLength": 1
      },
      "status": {
        "aggregation": "text"
      }
    },
    "createdAt": "2025-12-07T01:55:47.991Z",
    "updatedAt": "2025-12-07T01:55:47.991Z",
    "createdBy": "text",
    "updatedBy": "text"
  }
}

Add children to a collection

post

Associates a list of entity UUIDs as children of a data collection

Authorizations

bearerAuth

AuthorizationstringRequired

Insert the JWT token here

Path parameters

idstring · uuidRequired

Collection ID to which entities will be added as children

Body

application/json

entitiesstring · uuid[] · min: 1Required

List of entity UUIDs to add as children

Responses

200

Default Response

application/json

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

post

/api/public/v1/data-collections/{id}/add-children

HTTPcURLJavaScriptPython

POST /api/public/v1/data-collections/{id}/add-children HTTP/1.1
Host: hostname
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "entities": [
    "33ac6611-5b1d-4f13-991d-871f179cb310",
    "a95baf89-6ee2-4c3f-a4ad-bd528cd43fd8"
  ]
}

{
  "status": 200,
  "message": "Children successfully added to collection"
}

Remove children from a collection

post

Disassociates a list of entity UUIDs from a data collection

Authorizations

bearerAuth

AuthorizationstringRequired

Insert the JWT token here

Path parameters

idstring · uuidRequired

Collection ID to remove entities from

Body

application/json

entitiesstring · uuid[] · min: 1Required

List of entity UUIDs to remove

Responses

200

Default Response

application/json

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

post

/api/public/v1/data-collections/{id}/remove-children

HTTPcURLJavaScriptPython

POST /api/public/v1/data-collections/{id}/remove-children HTTP/1.1
Host: hostname
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "entities": [
    "33ac6611-5b1d-4f13-991d-871f179cb310",
    "a95baf89-6ee2-4c3f-a4ad-bd528cd43fd8"
  ]
}

{
  "status": 200,
  "message": "Children successfully removed from collection"
}

Get Data Collections by IDs

post

Returns an array of metadata and attribute info for multiple data collections by their IDs

🚨 Note: Results are limited to 10,000 items.

Authorizations

bearerAuth

AuthorizationstringRequired

Insert the JWT token here

Body

application/json

idsstring · uuid[] · min: 1Required

List of data collection IDs

Responses

200

Default Response

application/json

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

post

/api/public/v1/data-collections/by-ids

HTTPcURLJavaScriptPython

POST /api/public/v1/data-collections/by-ids HTTP/1.1
Host: hostname
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "status": 200,
  "data": [
    {
      "_id": "123e4567-e89b-12d3-a456-426614174000",
      "_index": "text",
      "name": "text",
      "type": "category",
      "parentId": "123e4567-e89b-12d3-a456-426614174000",
      "rootId": "123e4567-e89b-12d3-a456-426614174000",
      "attributes": {
        "info": {
          "definition": "text",
          "description": "text",
          "purpose": "text",
          "abbreviation": "text",
          "domain": "text",
          "owner": "text",
          "custodian": "text",
          "businessSteward": "text",
          "status": "text"
        },
        "features": {
          "sensitivity": "text",
          "rating": {
            "value": 1,
            "users": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "qualityScore": 1,
          "trustScore": 1,
          "isCriticalDataElement": true,
          "isLineageVerified": true
        },
        "customProperties": [
          {
            "id": "text",
            "value": "text"
          }
        ],
        "tags": [
          {
            "name": "text",
            "type": "text"
          }
        ],
        "businessTerms": [
          {
            "id": "text",
            "glossaryId": "text",
            "name": "text"
          }
        ],
        "policies": [
          {
            "id": "text"
          }
        ],
        "applications": [
          {
            "id": "text"
          }
        ],
        "physicalAssets": [
          {
            "id": "text"
          }
        ],
        "objectAccess": [
          {
            "id": "text",
            "type": "text",
            "accessType": "text"
          }
        ],
        "originalType": "category",
        "predecessorId": "text",
        "isDuplicated": true
      },
      "system": {
        "aggregatedAt": "text"
      },
      "metadata": {
        "column": {
          "ordinalPosition": "text",
          "dataType": "text",
          "sqlDataType": "text",
          "typeName": "text",
          "reference": {
            "sourceDataType": "text",
            "scopeCatalog": "text",
            "scopeSchema": "text",
            "scopeTable": true
          },
          "isNullable": true,
          "isAutoIncrement": true,
          "isGeneratedColumn": true,
          "isPrimaryKey": true,
          "isForeignKey": true,
          "columnDefault": true,
          "columnSize": 1,
          "bufferLength": 1,
          "decimalDigits": 1,
          "numPrecRadix": 1,
          "charOctetLength": 1,
          "sqlDateTimeSub": 1,
          "remarks": "text",
          "extended": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        },
        "stats": {
          "rowCount": 1,
          "sizeInBytes": 1,
          "schemas": 1,
          "tables": 1,
          "columns": 1,
          "rows": 1,
          "bytes": 1,
          "nulls": 1,
          "blanks": 1,
          "zeros": 1,
          "cardinality": 1,
          "minValue": 1,
          "maxValue": 1,
          "avgValue": 1,
          "stdevValue": 1,
          "minLength": 1,
          "maxLength": 1,
          "avgLength": 1,
          "stdevLength": 1
        },
        "status": {
          "aggregation": "text"
        }
      },
      "createdAt": "2025-12-07T01:55:47.991Z",
      "updatedAt": "2025-12-07T01:55:47.991Z",
      "createdBy": "text",
      "updatedBy": "text"
    }
  ]
}