> For the complete documentation index, see [llms.txt](https://docs.pentaho.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pentaho.com/pdc-api-docs/pdc-api-ref-v2/data-collections.md).

# 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 (v3)","version":"v3"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v3/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"},"parentId":{"type":"string","format":"uuid","description":"Parent collection UUID"},"type":{"type":"string","enum":["category","group","collection","dataset"],"description":"Type of the data collection"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"applications":{"type":"array","description":"IDs of application associated with the data collection","items":{"type":"string"}},"businessTerms":{"type":"array","description":"IDs of business terms associated with the data collection","items":{"type":"string"}},"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}},"features":{"type":"object","properties":{"isLineageVerified":{"type":["boolean","null"],"description":"Indicates if lineage is verified"},"qualityScore":{"type":["number","null"],"description":"Quality score value"},"sensitivity":{"type":["string","null"],"description":"Sensitivity value"}},"additionalProperties":false},"info":{"type":"object","description":"General information about the data collection","properties":{"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner of the data collection"},"status":{"type":"string","description":"Status of the data collection"}},"additionalProperties":false},"mlModels":{"type":"array","description":"IDs of ML Models associated with the data collection","items":{"type":"string"}},"businessIntelligence":{"type":"array","description":"IDs of business intelligence tools associated with the data collection","items":{"type":"string"}},"physicalAssets":{"type":"array","description":"IDs of physical assets associated with the data collection","items":{"type":"string"}},"policies":{"type":"array","description":"IDs of policies associated with the data collection","items":{"type":"string"}},"tags":{"type":"array","description":"Tags associated with the data collection","items":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"value":{"type":"string","description":"Tag value"}},"additionalProperties":false}},"thresholds":{"type":"object","description":"Threshold attributes of the data collection","properties":{"dataQuality":{"type":["number","null"],"description":"Custom threshold for quality of the data collection"},"trustScore":{"type":["number","null"],"description":"Custom threshold for trust score of the data collection"}},"additionalProperties":false}},"additionalProperties":false},"entities":{"type":"array","description":"IDs of entities to be added to the collection","items":{"type":"string","format":"uuid"}}},"required":["name","type"]},{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the data collection"},"parentId":{"type":"string","format":"uuid","description":"Parent collection UUID"},"type":{"type":"string","enum":["category","group","collection","dataset"],"description":"Type of the data collection"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"applications":{"type":"array","description":"IDs of application associated with the data collection","items":{"type":"string"}},"businessTerms":{"type":"array","description":"IDs of business terms associated with the data collection","items":{"type":"string"}},"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}},"features":{"type":"object","properties":{"isLineageVerified":{"type":["boolean","null"],"description":"Indicates if lineage is verified"},"qualityScore":{"type":["number","null"],"description":"Quality score value"},"sensitivity":{"type":["string","null"],"description":"Sensitivity value"}},"additionalProperties":false},"info":{"type":"object","description":"General information about the data collection","properties":{"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner of the data collection"},"status":{"type":"string","description":"Status of the data collection"}},"additionalProperties":false},"mlModels":{"type":"array","description":"IDs of ML Models associated with the data collection","items":{"type":"string"}},"businessIntelligence":{"type":"array","description":"IDs of business intelligence tools associated with the data collection","items":{"type":"string"}},"physicalAssets":{"type":"array","description":"IDs of physical assets associated with the data collection","items":{"type":"string"}},"policies":{"type":"array","description":"IDs of policies associated with the data collection","items":{"type":"string"}},"tags":{"type":"array","description":"Tags associated with the data collection","items":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"value":{"type":"string","description":"Tag value"}},"additionalProperties":false}},"thresholds":{"type":"object","description":"Threshold attributes of the data collection","properties":{"dataQuality":{"type":["number","null"],"description":"Custom threshold for quality of the data collection"},"trustScore":{"type":["number","null"],"description":"Custom threshold for trust score of the data collection"}},"additionalProperties":false}},"additionalProperties":false},"entities":{"type":"array","description":"IDs of entities to be added to the collection","items":{"type":"string","format":"uuid"}}},"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"},"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"},"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"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner 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":"object","description":"Sensitivity of the data collection","properties":{"value":{"type":["null","string"],"description":"Sensitivity value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"qualityScore":{"type":"object","description":"Quality score of the data collection","properties":{"value":{"type":["null","number"],"description":"Quality score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Trust score of the data collection","properties":{"value":{"type":["null","number"],"description":"Trust score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}}},"isLineageVerified":{"type":"object","description":"Lineage verification status of the data collection","properties":{"value":{"type":["null","boolean"],"description":"Indicates if lineage is verified"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"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}},"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"},"value":{"type":"string","description":"Tag value"}},"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}},"mlModels":{"type":"array","description":"ML Models associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"ML Model ID"},"name":{"type":"string","description":"ML Model name"}},"additionalProperties":false}},"businessIntelligence":{"type":"array","description":"Business intelligence tools associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business intelligence tool ID"}},"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"],"description":"Original type of the data collection"},"thresholds":{"type":"object","description":"Threshold attributes of the data collection","properties":{"dataQuality":{"type":"object","description":"Custom threshold for quality of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for data quality"},"updatedBy":{"type":"string","description":"User that updated custom threshold for data quality"},"updatedAt":{"type":"string","description":"Timestamp when data quality custom threshold was updated"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Custom threshold for trust score of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for trust score"},"updatedBy":{"type":"string","description":"User that updated custom threshold for trust score"},"updatedAt":{"type":"string","description":"Timestamp when trust score custom threshold was updated"}},"additionalProperties":false}},"additionalProperties":false},"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"}}},"metadata":{"type":"object","description":"Metadata of the data collection","additionalProperties":true},"system":{"type":"object","description":"System attributes of the data collection","properties":{"aggregatedAt":{"type":"string","description":"Timestamp when the data collection was aggregated"},"ingestedAt":{"type":"string","description":"Timestamp when the data collection was ingested"},"profiledAt":{"type":"string","description":"Timestamp when the data collection was profiled"}},"additionalProperties":false},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN","sqlView"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"definition":{"type":"string","description":"SQL statement that defines View in the collection"},"hasChildren":{"type":"boolean","description":"Indicates if collection has children"}},"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 (v3)","version":"v3"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v3/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"},"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"},"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"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner 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":"object","description":"Sensitivity of the data collection","properties":{"value":{"type":["null","string"],"description":"Sensitivity value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"qualityScore":{"type":"object","description":"Quality score of the data collection","properties":{"value":{"type":["null","number"],"description":"Quality score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Trust score of the data collection","properties":{"value":{"type":["null","number"],"description":"Trust score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}}},"isLineageVerified":{"type":"object","description":"Lineage verification status of the data collection","properties":{"value":{"type":["null","boolean"],"description":"Indicates if lineage is verified"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"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}},"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"},"value":{"type":"string","description":"Tag value"}},"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}},"mlModels":{"type":"array","description":"ML Models associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"ML Model ID"},"name":{"type":"string","description":"ML Model name"}},"additionalProperties":false}},"businessIntelligence":{"type":"array","description":"Business intelligence tools associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business intelligence tool ID"}},"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"],"description":"Original type of the data collection"},"thresholds":{"type":"object","description":"Threshold attributes of the data collection","properties":{"dataQuality":{"type":"object","description":"Custom threshold for quality of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for data quality"},"updatedBy":{"type":"string","description":"User that updated custom threshold for data quality"},"updatedAt":{"type":"string","description":"Timestamp when data quality custom threshold was updated"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Custom threshold for trust score of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for trust score"},"updatedBy":{"type":"string","description":"User that updated custom threshold for trust score"},"updatedAt":{"type":"string","description":"Timestamp when trust score custom threshold was updated"}},"additionalProperties":false}},"additionalProperties":false},"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"}}},"metadata":{"type":"object","description":"Metadata of the data collection","additionalProperties":true},"system":{"type":"object","description":"System attributes of the data collection","properties":{"aggregatedAt":{"type":"string","description":"Timestamp when the data collection was aggregated"},"ingestedAt":{"type":"string","description":"Timestamp when the data collection was ingested"},"profiledAt":{"type":"string","description":"Timestamp when the data collection was profiled"}},"additionalProperties":false},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN","sqlView"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"definition":{"type":"string","description":"SQL statement that defines View in the collection"},"hasChildren":{"type":"boolean","description":"Indicates if collection has children"}},"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 (v3)","version":"v3"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v3/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 attributes for an existing data collection by ID

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v3)","version":"v3"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v3/data-collections/{id}":{"patch":{"summary":"Update a Data Collection","tags":["Data Collections"],"description":"Updates 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"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"applications":{"type":"array","description":"IDs of application associated with the data collection","items":{"type":"string"}},"businessTerms":{"type":"array","description":"IDs of business terms associated with the data collection","items":{"type":"string"}},"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}},"features":{"type":"object","properties":{"isLineageVerified":{"type":["boolean","null"],"description":"Indicates if lineage is verified"},"qualityScore":{"type":["number","null"],"description":"Quality score value"},"sensitivity":{"type":["string","null"],"description":"Sensitivity value"}},"additionalProperties":false},"info":{"type":"object","description":"General information about the data collection","properties":{"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner of the data collection"},"status":{"type":"string","description":"Status of the data collection"}},"additionalProperties":false},"mlModels":{"type":"array","description":"IDs of ML Models associated with the data collection","items":{"type":"string"}},"businessIntelligence":{"type":"array","description":"IDs of business intelligence tools associated with the data collection","items":{"type":"string"}},"physicalAssets":{"type":"array","description":"IDs of physical assets associated with the data collection","items":{"type":"string"}},"policies":{"type":"array","description":"IDs of policies associated with the data collection","items":{"type":"string"}},"tags":{"type":"array","description":"Tags associated with the data collection","items":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"value":{"type":"string","description":"Tag value"}},"additionalProperties":false}},"thresholds":{"type":"object","description":"Threshold attributes of the data collection","properties":{"dataQuality":{"type":["number","null"],"description":"Custom threshold for quality of the data collection"},"trustScore":{"type":["number","null"],"description":"Custom threshold for trust score of the data collection"}},"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"},"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"},"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"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner 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":"object","description":"Sensitivity of the data collection","properties":{"value":{"type":["null","string"],"description":"Sensitivity value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"qualityScore":{"type":"object","description":"Quality score of the data collection","properties":{"value":{"type":["null","number"],"description":"Quality score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Trust score of the data collection","properties":{"value":{"type":["null","number"],"description":"Trust score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}}},"isLineageVerified":{"type":"object","description":"Lineage verification status of the data collection","properties":{"value":{"type":["null","boolean"],"description":"Indicates if lineage is verified"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"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}},"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"},"value":{"type":"string","description":"Tag value"}},"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}},"mlModels":{"type":"array","description":"ML Models associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"ML Model ID"},"name":{"type":"string","description":"ML Model name"}},"additionalProperties":false}},"businessIntelligence":{"type":"array","description":"Business intelligence tools associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business intelligence tool ID"}},"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"],"description":"Original type of the data collection"},"thresholds":{"type":"object","description":"Threshold attributes of the data collection","properties":{"dataQuality":{"type":"object","description":"Custom threshold for quality of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for data quality"},"updatedBy":{"type":"string","description":"User that updated custom threshold for data quality"},"updatedAt":{"type":"string","description":"Timestamp when data quality custom threshold was updated"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Custom threshold for trust score of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for trust score"},"updatedBy":{"type":"string","description":"User that updated custom threshold for trust score"},"updatedAt":{"type":"string","description":"Timestamp when trust score custom threshold was updated"}},"additionalProperties":false}},"additionalProperties":false},"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"}}},"metadata":{"type":"object","description":"Metadata of the data collection","additionalProperties":true},"system":{"type":"object","description":"System attributes of the data collection","properties":{"aggregatedAt":{"type":"string","description":"Timestamp when the data collection was aggregated"},"ingestedAt":{"type":"string","description":"Timestamp when the data collection was ingested"},"profiledAt":{"type":"string","description":"Timestamp when the data collection was profiled"}},"additionalProperties":false},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN","sqlView"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"definition":{"type":"string","description":"SQL statement that defines View in the collection"},"hasChildren":{"type":"boolean","description":"Indicates if collection has children"}}}},"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 (v3)","version":"v3"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v3/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"},"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"},"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"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner 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":"object","description":"Sensitivity of the data collection","properties":{"value":{"type":["null","string"],"description":"Sensitivity value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"qualityScore":{"type":"object","description":"Quality score of the data collection","properties":{"value":{"type":["null","number"],"description":"Quality score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Trust score of the data collection","properties":{"value":{"type":["null","number"],"description":"Trust score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}}},"isLineageVerified":{"type":"object","description":"Lineage verification status of the data collection","properties":{"value":{"type":["null","boolean"],"description":"Indicates if lineage is verified"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"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}},"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"},"value":{"type":"string","description":"Tag value"}},"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}},"mlModels":{"type":"array","description":"ML Models associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"ML Model ID"},"name":{"type":"string","description":"ML Model name"}},"additionalProperties":false}},"businessIntelligence":{"type":"array","description":"Business intelligence tools associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business intelligence tool ID"}},"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"],"description":"Original type of the data collection"},"thresholds":{"type":"object","description":"Threshold attributes of the data collection","properties":{"dataQuality":{"type":"object","description":"Custom threshold for quality of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for data quality"},"updatedBy":{"type":"string","description":"User that updated custom threshold for data quality"},"updatedAt":{"type":"string","description":"Timestamp when data quality custom threshold was updated"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Custom threshold for trust score of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for trust score"},"updatedBy":{"type":"string","description":"User that updated custom threshold for trust score"},"updatedAt":{"type":"string","description":"Timestamp when trust score custom threshold was updated"}},"additionalProperties":false}},"additionalProperties":false},"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"}}},"metadata":{"type":"object","description":"Metadata of the data collection","additionalProperties":true},"system":{"type":"object","description":"System attributes of the data collection","properties":{"aggregatedAt":{"type":"string","description":"Timestamp when the data collection was aggregated"},"ingestedAt":{"type":"string","description":"Timestamp when the data collection was ingested"},"profiledAt":{"type":"string","description":"Timestamp when the data collection was profiled"}},"additionalProperties":false},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN","sqlView"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"definition":{"type":"string","description":"SQL statement that defines View in the collection"},"hasChildren":{"type":"boolean","description":"Indicates if collection has children"}},"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 (v3)","version":"v3"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v3/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 (v3)","version":"v3"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v3/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 (v3)","version":"v3"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v3/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, sqlView"},"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"},"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"},"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"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner 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":"object","description":"Sensitivity of the data collection","properties":{"value":{"type":["null","string"],"description":"Sensitivity value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"qualityScore":{"type":"object","description":"Quality score of the data collection","properties":{"value":{"type":["null","number"],"description":"Quality score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Trust score of the data collection","properties":{"value":{"type":["null","number"],"description":"Trust score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}}},"isLineageVerified":{"type":"object","description":"Lineage verification status of the data collection","properties":{"value":{"type":["null","boolean"],"description":"Indicates if lineage is verified"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"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}},"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"},"value":{"type":"string","description":"Tag value"}},"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}},"mlModels":{"type":"array","description":"ML Models associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"ML Model ID"},"name":{"type":"string","description":"ML Model name"}},"additionalProperties":false}},"businessIntelligence":{"type":"array","description":"Business intelligence tools associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business intelligence tool ID"}},"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"],"description":"Original type of the data collection"},"thresholds":{"type":"object","description":"Threshold attributes of the data collection","properties":{"dataQuality":{"type":"object","description":"Custom threshold for quality of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for data quality"},"updatedBy":{"type":"string","description":"User that updated custom threshold for data quality"},"updatedAt":{"type":"string","description":"Timestamp when data quality custom threshold was updated"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Custom threshold for trust score of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for trust score"},"updatedBy":{"type":"string","description":"User that updated custom threshold for trust score"},"updatedAt":{"type":"string","description":"Timestamp when trust score custom threshold was updated"}},"additionalProperties":false}},"additionalProperties":false},"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"}}},"metadata":{"type":"object","description":"Metadata of the data collection","additionalProperties":true},"system":{"type":"object","description":"System attributes of the data collection","properties":{"aggregatedAt":{"type":"string","description":"Timestamp when the data collection was aggregated"},"ingestedAt":{"type":"string","description":"Timestamp when the data collection was ingested"},"profiledAt":{"type":"string","description":"Timestamp when the data collection was profiled"}},"additionalProperties":false},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN","sqlView"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"definition":{"type":"string","description":"SQL statement that defines View in the collection"},"hasChildren":{"type":"boolean","description":"Indicates if collection has children"}},"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 (v3)","version":"v3"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v3/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"},"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"},"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"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner 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":"object","description":"Sensitivity of the data collection","properties":{"value":{"type":["null","string"],"description":"Sensitivity value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"qualityScore":{"type":"object","description":"Quality score of the data collection","properties":{"value":{"type":["null","number"],"description":"Quality score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Trust score of the data collection","properties":{"value":{"type":["null","number"],"description":"Trust score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}}},"isLineageVerified":{"type":"object","description":"Lineage verification status of the data collection","properties":{"value":{"type":["null","boolean"],"description":"Indicates if lineage is verified"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"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}},"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"},"value":{"type":"string","description":"Tag value"}},"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}},"mlModels":{"type":"array","description":"ML Models associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"ML Model ID"},"name":{"type":"string","description":"ML Model name"}},"additionalProperties":false}},"businessIntelligence":{"type":"array","description":"Business intelligence tools associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business intelligence tool ID"}},"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"],"description":"Original type of the data collection"},"thresholds":{"type":"object","description":"Threshold attributes of the data collection","properties":{"dataQuality":{"type":"object","description":"Custom threshold for quality of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for data quality"},"updatedBy":{"type":"string","description":"User that updated custom threshold for data quality"},"updatedAt":{"type":"string","description":"Timestamp when data quality custom threshold was updated"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Custom threshold for trust score of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for trust score"},"updatedBy":{"type":"string","description":"User that updated custom threshold for trust score"},"updatedAt":{"type":"string","description":"Timestamp when trust score custom threshold was updated"}},"additionalProperties":false}},"additionalProperties":false},"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"}}},"metadata":{"type":"object","description":"Metadata of the data collection","additionalProperties":true},"system":{"type":"object","description":"System attributes of the data collection","properties":{"aggregatedAt":{"type":"string","description":"Timestamp when the data collection was aggregated"},"ingestedAt":{"type":"string","description":"Timestamp when the data collection was ingested"},"profiledAt":{"type":"string","description":"Timestamp when the data collection was profiled"}},"additionalProperties":false},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN","sqlView"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"definition":{"type":"string","description":"SQL statement that defines View in the collection"},"hasChildren":{"type":"boolean","description":"Indicates if collection has children"}},"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 (v3)","version":"v3"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v3/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"},"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"},"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"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner 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":"object","description":"Sensitivity of the data collection","properties":{"value":{"type":["null","string"],"description":"Sensitivity value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"qualityScore":{"type":"object","description":"Quality score of the data collection","properties":{"value":{"type":["null","number"],"description":"Quality score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Trust score of the data collection","properties":{"value":{"type":["null","number"],"description":"Trust score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}}},"isLineageVerified":{"type":"object","description":"Lineage verification status of the data collection","properties":{"value":{"type":["null","boolean"],"description":"Indicates if lineage is verified"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"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}},"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"},"value":{"type":"string","description":"Tag value"}},"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}},"mlModels":{"type":"array","description":"ML Models associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"ML Model ID"},"name":{"type":"string","description":"ML Model name"}},"additionalProperties":false}},"businessIntelligence":{"type":"array","description":"Business intelligence tools associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business intelligence tool ID"}},"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"],"description":"Original type of the data collection"},"thresholds":{"type":"object","description":"Threshold attributes of the data collection","properties":{"dataQuality":{"type":"object","description":"Custom threshold for quality of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for data quality"},"updatedBy":{"type":"string","description":"User that updated custom threshold for data quality"},"updatedAt":{"type":"string","description":"Timestamp when data quality custom threshold was updated"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Custom threshold for trust score of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for trust score"},"updatedBy":{"type":"string","description":"User that updated custom threshold for trust score"},"updatedAt":{"type":"string","description":"Timestamp when trust score custom threshold was updated"}},"additionalProperties":false}},"additionalProperties":false},"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"}}},"metadata":{"type":"object","description":"Metadata of the data collection","additionalProperties":true},"system":{"type":"object","description":"System attributes of the data collection","properties":{"aggregatedAt":{"type":"string","description":"Timestamp when the data collection was aggregated"},"ingestedAt":{"type":"string","description":"Timestamp when the data collection was ingested"},"profiledAt":{"type":"string","description":"Timestamp when the data collection was profiled"}},"additionalProperties":false},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN","sqlView"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"definition":{"type":"string","description":"SQL statement that defines View in the collection"},"hasChildren":{"type":"boolean","description":"Indicates if collection has children"}},"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 (v3)","version":"v3"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v3/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":["accessType"],"oneOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","format":"uuid"}}},{"type":"object","required":["username"],"properties":{"username":{"type":"string"}}}],"properties":{"id":{"type":"string","format":"uuid"},"username":{"type":"string"},"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":["accessType"],"oneOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","format":"uuid"}}},{"type":"object","required":["username"],"properties":{"username":{"type":"string"}}}],"properties":{"id":{"type":"string","format":"uuid"},"username":{"type":"string"},"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,"oneOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","format":"uuid"}}},{"type":"object","required":["username"],"properties":{"username":{"type":"string"}}}],"properties":{"id":{"type":"string","format":"uuid"},"username":{"type":"string"}}}}}}}}}},"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"},"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"},"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"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner 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":"object","description":"Sensitivity of the data collection","properties":{"value":{"type":["null","string"],"description":"Sensitivity value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"qualityScore":{"type":"object","description":"Quality score of the data collection","properties":{"value":{"type":["null","number"],"description":"Quality score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Trust score of the data collection","properties":{"value":{"type":["null","number"],"description":"Trust score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}}},"isLineageVerified":{"type":"object","description":"Lineage verification status of the data collection","properties":{"value":{"type":["null","boolean"],"description":"Indicates if lineage is verified"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"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}},"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"},"value":{"type":"string","description":"Tag value"}},"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}},"mlModels":{"type":"array","description":"ML Models associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"ML Model ID"},"name":{"type":"string","description":"ML Model name"}},"additionalProperties":false}},"businessIntelligence":{"type":"array","description":"Business intelligence tools associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business intelligence tool ID"}},"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"],"description":"Original type of the data collection"},"thresholds":{"type":"object","description":"Threshold attributes of the data collection","properties":{"dataQuality":{"type":"object","description":"Custom threshold for quality of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for data quality"},"updatedBy":{"type":"string","description":"User that updated custom threshold for data quality"},"updatedAt":{"type":"string","description":"Timestamp when data quality custom threshold was updated"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Custom threshold for trust score of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for trust score"},"updatedBy":{"type":"string","description":"User that updated custom threshold for trust score"},"updatedAt":{"type":"string","description":"Timestamp when trust score custom threshold was updated"}},"additionalProperties":false}},"additionalProperties":false},"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"}}},"metadata":{"type":"object","description":"Metadata of the data collection","additionalProperties":true},"system":{"type":"object","description":"System attributes of the data collection","properties":{"aggregatedAt":{"type":"string","description":"Timestamp when the data collection was aggregated"},"ingestedAt":{"type":"string","description":"Timestamp when the data collection was ingested"},"profiledAt":{"type":"string","description":"Timestamp when the data collection was profiled"}},"additionalProperties":false},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN","sqlView"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"definition":{"type":"string","description":"SQL statement that defines View in the collection"},"hasChildren":{"type":"boolean","description":"Indicates if collection has children"}},"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"}}}}}}}}}}}
```

## Publish a Data Collection

> Publishes a data collection by promoting it to a Data Product. The collection must be marketplace-ready before it can be published.

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v3)","version":"v3"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v3/data-collections/{id}/action/publish":{"post":{"summary":"Publish a Data Collection","tags":["Data Collections"],"description":"Publishes a data collection by promoting it to a Data Product. The collection must be marketplace-ready before it can be published.","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"},"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"},"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"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner 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":"object","description":"Sensitivity of the data collection","properties":{"value":{"type":["null","string"],"description":"Sensitivity value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"qualityScore":{"type":"object","description":"Quality score of the data collection","properties":{"value":{"type":["null","number"],"description":"Quality score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Trust score of the data collection","properties":{"value":{"type":["null","number"],"description":"Trust score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}}},"isLineageVerified":{"type":"object","description":"Lineage verification status of the data collection","properties":{"value":{"type":["null","boolean"],"description":"Indicates if lineage is verified"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"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}},"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"},"value":{"type":"string","description":"Tag value"}},"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}},"mlModels":{"type":"array","description":"ML Models associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"ML Model ID"},"name":{"type":"string","description":"ML Model name"}},"additionalProperties":false}},"businessIntelligence":{"type":"array","description":"Business intelligence tools associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business intelligence tool ID"}},"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"],"description":"Original type of the data collection"},"thresholds":{"type":"object","description":"Threshold attributes of the data collection","properties":{"dataQuality":{"type":"object","description":"Custom threshold for quality of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for data quality"},"updatedBy":{"type":"string","description":"User that updated custom threshold for data quality"},"updatedAt":{"type":"string","description":"Timestamp when data quality custom threshold was updated"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Custom threshold for trust score of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for trust score"},"updatedBy":{"type":"string","description":"User that updated custom threshold for trust score"},"updatedAt":{"type":"string","description":"Timestamp when trust score custom threshold was updated"}},"additionalProperties":false}},"additionalProperties":false},"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"}}},"metadata":{"type":"object","description":"Metadata of the data collection","additionalProperties":true},"system":{"type":"object","description":"System attributes of the data collection","properties":{"aggregatedAt":{"type":"string","description":"Timestamp when the data collection was aggregated"},"ingestedAt":{"type":"string","description":"Timestamp when the data collection was ingested"},"profiledAt":{"type":"string","description":"Timestamp when the data collection was profiled"}},"additionalProperties":false},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN","sqlView"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"definition":{"type":"string","description":"SQL statement that defines View in the collection"},"hasChildren":{"type":"boolean","description":"Indicates if collection has children"}},"description":"The updated data collection after the action"}},"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"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"description":"Forbidden","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"description":"Unprocessable Entity","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"}}}}}}}}}}}
```

