# Data Collections

## Create one or more Data Collections

> Creates one or multiple data collections with provided metadata and attributes

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v2)","version":"v2"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v2/data-collections":{"post":{"summary":"Create one or more Data Collections","tags":["Data Collections"],"description":"Creates one or multiple data collections with provided metadata and attributes","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the data collection"},"originalName":{"type":"string","description":"Original name of the data collection"},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"fqdn":{"type":"string","description":"Fully qualified domain name"},"fqdnDisplay":{"type":"string","description":"Display of the fully qualified domain name"},"parentId":{"type":"string","format":"uuid","description":"Parent collection UUID"},"rootId":{"type":"string","format":"uuid","description":"Root collection UUID"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"definition":{"type":"string","description":"Definition of the data collection"},"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"abbreviation":{"type":"string","description":"Abbreviation for the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner of the data collection"},"custodian":{"type":"string","description":"Custodian of the data collection"},"businessSteward":{"type":"string","description":"Business steward of the data collection"},"status":{"type":"string","description":"Status of the data collection"}},"additionalProperties":false},"features":{"type":"object","description":"Feature attributes of the data collection","properties":{"sensitivity":{"type":"string","description":"Sensitivity of the data collection"},"rating":{"type":"object","description":"Rating information","properties":{"value":{"type":"number","description":"Rating value"},"users":{"type":"object","description":"Users who rated the collection","additionalProperties":true}},"additionalProperties":false},"qualityScore":{"type":"number","description":"Quality score of the data collection"},"trustScore":{"type":"number","description":"Trust score of the data collection"},"isCriticalDataElement":{"type":"boolean","description":"Indicates if this is a critical data element"},"isLineageVerified":{"type":"boolean","description":"Indicates if lineage is verified"}},"additionalProperties":false},"customProperties":{"type":"array","description":"Custom properties for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Custom property ID"},"value":{"type":"string","description":"Custom property value"}},"additionalProperties":false}},"tags":{"type":"array","description":"Tags associated with the data collection","items":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"type":{"type":"string","description":"Tag type"}},"additionalProperties":false}},"businessTerms":{"type":"array","description":"Business terms associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business term ID"},"glossaryId":{"type":"string","description":"Glossary ID for the business term"},"name":{"type":"string","description":"Business term name"}},"additionalProperties":false}},"policies":{"type":"array","description":"Policies associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy ID"}},"additionalProperties":false}},"applications":{"type":"array","description":"Applications associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Application ID"}},"additionalProperties":false}},"physicalAssets":{"type":"array","description":"Physical assets associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Physical asset ID"}},"additionalProperties":false}},"objectAccess":{"type":"array","description":"Object access details for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Object access ID"},"type":{"type":"string","description":"Object access type"},"accessType":{"type":"string","description":"Type of access"}},"additionalProperties":false}},"originalType":{"type":"string","enum":["category","group","collection","dataset","COLUMN"],"description":"Original type of the data collection"}},"additionalProperties":false}},"required":["name","type"]},{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the data collection"},"originalName":{"type":"string","description":"Original name of the data collection"},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"fqdn":{"type":"string","description":"Fully qualified domain name"},"fqdnDisplay":{"type":"string","description":"Display of the fully qualified domain name"},"parentId":{"type":"string","format":"uuid","description":"Parent collection UUID"},"rootId":{"type":"string","format":"uuid","description":"Root collection UUID"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"definition":{"type":"string","description":"Definition of the data collection"},"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"abbreviation":{"type":"string","description":"Abbreviation for the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner of the data collection"},"custodian":{"type":"string","description":"Custodian of the data collection"},"businessSteward":{"type":"string","description":"Business steward of the data collection"},"status":{"type":"string","description":"Status of the data collection"}},"additionalProperties":false},"features":{"type":"object","description":"Feature attributes of the data collection","properties":{"sensitivity":{"type":"string","description":"Sensitivity of the data collection"},"rating":{"type":"object","description":"Rating information","properties":{"value":{"type":"number","description":"Rating value"},"users":{"type":"object","description":"Users who rated the collection","additionalProperties":true}},"additionalProperties":false},"qualityScore":{"type":"number","description":"Quality score of the data collection"},"trustScore":{"type":"number","description":"Trust score of the data collection"},"isCriticalDataElement":{"type":"boolean","description":"Indicates if this is a critical data element"},"isLineageVerified":{"type":"boolean","description":"Indicates if lineage is verified"}},"additionalProperties":false},"customProperties":{"type":"array","description":"Custom properties for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Custom property ID"},"value":{"type":"string","description":"Custom property value"}},"additionalProperties":false}},"tags":{"type":"array","description":"Tags associated with the data collection","items":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"type":{"type":"string","description":"Tag type"}},"additionalProperties":false}},"businessTerms":{"type":"array","description":"Business terms associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business term ID"},"glossaryId":{"type":"string","description":"Glossary ID for the business term"},"name":{"type":"string","description":"Business term name"}},"additionalProperties":false}},"policies":{"type":"array","description":"Policies associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy ID"}},"additionalProperties":false}},"applications":{"type":"array","description":"Applications associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Application ID"}},"additionalProperties":false}},"physicalAssets":{"type":"array","description":"Physical assets associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Physical asset ID"}},"additionalProperties":false}},"objectAccess":{"type":"array","description":"Object access details for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Object access ID"},"type":{"type":"string","description":"Object access type"},"accessType":{"type":"string","description":"Type of access"}},"additionalProperties":false}},"originalType":{"type":"string","enum":["category","group","collection","dataset","COLUMN"],"description":"Original type of the data collection"}},"additionalProperties":false}},"required":["name","type"]},"minItems":1}]}}}},"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier for the data collection"},"_index":{"type":"string","description":"Index name (e.g., OpenSearch index)"},"name":{"type":"string","description":"Name of the data collection"},"originalName":{"type":"string","description":"Original name of the data collection"},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"fqdn":{"type":"string","description":"Fully qualified domain name"},"fqdnDisplay":{"type":"string","description":"Display of the fully qualified domain name"},"parentId":{"type":"string","format":"uuid","description":"Parent collection UUID"},"rootId":{"type":"string","format":"uuid","description":"Root collection UUID"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"definition":{"type":"string","description":"Definition of the data collection"},"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"abbreviation":{"type":"string","description":"Abbreviation for the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner of the data collection"},"custodian":{"type":"string","description":"Custodian of the data collection"},"businessSteward":{"type":"string","description":"Business steward of the data collection"},"status":{"type":"string","description":"Status of the data collection"}},"additionalProperties":false},"features":{"type":"object","description":"Feature attributes of the data collection","properties":{"sensitivity":{"type":"string","description":"Sensitivity of the data collection"},"rating":{"type":"object","description":"Rating information","properties":{"value":{"type":"number","description":"Rating value"},"users":{"type":"object","description":"Users who rated the collection","additionalProperties":true}},"additionalProperties":false},"qualityScore":{"type":"number","description":"Quality score of the data collection"},"trustScore":{"type":"number","description":"Trust score of the data collection"},"isCriticalDataElement":{"type":"boolean","description":"Indicates if this is a critical data element"},"isLineageVerified":{"type":"boolean","description":"Indicates if lineage is verified"}},"additionalProperties":false},"customProperties":{"type":"array","description":"Custom properties for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Custom property ID"},"value":{"type":"string","description":"Custom property value"}},"additionalProperties":false}},"tags":{"type":"array","description":"Tags associated with the data collection","items":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"type":{"type":"string","description":"Tag type"}},"additionalProperties":false}},"businessTerms":{"type":"array","description":"Business terms associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business term ID"},"glossaryId":{"type":"string","description":"Glossary ID for the business term"},"name":{"type":"string","description":"Business term name"}},"additionalProperties":false}},"policies":{"type":"array","description":"Policies associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy ID"}},"additionalProperties":false}},"applications":{"type":"array","description":"Applications associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Application ID"}},"additionalProperties":false}},"physicalAssets":{"type":"array","description":"Physical assets associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Physical asset ID"}},"additionalProperties":false}},"objectAccess":{"type":"array","description":"Object access details for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Object access ID"},"type":{"type":"string","description":"Object access type"},"accessType":{"type":"string","description":"Type of access"}},"additionalProperties":false}},"originalType":{"type":"string","enum":["category","group","collection","dataset","COLUMN"],"description":"Original type of the data collection"},"predecessorId":{"type":"string","description":"ID of the predecessor data collection, if any"},"isDuplicated":{"type":"boolean","description":"Indicates if the data collection is a duplicated or not"}}},"system":{"type":"object","description":"System attributes of the data collection","properties":{"aggregatedAt":{"type":"string","description":"Timestamp when the data collection was aggregated"},"profiledAt":{"type":"string","description":"Timestamp when the data collection was profiled"}},"additionalProperties":false},"metadata":{"type":"object","description":"Metadata attributes of the data collection","properties":{"column":{"type":"object","description":"Column metadata for the data collection","properties":{"ordinalPosition":{"type":"string","description":"Ordinal Position of the column in the data collection"},"dataType":{"type":"string","description":"Data type of the column in the data collection"},"sqlDataType":{"type":"string","description":"SQL data type of the column in the data collection"},"typeName":{"type":"string","description":"Type name of the column in the data collection"},"reference":{"type":"object","description":"Column metadata for the data collection","properties":{"sourceDataType":{"type":"string","description":"Source data type of the column reference"},"scopeCatalog":{"type":"string","description":"Catalog name of the column reference"},"scopeSchema":{"type":"string","description":"Schema name of the column reference"},"scopeTable":{"type":"boolean","description":"Table name of the column reference"}}},"isNullable":{"type":"boolean","description":"Indicates if the column is nullable"},"isAutoIncrement":{"type":"boolean","description":"Indicates if the column is auto-incremented"},"isGeneratedColumn":{"type":"boolean","description":"Indicates if the column is a generated column"},"isPrimaryKey":{"type":"boolean","description":"Indicates if the column is a primary key"},"isForeignKey":{"type":"boolean","description":"Indicates if the column is a foreign key"},"columnDefault":{"type":"boolean","description":"Indicates if the column has a default value"},"columnSize":{"type":"number","description":"Indicates the size of the column"},"bufferLength":{"type":"number","description":"Buffer length of the column"},"decimalDigits":{"type":"number","description":"Indicates the number of decimal digits in the column"},"numPrecRadix":{"type":"number","description":"Indicates the numeric precision radix of the column"},"charOctetLength":{"type":"number","description":"Indicates the character octet length of the column"},"sqlDateTimeSub":{"type":"number","description":"Indicates the SQL date time sub of the column"},"remarks":{"type":"string","description":"The remarks for the column"},"extended":{"type":"object","description":"Extended metadata for the column","additionalProperties":true}}},"stats":{"type":"object","description":"Statistics for the data collection","properties":{"rowCount":{"type":"number","description":"Number of rows in the data collection"},"sizeInBytes":{"type":"number","description":"Size of the data collection in bytes"},"schemas":{"type":"number","description":"Number of schemas in the data collection"},"tables":{"type":"number","description":"Number of tables in the data collection"},"columns":{"type":"number","description":"Number of columns in the data collection"},"rows":{"type":"number","description":"Number of rows in the data collection"},"bytes":{"type":"number","description":"Number of bytes in the data collection"},"nulls":{"type":"number","description":"Number of nulls in the data collection"},"blanks":{"type":"number","description":"Number of blanks in the data collection"},"zeros":{"type":"number","description":"Number of zeros in the data collection"},"cardinality":{"type":"number","description":"Cardinality of the data collection"},"minValue":{"type":"number","description":"Minimum value in the data collection"},"maxValue":{"type":"number","description":"Maximum value in the data collection"},"avgValue":{"type":"number","description":"Average value in the data collection"},"stdevValue":{"type":"number","description":"Standard deviation of values in the data collection"},"minLength":{"type":"number","description":"Minimum length in the data collection"},"maxLength":{"type":"number","description":"Maximum length in the data collection"},"avgLength":{"type":"number","description":"Average length in the data collection"},"stdevLength":{"type":"number","description":"Standard deviation of lengths in the data collection"}},"additionalProperties":true},"status":{"type":"object","description":"Status of the data collection","properties":{"aggregation":{"type":"string","description":"Aggregation status of the data collection"},"profile":{"type":"string","description":"Profile status of the data collection"}},"additionalProperties":false},"profile":{"type":"object","properties":{"patterns":{"type":"array","items":{"type":"object","properties":{"pattern":{"type":"string"},"counter":{"type":"number"},"sample":{"type":"string"}},"required":["pattern","counter","sample"],"additionalProperties":false}},"distinctCount":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"count":{"type":"number"}},"required":["value","count"],"additionalProperties":false}},"sampleValues":{"type":"array","items":{"type":"string"}},"sampleFiles":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"},"createdBy":{"type":"string","description":"Identifier of the user who created the data collection"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the data collection"}},"description":"Metadata and attributes of a data collection"},"description":"Array of data collections"}},"required":["status","data"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"status":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array"},{"type":"object","additionalProperties":true}]}}}}}},"401":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","content":{"application/json":{"schema":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"503":{"description":"Service Unavailable — Connection Refused","content":{"application/json":{"schema":{"description":"Service Unavailable — Connection Refused","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}}}}}}}
```

## Get Data Collection by ID

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

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v2)","version":"v2"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v2/data-collections/{id}":{"get":{"summary":"Get Data Collection by ID","tags":["Data Collections"],"description":"Returns metadata and attribute information for a single data collection by its ID","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"Data Collection ID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"data":{"type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier for the data collection"},"_index":{"type":"string","description":"Index name (e.g., OpenSearch index)"},"name":{"type":"string","description":"Name of the data collection"},"originalName":{"type":"string","description":"Original name of the data collection"},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"fqdn":{"type":"string","description":"Fully qualified domain name"},"fqdnDisplay":{"type":"string","description":"Display of the fully qualified domain name"},"parentId":{"type":"string","format":"uuid","description":"Parent collection UUID"},"rootId":{"type":"string","format":"uuid","description":"Root collection UUID"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"definition":{"type":"string","description":"Definition of the data collection"},"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"abbreviation":{"type":"string","description":"Abbreviation for the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner of the data collection"},"custodian":{"type":"string","description":"Custodian of the data collection"},"businessSteward":{"type":"string","description":"Business steward of the data collection"},"status":{"type":"string","description":"Status of the data collection"}},"additionalProperties":false},"features":{"type":"object","description":"Feature attributes of the data collection","properties":{"sensitivity":{"type":"string","description":"Sensitivity of the data collection"},"rating":{"type":"object","description":"Rating information","properties":{"value":{"type":"number","description":"Rating value"},"users":{"type":"object","description":"Users who rated the collection","additionalProperties":true}},"additionalProperties":false},"qualityScore":{"type":"number","description":"Quality score of the data collection"},"trustScore":{"type":"number","description":"Trust score of the data collection"},"isCriticalDataElement":{"type":"boolean","description":"Indicates if this is a critical data element"},"isLineageVerified":{"type":"boolean","description":"Indicates if lineage is verified"}},"additionalProperties":false},"customProperties":{"type":"array","description":"Custom properties for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Custom property ID"},"value":{"type":"string","description":"Custom property value"}},"additionalProperties":false}},"tags":{"type":"array","description":"Tags associated with the data collection","items":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"type":{"type":"string","description":"Tag type"}},"additionalProperties":false}},"businessTerms":{"type":"array","description":"Business terms associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business term ID"},"glossaryId":{"type":"string","description":"Glossary ID for the business term"},"name":{"type":"string","description":"Business term name"}},"additionalProperties":false}},"policies":{"type":"array","description":"Policies associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy ID"}},"additionalProperties":false}},"applications":{"type":"array","description":"Applications associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Application ID"}},"additionalProperties":false}},"physicalAssets":{"type":"array","description":"Physical assets associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Physical asset ID"}},"additionalProperties":false}},"objectAccess":{"type":"array","description":"Object access details for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Object access ID"},"type":{"type":"string","description":"Object access type"},"accessType":{"type":"string","description":"Type of access"}},"additionalProperties":false}},"originalType":{"type":"string","enum":["category","group","collection","dataset","COLUMN"],"description":"Original type of the data collection"},"predecessorId":{"type":"string","description":"ID of the predecessor data collection, if any"},"isDuplicated":{"type":"boolean","description":"Indicates if the data collection is a duplicated or not"}}},"system":{"type":"object","description":"System attributes of the data collection","properties":{"aggregatedAt":{"type":"string","description":"Timestamp when the data collection was aggregated"},"profiledAt":{"type":"string","description":"Timestamp when the data collection was profiled"}},"additionalProperties":false},"metadata":{"type":"object","description":"Metadata attributes of the data collection","properties":{"column":{"type":"object","description":"Column metadata for the data collection","properties":{"ordinalPosition":{"type":"string","description":"Ordinal Position of the column in the data collection"},"dataType":{"type":"string","description":"Data type of the column in the data collection"},"sqlDataType":{"type":"string","description":"SQL data type of the column in the data collection"},"typeName":{"type":"string","description":"Type name of the column in the data collection"},"reference":{"type":"object","description":"Column metadata for the data collection","properties":{"sourceDataType":{"type":"string","description":"Source data type of the column reference"},"scopeCatalog":{"type":"string","description":"Catalog name of the column reference"},"scopeSchema":{"type":"string","description":"Schema name of the column reference"},"scopeTable":{"type":"boolean","description":"Table name of the column reference"}}},"isNullable":{"type":"boolean","description":"Indicates if the column is nullable"},"isAutoIncrement":{"type":"boolean","description":"Indicates if the column is auto-incremented"},"isGeneratedColumn":{"type":"boolean","description":"Indicates if the column is a generated column"},"isPrimaryKey":{"type":"boolean","description":"Indicates if the column is a primary key"},"isForeignKey":{"type":"boolean","description":"Indicates if the column is a foreign key"},"columnDefault":{"type":"boolean","description":"Indicates if the column has a default value"},"columnSize":{"type":"number","description":"Indicates the size of the column"},"bufferLength":{"type":"number","description":"Buffer length of the column"},"decimalDigits":{"type":"number","description":"Indicates the number of decimal digits in the column"},"numPrecRadix":{"type":"number","description":"Indicates the numeric precision radix of the column"},"charOctetLength":{"type":"number","description":"Indicates the character octet length of the column"},"sqlDateTimeSub":{"type":"number","description":"Indicates the SQL date time sub of the column"},"remarks":{"type":"string","description":"The remarks for the column"},"extended":{"type":"object","description":"Extended metadata for the column","additionalProperties":true}}},"stats":{"type":"object","description":"Statistics for the data collection","properties":{"rowCount":{"type":"number","description":"Number of rows in the data collection"},"sizeInBytes":{"type":"number","description":"Size of the data collection in bytes"},"schemas":{"type":"number","description":"Number of schemas in the data collection"},"tables":{"type":"number","description":"Number of tables in the data collection"},"columns":{"type":"number","description":"Number of columns in the data collection"},"rows":{"type":"number","description":"Number of rows in the data collection"},"bytes":{"type":"number","description":"Number of bytes in the data collection"},"nulls":{"type":"number","description":"Number of nulls in the data collection"},"blanks":{"type":"number","description":"Number of blanks in the data collection"},"zeros":{"type":"number","description":"Number of zeros in the data collection"},"cardinality":{"type":"number","description":"Cardinality of the data collection"},"minValue":{"type":"number","description":"Minimum value in the data collection"},"maxValue":{"type":"number","description":"Maximum value in the data collection"},"avgValue":{"type":"number","description":"Average value in the data collection"},"stdevValue":{"type":"number","description":"Standard deviation of values in the data collection"},"minLength":{"type":"number","description":"Minimum length in the data collection"},"maxLength":{"type":"number","description":"Maximum length in the data collection"},"avgLength":{"type":"number","description":"Average length in the data collection"},"stdevLength":{"type":"number","description":"Standard deviation of lengths in the data collection"}},"additionalProperties":true},"status":{"type":"object","description":"Status of the data collection","properties":{"aggregation":{"type":"string","description":"Aggregation status of the data collection"},"profile":{"type":"string","description":"Profile status of the data collection"}},"additionalProperties":false},"profile":{"type":"object","properties":{"patterns":{"type":"array","items":{"type":"object","properties":{"pattern":{"type":"string"},"counter":{"type":"number"},"sample":{"type":"string"}},"required":["pattern","counter","sample"],"additionalProperties":false}},"distinctCount":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"count":{"type":"number"}},"required":["value","count"],"additionalProperties":false}},"sampleValues":{"type":"array","items":{"type":"string"}},"sampleFiles":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"},"createdBy":{"type":"string","description":"Identifier of the user who created the data collection"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the data collection"}},"description":"Metadata and attributes of the requested data collection"}},"required":["status","data"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"status":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array"},{"type":"object","additionalProperties":true}]}}}}}},"401":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","content":{"application/json":{"schema":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"503":{"description":"Service Unavailable — Connection Refused","content":{"application/json":{"schema":{"description":"Service Unavailable — Connection Refused","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}}}}}}}
```

## Delete a Data Collection

> Deletes a data collection by its ID

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v2)","version":"v2"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v2/data-collections/{id}":{"delete":{"summary":"Delete a Data Collection","tags":["Data Collections"],"description":"Deletes a data collection by its ID","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"UUID of the data collection to delete"}],"responses":{"200":{"description":"Successfully deleted the collection","content":{"application/json":{"schema":{"description":"Successfully deleted the collection","type":"object","properties":{"status":{"type":"integer"},"data":{"type":"object","properties":{"deletedCount":{"type":"integer","description":"Number of collections deleted"},"deletedIDs":{"type":"array","items":{"type":"string","format":"uuid","description":"IDs of deleted collections"}}},"description":"Details of the deleted data collection"},"message":{"type":"string"}},"required":["status","data"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"status":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array"},{"type":"object","additionalProperties":true}]}}}}}},"401":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","content":{"application/json":{"schema":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"503":{"description":"Service Unavailable — Connection Refused","content":{"application/json":{"schema":{"description":"Service Unavailable — Connection Refused","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}}}}}}}
```

## Update a Data Collection

> Updates metadata or attributes for an existing data collection by ID

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v2)","version":"v2"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v2/data-collections/{id}":{"patch":{"summary":"Update a Data Collection","tags":["Data Collections"],"description":"Updates metadata or attributes for an existing data collection by ID","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the data collection"},"originalName":{"type":"string","description":"Original name of the data collection"},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"fqdn":{"type":"string","description":"Fully qualified domain name"},"fqdnDisplay":{"type":"string","description":"Display of the fully qualified domain name"},"parentId":{"type":"string","format":"uuid","description":"Parent collection UUID"},"rootId":{"type":"string","format":"uuid","description":"Root collection UUID"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"definition":{"type":"string","description":"Definition of the data collection"},"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"abbreviation":{"type":"string","description":"Abbreviation for the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner of the data collection"},"custodian":{"type":"string","description":"Custodian of the data collection"},"businessSteward":{"type":"string","description":"Business steward of the data collection"},"status":{"type":"string","description":"Status of the data collection"}},"additionalProperties":false},"features":{"type":"object","description":"Feature attributes of the data collection","properties":{"sensitivity":{"type":"string","description":"Sensitivity of the data collection"},"rating":{"type":"object","description":"Rating information","properties":{"value":{"type":"number","description":"Rating value"},"users":{"type":"object","description":"Users who rated the collection","additionalProperties":true}},"additionalProperties":false},"qualityScore":{"type":"number","description":"Quality score of the data collection"},"trustScore":{"type":"number","description":"Trust score of the data collection"},"isCriticalDataElement":{"type":"boolean","description":"Indicates if this is a critical data element"},"isLineageVerified":{"type":"boolean","description":"Indicates if lineage is verified"}},"additionalProperties":false},"customProperties":{"type":"array","description":"Custom properties for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Custom property ID"},"value":{"type":"string","description":"Custom property value"}},"additionalProperties":false}},"tags":{"type":"array","description":"Tags associated with the data collection","items":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"type":{"type":"string","description":"Tag type"}},"additionalProperties":false}},"businessTerms":{"type":"array","description":"Business terms associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business term ID"},"glossaryId":{"type":"string","description":"Glossary ID for the business term"},"name":{"type":"string","description":"Business term name"}},"additionalProperties":false}},"policies":{"type":"array","description":"Policies associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy ID"}},"additionalProperties":false}},"applications":{"type":"array","description":"Applications associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Application ID"}},"additionalProperties":false}},"physicalAssets":{"type":"array","description":"Physical assets associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Physical asset ID"}},"additionalProperties":false}},"objectAccess":{"type":"array","description":"Object access details for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Object access ID"},"type":{"type":"string","description":"Object access type"},"accessType":{"type":"string","description":"Type of access"}},"additionalProperties":false}},"originalType":{"type":"string","enum":["category","group","collection","dataset","COLUMN"],"description":"Original type of the data collection"},"predecessorId":{"type":"string","description":"ID of the predecessor data collection, if any"},"isDuplicated":{"type":"boolean","description":"Indicates if the data collection is a duplicated or not"}}},"system":{"type":"object","description":"System attributes of the data collection","properties":{"aggregatedAt":{"type":"string","description":"Timestamp when the data collection was aggregated"},"profiledAt":{"type":"string","description":"Timestamp when the data collection was profiled"}},"additionalProperties":false},"metadata":{"type":"object","description":"Metadata attributes of the data collection","properties":{"column":{"type":"object","description":"Column metadata for the data collection","properties":{"ordinalPosition":{"type":"string","description":"Ordinal Position of the column in the data collection"},"dataType":{"type":"string","description":"Data type of the column in the data collection"},"sqlDataType":{"type":"string","description":"SQL data type of the column in the data collection"},"typeName":{"type":"string","description":"Type name of the column in the data collection"},"reference":{"type":"object","description":"Column metadata for the data collection","properties":{"sourceDataType":{"type":"string","description":"Source data type of the column reference"},"scopeCatalog":{"type":"string","description":"Catalog name of the column reference"},"scopeSchema":{"type":"string","description":"Schema name of the column reference"},"scopeTable":{"type":"boolean","description":"Table name of the column reference"}}},"isNullable":{"type":"boolean","description":"Indicates if the column is nullable"},"isAutoIncrement":{"type":"boolean","description":"Indicates if the column is auto-incremented"},"isGeneratedColumn":{"type":"boolean","description":"Indicates if the column is a generated column"},"isPrimaryKey":{"type":"boolean","description":"Indicates if the column is a primary key"},"isForeignKey":{"type":"boolean","description":"Indicates if the column is a foreign key"},"columnDefault":{"type":"boolean","description":"Indicates if the column has a default value"},"columnSize":{"type":"number","description":"Indicates the size of the column"},"bufferLength":{"type":"number","description":"Buffer length of the column"},"decimalDigits":{"type":"number","description":"Indicates the number of decimal digits in the column"},"numPrecRadix":{"type":"number","description":"Indicates the numeric precision radix of the column"},"charOctetLength":{"type":"number","description":"Indicates the character octet length of the column"},"sqlDateTimeSub":{"type":"number","description":"Indicates the SQL date time sub of the column"},"remarks":{"type":"string","description":"The remarks for the column"},"extended":{"type":"object","description":"Extended metadata for the column","additionalProperties":true}}},"stats":{"type":"object","description":"Statistics for the data collection","properties":{"rowCount":{"type":"number","description":"Number of rows in the data collection"},"sizeInBytes":{"type":"number","description":"Size of the data collection in bytes"},"schemas":{"type":"number","description":"Number of schemas in the data collection"},"tables":{"type":"number","description":"Number of tables in the data collection"},"columns":{"type":"number","description":"Number of columns in the data collection"},"rows":{"type":"number","description":"Number of rows in the data collection"},"bytes":{"type":"number","description":"Number of bytes in the data collection"},"nulls":{"type":"number","description":"Number of nulls in the data collection"},"blanks":{"type":"number","description":"Number of blanks in the data collection"},"zeros":{"type":"number","description":"Number of zeros in the data collection"},"cardinality":{"type":"number","description":"Cardinality of the data collection"},"minValue":{"type":"number","description":"Minimum value in the data collection"},"maxValue":{"type":"number","description":"Maximum value in the data collection"},"avgValue":{"type":"number","description":"Average value in the data collection"},"stdevValue":{"type":"number","description":"Standard deviation of values in the data collection"},"minLength":{"type":"number","description":"Minimum length in the data collection"},"maxLength":{"type":"number","description":"Maximum length in the data collection"},"avgLength":{"type":"number","description":"Average length in the data collection"},"stdevLength":{"type":"number","description":"Standard deviation of lengths in the data collection"}},"additionalProperties":true},"status":{"type":"object","description":"Status of the data collection","properties":{"aggregation":{"type":"string","description":"Aggregation status of the data collection"},"profile":{"type":"string","description":"Profile status of the data collection"}},"additionalProperties":false},"profile":{"type":"object","properties":{"patterns":{"type":"array","items":{"type":"object","properties":{"pattern":{"type":"string"},"counter":{"type":"number"},"sample":{"type":"string"}},"required":["pattern","counter","sample"],"additionalProperties":false}},"distinctCount":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"count":{"type":"number"}},"required":["value","count"],"additionalProperties":false}},"sampleValues":{"type":"array","items":{"type":"string"}},"sampleFiles":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false}}}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"Data Collection ID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"data":{"type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier for the data collection"},"_index":{"type":"string","description":"Index name (e.g., OpenSearch index)"},"name":{"type":"string","description":"Name of the data collection"},"originalName":{"type":"string","description":"Original name of the data collection"},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"fqdn":{"type":"string","description":"Fully qualified domain name"},"fqdnDisplay":{"type":"string","description":"Display of the fully qualified domain name"},"parentId":{"type":"string","format":"uuid","description":"Parent collection UUID"},"rootId":{"type":"string","format":"uuid","description":"Root collection UUID"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"definition":{"type":"string","description":"Definition of the data collection"},"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"abbreviation":{"type":"string","description":"Abbreviation for the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner of the data collection"},"custodian":{"type":"string","description":"Custodian of the data collection"},"businessSteward":{"type":"string","description":"Business steward of the data collection"},"status":{"type":"string","description":"Status of the data collection"}},"additionalProperties":false},"features":{"type":"object","description":"Feature attributes of the data collection","properties":{"sensitivity":{"type":"string","description":"Sensitivity of the data collection"},"rating":{"type":"object","description":"Rating information","properties":{"value":{"type":"number","description":"Rating value"},"users":{"type":"object","description":"Users who rated the collection","additionalProperties":true}},"additionalProperties":false},"qualityScore":{"type":"number","description":"Quality score of the data collection"},"trustScore":{"type":"number","description":"Trust score of the data collection"},"isCriticalDataElement":{"type":"boolean","description":"Indicates if this is a critical data element"},"isLineageVerified":{"type":"boolean","description":"Indicates if lineage is verified"}},"additionalProperties":false},"customProperties":{"type":"array","description":"Custom properties for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Custom property ID"},"value":{"type":"string","description":"Custom property value"}},"additionalProperties":false}},"tags":{"type":"array","description":"Tags associated with the data collection","items":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"type":{"type":"string","description":"Tag type"}},"additionalProperties":false}},"businessTerms":{"type":"array","description":"Business terms associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business term ID"},"glossaryId":{"type":"string","description":"Glossary ID for the business term"},"name":{"type":"string","description":"Business term name"}},"additionalProperties":false}},"policies":{"type":"array","description":"Policies associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy ID"}},"additionalProperties":false}},"applications":{"type":"array","description":"Applications associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Application ID"}},"additionalProperties":false}},"physicalAssets":{"type":"array","description":"Physical assets associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Physical asset ID"}},"additionalProperties":false}},"objectAccess":{"type":"array","description":"Object access details for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Object access ID"},"type":{"type":"string","description":"Object access type"},"accessType":{"type":"string","description":"Type of access"}},"additionalProperties":false}},"originalType":{"type":"string","enum":["category","group","collection","dataset","COLUMN"],"description":"Original type of the data collection"},"predecessorId":{"type":"string","description":"ID of the predecessor data collection, if any"},"isDuplicated":{"type":"boolean","description":"Indicates if the data collection is a duplicated or not"}}},"system":{"type":"object","description":"System attributes of the data collection","properties":{"aggregatedAt":{"type":"string","description":"Timestamp when the data collection was aggregated"},"profiledAt":{"type":"string","description":"Timestamp when the data collection was profiled"}},"additionalProperties":false},"metadata":{"type":"object","description":"Metadata attributes of the data collection","properties":{"column":{"type":"object","description":"Column metadata for the data collection","properties":{"ordinalPosition":{"type":"string","description":"Ordinal Position of the column in the data collection"},"dataType":{"type":"string","description":"Data type of the column in the data collection"},"sqlDataType":{"type":"string","description":"SQL data type of the column in the data collection"},"typeName":{"type":"string","description":"Type name of the column in the data collection"},"reference":{"type":"object","description":"Column metadata for the data collection","properties":{"sourceDataType":{"type":"string","description":"Source data type of the column reference"},"scopeCatalog":{"type":"string","description":"Catalog name of the column reference"},"scopeSchema":{"type":"string","description":"Schema name of the column reference"},"scopeTable":{"type":"boolean","description":"Table name of the column reference"}}},"isNullable":{"type":"boolean","description":"Indicates if the column is nullable"},"isAutoIncrement":{"type":"boolean","description":"Indicates if the column is auto-incremented"},"isGeneratedColumn":{"type":"boolean","description":"Indicates if the column is a generated column"},"isPrimaryKey":{"type":"boolean","description":"Indicates if the column is a primary key"},"isForeignKey":{"type":"boolean","description":"Indicates if the column is a foreign key"},"columnDefault":{"type":"boolean","description":"Indicates if the column has a default value"},"columnSize":{"type":"number","description":"Indicates the size of the column"},"bufferLength":{"type":"number","description":"Buffer length of the column"},"decimalDigits":{"type":"number","description":"Indicates the number of decimal digits in the column"},"numPrecRadix":{"type":"number","description":"Indicates the numeric precision radix of the column"},"charOctetLength":{"type":"number","description":"Indicates the character octet length of the column"},"sqlDateTimeSub":{"type":"number","description":"Indicates the SQL date time sub of the column"},"remarks":{"type":"string","description":"The remarks for the column"},"extended":{"type":"object","description":"Extended metadata for the column","additionalProperties":true}}},"stats":{"type":"object","description":"Statistics for the data collection","properties":{"rowCount":{"type":"number","description":"Number of rows in the data collection"},"sizeInBytes":{"type":"number","description":"Size of the data collection in bytes"},"schemas":{"type":"number","description":"Number of schemas in the data collection"},"tables":{"type":"number","description":"Number of tables in the data collection"},"columns":{"type":"number","description":"Number of columns in the data collection"},"rows":{"type":"number","description":"Number of rows in the data collection"},"bytes":{"type":"number","description":"Number of bytes in the data collection"},"nulls":{"type":"number","description":"Number of nulls in the data collection"},"blanks":{"type":"number","description":"Number of blanks in the data collection"},"zeros":{"type":"number","description":"Number of zeros in the data collection"},"cardinality":{"type":"number","description":"Cardinality of the data collection"},"minValue":{"type":"number","description":"Minimum value in the data collection"},"maxValue":{"type":"number","description":"Maximum value in the data collection"},"avgValue":{"type":"number","description":"Average value in the data collection"},"stdevValue":{"type":"number","description":"Standard deviation of values in the data collection"},"minLength":{"type":"number","description":"Minimum length in the data collection"},"maxLength":{"type":"number","description":"Maximum length in the data collection"},"avgLength":{"type":"number","description":"Average length in the data collection"},"stdevLength":{"type":"number","description":"Standard deviation of lengths in the data collection"}},"additionalProperties":true},"status":{"type":"object","description":"Status of the data collection","properties":{"aggregation":{"type":"string","description":"Aggregation status of the data collection"},"profile":{"type":"string","description":"Profile status of the data collection"}},"additionalProperties":false},"profile":{"type":"object","properties":{"patterns":{"type":"array","items":{"type":"object","properties":{"pattern":{"type":"string"},"counter":{"type":"number"},"sample":{"type":"string"}},"required":["pattern","counter","sample"],"additionalProperties":false}},"distinctCount":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"count":{"type":"number"}},"required":["value","count"],"additionalProperties":false}},"sampleValues":{"type":"array","items":{"type":"string"}},"sampleFiles":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"},"createdBy":{"type":"string","description":"Identifier of the user who created the data collection"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the data collection"}}}},"required":["status","data"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"status":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array"},{"type":"object","additionalProperties":true}]}}}}}},"401":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","content":{"application/json":{"schema":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"503":{"description":"Service Unavailable — Connection Refused","content":{"application/json":{"schema":{"description":"Service Unavailable — Connection Refused","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}}}}}}}
```

## Get Data Collections by IDs

> Returns an array of metadata and attribute info for multiple data collections by their IDs\
>                 \
> \
> 🚨 \*\*Note:\*\* Results are limited to 10,000 items.

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v2)","version":"v2"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v2/data-collections/by-ids":{"post":{"summary":"Get Data Collections by IDs","tags":["Data Collections"],"description":"Returns an array of metadata and attribute info for multiple data collections by their IDs\n                \n\n🚨 **Note:** Results are limited to 10,000 items.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","minItems":1,"items":{"type":"string","format":"uuid","description":"Data Collection ID"},"description":"List of data collection IDs"}},"required":["ids"]}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"data":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier for the data collection"},"_index":{"type":"string","description":"Index name (e.g., OpenSearch index)"},"name":{"type":"string","description":"Name of the data collection"},"originalName":{"type":"string","description":"Original name of the data collection"},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"fqdn":{"type":"string","description":"Fully qualified domain name"},"fqdnDisplay":{"type":"string","description":"Display of the fully qualified domain name"},"parentId":{"type":"string","format":"uuid","description":"Parent collection UUID"},"rootId":{"type":"string","format":"uuid","description":"Root collection UUID"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"definition":{"type":"string","description":"Definition of the data collection"},"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"abbreviation":{"type":"string","description":"Abbreviation for the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner of the data collection"},"custodian":{"type":"string","description":"Custodian of the data collection"},"businessSteward":{"type":"string","description":"Business steward of the data collection"},"status":{"type":"string","description":"Status of the data collection"}},"additionalProperties":false},"features":{"type":"object","description":"Feature attributes of the data collection","properties":{"sensitivity":{"type":"string","description":"Sensitivity of the data collection"},"rating":{"type":"object","description":"Rating information","properties":{"value":{"type":"number","description":"Rating value"},"users":{"type":"object","description":"Users who rated the collection","additionalProperties":true}},"additionalProperties":false},"qualityScore":{"type":"number","description":"Quality score of the data collection"},"trustScore":{"type":"number","description":"Trust score of the data collection"},"isCriticalDataElement":{"type":"boolean","description":"Indicates if this is a critical data element"},"isLineageVerified":{"type":"boolean","description":"Indicates if lineage is verified"}},"additionalProperties":false},"customProperties":{"type":"array","description":"Custom properties for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Custom property ID"},"value":{"type":"string","description":"Custom property value"}},"additionalProperties":false}},"tags":{"type":"array","description":"Tags associated with the data collection","items":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"type":{"type":"string","description":"Tag type"}},"additionalProperties":false}},"businessTerms":{"type":"array","description":"Business terms associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business term ID"},"glossaryId":{"type":"string","description":"Glossary ID for the business term"},"name":{"type":"string","description":"Business term name"}},"additionalProperties":false}},"policies":{"type":"array","description":"Policies associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy ID"}},"additionalProperties":false}},"applications":{"type":"array","description":"Applications associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Application ID"}},"additionalProperties":false}},"physicalAssets":{"type":"array","description":"Physical assets associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Physical asset ID"}},"additionalProperties":false}},"objectAccess":{"type":"array","description":"Object access details for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Object access ID"},"type":{"type":"string","description":"Object access type"},"accessType":{"type":"string","description":"Type of access"}},"additionalProperties":false}},"originalType":{"type":"string","enum":["category","group","collection","dataset","COLUMN"],"description":"Original type of the data collection"},"predecessorId":{"type":"string","description":"ID of the predecessor data collection, if any"},"isDuplicated":{"type":"boolean","description":"Indicates if the data collection is a duplicated or not"}}},"system":{"type":"object","description":"System attributes of the data collection","properties":{"aggregatedAt":{"type":"string","description":"Timestamp when the data collection was aggregated"},"profiledAt":{"type":"string","description":"Timestamp when the data collection was profiled"}},"additionalProperties":false},"metadata":{"type":"object","description":"Metadata attributes of the data collection","properties":{"column":{"type":"object","description":"Column metadata for the data collection","properties":{"ordinalPosition":{"type":"string","description":"Ordinal Position of the column in the data collection"},"dataType":{"type":"string","description":"Data type of the column in the data collection"},"sqlDataType":{"type":"string","description":"SQL data type of the column in the data collection"},"typeName":{"type":"string","description":"Type name of the column in the data collection"},"reference":{"type":"object","description":"Column metadata for the data collection","properties":{"sourceDataType":{"type":"string","description":"Source data type of the column reference"},"scopeCatalog":{"type":"string","description":"Catalog name of the column reference"},"scopeSchema":{"type":"string","description":"Schema name of the column reference"},"scopeTable":{"type":"boolean","description":"Table name of the column reference"}}},"isNullable":{"type":"boolean","description":"Indicates if the column is nullable"},"isAutoIncrement":{"type":"boolean","description":"Indicates if the column is auto-incremented"},"isGeneratedColumn":{"type":"boolean","description":"Indicates if the column is a generated column"},"isPrimaryKey":{"type":"boolean","description":"Indicates if the column is a primary key"},"isForeignKey":{"type":"boolean","description":"Indicates if the column is a foreign key"},"columnDefault":{"type":"boolean","description":"Indicates if the column has a default value"},"columnSize":{"type":"number","description":"Indicates the size of the column"},"bufferLength":{"type":"number","description":"Buffer length of the column"},"decimalDigits":{"type":"number","description":"Indicates the number of decimal digits in the column"},"numPrecRadix":{"type":"number","description":"Indicates the numeric precision radix of the column"},"charOctetLength":{"type":"number","description":"Indicates the character octet length of the column"},"sqlDateTimeSub":{"type":"number","description":"Indicates the SQL date time sub of the column"},"remarks":{"type":"string","description":"The remarks for the column"},"extended":{"type":"object","description":"Extended metadata for the column","additionalProperties":true}}},"stats":{"type":"object","description":"Statistics for the data collection","properties":{"rowCount":{"type":"number","description":"Number of rows in the data collection"},"sizeInBytes":{"type":"number","description":"Size of the data collection in bytes"},"schemas":{"type":"number","description":"Number of schemas in the data collection"},"tables":{"type":"number","description":"Number of tables in the data collection"},"columns":{"type":"number","description":"Number of columns in the data collection"},"rows":{"type":"number","description":"Number of rows in the data collection"},"bytes":{"type":"number","description":"Number of bytes in the data collection"},"nulls":{"type":"number","description":"Number of nulls in the data collection"},"blanks":{"type":"number","description":"Number of blanks in the data collection"},"zeros":{"type":"number","description":"Number of zeros in the data collection"},"cardinality":{"type":"number","description":"Cardinality of the data collection"},"minValue":{"type":"number","description":"Minimum value in the data collection"},"maxValue":{"type":"number","description":"Maximum value in the data collection"},"avgValue":{"type":"number","description":"Average value in the data collection"},"stdevValue":{"type":"number","description":"Standard deviation of values in the data collection"},"minLength":{"type":"number","description":"Minimum length in the data collection"},"maxLength":{"type":"number","description":"Maximum length in the data collection"},"avgLength":{"type":"number","description":"Average length in the data collection"},"stdevLength":{"type":"number","description":"Standard deviation of lengths in the data collection"}},"additionalProperties":true},"status":{"type":"object","description":"Status of the data collection","properties":{"aggregation":{"type":"string","description":"Aggregation status of the data collection"},"profile":{"type":"string","description":"Profile status of the data collection"}},"additionalProperties":false},"profile":{"type":"object","properties":{"patterns":{"type":"array","items":{"type":"object","properties":{"pattern":{"type":"string"},"counter":{"type":"number"},"sample":{"type":"string"}},"required":["pattern","counter","sample"],"additionalProperties":false}},"distinctCount":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"count":{"type":"number"}},"required":["value","count"],"additionalProperties":false}},"sampleValues":{"type":"array","items":{"type":"string"}},"sampleFiles":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"},"createdBy":{"type":"string","description":"Identifier of the user who created the data collection"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the data collection"}},"description":"Metadata and attributes of a data collection"},"description":"Array of data collections"}},"required":["status","data"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"status":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array"},{"type":"object","additionalProperties":true}]}}}}}},"401":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","content":{"application/json":{"schema":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"503":{"description":"Service Unavailable — Connection Refused","content":{"application/json":{"schema":{"description":"Service Unavailable — Connection Refused","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}}}}}}}
```

## Add children to a collection

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

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v2)","version":"v2"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v2/data-collections/{id}/add-children":{"post":{"summary":"Add children to a collection","tags":["Data Collections"],"description":"Associates a list of entity UUIDs as children of a data collection","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["entities"],"additionalProperties":false,"properties":{"entities":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"List of entity UUIDs to add as children"}}}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"Collection ID to which entities will be added as children"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"}},"required":["status","message"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"status":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array"},{"type":"object","additionalProperties":true}]}}}}}},"401":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","content":{"application/json":{"schema":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"503":{"description":"Service Unavailable — Connection Refused","content":{"application/json":{"schema":{"description":"Service Unavailable — Connection Refused","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}}}}}}}
```

## Remove children from a collection

> Disassociates a list of entity UUIDs from a data collection

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v2)","version":"v2"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v2/data-collections/{id}/remove-children":{"post":{"summary":"Remove children from a collection","tags":["Data Collections"],"description":"Disassociates a list of entity UUIDs from a data collection","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["entities"],"additionalProperties":false,"properties":{"entities":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"List of entity UUIDs to remove"}}}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"Collection ID to remove entities from"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"}},"required":["status","message"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"status":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array"},{"type":"object","additionalProperties":true}]}}}}}},"401":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","content":{"application/json":{"schema":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"503":{"description":"Service Unavailable — Connection Refused","content":{"application/json":{"schema":{"description":"Service Unavailable — Connection Refused","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}}}}}}}
```

## Filter Collections

> Returns array of collections filtered by criteria with pagination support. \
> \
> 🚨 \*\*Note:\*\* Results are limited to 10,000 items.

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v2)","version":"v2"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v2/data-collections/filter":{"post":{"summary":"Filter Collections","tags":["Data Collections"],"description":"Returns array of collections filtered by criteria with pagination support. \n\n🚨 **Note:** Results are limited to 10,000 items.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"type":"object","properties":{"parentIds":{"type":"array","items":{"type":"string","description":"Parent ID"},"description":"Filter by array of parent IDs"},"rootIds":{"type":"array","items":{"type":"string","description":"Root ID"},"description":"Filter by array of root IDs"},"types":{"type":"array","items":{"type":"string","description":"Type"},"description":"Filter by array of types: category, group, dataProduct, collection, dataset, COLUMN"},"names":{"type":"array","items":{"type":"string","description":"Name"},"description":"Filter by array of names"},"fqdns":{"type":"array","items":{"type":"string","description":"Fully qualified domain name"},"description":"Filter by array of fully qualified domain names"},"profileStatus":{"type":"array","items":{"type":"string","description":"Profile status","enum":["COMPLETED","SKIPPED","FAILED"]},"description":"Filter by array of profile statuses"},"profiledAt":{"type":"object","properties":{"min":{"type":"string","format":"date-time","description":"Minimum profiling date (inclusive). Supports ISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ)"},"max":{"type":"string","format":"date-time","description":"Maximum profiling date (inclusive). Supports ISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ)"}},"description":"Filter by profiling date range. Supports both full ISO 8601 timestamps (YYYY-MM-DDTHH:mm:ss.sssZ)."}},"additionalProperties":false,"description":"Filter criteria for collections"},"page":{"type":"integer","minimum":1,"default":1,"description":"Page number for pagination (starts from 1)"},"perPage":{"type":"integer","minimum":1,"default":1000,"description":"Number of items per page"}},"additionalProperties":false,"required":["filters"],"description":"At least one filter must be provided"}}},"required":true,"description":"At least one filter must be provided"},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"data":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier for the data collection"},"_index":{"type":"string","description":"Index name (e.g., OpenSearch index)"},"name":{"type":"string","description":"Name of the data collection"},"originalName":{"type":"string","description":"Original name of the data collection"},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"fqdn":{"type":"string","description":"Fully qualified domain name"},"fqdnDisplay":{"type":"string","description":"Display of the fully qualified domain name"},"parentId":{"type":"string","format":"uuid","description":"Parent collection UUID"},"rootId":{"type":"string","format":"uuid","description":"Root collection UUID"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"definition":{"type":"string","description":"Definition of the data collection"},"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"abbreviation":{"type":"string","description":"Abbreviation for the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner of the data collection"},"custodian":{"type":"string","description":"Custodian of the data collection"},"businessSteward":{"type":"string","description":"Business steward of the data collection"},"status":{"type":"string","description":"Status of the data collection"}},"additionalProperties":false},"features":{"type":"object","description":"Feature attributes of the data collection","properties":{"sensitivity":{"type":"string","description":"Sensitivity of the data collection"},"rating":{"type":"object","description":"Rating information","properties":{"value":{"type":"number","description":"Rating value"},"users":{"type":"object","description":"Users who rated the collection","additionalProperties":true}},"additionalProperties":false},"qualityScore":{"type":"number","description":"Quality score of the data collection"},"trustScore":{"type":"number","description":"Trust score of the data collection"},"isCriticalDataElement":{"type":"boolean","description":"Indicates if this is a critical data element"},"isLineageVerified":{"type":"boolean","description":"Indicates if lineage is verified"}},"additionalProperties":false},"customProperties":{"type":"array","description":"Custom properties for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Custom property ID"},"value":{"type":"string","description":"Custom property value"}},"additionalProperties":false}},"tags":{"type":"array","description":"Tags associated with the data collection","items":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"type":{"type":"string","description":"Tag type"}},"additionalProperties":false}},"businessTerms":{"type":"array","description":"Business terms associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business term ID"},"glossaryId":{"type":"string","description":"Glossary ID for the business term"},"name":{"type":"string","description":"Business term name"}},"additionalProperties":false}},"policies":{"type":"array","description":"Policies associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy ID"}},"additionalProperties":false}},"applications":{"type":"array","description":"Applications associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Application ID"}},"additionalProperties":false}},"physicalAssets":{"type":"array","description":"Physical assets associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Physical asset ID"}},"additionalProperties":false}},"objectAccess":{"type":"array","description":"Object access details for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Object access ID"},"type":{"type":"string","description":"Object access type"},"accessType":{"type":"string","description":"Type of access"}},"additionalProperties":false}},"originalType":{"type":"string","enum":["category","group","collection","dataset","COLUMN"],"description":"Original type of the data collection"},"predecessorId":{"type":"string","description":"ID of the predecessor data collection, if any"},"isDuplicated":{"type":"boolean","description":"Indicates if the data collection is a duplicated or not"}}},"system":{"type":"object","description":"System attributes of the data collection","properties":{"aggregatedAt":{"type":"string","description":"Timestamp when the data collection was aggregated"},"profiledAt":{"type":"string","description":"Timestamp when the data collection was profiled"}},"additionalProperties":false},"metadata":{"type":"object","description":"Metadata attributes of the data collection","properties":{"column":{"type":"object","description":"Column metadata for the data collection","properties":{"ordinalPosition":{"type":"string","description":"Ordinal Position of the column in the data collection"},"dataType":{"type":"string","description":"Data type of the column in the data collection"},"sqlDataType":{"type":"string","description":"SQL data type of the column in the data collection"},"typeName":{"type":"string","description":"Type name of the column in the data collection"},"reference":{"type":"object","description":"Column metadata for the data collection","properties":{"sourceDataType":{"type":"string","description":"Source data type of the column reference"},"scopeCatalog":{"type":"string","description":"Catalog name of the column reference"},"scopeSchema":{"type":"string","description":"Schema name of the column reference"},"scopeTable":{"type":"boolean","description":"Table name of the column reference"}}},"isNullable":{"type":"boolean","description":"Indicates if the column is nullable"},"isAutoIncrement":{"type":"boolean","description":"Indicates if the column is auto-incremented"},"isGeneratedColumn":{"type":"boolean","description":"Indicates if the column is a generated column"},"isPrimaryKey":{"type":"boolean","description":"Indicates if the column is a primary key"},"isForeignKey":{"type":"boolean","description":"Indicates if the column is a foreign key"},"columnDefault":{"type":"boolean","description":"Indicates if the column has a default value"},"columnSize":{"type":"number","description":"Indicates the size of the column"},"bufferLength":{"type":"number","description":"Buffer length of the column"},"decimalDigits":{"type":"number","description":"Indicates the number of decimal digits in the column"},"numPrecRadix":{"type":"number","description":"Indicates the numeric precision radix of the column"},"charOctetLength":{"type":"number","description":"Indicates the character octet length of the column"},"sqlDateTimeSub":{"type":"number","description":"Indicates the SQL date time sub of the column"},"remarks":{"type":"string","description":"The remarks for the column"},"extended":{"type":"object","description":"Extended metadata for the column","additionalProperties":true}}},"stats":{"type":"object","description":"Statistics for the data collection","properties":{"rowCount":{"type":"number","description":"Number of rows in the data collection"},"sizeInBytes":{"type":"number","description":"Size of the data collection in bytes"},"schemas":{"type":"number","description":"Number of schemas in the data collection"},"tables":{"type":"number","description":"Number of tables in the data collection"},"columns":{"type":"number","description":"Number of columns in the data collection"},"rows":{"type":"number","description":"Number of rows in the data collection"},"bytes":{"type":"number","description":"Number of bytes in the data collection"},"nulls":{"type":"number","description":"Number of nulls in the data collection"},"blanks":{"type":"number","description":"Number of blanks in the data collection"},"zeros":{"type":"number","description":"Number of zeros in the data collection"},"cardinality":{"type":"number","description":"Cardinality of the data collection"},"minValue":{"type":"number","description":"Minimum value in the data collection"},"maxValue":{"type":"number","description":"Maximum value in the data collection"},"avgValue":{"type":"number","description":"Average value in the data collection"},"stdevValue":{"type":"number","description":"Standard deviation of values in the data collection"},"minLength":{"type":"number","description":"Minimum length in the data collection"},"maxLength":{"type":"number","description":"Maximum length in the data collection"},"avgLength":{"type":"number","description":"Average length in the data collection"},"stdevLength":{"type":"number","description":"Standard deviation of lengths in the data collection"}},"additionalProperties":true},"status":{"type":"object","description":"Status of the data collection","properties":{"aggregation":{"type":"string","description":"Aggregation status of the data collection"},"profile":{"type":"string","description":"Profile status of the data collection"}},"additionalProperties":false},"profile":{"type":"object","properties":{"patterns":{"type":"array","items":{"type":"object","properties":{"pattern":{"type":"string"},"counter":{"type":"number"},"sample":{"type":"string"}},"required":["pattern","counter","sample"],"additionalProperties":false}},"distinctCount":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"count":{"type":"number"}},"required":["value","count"],"additionalProperties":false}},"sampleValues":{"type":"array","items":{"type":"string"}},"sampleFiles":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"},"createdBy":{"type":"string","description":"Identifier of the user who created the data collection"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the data collection"}},"description":"Metadata and attributes of the collection."},"description":"Array of collections with their metadata and attributes."},"pageInfo":{"type":"object","properties":{"currentPage":{"type":"integer","description":"Current page number"},"perPage":{"type":"integer","description":"Number of items per page"},"totalCount":{"type":"integer","description":"Total number of items"},"pageCount":{"type":"integer","description":"Total number of pages"}},"required":["currentPage","perPage","totalCount","pageCount"],"description":"Pagination information"}},"required":["status","data","pageInfo"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"status":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array"},{"type":"object","additionalProperties":true}]}}}}}},"401":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","content":{"application/json":{"schema":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"503":{"description":"Service Unavailable — Connection Refused","content":{"application/json":{"schema":{"description":"Service Unavailable — Connection Refused","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}}}}}}}
```

## Get Profiling Information by Collection IDs

> Returns profiling statistics for a list of collections by their IDs. \
> \
> 🚨 \*\*Note:\*\* Results are limited to 10,000 items.

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v2)","version":"v2"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v2/data-collections/by-ids/profiling-info":{"post":{"summary":"Get Profiling Information by Collection IDs","tags":["Data Collections"],"description":"Returns profiling statistics for a list of collections by their IDs. \n\n🚨 **Note:** Results are limited to 10,000 items.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","minItems":1,"items":{"type":"string","format":"uuid","description":"Collection ID"},"description":"Array of collection IDs"}},"required":["ids"]}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"data":{"type":"array","items":{"type":"object","properties":{"collection":{"type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier for the data collection"},"_index":{"type":"string","description":"Index name (e.g., OpenSearch index)"},"name":{"type":"string","description":"Name of the data collection"},"originalName":{"type":"string","description":"Original name of the data collection"},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"fqdn":{"type":"string","description":"Fully qualified domain name"},"fqdnDisplay":{"type":"string","description":"Display of the fully qualified domain name"},"parentId":{"type":"string","format":"uuid","description":"Parent collection UUID"},"rootId":{"type":"string","format":"uuid","description":"Root collection UUID"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"definition":{"type":"string","description":"Definition of the data collection"},"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"abbreviation":{"type":"string","description":"Abbreviation for the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner of the data collection"},"custodian":{"type":"string","description":"Custodian of the data collection"},"businessSteward":{"type":"string","description":"Business steward of the data collection"},"status":{"type":"string","description":"Status of the data collection"}},"additionalProperties":false},"features":{"type":"object","description":"Feature attributes of the data collection","properties":{"sensitivity":{"type":"string","description":"Sensitivity of the data collection"},"rating":{"type":"object","description":"Rating information","properties":{"value":{"type":"number","description":"Rating value"},"users":{"type":"object","description":"Users who rated the collection","additionalProperties":true}},"additionalProperties":false},"qualityScore":{"type":"number","description":"Quality score of the data collection"},"trustScore":{"type":"number","description":"Trust score of the data collection"},"isCriticalDataElement":{"type":"boolean","description":"Indicates if this is a critical data element"},"isLineageVerified":{"type":"boolean","description":"Indicates if lineage is verified"}},"additionalProperties":false},"customProperties":{"type":"array","description":"Custom properties for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Custom property ID"},"value":{"type":"string","description":"Custom property value"}},"additionalProperties":false}},"tags":{"type":"array","description":"Tags associated with the data collection","items":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"type":{"type":"string","description":"Tag type"}},"additionalProperties":false}},"businessTerms":{"type":"array","description":"Business terms associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business term ID"},"glossaryId":{"type":"string","description":"Glossary ID for the business term"},"name":{"type":"string","description":"Business term name"}},"additionalProperties":false}},"policies":{"type":"array","description":"Policies associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy ID"}},"additionalProperties":false}},"applications":{"type":"array","description":"Applications associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Application ID"}},"additionalProperties":false}},"physicalAssets":{"type":"array","description":"Physical assets associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Physical asset ID"}},"additionalProperties":false}},"objectAccess":{"type":"array","description":"Object access details for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Object access ID"},"type":{"type":"string","description":"Object access type"},"accessType":{"type":"string","description":"Type of access"}},"additionalProperties":false}},"originalType":{"type":"string","enum":["category","group","collection","dataset","COLUMN"],"description":"Original type of the data collection"},"predecessorId":{"type":"string","description":"ID of the predecessor data collection, if any"},"isDuplicated":{"type":"boolean","description":"Indicates if the data collection is a duplicated or not"}}},"system":{"type":"object","description":"System attributes of the data collection","properties":{"aggregatedAt":{"type":"string","description":"Timestamp when the data collection was aggregated"},"profiledAt":{"type":"string","description":"Timestamp when the data collection was profiled"}},"additionalProperties":false},"metadata":{"type":"object","description":"Metadata attributes of the data collection","properties":{"column":{"type":"object","description":"Column metadata for the data collection","properties":{"ordinalPosition":{"type":"string","description":"Ordinal Position of the column in the data collection"},"dataType":{"type":"string","description":"Data type of the column in the data collection"},"sqlDataType":{"type":"string","description":"SQL data type of the column in the data collection"},"typeName":{"type":"string","description":"Type name of the column in the data collection"},"reference":{"type":"object","description":"Column metadata for the data collection","properties":{"sourceDataType":{"type":"string","description":"Source data type of the column reference"},"scopeCatalog":{"type":"string","description":"Catalog name of the column reference"},"scopeSchema":{"type":"string","description":"Schema name of the column reference"},"scopeTable":{"type":"boolean","description":"Table name of the column reference"}}},"isNullable":{"type":"boolean","description":"Indicates if the column is nullable"},"isAutoIncrement":{"type":"boolean","description":"Indicates if the column is auto-incremented"},"isGeneratedColumn":{"type":"boolean","description":"Indicates if the column is a generated column"},"isPrimaryKey":{"type":"boolean","description":"Indicates if the column is a primary key"},"isForeignKey":{"type":"boolean","description":"Indicates if the column is a foreign key"},"columnDefault":{"type":"boolean","description":"Indicates if the column has a default value"},"columnSize":{"type":"number","description":"Indicates the size of the column"},"bufferLength":{"type":"number","description":"Buffer length of the column"},"decimalDigits":{"type":"number","description":"Indicates the number of decimal digits in the column"},"numPrecRadix":{"type":"number","description":"Indicates the numeric precision radix of the column"},"charOctetLength":{"type":"number","description":"Indicates the character octet length of the column"},"sqlDateTimeSub":{"type":"number","description":"Indicates the SQL date time sub of the column"},"remarks":{"type":"string","description":"The remarks for the column"},"extended":{"type":"object","description":"Extended metadata for the column","additionalProperties":true}}},"stats":{"type":"object","description":"Statistics for the data collection","properties":{"rowCount":{"type":"number","description":"Number of rows in the data collection"},"sizeInBytes":{"type":"number","description":"Size of the data collection in bytes"},"schemas":{"type":"number","description":"Number of schemas in the data collection"},"tables":{"type":"number","description":"Number of tables in the data collection"},"columns":{"type":"number","description":"Number of columns in the data collection"},"rows":{"type":"number","description":"Number of rows in the data collection"},"bytes":{"type":"number","description":"Number of bytes in the data collection"},"nulls":{"type":"number","description":"Number of nulls in the data collection"},"blanks":{"type":"number","description":"Number of blanks in the data collection"},"zeros":{"type":"number","description":"Number of zeros in the data collection"},"cardinality":{"type":"number","description":"Cardinality of the data collection"},"minValue":{"type":"number","description":"Minimum value in the data collection"},"maxValue":{"type":"number","description":"Maximum value in the data collection"},"avgValue":{"type":"number","description":"Average value in the data collection"},"stdevValue":{"type":"number","description":"Standard deviation of values in the data collection"},"minLength":{"type":"number","description":"Minimum length in the data collection"},"maxLength":{"type":"number","description":"Maximum length in the data collection"},"avgLength":{"type":"number","description":"Average length in the data collection"},"stdevLength":{"type":"number","description":"Standard deviation of lengths in the data collection"}},"additionalProperties":true},"status":{"type":"object","description":"Status of the data collection","properties":{"aggregation":{"type":"string","description":"Aggregation status of the data collection"},"profile":{"type":"string","description":"Profile status of the data collection"}},"additionalProperties":false},"profile":{"type":"object","properties":{"patterns":{"type":"array","items":{"type":"object","properties":{"pattern":{"type":"string"},"counter":{"type":"number"},"sample":{"type":"string"}},"required":["pattern","counter","sample"],"additionalProperties":false}},"distinctCount":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"count":{"type":"number"}},"required":["value","count"],"additionalProperties":false}},"sampleValues":{"type":"array","items":{"type":"string"}},"sampleFiles":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"},"createdBy":{"type":"string","description":"Identifier of the user who created the data collection"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the data collection"}},"description":"Metadata and attributes of the collection."},"profilingInfo":{"type":"array","description":"Profiling statistics for the collection","items":{"type":"object","properties":{"entity":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"parentId":{"type":"string"},"rootId":{"type":"string"},"resourceId":{"type":"string"},"fqdn":{"type":"string"}}},"profile":{"type":"object","additionalProperties":true},"children":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}},"description":"Metadata, attributes, and profiling information of the collection."},"description":"Array of collections with their metadata, attributes, and profiling information."}},"required":["status","data"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"status":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array"},{"type":"object","additionalProperties":true}]}}}}}},"401":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","content":{"application/json":{"schema":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"503":{"description":"Service Unavailable — Connection Refused","content":{"application/json":{"schema":{"description":"Service Unavailable — Connection Refused","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}}}}}}}
```

## Filter Collections and Get Profiling Information

> Returns array of collections with their profiling information filtered by criteria with pagination support. \
> \
> 🚨 \*\*Note:\*\* Results are limited to 10,000 items.

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v2)","version":"v2"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v2/data-collections/filter/profiling-info":{"post":{"summary":"Filter Collections and Get Profiling Information","tags":["Data Collections"],"description":"Returns array of collections with their profiling information filtered by criteria with pagination support. \n\n🚨 **Note:** Results are limited to 10,000 items.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"type":"object","properties":{"parentIds":{"type":"array","items":{"type":"string","description":"Parent ID"},"description":"Filter by array of parent IDs"},"rootIds":{"type":"array","items":{"type":"string","description":"Root ID"},"description":"Filter by array of root IDs"},"types":{"type":"array","items":{"type":"string","description":"Type"},"description":"Filter by array of types: dataProduct, collection, and dataset"},"names":{"type":"array","items":{"type":"string","description":"Name"},"description":"Filter by array of names"},"fqdns":{"type":"array","items":{"type":"string","description":"Fully qualified domain name"},"description":"Filter by array of fully qualified domain names"},"profileStatus":{"type":"array","items":{"type":"string","description":"Profile status","enum":["COMPLETED","SKIPPED","FAILED"]},"description":"Filter by array of profile statuses"},"profiledAt":{"type":"object","properties":{"min":{"type":"string","format":"date-time","description":"Minimum profiling date (inclusive). Supports ISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ)"},"max":{"type":"string","format":"date-time","description":"Maximum profiling date (inclusive). Supports ISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ)"}},"description":"Filter by profiling date range. Supports both full ISO 8601 timestamps (YYYY-MM-DDTHH:mm:ss.sssZ)."}},"additionalProperties":false,"description":"Filter criteria for collections"},"page":{"type":"integer","minimum":1,"default":1,"description":"Page number for pagination (starts from 1)"},"perPage":{"type":"integer","minimum":1,"default":1000,"description":"Number of items per page"}},"additionalProperties":false,"required":["filters"],"description":"At least one filter must be provided"}}},"required":true,"description":"At least one filter must be provided"},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"data":{"type":"array","items":{"type":"object","properties":{"collection":{"type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier for the data collection"},"_index":{"type":"string","description":"Index name (e.g., OpenSearch index)"},"name":{"type":"string","description":"Name of the data collection"},"originalName":{"type":"string","description":"Original name of the data collection"},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"fqdn":{"type":"string","description":"Fully qualified domain name"},"fqdnDisplay":{"type":"string","description":"Display of the fully qualified domain name"},"parentId":{"type":"string","format":"uuid","description":"Parent collection UUID"},"rootId":{"type":"string","format":"uuid","description":"Root collection UUID"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"definition":{"type":"string","description":"Definition of the data collection"},"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"abbreviation":{"type":"string","description":"Abbreviation for the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner of the data collection"},"custodian":{"type":"string","description":"Custodian of the data collection"},"businessSteward":{"type":"string","description":"Business steward of the data collection"},"status":{"type":"string","description":"Status of the data collection"}},"additionalProperties":false},"features":{"type":"object","description":"Feature attributes of the data collection","properties":{"sensitivity":{"type":"string","description":"Sensitivity of the data collection"},"rating":{"type":"object","description":"Rating information","properties":{"value":{"type":"number","description":"Rating value"},"users":{"type":"object","description":"Users who rated the collection","additionalProperties":true}},"additionalProperties":false},"qualityScore":{"type":"number","description":"Quality score of the data collection"},"trustScore":{"type":"number","description":"Trust score of the data collection"},"isCriticalDataElement":{"type":"boolean","description":"Indicates if this is a critical data element"},"isLineageVerified":{"type":"boolean","description":"Indicates if lineage is verified"}},"additionalProperties":false},"customProperties":{"type":"array","description":"Custom properties for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Custom property ID"},"value":{"type":"string","description":"Custom property value"}},"additionalProperties":false}},"tags":{"type":"array","description":"Tags associated with the data collection","items":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"type":{"type":"string","description":"Tag type"}},"additionalProperties":false}},"businessTerms":{"type":"array","description":"Business terms associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business term ID"},"glossaryId":{"type":"string","description":"Glossary ID for the business term"},"name":{"type":"string","description":"Business term name"}},"additionalProperties":false}},"policies":{"type":"array","description":"Policies associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy ID"}},"additionalProperties":false}},"applications":{"type":"array","description":"Applications associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Application ID"}},"additionalProperties":false}},"physicalAssets":{"type":"array","description":"Physical assets associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Physical asset ID"}},"additionalProperties":false}},"objectAccess":{"type":"array","description":"Object access details for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Object access ID"},"type":{"type":"string","description":"Object access type"},"accessType":{"type":"string","description":"Type of access"}},"additionalProperties":false}},"originalType":{"type":"string","enum":["category","group","collection","dataset","COLUMN"],"description":"Original type of the data collection"},"predecessorId":{"type":"string","description":"ID of the predecessor data collection, if any"},"isDuplicated":{"type":"boolean","description":"Indicates if the data collection is a duplicated or not"}}},"system":{"type":"object","description":"System attributes of the data collection","properties":{"aggregatedAt":{"type":"string","description":"Timestamp when the data collection was aggregated"},"profiledAt":{"type":"string","description":"Timestamp when the data collection was profiled"}},"additionalProperties":false},"metadata":{"type":"object","description":"Metadata attributes of the data collection","properties":{"column":{"type":"object","description":"Column metadata for the data collection","properties":{"ordinalPosition":{"type":"string","description":"Ordinal Position of the column in the data collection"},"dataType":{"type":"string","description":"Data type of the column in the data collection"},"sqlDataType":{"type":"string","description":"SQL data type of the column in the data collection"},"typeName":{"type":"string","description":"Type name of the column in the data collection"},"reference":{"type":"object","description":"Column metadata for the data collection","properties":{"sourceDataType":{"type":"string","description":"Source data type of the column reference"},"scopeCatalog":{"type":"string","description":"Catalog name of the column reference"},"scopeSchema":{"type":"string","description":"Schema name of the column reference"},"scopeTable":{"type":"boolean","description":"Table name of the column reference"}}},"isNullable":{"type":"boolean","description":"Indicates if the column is nullable"},"isAutoIncrement":{"type":"boolean","description":"Indicates if the column is auto-incremented"},"isGeneratedColumn":{"type":"boolean","description":"Indicates if the column is a generated column"},"isPrimaryKey":{"type":"boolean","description":"Indicates if the column is a primary key"},"isForeignKey":{"type":"boolean","description":"Indicates if the column is a foreign key"},"columnDefault":{"type":"boolean","description":"Indicates if the column has a default value"},"columnSize":{"type":"number","description":"Indicates the size of the column"},"bufferLength":{"type":"number","description":"Buffer length of the column"},"decimalDigits":{"type":"number","description":"Indicates the number of decimal digits in the column"},"numPrecRadix":{"type":"number","description":"Indicates the numeric precision radix of the column"},"charOctetLength":{"type":"number","description":"Indicates the character octet length of the column"},"sqlDateTimeSub":{"type":"number","description":"Indicates the SQL date time sub of the column"},"remarks":{"type":"string","description":"The remarks for the column"},"extended":{"type":"object","description":"Extended metadata for the column","additionalProperties":true}}},"stats":{"type":"object","description":"Statistics for the data collection","properties":{"rowCount":{"type":"number","description":"Number of rows in the data collection"},"sizeInBytes":{"type":"number","description":"Size of the data collection in bytes"},"schemas":{"type":"number","description":"Number of schemas in the data collection"},"tables":{"type":"number","description":"Number of tables in the data collection"},"columns":{"type":"number","description":"Number of columns in the data collection"},"rows":{"type":"number","description":"Number of rows in the data collection"},"bytes":{"type":"number","description":"Number of bytes in the data collection"},"nulls":{"type":"number","description":"Number of nulls in the data collection"},"blanks":{"type":"number","description":"Number of blanks in the data collection"},"zeros":{"type":"number","description":"Number of zeros in the data collection"},"cardinality":{"type":"number","description":"Cardinality of the data collection"},"minValue":{"type":"number","description":"Minimum value in the data collection"},"maxValue":{"type":"number","description":"Maximum value in the data collection"},"avgValue":{"type":"number","description":"Average value in the data collection"},"stdevValue":{"type":"number","description":"Standard deviation of values in the data collection"},"minLength":{"type":"number","description":"Minimum length in the data collection"},"maxLength":{"type":"number","description":"Maximum length in the data collection"},"avgLength":{"type":"number","description":"Average length in the data collection"},"stdevLength":{"type":"number","description":"Standard deviation of lengths in the data collection"}},"additionalProperties":true},"status":{"type":"object","description":"Status of the data collection","properties":{"aggregation":{"type":"string","description":"Aggregation status of the data collection"},"profile":{"type":"string","description":"Profile status of the data collection"}},"additionalProperties":false},"profile":{"type":"object","properties":{"patterns":{"type":"array","items":{"type":"object","properties":{"pattern":{"type":"string"},"counter":{"type":"number"},"sample":{"type":"string"}},"required":["pattern","counter","sample"],"additionalProperties":false}},"distinctCount":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"count":{"type":"number"}},"required":["value","count"],"additionalProperties":false}},"sampleValues":{"type":"array","items":{"type":"string"}},"sampleFiles":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"},"createdBy":{"type":"string","description":"Identifier of the user who created the data collection"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the data collection"}},"description":"Metadata and attributes of the collection."},"profilingInfo":{"type":"array","description":"Profiling statistics for the collection","items":{"type":"object","properties":{"entity":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"parentId":{"type":"string"},"rootId":{"type":"string"},"resourceId":{"type":"string"},"fqdn":{"type":"string"}}},"profile":{"type":"object","additionalProperties":true},"children":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}},"description":"Metadata, attributes, and profiling information of the collection."},"description":"Array of collections with their metadata, attributes, and profiling information."},"pageInfo":{"type":"object","properties":{"currentPage":{"type":"integer","description":"Current page number"},"perPage":{"type":"integer","description":"Number of items per page"},"totalCount":{"type":"integer","description":"Total number of items"},"pageCount":{"type":"integer","description":"Total number of pages"}},"required":["currentPage","perPage","totalCount","pageCount"],"description":"Pagination information"}},"required":["status","data","pageInfo"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"status":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array"},{"type":"object","additionalProperties":true}]}}}}}},"401":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","content":{"application/json":{"schema":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"503":{"description":"Service Unavailable — Connection Refused","content":{"application/json":{"schema":{"description":"Service Unavailable — Connection Refused","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}}}}}}}
```