## Unpublish a Data Collection

> Unpublishes a data collection by reverting it from a Data Product back to its original type. Only collections that are currently published as a Data Product can be unpublished.

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v3)","version":"v3"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v3/data-collections/{id}/action/unpublish":{"post":{"summary":"Unpublish a Data Collection","tags":["Data Collections"],"description":"Unpublishes a data collection by reverting it from a Data Product back to its original type. Only collections that are currently published as a Data Product can be unpublished.","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"},"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"},"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"},"attributes":{"type":"object","description":"Attributes of the data collection","properties":{"info":{"type":"object","description":"General information about the data collection","properties":{"description":{"type":"string","description":"Description of the data collection"},"purpose":{"type":"string","description":"Purpose of the data collection"},"domain":{"type":"string","description":"Domain of the data collection"},"owner":{"type":"string","description":"Owner 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":"object","description":"Sensitivity of the data collection","properties":{"value":{"type":["null","string"],"description":"Sensitivity value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"qualityScore":{"type":"object","description":"Quality score of the data collection","properties":{"value":{"type":["null","number"],"description":"Quality score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Trust score of the data collection","properties":{"value":{"type":["null","number"],"description":"Trust score value"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}}},"isLineageVerified":{"type":"object","description":"Lineage verification status of the data collection","properties":{"value":{"type":["null","boolean"],"description":"Indicates if lineage is verified"},"type":{"type":"string","enum":["CALCULATED","MANUAL"],"description":"Type of the metric whether calculated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the metric was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the metric"}},"additionalProperties":false},"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}},"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"},"value":{"type":"string","description":"Tag value"}},"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}},"mlModels":{"type":"array","description":"ML Models associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"ML Model ID"},"name":{"type":"string","description":"ML Model name"}},"additionalProperties":false}},"businessIntelligence":{"type":"array","description":"Business intelligence tools associated with the data collection","items":{"type":"object","properties":{"id":{"type":"string","description":"Business intelligence tool ID"}},"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"],"description":"Original type of the data collection"},"thresholds":{"type":"object","description":"Threshold attributes of the data collection","properties":{"dataQuality":{"type":"object","description":"Custom threshold for quality of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for data quality"},"updatedBy":{"type":"string","description":"User that updated custom threshold for data quality"},"updatedAt":{"type":"string","description":"Timestamp when data quality custom threshold was updated"}},"additionalProperties":false},"trustScore":{"type":"object","description":"Custom threshold for trust score of the data collection","properties":{"value":{"type":"number","description":"Custom threshold value for trust score"},"updatedBy":{"type":"string","description":"User that updated custom threshold for trust score"},"updatedAt":{"type":"string","description":"Timestamp when trust score custom threshold was updated"}},"additionalProperties":false}},"additionalProperties":false},"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"}}},"metadata":{"type":"object","description":"Metadata of the data collection","additionalProperties":true},"system":{"type":"object","description":"System attributes of the data collection","properties":{"aggregatedAt":{"type":"string","description":"Timestamp when the data collection was aggregated"},"ingestedAt":{"type":"string","description":"Timestamp when the data collection was ingested"},"profiledAt":{"type":"string","description":"Timestamp when the data collection was profiled"}},"additionalProperties":false},"type":{"type":"string","enum":["category","group","dataProduct","collection","dataset","COLUMN","sqlView"],"description":"Type of the data collection (e.g., COLLECTION, DATASET)"},"definition":{"type":"string","description":"SQL statement that defines View in the collection"},"hasChildren":{"type":"boolean","description":"Indicates if collection has children"}},"description":"The updated data collection after the action"}},"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"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"description":"Forbidden","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found","type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"description":"Unprocessable Entity","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 output

> Returns the collection output: data entities that are part of the collection

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v3)","version":"v3"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v3/data-collections/{id}/output":{"get":{"summary":"Get data collection output","tags":["Data Collections"],"description":"Returns the collection output: data entities that are part of the collection","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"Data Collection ID to retrieve output for"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"data":{"description":"Collection output. Includes the collection ID and its objects.","type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier of the collection"},"entities":{"type":"array","items":{"description":"Collection output entity","type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier for the entity"},"fqdn":{"type":"string","description":"Fully qualified domain name of the entity"},"name":{"type":"string","description":"Name of the entity"},"type":{"type":"string","description":"Type of the entity"},"rootId":{"type":"string","format":"uuid","description":"Root UUID of the entity"},"datasourceType":{"type":"string","description":"Type of the datasource"},"path":{"type":"string","description":"Path of the entity"}},"required":["_id","fqdn","name","type","datasourceType"],"additionalProperties":false}},"virtualEntities":{"type":"array","items":{"description":"Collection output virtual entity (for dataset columns)","type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier for the virtual entity"},"name":{"type":"string","description":"Name of the virtual entity"},"entities":{"type":"array","items":{"description":"Collection output entity","type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier for the entity"},"fqdn":{"type":"string","description":"Fully qualified domain name of the entity"},"name":{"type":"string","description":"Name of the entity"},"type":{"type":"string","description":"Type of the entity"},"rootId":{"type":"string","format":"uuid","description":"Root UUID of the entity"},"datasourceType":{"type":"string","description":"Type of the datasource"},"path":{"type":"string","description":"Path of the entity"}},"required":["_id","fqdn","name","type","datasourceType"],"additionalProperties":false}}},"required":["_id","name","entities"],"additionalProperties":false}},"sqlView":{"type":"string","description":"SQL query that defines the collection output"}},"required":["_id","entities"],"additionalProperties":false}},"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
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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/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.