## Share a data collection

> Shares a data collection with other users. Only the \`changes\` payload (add/update/remove) is supported. The valid types are "View", "View,Update", and "View,Update,Run".

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v2)","version":"v2"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v2/data-collections/{id}/share":{"post":{"summary":"Share a data collection","tags":["Data Collections"],"description":"Shares a data collection with other users. Only the `changes` payload (add/update/remove) is supported. The valid types are \"View\", \"View,Update\", and \"View,Update,Run\".","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["changes"],"properties":{"changes":{"type":"object","additionalProperties":false,"properties":{"add":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"required":["id","accessType"],"properties":{"id":{"type":"string","format":"uuid"},"accessType":{"type":"string","enum":["View","View,Update","View,Update,Run"],"description":"Access type with valid values: \"View\", \"View,Update\", and \"View,Update,Run\"."}}}},"update":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"required":["id","accessType"],"properties":{"id":{"type":"string","format":"uuid"},"accessType":{"type":"string","enum":["View","View,Update","View,Update,Run"],"description":"Access type with valid values: \"View\", \"View,Update\", and \"View,Update,Run\"."}}}},"remove":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"string","format":"uuid"}}}}}}}}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"Data Collection ID to share"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"data":{"type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier for the data collection"},"_index":{"type":"string","description":"Index name (e.g., OpenSearch index)"},"name":{"type":"string","description":"Name of the data collection"},"originalName":{"type":"string","description":"Original name of the data collection"},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"fqdn":{"type":"string","description":"Fully qualified domain name"},"fqdnDisplay":{"type":"string","description":"Display of the fully qualified domain name"},"parentId":{"type":"string","format":"uuid","description":"Parent collection UUID"},"rootId":{"type":"string","format":"uuid","description":"Root collection UUID"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"definition":{"type":"string","description":"Definition of the data collection"},"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"abbreviation":{"type":"string","description":"Abbreviation for the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner of the data collection"},"custodian":{"type":"string","description":"Custodian of the data collection"},"businessSteward":{"type":"string","description":"Business steward of the data collection"},"status":{"type":"string","description":"Status of the data collection"}},"additionalProperties":false},"features":{"type":"object","description":"Feature attributes of the data collection","properties":{"sensitivity":{"type":"string","description":"Sensitivity of the data collection"},"rating":{"type":"object","description":"Rating information","properties":{"value":{"type":"number","description":"Rating value"},"users":{"type":"object","description":"Users who rated the collection","additionalProperties":true}},"additionalProperties":false},"qualityScore":{"type":"number","description":"Quality score of the data collection"},"trustScore":{"type":"number","description":"Trust score of the data collection"},"isCriticalDataElement":{"type":"boolean","description":"Indicates if this is a critical data element"},"isLineageVerified":{"type":"boolean","description":"Indicates if lineage is verified"}},"additionalProperties":false},"customProperties":{"type":"array","description":"Custom properties for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Custom property ID"},"value":{"type":"string","description":"Custom property value"}},"additionalProperties":false}},"tags":{"type":"array","description":"Tags associated with the data collection","items":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"type":{"type":"string","description":"Tag type"}},"additionalProperties":false}},"businessTerms":{"type":"array","description":"Business terms associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business term ID"},"glossaryId":{"type":"string","description":"Glossary ID for the business term"},"name":{"type":"string","description":"Business term name"}},"additionalProperties":false}},"policies":{"type":"array","description":"Policies associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy ID"}},"additionalProperties":false}},"applications":{"type":"array","description":"Applications associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Application ID"}},"additionalProperties":false}},"physicalAssets":{"type":"array","description":"Physical assets associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Physical asset ID"}},"additionalProperties":false}},"objectAccess":{"type":"array","description":"Object access details for the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Object access ID"},"type":{"type":"string","description":"Object access type"},"accessType":{"type":"string","description":"Type of access"}},"additionalProperties":false}},"originalType":{"type":"string","enum":["category","group","collection","dataset","COLUMN"],"description":"Original type of the data collection"},"predecessorId":{"type":"string","description":"ID of the predecessor data collection, if any"},"isDuplicated":{"type":"boolean","description":"Indicates if the data collection is a duplicated or not"}}},"system":{"type":"object","description":"System attributes of the data collection","properties":{"aggregatedAt":{"type":"string","description":"Timestamp when the data collection was aggregated"},"profiledAt":{"type":"string","description":"Timestamp when the data collection was profiled"}},"additionalProperties":false},"metadata":{"type":"object","description":"Metadata attributes of the data collection","properties":{"column":{"type":"object","description":"Column metadata for the data collection","properties":{"ordinalPosition":{"type":"string","description":"Ordinal Position of the column in the data collection"},"dataType":{"type":"string","description":"Data type of the column in the data collection"},"sqlDataType":{"type":"string","description":"SQL data type of the column in the data collection"},"typeName":{"type":"string","description":"Type name of the column in the data collection"},"reference":{"type":"object","description":"Column metadata for the data collection","properties":{"sourceDataType":{"type":"string","description":"Source data type of the column reference"},"scopeCatalog":{"type":"string","description":"Catalog name of the column reference"},"scopeSchema":{"type":"string","description":"Schema name of the column reference"},"scopeTable":{"type":"boolean","description":"Table name of the column reference"}}},"isNullable":{"type":"boolean","description":"Indicates if the column is nullable"},"isAutoIncrement":{"type":"boolean","description":"Indicates if the column is auto-incremented"},"isGeneratedColumn":{"type":"boolean","description":"Indicates if the column is a generated column"},"isPrimaryKey":{"type":"boolean","description":"Indicates if the column is a primary key"},"isForeignKey":{"type":"boolean","description":"Indicates if the column is a foreign key"},"columnDefault":{"type":"boolean","description":"Indicates if the column has a default value"},"columnSize":{"type":"number","description":"Indicates the size of the column"},"bufferLength":{"type":"number","description":"Buffer length of the column"},"decimalDigits":{"type":"number","description":"Indicates the number of decimal digits in the column"},"numPrecRadix":{"type":"number","description":"Indicates the numeric precision radix of the column"},"charOctetLength":{"type":"number","description":"Indicates the character octet length of the column"},"sqlDateTimeSub":{"type":"number","description":"Indicates the SQL date time sub of the column"},"remarks":{"type":"string","description":"The remarks for the column"},"extended":{"type":"object","description":"Extended metadata for the column","additionalProperties":true}}},"stats":{"type":"object","description":"Statistics for the data collection","properties":{"rowCount":{"type":"number","description":"Number of rows in the data collection"},"sizeInBytes":{"type":"number","description":"Size of the data collection in bytes"},"schemas":{"type":"number","description":"Number of schemas in the data collection"},"tables":{"type":"number","description":"Number of tables in the data collection"},"columns":{"type":"number","description":"Number of columns in the data collection"},"rows":{"type":"number","description":"Number of rows in the data collection"},"bytes":{"type":"number","description":"Number of bytes in the data collection"},"nulls":{"type":"number","description":"Number of nulls in the data collection"},"blanks":{"type":"number","description":"Number of blanks in the data collection"},"zeros":{"type":"number","description":"Number of zeros in the data collection"},"cardinality":{"type":"number","description":"Cardinality of the data collection"},"minValue":{"type":"number","description":"Minimum value in the data collection"},"maxValue":{"type":"number","description":"Maximum value in the data collection"},"avgValue":{"type":"number","description":"Average value in the data collection"},"stdevValue":{"type":"number","description":"Standard deviation of values in the data collection"},"minLength":{"type":"number","description":"Minimum length in the data collection"},"maxLength":{"type":"number","description":"Maximum length in the data collection"},"avgLength":{"type":"number","description":"Average length in the data collection"},"stdevLength":{"type":"number","description":"Standard deviation of lengths in the data collection"}},"additionalProperties":true},"status":{"type":"object","description":"Status of the data collection","properties":{"aggregation":{"type":"string","description":"Aggregation status of the data collection"},"profile":{"type":"string","description":"Profile status of the data collection"}},"additionalProperties":false},"profile":{"type":"object","properties":{"patterns":{"type":"array","items":{"type":"object","properties":{"pattern":{"type":"string"},"counter":{"type":"number"},"sample":{"type":"string"}},"required":["pattern","counter","sample"],"additionalProperties":false}},"distinctCount":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"count":{"type":"number"}},"required":["value","count"],"additionalProperties":false}},"sampleValues":{"type":"array","items":{"type":"string"}},"sampleFiles":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp"},"createdBy":{"type":"string","description":"Identifier of the user who created the data collection"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the data collection"}},"description":"Updated data collection after sharing changes are applied"}},"required":["status","data"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Bad Request","type":"object","properties":{"status":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array"},{"type":"object","additionalProperties":true}]}}}}}},"401":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","content":{"application/json":{"schema":{"description":"Unauthorized - The request requires a valid Bearer token.\n\n    \tTo access this endpoint:\n\n        1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.\n        2. Click the \"Authorize\" button in the Swagger UI and enter the token.\n        3. All protected endpoints require the Authorization header: \"Authorization: 'Bearer your-access-token'\"\n    ","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Internal Server Error","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"503":{"description":"Service Unavailable — Connection Refused","content":{"application/json":{"schema":{"description":"Service Unavailable — Connection Refused","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.pentaho.com/pdc-api-docs/v2/pdc-api-ref-v2/data-collections.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.