> 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/v1/pdc-api-ref-v1/data-entities.md).

# Data Entities

## Get Entity by ID

> Returns metadata and system info for an entity by its ID

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v1)","version":"v1"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v1/entities/{id}":{"get":{"summary":"Get Entity by ID","tags":["Data Entities"],"description":"Returns metadata and system info for an entity by its ID","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"Entity 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 entity"},"_index":{"type":"string","description":"Index name (e.g., OpenSearch index)"},"name":{"type":"string","description":"Name of the entity"},"type":{"type":"string","description":"Type of the entity (e.g., RESOURCE)"},"createdAt":{"type":"string","format":"date-time","description":"Entity creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Entity last update timestamp"},"fqdn":{"type":"string","description":"Fully qualified domain name"},"fqdnDisplay":{"type":"string","description":"User-friendly display version of the FQDN"},"parentId":{"type":"string","format":"uuid","description":"Parent entity UUID"},"rootId":{"type":"string","format":"uuid","description":"Root entity UUID"},"resourceId":{"type":"string","description":"Resource identifier"},"resourceName":{"type":"string","description":"User-friendly name of the resource"},"system":{"type":"object","description":"System Info for the entity","properties":{"version":{"type":"string","description":"Version of the entity"},"scannedAt":{"type":"string","format":"date-time","description":"Timestamp when the entity was last scanned"},"profiledAt":{"type":"string","format":"date-time","description":"Timestamp when the entity was last profiled"},"session":{"type":"string","description":"Session identifier related to the entity"}},"additionalProperties":false},"metadata":{"type":"object","description":"Metadata details of the entity","properties":{"resource":{"type":"object","description":"Resource metadata information","properties":{"type":{"type":"string","description":"Type of the resource"},"url":{"type":"string","description":"URL of the resource"},"productName":{"type":"string","description":"Product name associated with the resource"},"productVersion":{"type":"string","description":"Product version associated with the resource"},"driverName":{"type":"string","description":"Driver name used for the resource"}},"additionalProperties":false},"dir":{"type":"object","description":"Directory metadata information","properties":{"childDirs":{"type":"integer","description":"Number of child directories"},"childFiles":{"type":"integer","description":"Number of child files"},"childDirSize":{"type":"integer","description":"Size of child directories"},"childFileSize":{"type":"integer","description":"Size of child files"},"totalChildDirs":{"type":"integer","description":"Total number of child directories"},"totalChildFiles":{"type":"integer","description":"Total number of child files"},"totalChildDirSize":{"type":"integer","description":"Total size of child directories"},"totalChildFileSize":{"type":"integer","description":"Total size of child files"},"extended":{"type":"object","description":"Extended directory metadata","additionalProperties":true}},"additionalProperties":false},"file":{"type":"object","description":"File metadata information","properties":{"path":{"type":"string","description":"File path"},"symLinkPath":{"type":"string","description":"Symbolic link path"},"bucket":{"type":"string","description":"Bucket name"},"extension":{"type":"string","description":"File extension"},"type":{"type":"string","description":"File type"},"flags":{"type":"integer","description":"File flags"},"owner":{"type":"string","description":"File owner"},"group":{"type":"string","description":"File group"},"createdAt":{"type":"string","format":"date-time","description":"File creation date"},"modifiedAt":{"type":"string","format":"date-time","description":"File modification date"},"accessedAt":{"type":"string","format":"date-time","description":"File last accessed date"},"firstKnownAccessedAt":{"type":"string","format":"date-time","description":"First known file access date"},"checksum":{"type":"string","description":"File checksum"},"extended":{"type":"object","description":"Extended file metadata","additionalProperties":true}},"additionalProperties":false},"catalog":{"type":"object","description":"Catalog metadata information","properties":{"extended":{"type":"object","description":"Extended catalog metadata","additionalProperties":true}},"additionalProperties":false},"schema":{"type":"object","description":"Schema metadata information","properties":{"extended":{"type":"object","description":"Extended schema metadata","additionalProperties":true}},"additionalProperties":false},"table":{"type":"object","description":"Table metadata information","properties":{"type":{"type":"string","description":"Table type"},"typeName":{"type":"string","description":"Table type name"},"kind":{"type":"string","description":"Table kind"},"schemaName":{"type":"string","description":"Schema name"},"schemaType":{"type":"string","description":"Schema type"},"catalogName":{"type":"string","description":"Catalog name"},"catalogType":{"type":"string","description":"Catalog type"},"databaseName":{"type":"string","description":"Database name"},"relationships":{"type":"array","description":"Table relationships","items":{"type":"object","properties":{"id":{"type":"string","description":"Relationship ID"},"fqdn":{"type":"string","description":"FQDN"},"name":{"type":"string","description":"Name"},"type":{"type":"string","description":"Type"},"primaryKeyId":{"type":"string","description":"Primary key ID"},"primaryKeyFqdn":{"type":"string","description":"Primary key FQDN"},"primaryKeyName":{"type":"string","description":"Primary key name"},"foreignKeyId":{"type":"string","description":"Foreign key ID"},"foreignKeyFqdn":{"type":"string","description":"Foreign key FQDN"},"foreignKeyName":{"type":"string","description":"Foreign key name"}},"additionalProperties":false}},"createdTime":{"type":"string","description":"Table creation time"},"lastDdlTime":{"type":"string","description":"Last DDL time"},"selfReferencingColName":{"type":"string","description":"Self-referencing column name"},"refGeneration":{"type":"string","description":"Reference generation"},"checkClause":{"type":"string","description":"Check clause"},"owner":{"type":"string","description":"Table owner"},"description":{"type":"string","description":"Table description"},"remarks":{"type":"string","description":"Table remarks"},"changeTracking":{"type":"string","description":"Change tracking"},"retentionTime":{"type":"string","description":"Retention time"},"searchOptimization":{"type":"string","description":"Search optimization"},"usage":{"type":"object","description":"Table usage information","properties":{"total":{"type":"object","description":"Total usage","properties":{"fetchedAt":{"type":"string","description":"Fetched at"},"readAt":{"type":"string","description":"Read at"},"writeAt":{"type":"string","description":"Write at"},"alterAt":{"type":"string","description":"Alter at"},"readCount":{"type":"integer","description":"Read count"},"writeCount":{"type":"integer","description":"Write count"},"alterCount":{"type":"integer","description":"Alter count"}},"additionalProperties":false},"users":{"type":"array","description":"Usage by users","items":{"type":"object","properties":{"name":{"type":"string","description":"User name"},"ok":{"type":"object","description":"Successful usage","properties":{"fetchedAt":{"type":"string","description":"Fetched at"},"readAt":{"type":"string","description":"Read at"},"writeAt":{"type":"string","description":"Write at"},"alterAt":{"type":"string","description":"Alter at"},"readCount":{"type":"integer","description":"Read count"},"writeCount":{"type":"integer","description":"Write count"},"alterCount":{"type":"integer","description":"Alter count"}},"additionalProperties":false},"failed":{"type":"object","description":"Failed usage","properties":{"fetchedAt":{"type":"string","description":"Fetched at"},"readAt":{"type":"string","description":"Read at"},"writeAt":{"type":"string","description":"Write at"},"alterAt":{"type":"string","description":"Alter at"},"readCount":{"type":"integer","description":"Read count"},"writeCount":{"type":"integer","description":"Write count"},"alterCount":{"type":"integer","description":"Alter count"}},"additionalProperties":false}},"additionalProperties":false}}},"additionalProperties":false},"extended":{"type":"object","description":"Extended table metadata","additionalProperties":true}},"additionalProperties":false},"column":{"type":"object","description":"Column metadata information","properties":{"ordinalPosition":{"type":"integer","description":"Ordinal position"},"dataType":{"type":"string","description":"Data type"},"sqlDataType":{"type":"string","description":"SQL data type"},"typeName":{"type":"string","description":"Type name"},"reference":{"type":"object","description":"Reference information","properties":{"sourceDataType":{"type":"string","description":"Source data type"},"scopeCatalog":{"type":"string","description":"Scope catalog"},"scopeSchema":{"type":"string","description":"Scope schema"},"scopeTable":{"type":"string","description":"Scope table"}},"additionalProperties":false},"isNullable":{"type":"boolean","description":"Is nullable"},"isAutoIncrement":{"type":"boolean","description":"Is auto increment"},"isGeneratedColumn":{"type":"boolean","description":"Is generated column"},"isPrimaryKey":{"type":"boolean","description":"Is primary key"},"isForeignKey":{"type":"boolean","description":"Is foreign key"},"columnDefault":{"type":"string","description":"Column default value"},"columnSize":{"type":"integer","description":"Column size"},"bufferLength":{"type":"integer","description":"Buffer length"},"decimalDigits":{"type":"integer","description":"Decimal digits"},"numPrecRadix":{"type":"integer","description":"Numeric precision radix"},"charOctetLength":{"type":"integer","description":"Character octet length"},"sqlDateTimeSub":{"type":"string","description":"SQL date time sub"},"remarks":{"type":"string","description":"Column remarks"},"extended":{"type":"object","description":"Extended column metadata","additionalProperties":true}},"additionalProperties":false},"document":{"type":"object","description":"Document metadata information","properties":{"title":{"type":"string","description":"Document title"},"author":{"type":"string","description":"Document author"},"subject":{"type":"string","description":"Document subject"},"language":{"type":"string","description":"Document language"},"keywords":{"type":"string","description":"Document keywords"},"application":{"type":"string","description":"Application used"},"producer":{"type":"string","description":"Document producer"},"company":{"type":"string","description":"Company"},"version":{"type":"string","description":"Document version"},"checksum":{"type":"string","description":"Document checksum"},"documentSize":{"type":"integer","description":"Document size"},"pageSize":{"type":"integer","description":"Page size"},"pages":{"type":"integer","description":"Number of pages"},"paragraphs":{"type":"integer","description":"Number of paragraphs"},"lines":{"type":"integer","description":"Number of lines"},"words":{"type":"integer","description":"Number of words"},"characters":{"type":"integer","description":"Number of characters"},"charactersWithSpaces":{"type":"integer","description":"Characters with spaces"},"extended":{"type":"object","description":"Extended document metadata","additionalProperties":true}},"additionalProperties":false},"stats":{"type":"object","description":"Statistics metadata information","properties":{"schemas":{"type":"integer","description":"Number of schemas"},"tables":{"type":"integer","description":"Number of tables"},"columns":{"type":"integer","description":"Number of columns"},"rows":{"type":"integer","description":"Number of rows"},"bytes":{"type":"integer","description":"Number of bytes"},"nulls":{"type":"integer","description":"Number of nulls"},"blanks":{"type":"integer","description":"Number of blanks"},"zeros":{"type":"integer","description":"Number of zeros"},"cardinality":{"type":"integer","description":"Cardinality"},"avgLength":{"type":"number","description":"Average length"},"minLength":{"type":"integer","description":"Minimum length"},"maxLength":{"type":"integer","description":"Maximum length"},"stdevLength":{"type":"number","description":"Standard deviation of length"},"avgValue":{"type":"number","description":"Average value"},"minValue":{"type":"number","description":"Minimum value"},"maxValue":{"type":"number","description":"Maximum value"},"stdevValue":{"type":"number","description":"Standard deviation of value"},"density":{"type":"number","description":"Density"},"selectivity":{"type":"number","description":"Selectivity"},"uniqueness":{"type":"number","description":"Uniqueness"},"lexicalMin":{"type":"string","description":"Lexical minimum"},"lexicalMax":{"type":"string","description":"Lexical maximum"}},"additionalProperties":false},"status":{"type":"object","description":"Status metadata information","properties":{"filterFlags":{"type":"integer","description":"Filter flags"},"scan":{"type":"string","description":"Scan status"},"checksum":{"type":"string","description":"Checksum"},"docMetadata":{"type":"string","description":"Document metadata"},"profile":{"type":"string","description":"Profile"},"contentScan":{"type":"string","description":"Content scan"}},"additionalProperties":false}},"additionalProperties":false},"attributes":{"type":"object","description":"Attributes of the entity","properties":{"info":{"type":"object","description":"General information about the entity","properties":{"description":{"type":"string","description":"Description of the entity"}},"additionalProperties":false},"features":{"type":"object","description":"Feature flags and scores for the entity","properties":{"sensitivity":{"type":"string","description":"Sensitivity classification of the entity"},"rating":{"type":"object","description":"Rating information for the entity","properties":{"value":{"type":"number","description":"Rating value"},"users":{"type":"object","description":"Users who rated the entity","additionalProperties":true}},"additionalProperties":false},"qualityScore":{"type":"number","description":"Quality score of the entity"},"trustScore":{"type":"object","description":"Trust score of the entity","properties":{"value":{"type":"number","description":"Trust score value"},"type":{"type":"string","description":"Type of trust score whether automated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the trust score was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the trust score"}}},"isCriticalDataElement":{"type":"boolean","description":"Indicates if this is a critical data element"},"isLineageVerified":{"type":"boolean","description":"Indicates if lineage is verified"}},"additionalProperties":false},"customProperties":{"type":"array","description":"Custom properties for the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Custom property identifier"},"value":{"type":"string","description":"Custom property value"}},"additionalProperties":false}},"tags":{"type":"array","description":"Tags associated with the entity","items":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"type":{"type":"string","description":"Tag type"},"value":{"type":"string","description":"Tag value"},"sourceName":{"type":"string","description":"Source name for the tag"},"targetName":{"type":"string","description":"Target name for the tag"},"confidenceScore":{"type":"number","description":"Confidence score for the tag"}},"additionalProperties":false}},"businessTerms":{"type":"array","description":"Business terms associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Business term identifier"},"glossaryId":{"type":"string","description":"Glossary identifier"},"name":{"type":"string","description":"Business term name"},"sourceName":{"type":"string","description":"Source name for the business term"},"sourceType":{"type":"string","description":"Source type for the business term"},"confidenceScore":{"type":"number","description":"Confidence score for the business term"}},"additionalProperties":false}},"owners":{"type":"array","description":"Owners of the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Owner identifier"},"name":{"type":"string","description":"Owner name"}},"additionalProperties":false}},"policies":{"type":"array","description":"Policies associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy identifier"}},"additionalProperties":false}},"mlModels":{"type":"array","description":"Machine learning models associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"ML model identifier"}},"additionalProperties":false}},"applications":{"type":"array","description":"Applications associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Application identifier"}},"additionalProperties":false}},"physicalAssets":{"type":"array","description":"Physical assets associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Physical asset identifier"}},"additionalProperties":false}},"contentScanDiscoveries":{"type":"array","description":"Content scan discoveries for the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Discovery identifier"},"type":{"type":"string","description":"Discovery type"},"value":{"type":"string","description":"Discovery value"},"count":{"type":"integer","description":"Discovery count"},"locations":{"type":"string","description":"Discovery locations"}},"additionalProperties":false}},"dataCollections":{"type":"array","description":"Data collections associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Data collection identifier"}},"additionalProperties":false}},"extended":{"type":"object","description":"Extended attributes for the entity","additionalProperties":true}},"additionalProperties":false}},"description":"Entity Properties with metadata , attributes & system info"}},"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 Entity Attributes

> Update attributes of an entity.\
>    \
> \
> 🚨 \*\*Note:\*\*\
>          \
>  \- Array-type fields (e.g. \`tags\`) will fully replace existing values if provided.\
>          \
>  \- Scalar fields (e.g. \`sensitivity\`, \`description\`) will overwrite the current value.\
>          \
>  \- Object-type fields (e.g. \`info\`) will overwrite only the keys provided, keeping other keys unchanged.\
>   \
> \
>  Only the specified fields will be affected — other attributes remain untouched.

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v1)","version":"v1"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v1/entities/{id}":{"patch":{"summary":"Update Entity Attributes","tags":["Data Entities"],"description":"Update attributes of an entity.\n   \n\n🚨 **Note:**\n         \n - Array-type fields (e.g. `tags`) will fully replace existing values if provided.\n         \n - Scalar fields (e.g. `sensitivity`, `description`) will overwrite the current value.\n         \n - Object-type fields (e.g. `info`) will overwrite only the keys provided, keeping other keys unchanged.\n  \n\n Only the specified fields will be affected — other attributes remain untouched.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"object","description":"Attributes of the entity","properties":{"info":{"type":"object","description":"General information about the entity","properties":{"description":{"type":"string","description":"Description of the entity"}},"additionalProperties":false},"features":{"type":"object","description":"Feature flags and scores for the entity","properties":{"sensitivity":{"type":"string","description":"Sensitivity classification of the entity"},"rating":{"type":"object","description":"Rating information for the entity","properties":{"value":{"type":"number","description":"Rating value"},"users":{"type":"object","description":"Users who rated the entity","additionalProperties":true}},"additionalProperties":false},"qualityScore":{"type":"number","description":"Quality score of the entity"},"trustScore":{"type":"object","description":"Trust score of the entity","properties":{"value":{"type":"number","description":"Trust score value"},"type":{"type":"string","description":"Type of trust score whether automated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the trust score was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the trust score"}}},"isCriticalDataElement":{"type":"boolean","description":"Indicates if this is a critical data element"},"isLineageVerified":{"type":"boolean","description":"Indicates if lineage is verified"}},"additionalProperties":false},"customProperties":{"type":"array","description":"Custom properties for the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Custom property identifier"},"value":{"type":"string","description":"Custom property value"}},"additionalProperties":false}},"tags":{"type":"array","description":"Tags associated with the entity","items":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"type":{"type":"string","description":"Tag type"},"value":{"type":"string","description":"Tag value"},"sourceName":{"type":"string","description":"Source name for the tag"},"targetName":{"type":"string","description":"Target name for the tag"},"confidenceScore":{"type":"number","description":"Confidence score for the tag"}},"additionalProperties":false}},"businessTerms":{"type":"array","description":"Business terms associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Business term identifier"},"glossaryId":{"type":"string","description":"Glossary identifier"},"name":{"type":"string","description":"Business term name"},"sourceName":{"type":"string","description":"Source name for the business term"},"sourceType":{"type":"string","description":"Source type for the business term"},"confidenceScore":{"type":"number","description":"Confidence score for the business term"}},"additionalProperties":false}},"owners":{"type":"array","description":"Owners of the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Owner identifier"},"name":{"type":"string","description":"Owner name"}},"additionalProperties":false}},"policies":{"type":"array","description":"Policies associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy identifier"}},"additionalProperties":false}},"mlModels":{"type":"array","description":"Machine learning models associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"ML model identifier"}},"additionalProperties":false}},"applications":{"type":"array","description":"Applications associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Application identifier"}},"additionalProperties":false}},"physicalAssets":{"type":"array","description":"Physical assets associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Physical asset identifier"}},"additionalProperties":false}},"contentScanDiscoveries":{"type":"array","description":"Content scan discoveries for the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Discovery identifier"},"type":{"type":"string","description":"Discovery type"},"value":{"type":"string","description":"Discovery value"},"count":{"type":"integer","description":"Discovery count"},"locations":{"type":"string","description":"Discovery locations"}},"additionalProperties":false}},"dataCollections":{"type":"array","description":"Data collections associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Data collection identifier"}},"additionalProperties":false}},"extended":{"type":"object","description":"Extended attributes for the entity","additionalProperties":true}},"additionalProperties":false}},"required":["attributes"]}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"Entity 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 entity"},"_index":{"type":"string","description":"Index name (e.g., OpenSearch index)"},"name":{"type":"string","description":"Name of the entity"},"type":{"type":"string","description":"Type of the entity (e.g., RESOURCE)"},"createdAt":{"type":"string","format":"date-time","description":"Entity creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Entity last update timestamp"},"fqdn":{"type":"string","description":"Fully qualified domain name"},"fqdnDisplay":{"type":"string","description":"User-friendly display version of the FQDN"},"parentId":{"type":"string","format":"uuid","description":"Parent entity UUID"},"rootId":{"type":"string","format":"uuid","description":"Root entity UUID"},"resourceId":{"type":"string","description":"Resource identifier"},"resourceName":{"type":"string","description":"User-friendly name of the resource"},"system":{"type":"object","description":"System Info for the entity","properties":{"version":{"type":"string","description":"Version of the entity"},"scannedAt":{"type":"string","format":"date-time","description":"Timestamp when the entity was last scanned"},"profiledAt":{"type":"string","format":"date-time","description":"Timestamp when the entity was last profiled"},"session":{"type":"string","description":"Session identifier related to the entity"}},"additionalProperties":false},"metadata":{"type":"object","description":"Metadata details of the entity","properties":{"resource":{"type":"object","description":"Resource metadata information","properties":{"type":{"type":"string","description":"Type of the resource"},"url":{"type":"string","description":"URL of the resource"},"productName":{"type":"string","description":"Product name associated with the resource"},"productVersion":{"type":"string","description":"Product version associated with the resource"},"driverName":{"type":"string","description":"Driver name used for the resource"}},"additionalProperties":false},"dir":{"type":"object","description":"Directory metadata information","properties":{"childDirs":{"type":"integer","description":"Number of child directories"},"childFiles":{"type":"integer","description":"Number of child files"},"childDirSize":{"type":"integer","description":"Size of child directories"},"childFileSize":{"type":"integer","description":"Size of child files"},"totalChildDirs":{"type":"integer","description":"Total number of child directories"},"totalChildFiles":{"type":"integer","description":"Total number of child files"},"totalChildDirSize":{"type":"integer","description":"Total size of child directories"},"totalChildFileSize":{"type":"integer","description":"Total size of child files"},"extended":{"type":"object","description":"Extended directory metadata","additionalProperties":true}},"additionalProperties":false},"file":{"type":"object","description":"File metadata information","properties":{"path":{"type":"string","description":"File path"},"symLinkPath":{"type":"string","description":"Symbolic link path"},"bucket":{"type":"string","description":"Bucket name"},"extension":{"type":"string","description":"File extension"},"type":{"type":"string","description":"File type"},"flags":{"type":"integer","description":"File flags"},"owner":{"type":"string","description":"File owner"},"group":{"type":"string","description":"File group"},"createdAt":{"type":"string","format":"date-time","description":"File creation date"},"modifiedAt":{"type":"string","format":"date-time","description":"File modification date"},"accessedAt":{"type":"string","format":"date-time","description":"File last accessed date"},"firstKnownAccessedAt":{"type":"string","format":"date-time","description":"First known file access date"},"checksum":{"type":"string","description":"File checksum"},"extended":{"type":"object","description":"Extended file metadata","additionalProperties":true}},"additionalProperties":false},"catalog":{"type":"object","description":"Catalog metadata information","properties":{"extended":{"type":"object","description":"Extended catalog metadata","additionalProperties":true}},"additionalProperties":false},"schema":{"type":"object","description":"Schema metadata information","properties":{"extended":{"type":"object","description":"Extended schema metadata","additionalProperties":true}},"additionalProperties":false},"table":{"type":"object","description":"Table metadata information","properties":{"type":{"type":"string","description":"Table type"},"typeName":{"type":"string","description":"Table type name"},"kind":{"type":"string","description":"Table kind"},"schemaName":{"type":"string","description":"Schema name"},"schemaType":{"type":"string","description":"Schema type"},"catalogName":{"type":"string","description":"Catalog name"},"catalogType":{"type":"string","description":"Catalog type"},"databaseName":{"type":"string","description":"Database name"},"relationships":{"type":"array","description":"Table relationships","items":{"type":"object","properties":{"id":{"type":"string","description":"Relationship ID"},"fqdn":{"type":"string","description":"FQDN"},"name":{"type":"string","description":"Name"},"type":{"type":"string","description":"Type"},"primaryKeyId":{"type":"string","description":"Primary key ID"},"primaryKeyFqdn":{"type":"string","description":"Primary key FQDN"},"primaryKeyName":{"type":"string","description":"Primary key name"},"foreignKeyId":{"type":"string","description":"Foreign key ID"},"foreignKeyFqdn":{"type":"string","description":"Foreign key FQDN"},"foreignKeyName":{"type":"string","description":"Foreign key name"}},"additionalProperties":false}},"createdTime":{"type":"string","description":"Table creation time"},"lastDdlTime":{"type":"string","description":"Last DDL time"},"selfReferencingColName":{"type":"string","description":"Self-referencing column name"},"refGeneration":{"type":"string","description":"Reference generation"},"checkClause":{"type":"string","description":"Check clause"},"owner":{"type":"string","description":"Table owner"},"description":{"type":"string","description":"Table description"},"remarks":{"type":"string","description":"Table remarks"},"changeTracking":{"type":"string","description":"Change tracking"},"retentionTime":{"type":"string","description":"Retention time"},"searchOptimization":{"type":"string","description":"Search optimization"},"usage":{"type":"object","description":"Table usage information","properties":{"total":{"type":"object","description":"Total usage","properties":{"fetchedAt":{"type":"string","description":"Fetched at"},"readAt":{"type":"string","description":"Read at"},"writeAt":{"type":"string","description":"Write at"},"alterAt":{"type":"string","description":"Alter at"},"readCount":{"type":"integer","description":"Read count"},"writeCount":{"type":"integer","description":"Write count"},"alterCount":{"type":"integer","description":"Alter count"}},"additionalProperties":false},"users":{"type":"array","description":"Usage by users","items":{"type":"object","properties":{"name":{"type":"string","description":"User name"},"ok":{"type":"object","description":"Successful usage","properties":{"fetchedAt":{"type":"string","description":"Fetched at"},"readAt":{"type":"string","description":"Read at"},"writeAt":{"type":"string","description":"Write at"},"alterAt":{"type":"string","description":"Alter at"},"readCount":{"type":"integer","description":"Read count"},"writeCount":{"type":"integer","description":"Write count"},"alterCount":{"type":"integer","description":"Alter count"}},"additionalProperties":false},"failed":{"type":"object","description":"Failed usage","properties":{"fetchedAt":{"type":"string","description":"Fetched at"},"readAt":{"type":"string","description":"Read at"},"writeAt":{"type":"string","description":"Write at"},"alterAt":{"type":"string","description":"Alter at"},"readCount":{"type":"integer","description":"Read count"},"writeCount":{"type":"integer","description":"Write count"},"alterCount":{"type":"integer","description":"Alter count"}},"additionalProperties":false}},"additionalProperties":false}}},"additionalProperties":false},"extended":{"type":"object","description":"Extended table metadata","additionalProperties":true}},"additionalProperties":false},"column":{"type":"object","description":"Column metadata information","properties":{"ordinalPosition":{"type":"integer","description":"Ordinal position"},"dataType":{"type":"string","description":"Data type"},"sqlDataType":{"type":"string","description":"SQL data type"},"typeName":{"type":"string","description":"Type name"},"reference":{"type":"object","description":"Reference information","properties":{"sourceDataType":{"type":"string","description":"Source data type"},"scopeCatalog":{"type":"string","description":"Scope catalog"},"scopeSchema":{"type":"string","description":"Scope schema"},"scopeTable":{"type":"string","description":"Scope table"}},"additionalProperties":false},"isNullable":{"type":"boolean","description":"Is nullable"},"isAutoIncrement":{"type":"boolean","description":"Is auto increment"},"isGeneratedColumn":{"type":"boolean","description":"Is generated column"},"isPrimaryKey":{"type":"boolean","description":"Is primary key"},"isForeignKey":{"type":"boolean","description":"Is foreign key"},"columnDefault":{"type":"string","description":"Column default value"},"columnSize":{"type":"integer","description":"Column size"},"bufferLength":{"type":"integer","description":"Buffer length"},"decimalDigits":{"type":"integer","description":"Decimal digits"},"numPrecRadix":{"type":"integer","description":"Numeric precision radix"},"charOctetLength":{"type":"integer","description":"Character octet length"},"sqlDateTimeSub":{"type":"string","description":"SQL date time sub"},"remarks":{"type":"string","description":"Column remarks"},"extended":{"type":"object","description":"Extended column metadata","additionalProperties":true}},"additionalProperties":false},"document":{"type":"object","description":"Document metadata information","properties":{"title":{"type":"string","description":"Document title"},"author":{"type":"string","description":"Document author"},"subject":{"type":"string","description":"Document subject"},"language":{"type":"string","description":"Document language"},"keywords":{"type":"string","description":"Document keywords"},"application":{"type":"string","description":"Application used"},"producer":{"type":"string","description":"Document producer"},"company":{"type":"string","description":"Company"},"version":{"type":"string","description":"Document version"},"checksum":{"type":"string","description":"Document checksum"},"documentSize":{"type":"integer","description":"Document size"},"pageSize":{"type":"integer","description":"Page size"},"pages":{"type":"integer","description":"Number of pages"},"paragraphs":{"type":"integer","description":"Number of paragraphs"},"lines":{"type":"integer","description":"Number of lines"},"words":{"type":"integer","description":"Number of words"},"characters":{"type":"integer","description":"Number of characters"},"charactersWithSpaces":{"type":"integer","description":"Characters with spaces"},"extended":{"type":"object","description":"Extended document metadata","additionalProperties":true}},"additionalProperties":false},"stats":{"type":"object","description":"Statistics metadata information","properties":{"schemas":{"type":"integer","description":"Number of schemas"},"tables":{"type":"integer","description":"Number of tables"},"columns":{"type":"integer","description":"Number of columns"},"rows":{"type":"integer","description":"Number of rows"},"bytes":{"type":"integer","description":"Number of bytes"},"nulls":{"type":"integer","description":"Number of nulls"},"blanks":{"type":"integer","description":"Number of blanks"},"zeros":{"type":"integer","description":"Number of zeros"},"cardinality":{"type":"integer","description":"Cardinality"},"avgLength":{"type":"number","description":"Average length"},"minLength":{"type":"integer","description":"Minimum length"},"maxLength":{"type":"integer","description":"Maximum length"},"stdevLength":{"type":"number","description":"Standard deviation of length"},"avgValue":{"type":"number","description":"Average value"},"minValue":{"type":"number","description":"Minimum value"},"maxValue":{"type":"number","description":"Maximum value"},"stdevValue":{"type":"number","description":"Standard deviation of value"},"density":{"type":"number","description":"Density"},"selectivity":{"type":"number","description":"Selectivity"},"uniqueness":{"type":"number","description":"Uniqueness"},"lexicalMin":{"type":"string","description":"Lexical minimum"},"lexicalMax":{"type":"string","description":"Lexical maximum"}},"additionalProperties":false},"status":{"type":"object","description":"Status metadata information","properties":{"filterFlags":{"type":"integer","description":"Filter flags"},"scan":{"type":"string","description":"Scan status"},"checksum":{"type":"string","description":"Checksum"},"docMetadata":{"type":"string","description":"Document metadata"},"profile":{"type":"string","description":"Profile"},"contentScan":{"type":"string","description":"Content scan"}},"additionalProperties":false}},"additionalProperties":false},"attributes":{"type":"object","description":"Attributes of the entity","properties":{"info":{"type":"object","description":"General information about the entity","properties":{"description":{"type":"string","description":"Description of the entity"}},"additionalProperties":false},"features":{"type":"object","description":"Feature flags and scores for the entity","properties":{"sensitivity":{"type":"string","description":"Sensitivity classification of the entity"},"rating":{"type":"object","description":"Rating information for the entity","properties":{"value":{"type":"number","description":"Rating value"},"users":{"type":"object","description":"Users who rated the entity","additionalProperties":true}},"additionalProperties":false},"qualityScore":{"type":"number","description":"Quality score of the entity"},"trustScore":{"type":"object","description":"Trust score of the entity","properties":{"value":{"type":"number","description":"Trust score value"},"type":{"type":"string","description":"Type of trust score whether automated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the trust score was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the trust score"}}},"isCriticalDataElement":{"type":"boolean","description":"Indicates if this is a critical data element"},"isLineageVerified":{"type":"boolean","description":"Indicates if lineage is verified"}},"additionalProperties":false},"customProperties":{"type":"array","description":"Custom properties for the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Custom property identifier"},"value":{"type":"string","description":"Custom property value"}},"additionalProperties":false}},"tags":{"type":"array","description":"Tags associated with the entity","items":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"type":{"type":"string","description":"Tag type"},"value":{"type":"string","description":"Tag value"},"sourceName":{"type":"string","description":"Source name for the tag"},"targetName":{"type":"string","description":"Target name for the tag"},"confidenceScore":{"type":"number","description":"Confidence score for the tag"}},"additionalProperties":false}},"businessTerms":{"type":"array","description":"Business terms associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Business term identifier"},"glossaryId":{"type":"string","description":"Glossary identifier"},"name":{"type":"string","description":"Business term name"},"sourceName":{"type":"string","description":"Source name for the business term"},"sourceType":{"type":"string","description":"Source type for the business term"},"confidenceScore":{"type":"number","description":"Confidence score for the business term"}},"additionalProperties":false}},"owners":{"type":"array","description":"Owners of the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Owner identifier"},"name":{"type":"string","description":"Owner name"}},"additionalProperties":false}},"policies":{"type":"array","description":"Policies associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy identifier"}},"additionalProperties":false}},"mlModels":{"type":"array","description":"Machine learning models associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"ML model identifier"}},"additionalProperties":false}},"applications":{"type":"array","description":"Applications associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Application identifier"}},"additionalProperties":false}},"physicalAssets":{"type":"array","description":"Physical assets associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Physical asset identifier"}},"additionalProperties":false}},"contentScanDiscoveries":{"type":"array","description":"Content scan discoveries for the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Discovery identifier"},"type":{"type":"string","description":"Discovery type"},"value":{"type":"string","description":"Discovery value"},"count":{"type":"integer","description":"Discovery count"},"locations":{"type":"string","description":"Discovery locations"}},"additionalProperties":false}},"dataCollections":{"type":"array","description":"Data collections associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Data collection identifier"}},"additionalProperties":false}},"extended":{"type":"object","description":"Extended attributes for the entity","additionalProperties":true}},"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"}}}}}}}}}}}
```

## Get Entities by IDs

> Returns array of metadata and system info for entities by their IDs\
>                 \
> \
> 🚨 \*\*Note:\*\* Results are limited to 10,000 items.

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v1)","version":"v1"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v1/entities/by-ids":{"post":{"summary":"Get Entities by IDs","tags":["Data Entities"],"description":"Returns array of metadata and system info for entities 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":"Entity ID"},"description":"Array of entity 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 entity"},"_index":{"type":"string","description":"Index name (e.g., OpenSearch index)"},"name":{"type":"string","description":"Name of the entity"},"type":{"type":"string","description":"Type of the entity (e.g., RESOURCE)"},"createdAt":{"type":"string","format":"date-time","description":"Entity creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Entity last update timestamp"},"fqdn":{"type":"string","description":"Fully qualified domain name"},"fqdnDisplay":{"type":"string","description":"User-friendly display version of the FQDN"},"parentId":{"type":"string","format":"uuid","description":"Parent entity UUID"},"rootId":{"type":"string","format":"uuid","description":"Root entity UUID"},"resourceId":{"type":"string","description":"Resource identifier"},"resourceName":{"type":"string","description":"User-friendly name of the resource"},"system":{"type":"object","description":"System Info for the entity","properties":{"version":{"type":"string","description":"Version of the entity"},"scannedAt":{"type":"string","format":"date-time","description":"Timestamp when the entity was last scanned"},"profiledAt":{"type":"string","format":"date-time","description":"Timestamp when the entity was last profiled"},"session":{"type":"string","description":"Session identifier related to the entity"}},"additionalProperties":false},"metadata":{"type":"object","description":"Metadata details of the entity","properties":{"resource":{"type":"object","description":"Resource metadata information","properties":{"type":{"type":"string","description":"Type of the resource"},"url":{"type":"string","description":"URL of the resource"},"productName":{"type":"string","description":"Product name associated with the resource"},"productVersion":{"type":"string","description":"Product version associated with the resource"},"driverName":{"type":"string","description":"Driver name used for the resource"}},"additionalProperties":false},"dir":{"type":"object","description":"Directory metadata information","properties":{"childDirs":{"type":"integer","description":"Number of child directories"},"childFiles":{"type":"integer","description":"Number of child files"},"childDirSize":{"type":"integer","description":"Size of child directories"},"childFileSize":{"type":"integer","description":"Size of child files"},"totalChildDirs":{"type":"integer","description":"Total number of child directories"},"totalChildFiles":{"type":"integer","description":"Total number of child files"},"totalChildDirSize":{"type":"integer","description":"Total size of child directories"},"totalChildFileSize":{"type":"integer","description":"Total size of child files"},"extended":{"type":"object","description":"Extended directory metadata","additionalProperties":true}},"additionalProperties":false},"file":{"type":"object","description":"File metadata information","properties":{"path":{"type":"string","description":"File path"},"symLinkPath":{"type":"string","description":"Symbolic link path"},"bucket":{"type":"string","description":"Bucket name"},"extension":{"type":"string","description":"File extension"},"type":{"type":"string","description":"File type"},"flags":{"type":"integer","description":"File flags"},"owner":{"type":"string","description":"File owner"},"group":{"type":"string","description":"File group"},"createdAt":{"type":"string","format":"date-time","description":"File creation date"},"modifiedAt":{"type":"string","format":"date-time","description":"File modification date"},"accessedAt":{"type":"string","format":"date-time","description":"File last accessed date"},"firstKnownAccessedAt":{"type":"string","format":"date-time","description":"First known file access date"},"checksum":{"type":"string","description":"File checksum"},"extended":{"type":"object","description":"Extended file metadata","additionalProperties":true}},"additionalProperties":false},"catalog":{"type":"object","description":"Catalog metadata information","properties":{"extended":{"type":"object","description":"Extended catalog metadata","additionalProperties":true}},"additionalProperties":false},"schema":{"type":"object","description":"Schema metadata information","properties":{"extended":{"type":"object","description":"Extended schema metadata","additionalProperties":true}},"additionalProperties":false},"table":{"type":"object","description":"Table metadata information","properties":{"type":{"type":"string","description":"Table type"},"typeName":{"type":"string","description":"Table type name"},"kind":{"type":"string","description":"Table kind"},"schemaName":{"type":"string","description":"Schema name"},"schemaType":{"type":"string","description":"Schema type"},"catalogName":{"type":"string","description":"Catalog name"},"catalogType":{"type":"string","description":"Catalog type"},"databaseName":{"type":"string","description":"Database name"},"relationships":{"type":"array","description":"Table relationships","items":{"type":"object","properties":{"id":{"type":"string","description":"Relationship ID"},"fqdn":{"type":"string","description":"FQDN"},"name":{"type":"string","description":"Name"},"type":{"type":"string","description":"Type"},"primaryKeyId":{"type":"string","description":"Primary key ID"},"primaryKeyFqdn":{"type":"string","description":"Primary key FQDN"},"primaryKeyName":{"type":"string","description":"Primary key name"},"foreignKeyId":{"type":"string","description":"Foreign key ID"},"foreignKeyFqdn":{"type":"string","description":"Foreign key FQDN"},"foreignKeyName":{"type":"string","description":"Foreign key name"}},"additionalProperties":false}},"createdTime":{"type":"string","description":"Table creation time"},"lastDdlTime":{"type":"string","description":"Last DDL time"},"selfReferencingColName":{"type":"string","description":"Self-referencing column name"},"refGeneration":{"type":"string","description":"Reference generation"},"checkClause":{"type":"string","description":"Check clause"},"owner":{"type":"string","description":"Table owner"},"description":{"type":"string","description":"Table description"},"remarks":{"type":"string","description":"Table remarks"},"changeTracking":{"type":"string","description":"Change tracking"},"retentionTime":{"type":"string","description":"Retention time"},"searchOptimization":{"type":"string","description":"Search optimization"},"usage":{"type":"object","description":"Table usage information","properties":{"total":{"type":"object","description":"Total usage","properties":{"fetchedAt":{"type":"string","description":"Fetched at"},"readAt":{"type":"string","description":"Read at"},"writeAt":{"type":"string","description":"Write at"},"alterAt":{"type":"string","description":"Alter at"},"readCount":{"type":"integer","description":"Read count"},"writeCount":{"type":"integer","description":"Write count"},"alterCount":{"type":"integer","description":"Alter count"}},"additionalProperties":false},"users":{"type":"array","description":"Usage by users","items":{"type":"object","properties":{"name":{"type":"string","description":"User name"},"ok":{"type":"object","description":"Successful usage","properties":{"fetchedAt":{"type":"string","description":"Fetched at"},"readAt":{"type":"string","description":"Read at"},"writeAt":{"type":"string","description":"Write at"},"alterAt":{"type":"string","description":"Alter at"},"readCount":{"type":"integer","description":"Read count"},"writeCount":{"type":"integer","description":"Write count"},"alterCount":{"type":"integer","description":"Alter count"}},"additionalProperties":false},"failed":{"type":"object","description":"Failed usage","properties":{"fetchedAt":{"type":"string","description":"Fetched at"},"readAt":{"type":"string","description":"Read at"},"writeAt":{"type":"string","description":"Write at"},"alterAt":{"type":"string","description":"Alter at"},"readCount":{"type":"integer","description":"Read count"},"writeCount":{"type":"integer","description":"Write count"},"alterCount":{"type":"integer","description":"Alter count"}},"additionalProperties":false}},"additionalProperties":false}}},"additionalProperties":false},"extended":{"type":"object","description":"Extended table metadata","additionalProperties":true}},"additionalProperties":false},"column":{"type":"object","description":"Column metadata information","properties":{"ordinalPosition":{"type":"integer","description":"Ordinal position"},"dataType":{"type":"string","description":"Data type"},"sqlDataType":{"type":"string","description":"SQL data type"},"typeName":{"type":"string","description":"Type name"},"reference":{"type":"object","description":"Reference information","properties":{"sourceDataType":{"type":"string","description":"Source data type"},"scopeCatalog":{"type":"string","description":"Scope catalog"},"scopeSchema":{"type":"string","description":"Scope schema"},"scopeTable":{"type":"string","description":"Scope table"}},"additionalProperties":false},"isNullable":{"type":"boolean","description":"Is nullable"},"isAutoIncrement":{"type":"boolean","description":"Is auto increment"},"isGeneratedColumn":{"type":"boolean","description":"Is generated column"},"isPrimaryKey":{"type":"boolean","description":"Is primary key"},"isForeignKey":{"type":"boolean","description":"Is foreign key"},"columnDefault":{"type":"string","description":"Column default value"},"columnSize":{"type":"integer","description":"Column size"},"bufferLength":{"type":"integer","description":"Buffer length"},"decimalDigits":{"type":"integer","description":"Decimal digits"},"numPrecRadix":{"type":"integer","description":"Numeric precision radix"},"charOctetLength":{"type":"integer","description":"Character octet length"},"sqlDateTimeSub":{"type":"string","description":"SQL date time sub"},"remarks":{"type":"string","description":"Column remarks"},"extended":{"type":"object","description":"Extended column metadata","additionalProperties":true}},"additionalProperties":false},"document":{"type":"object","description":"Document metadata information","properties":{"title":{"type":"string","description":"Document title"},"author":{"type":"string","description":"Document author"},"subject":{"type":"string","description":"Document subject"},"language":{"type":"string","description":"Document language"},"keywords":{"type":"string","description":"Document keywords"},"application":{"type":"string","description":"Application used"},"producer":{"type":"string","description":"Document producer"},"company":{"type":"string","description":"Company"},"version":{"type":"string","description":"Document version"},"checksum":{"type":"string","description":"Document checksum"},"documentSize":{"type":"integer","description":"Document size"},"pageSize":{"type":"integer","description":"Page size"},"pages":{"type":"integer","description":"Number of pages"},"paragraphs":{"type":"integer","description":"Number of paragraphs"},"lines":{"type":"integer","description":"Number of lines"},"words":{"type":"integer","description":"Number of words"},"characters":{"type":"integer","description":"Number of characters"},"charactersWithSpaces":{"type":"integer","description":"Characters with spaces"},"extended":{"type":"object","description":"Extended document metadata","additionalProperties":true}},"additionalProperties":false},"stats":{"type":"object","description":"Statistics metadata information","properties":{"schemas":{"type":"integer","description":"Number of schemas"},"tables":{"type":"integer","description":"Number of tables"},"columns":{"type":"integer","description":"Number of columns"},"rows":{"type":"integer","description":"Number of rows"},"bytes":{"type":"integer","description":"Number of bytes"},"nulls":{"type":"integer","description":"Number of nulls"},"blanks":{"type":"integer","description":"Number of blanks"},"zeros":{"type":"integer","description":"Number of zeros"},"cardinality":{"type":"integer","description":"Cardinality"},"avgLength":{"type":"number","description":"Average length"},"minLength":{"type":"integer","description":"Minimum length"},"maxLength":{"type":"integer","description":"Maximum length"},"stdevLength":{"type":"number","description":"Standard deviation of length"},"avgValue":{"type":"number","description":"Average value"},"minValue":{"type":"number","description":"Minimum value"},"maxValue":{"type":"number","description":"Maximum value"},"stdevValue":{"type":"number","description":"Standard deviation of value"},"density":{"type":"number","description":"Density"},"selectivity":{"type":"number","description":"Selectivity"},"uniqueness":{"type":"number","description":"Uniqueness"},"lexicalMin":{"type":"string","description":"Lexical minimum"},"lexicalMax":{"type":"string","description":"Lexical maximum"}},"additionalProperties":false},"status":{"type":"object","description":"Status metadata information","properties":{"filterFlags":{"type":"integer","description":"Filter flags"},"scan":{"type":"string","description":"Scan status"},"checksum":{"type":"string","description":"Checksum"},"docMetadata":{"type":"string","description":"Document metadata"},"profile":{"type":"string","description":"Profile"},"contentScan":{"type":"string","description":"Content scan"}},"additionalProperties":false}},"additionalProperties":false},"attributes":{"type":"object","description":"Attributes of the entity","properties":{"info":{"type":"object","description":"General information about the entity","properties":{"description":{"type":"string","description":"Description of the entity"}},"additionalProperties":false},"features":{"type":"object","description":"Feature flags and scores for the entity","properties":{"sensitivity":{"type":"string","description":"Sensitivity classification of the entity"},"rating":{"type":"object","description":"Rating information for the entity","properties":{"value":{"type":"number","description":"Rating value"},"users":{"type":"object","description":"Users who rated the entity","additionalProperties":true}},"additionalProperties":false},"qualityScore":{"type":"number","description":"Quality score of the entity"},"trustScore":{"type":"object","description":"Trust score of the entity","properties":{"value":{"type":"number","description":"Trust score value"},"type":{"type":"string","description":"Type of trust score whether automated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the trust score was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the trust score"}}},"isCriticalDataElement":{"type":"boolean","description":"Indicates if this is a critical data element"},"isLineageVerified":{"type":"boolean","description":"Indicates if lineage is verified"}},"additionalProperties":false},"customProperties":{"type":"array","description":"Custom properties for the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Custom property identifier"},"value":{"type":"string","description":"Custom property value"}},"additionalProperties":false}},"tags":{"type":"array","description":"Tags associated with the entity","items":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"type":{"type":"string","description":"Tag type"},"value":{"type":"string","description":"Tag value"},"sourceName":{"type":"string","description":"Source name for the tag"},"targetName":{"type":"string","description":"Target name for the tag"},"confidenceScore":{"type":"number","description":"Confidence score for the tag"}},"additionalProperties":false}},"businessTerms":{"type":"array","description":"Business terms associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Business term identifier"},"glossaryId":{"type":"string","description":"Glossary identifier"},"name":{"type":"string","description":"Business term name"},"sourceName":{"type":"string","description":"Source name for the business term"},"sourceType":{"type":"string","description":"Source type for the business term"},"confidenceScore":{"type":"number","description":"Confidence score for the business term"}},"additionalProperties":false}},"owners":{"type":"array","description":"Owners of the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Owner identifier"},"name":{"type":"string","description":"Owner name"}},"additionalProperties":false}},"policies":{"type":"array","description":"Policies associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy identifier"}},"additionalProperties":false}},"mlModels":{"type":"array","description":"Machine learning models associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"ML model identifier"}},"additionalProperties":false}},"applications":{"type":"array","description":"Applications associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Application identifier"}},"additionalProperties":false}},"physicalAssets":{"type":"array","description":"Physical assets associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Physical asset identifier"}},"additionalProperties":false}},"contentScanDiscoveries":{"type":"array","description":"Content scan discoveries for the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Discovery identifier"},"type":{"type":"string","description":"Discovery type"},"value":{"type":"string","description":"Discovery value"},"count":{"type":"integer","description":"Discovery count"},"locations":{"type":"string","description":"Discovery locations"}},"additionalProperties":false}},"dataCollections":{"type":"array","description":"Data collections associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Data collection identifier"}},"additionalProperties":false}},"extended":{"type":"object","description":"Extended attributes for the entity","additionalProperties":true}},"additionalProperties":false}},"description":"Entity Properties with metadata , attributes & system info"},"description":"Array of entities with metadata, attributes & system info"}},"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 Entities

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

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v1)","version":"v1"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v1/entities/filter":{"post":{"summary":"Filter Entities","tags":["Data Entities"],"description":"Returns array of entities filtered by criteria with pagination support\n               \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 entity ID"},"description":"Filter by array of parent entity IDs"},"rootIds":{"type":"array","items":{"type":"string","description":"Root entity ID"},"description":"Filter by array of root entity IDs"},"types":{"type":"array","items":{"type":"string","description":"Entity type"},"description":"Filter by array of entity types"},"collectionIds":{"type":"array","items":{"type":"string","description":"Collection ID"},"description":"Filter by array of collection IDs"},"resourceIds":{"type":"array","items":{"type":"string","description":"Resource ID"},"description":"Filter by array of resource IDs"},"names":{"type":"array","items":{"type":"string","description":"Entity name"},"description":"Filter by array of entity names"},"fqdns":{"type":"array","items":{"type":"string","description":"Fully qualified domain name"},"description":"Filter by array of fully qualified domain names"},"buckets":{"type":"array","items":{"type":"string","description":"Bucket"},"description":"Filter by array of buckets"},"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 entities"},"page":{"type":"integer","minimum":1,"default":1,"description":"Page number for pagination (starts from 1)"},"perPage":{"type":"integer","minimum":1,"maximum":10000,"default":100,"description":"Number of items per page (max 1000)"}},"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 entity"},"_index":{"type":"string","description":"Index name (e.g., OpenSearch index)"},"name":{"type":"string","description":"Name of the entity"},"type":{"type":"string","description":"Type of the entity (e.g., RESOURCE)"},"createdAt":{"type":"string","format":"date-time","description":"Entity creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Entity last update timestamp"},"fqdn":{"type":"string","description":"Fully qualified domain name"},"fqdnDisplay":{"type":"string","description":"User-friendly display version of the FQDN"},"parentId":{"type":"string","format":"uuid","description":"Parent entity UUID"},"rootId":{"type":"string","format":"uuid","description":"Root entity UUID"},"resourceId":{"type":"string","description":"Resource identifier"},"resourceName":{"type":"string","description":"User-friendly name of the resource"},"system":{"type":"object","description":"System Info for the entity","properties":{"version":{"type":"string","description":"Version of the entity"},"scannedAt":{"type":"string","format":"date-time","description":"Timestamp when the entity was last scanned"},"profiledAt":{"type":"string","format":"date-time","description":"Timestamp when the entity was last profiled"},"session":{"type":"string","description":"Session identifier related to the entity"}},"additionalProperties":false},"metadata":{"type":"object","description":"Metadata details of the entity","properties":{"resource":{"type":"object","description":"Resource metadata information","properties":{"type":{"type":"string","description":"Type of the resource"},"url":{"type":"string","description":"URL of the resource"},"productName":{"type":"string","description":"Product name associated with the resource"},"productVersion":{"type":"string","description":"Product version associated with the resource"},"driverName":{"type":"string","description":"Driver name used for the resource"}},"additionalProperties":false},"dir":{"type":"object","description":"Directory metadata information","properties":{"childDirs":{"type":"integer","description":"Number of child directories"},"childFiles":{"type":"integer","description":"Number of child files"},"childDirSize":{"type":"integer","description":"Size of child directories"},"childFileSize":{"type":"integer","description":"Size of child files"},"totalChildDirs":{"type":"integer","description":"Total number of child directories"},"totalChildFiles":{"type":"integer","description":"Total number of child files"},"totalChildDirSize":{"type":"integer","description":"Total size of child directories"},"totalChildFileSize":{"type":"integer","description":"Total size of child files"},"extended":{"type":"object","description":"Extended directory metadata","additionalProperties":true}},"additionalProperties":false},"file":{"type":"object","description":"File metadata information","properties":{"path":{"type":"string","description":"File path"},"symLinkPath":{"type":"string","description":"Symbolic link path"},"bucket":{"type":"string","description":"Bucket name"},"extension":{"type":"string","description":"File extension"},"type":{"type":"string","description":"File type"},"flags":{"type":"integer","description":"File flags"},"owner":{"type":"string","description":"File owner"},"group":{"type":"string","description":"File group"},"createdAt":{"type":"string","format":"date-time","description":"File creation date"},"modifiedAt":{"type":"string","format":"date-time","description":"File modification date"},"accessedAt":{"type":"string","format":"date-time","description":"File last accessed date"},"firstKnownAccessedAt":{"type":"string","format":"date-time","description":"First known file access date"},"checksum":{"type":"string","description":"File checksum"},"extended":{"type":"object","description":"Extended file metadata","additionalProperties":true}},"additionalProperties":false},"catalog":{"type":"object","description":"Catalog metadata information","properties":{"extended":{"type":"object","description":"Extended catalog metadata","additionalProperties":true}},"additionalProperties":false},"schema":{"type":"object","description":"Schema metadata information","properties":{"extended":{"type":"object","description":"Extended schema metadata","additionalProperties":true}},"additionalProperties":false},"table":{"type":"object","description":"Table metadata information","properties":{"type":{"type":"string","description":"Table type"},"typeName":{"type":"string","description":"Table type name"},"kind":{"type":"string","description":"Table kind"},"schemaName":{"type":"string","description":"Schema name"},"schemaType":{"type":"string","description":"Schema type"},"catalogName":{"type":"string","description":"Catalog name"},"catalogType":{"type":"string","description":"Catalog type"},"databaseName":{"type":"string","description":"Database name"},"relationships":{"type":"array","description":"Table relationships","items":{"type":"object","properties":{"id":{"type":"string","description":"Relationship ID"},"fqdn":{"type":"string","description":"FQDN"},"name":{"type":"string","description":"Name"},"type":{"type":"string","description":"Type"},"primaryKeyId":{"type":"string","description":"Primary key ID"},"primaryKeyFqdn":{"type":"string","description":"Primary key FQDN"},"primaryKeyName":{"type":"string","description":"Primary key name"},"foreignKeyId":{"type":"string","description":"Foreign key ID"},"foreignKeyFqdn":{"type":"string","description":"Foreign key FQDN"},"foreignKeyName":{"type":"string","description":"Foreign key name"}},"additionalProperties":false}},"createdTime":{"type":"string","description":"Table creation time"},"lastDdlTime":{"type":"string","description":"Last DDL time"},"selfReferencingColName":{"type":"string","description":"Self-referencing column name"},"refGeneration":{"type":"string","description":"Reference generation"},"checkClause":{"type":"string","description":"Check clause"},"owner":{"type":"string","description":"Table owner"},"description":{"type":"string","description":"Table description"},"remarks":{"type":"string","description":"Table remarks"},"changeTracking":{"type":"string","description":"Change tracking"},"retentionTime":{"type":"string","description":"Retention time"},"searchOptimization":{"type":"string","description":"Search optimization"},"usage":{"type":"object","description":"Table usage information","properties":{"total":{"type":"object","description":"Total usage","properties":{"fetchedAt":{"type":"string","description":"Fetched at"},"readAt":{"type":"string","description":"Read at"},"writeAt":{"type":"string","description":"Write at"},"alterAt":{"type":"string","description":"Alter at"},"readCount":{"type":"integer","description":"Read count"},"writeCount":{"type":"integer","description":"Write count"},"alterCount":{"type":"integer","description":"Alter count"}},"additionalProperties":false},"users":{"type":"array","description":"Usage by users","items":{"type":"object","properties":{"name":{"type":"string","description":"User name"},"ok":{"type":"object","description":"Successful usage","properties":{"fetchedAt":{"type":"string","description":"Fetched at"},"readAt":{"type":"string","description":"Read at"},"writeAt":{"type":"string","description":"Write at"},"alterAt":{"type":"string","description":"Alter at"},"readCount":{"type":"integer","description":"Read count"},"writeCount":{"type":"integer","description":"Write count"},"alterCount":{"type":"integer","description":"Alter count"}},"additionalProperties":false},"failed":{"type":"object","description":"Failed usage","properties":{"fetchedAt":{"type":"string","description":"Fetched at"},"readAt":{"type":"string","description":"Read at"},"writeAt":{"type":"string","description":"Write at"},"alterAt":{"type":"string","description":"Alter at"},"readCount":{"type":"integer","description":"Read count"},"writeCount":{"type":"integer","description":"Write count"},"alterCount":{"type":"integer","description":"Alter count"}},"additionalProperties":false}},"additionalProperties":false}}},"additionalProperties":false},"extended":{"type":"object","description":"Extended table metadata","additionalProperties":true}},"additionalProperties":false},"column":{"type":"object","description":"Column metadata information","properties":{"ordinalPosition":{"type":"integer","description":"Ordinal position"},"dataType":{"type":"string","description":"Data type"},"sqlDataType":{"type":"string","description":"SQL data type"},"typeName":{"type":"string","description":"Type name"},"reference":{"type":"object","description":"Reference information","properties":{"sourceDataType":{"type":"string","description":"Source data type"},"scopeCatalog":{"type":"string","description":"Scope catalog"},"scopeSchema":{"type":"string","description":"Scope schema"},"scopeTable":{"type":"string","description":"Scope table"}},"additionalProperties":false},"isNullable":{"type":"boolean","description":"Is nullable"},"isAutoIncrement":{"type":"boolean","description":"Is auto increment"},"isGeneratedColumn":{"type":"boolean","description":"Is generated column"},"isPrimaryKey":{"type":"boolean","description":"Is primary key"},"isForeignKey":{"type":"boolean","description":"Is foreign key"},"columnDefault":{"type":"string","description":"Column default value"},"columnSize":{"type":"integer","description":"Column size"},"bufferLength":{"type":"integer","description":"Buffer length"},"decimalDigits":{"type":"integer","description":"Decimal digits"},"numPrecRadix":{"type":"integer","description":"Numeric precision radix"},"charOctetLength":{"type":"integer","description":"Character octet length"},"sqlDateTimeSub":{"type":"string","description":"SQL date time sub"},"remarks":{"type":"string","description":"Column remarks"},"extended":{"type":"object","description":"Extended column metadata","additionalProperties":true}},"additionalProperties":false},"document":{"type":"object","description":"Document metadata information","properties":{"title":{"type":"string","description":"Document title"},"author":{"type":"string","description":"Document author"},"subject":{"type":"string","description":"Document subject"},"language":{"type":"string","description":"Document language"},"keywords":{"type":"string","description":"Document keywords"},"application":{"type":"string","description":"Application used"},"producer":{"type":"string","description":"Document producer"},"company":{"type":"string","description":"Company"},"version":{"type":"string","description":"Document version"},"checksum":{"type":"string","description":"Document checksum"},"documentSize":{"type":"integer","description":"Document size"},"pageSize":{"type":"integer","description":"Page size"},"pages":{"type":"integer","description":"Number of pages"},"paragraphs":{"type":"integer","description":"Number of paragraphs"},"lines":{"type":"integer","description":"Number of lines"},"words":{"type":"integer","description":"Number of words"},"characters":{"type":"integer","description":"Number of characters"},"charactersWithSpaces":{"type":"integer","description":"Characters with spaces"},"extended":{"type":"object","description":"Extended document metadata","additionalProperties":true}},"additionalProperties":false},"stats":{"type":"object","description":"Statistics metadata information","properties":{"schemas":{"type":"integer","description":"Number of schemas"},"tables":{"type":"integer","description":"Number of tables"},"columns":{"type":"integer","description":"Number of columns"},"rows":{"type":"integer","description":"Number of rows"},"bytes":{"type":"integer","description":"Number of bytes"},"nulls":{"type":"integer","description":"Number of nulls"},"blanks":{"type":"integer","description":"Number of blanks"},"zeros":{"type":"integer","description":"Number of zeros"},"cardinality":{"type":"integer","description":"Cardinality"},"avgLength":{"type":"number","description":"Average length"},"minLength":{"type":"integer","description":"Minimum length"},"maxLength":{"type":"integer","description":"Maximum length"},"stdevLength":{"type":"number","description":"Standard deviation of length"},"avgValue":{"type":"number","description":"Average value"},"minValue":{"type":"number","description":"Minimum value"},"maxValue":{"type":"number","description":"Maximum value"},"stdevValue":{"type":"number","description":"Standard deviation of value"},"density":{"type":"number","description":"Density"},"selectivity":{"type":"number","description":"Selectivity"},"uniqueness":{"type":"number","description":"Uniqueness"},"lexicalMin":{"type":"string","description":"Lexical minimum"},"lexicalMax":{"type":"string","description":"Lexical maximum"}},"additionalProperties":false},"status":{"type":"object","description":"Status metadata information","properties":{"filterFlags":{"type":"integer","description":"Filter flags"},"scan":{"type":"string","description":"Scan status"},"checksum":{"type":"string","description":"Checksum"},"docMetadata":{"type":"string","description":"Document metadata"},"profile":{"type":"string","description":"Profile"},"contentScan":{"type":"string","description":"Content scan"}},"additionalProperties":false}},"additionalProperties":false},"attributes":{"type":"object","description":"Attributes of the entity","properties":{"info":{"type":"object","description":"General information about the entity","properties":{"description":{"type":"string","description":"Description of the entity"}},"additionalProperties":false},"features":{"type":"object","description":"Feature flags and scores for the entity","properties":{"sensitivity":{"type":"string","description":"Sensitivity classification of the entity"},"rating":{"type":"object","description":"Rating information for the entity","properties":{"value":{"type":"number","description":"Rating value"},"users":{"type":"object","description":"Users who rated the entity","additionalProperties":true}},"additionalProperties":false},"qualityScore":{"type":"number","description":"Quality score of the entity"},"trustScore":{"type":"object","description":"Trust score of the entity","properties":{"value":{"type":"number","description":"Trust score value"},"type":{"type":"string","description":"Type of trust score whether automated or manual"},"updatedAt":{"type":"string","description":"Timestamp when the trust score was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the trust score"}}},"isCriticalDataElement":{"type":"boolean","description":"Indicates if this is a critical data element"},"isLineageVerified":{"type":"boolean","description":"Indicates if lineage is verified"}},"additionalProperties":false},"customProperties":{"type":"array","description":"Custom properties for the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Custom property identifier"},"value":{"type":"string","description":"Custom property value"}},"additionalProperties":false}},"tags":{"type":"array","description":"Tags associated with the entity","items":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"type":{"type":"string","description":"Tag type"},"value":{"type":"string","description":"Tag value"},"sourceName":{"type":"string","description":"Source name for the tag"},"targetName":{"type":"string","description":"Target name for the tag"},"confidenceScore":{"type":"number","description":"Confidence score for the tag"}},"additionalProperties":false}},"businessTerms":{"type":"array","description":"Business terms associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Business term identifier"},"glossaryId":{"type":"string","description":"Glossary identifier"},"name":{"type":"string","description":"Business term name"},"sourceName":{"type":"string","description":"Source name for the business term"},"sourceType":{"type":"string","description":"Source type for the business term"},"confidenceScore":{"type":"number","description":"Confidence score for the business term"}},"additionalProperties":false}},"owners":{"type":"array","description":"Owners of the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Owner identifier"},"name":{"type":"string","description":"Owner name"}},"additionalProperties":false}},"policies":{"type":"array","description":"Policies associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy identifier"}},"additionalProperties":false}},"mlModels":{"type":"array","description":"Machine learning models associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"ML model identifier"}},"additionalProperties":false}},"applications":{"type":"array","description":"Applications associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Application identifier"}},"additionalProperties":false}},"physicalAssets":{"type":"array","description":"Physical assets associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Physical asset identifier"}},"additionalProperties":false}},"contentScanDiscoveries":{"type":"array","description":"Content scan discoveries for the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Discovery identifier"},"type":{"type":"string","description":"Discovery type"},"value":{"type":"string","description":"Discovery value"},"count":{"type":"integer","description":"Discovery count"},"locations":{"type":"string","description":"Discovery locations"}},"additionalProperties":false}},"dataCollections":{"type":"array","description":"Data collections associated with the entity","items":{"type":"object","properties":{"id":{"type":"string","description":"Data collection identifier"}},"additionalProperties":false}},"extended":{"type":"object","description":"Extended attributes for the entity","additionalProperties":true}},"additionalProperties":false}},"description":"Entity Properties with metadata , attributes & system info"},"description":"Array of entities with metadata, attributes & system info"},"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 Entity IDs

> Returns profiling statistics for a list of entities by their IDs, including stats, sampling, pattern analysis, and countDistinct values.\
>                \
> \
> 🚨 \*\*Note:\*\* Results are limited to 10,000 items.

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v1)","version":"v1"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v1/entities/by-ids/profiling-info":{"post":{"summary":"Get Profiling Information by Entity IDs","tags":["Data Entities"],"description":"Returns profiling statistics for a list of entities by their IDs, including stats, sampling, pattern analysis, and countDistinct values.\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":"Entity ID"},"description":"Array of entity 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"},"name":{"type":"string"},"type":{"type":"string"},"fqdn":{"type":"string"},"fqdnDisplay":{"type":"string"},"rootId":{"type":"string"},"parentId":{"type":"string"},"resourceId":{"type":"string"},"resourceName":{"type":"string"},"dataCollections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Data collection identifier"}},"additionalProperties":false}},"profilingInfo":{"type":"object","properties":{"_id":{"type":"string"},"connectionStringType":{"type":"string"},"dbtype":{"type":"string"},"bindType":{"type":"string"},"lastUpdate":{"type":"string","format":"date-time"},"inputFilter":{"type":"object","additionalProperties":true},"stats":{"type":"object","additionalProperties":true,"properties":{"rowCount":{"type":"integer"},"nullCount":{"type":"integer"},"blankCount":{"type":"integer"},"min":{"type":"number"},"max":{"type":"number"},"nonNullCount":{"type":"integer"},"average":{"type":"number"},"stdev":{"type":"number"},"density":{"type":"number","description":"Density"},"selectivity":{"type":"number","description":"Selectivity"},"uniqueness":{"type":"number","description":"Uniqueness"},"lexicalMin":{"type":"string","description":"Lexical minimum"},"lexicalMax":{"type":"string","description":"Lexical maximum"}}},"bitset":{"type":"string"},"bitsetCardinality":{"type":"integer"},"bitsetTotalCount":{"type":"integer"},"bitsetSerializedBytes":{"type":"integer"},"bitsetEncodedBytes":{"type":"string"},"bitcount":{"type":"string"},"bitcountCardinality":{"type":"integer"},"bitcountTotalCount":{"type":"integer"},"bitcountSerializedBytes":{"type":"integer"},"bitcountEncodedBytes":{"type":"string"},"hll":{"type":"string"},"hllBytes":{"type":"integer"},"dataSampling":{"type":"object","additionalProperties":true,"properties":{"sample":{"type":"object","additionalProperties":true,"properties":{"filename":{"type":"string"},"maxCount":{"type":"integer"},"count":{"type":"integer"}}}}},"patternAnalysis":{"type":"object","additionalProperties":true,"properties":{"ok":{"type":"boolean"},"targetCount":{"type":"integer"},"failCount":{"type":"integer"},"lengthMax":{"type":"integer"},"uppercaseRatioThreshold":{"type":"number"},"totalSamples":{"type":"integer"},"discardedSamples":{"type":"integer"},"patterns":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"pattern":{"type":"string"},"sample":{"type":"string"},"counter":{"type":"integer"},"mins":{"type":"string"},"maxs":{"type":"string"}}}},"patternCandidates":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"compactPattern":{"type":"string"},"match":{"type":"number"},"loose":{"type":"string"},"caseSensitive":{"type":"string"},"rangeSensitive":{"type":"string"},"strict":{"type":"string"}}}}}},"sampleValues":{"type":"array","items":{"type":"string"}},"countDistinct":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"value":{"type":"string"},"count":{"type":"integer"}}}}}}},"required":["_id","name","type","fqdn","rootId","resourceId","dataCollections","profilingInfo"]}}},"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 Profiling Information

> Returns profiling statistics for entities filtered by criteria with pagination support, including stats, sampling, pattern analysis, and countDistinct values.\
>                \
> \
> 🚨 \*\*Note:\*\* Results are limited to 10,000 items.

```json
{"openapi":"3.0.3","info":{"title":"PDC Public API (v1)","version":"v1"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Insert the JWT token here","bearerFormat":"JWT"}}},"paths":{"/api/public/v1/entities/filter/profiling-info":{"post":{"summary":"Filter Profiling Information","tags":["Data Entities"],"description":"Returns profiling statistics for entities filtered by criteria with pagination support, including stats, sampling, pattern analysis, and countDistinct values.\n               \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 entity ID"},"description":"Filter by array of parent entity IDs"},"rootIds":{"type":"array","items":{"type":"string","description":"Root entity ID"},"description":"Filter by array of root entity IDs"},"types":{"type":"array","items":{"type":"string","description":"Entity type"},"description":"Filter by array of entity types"},"collectionIds":{"type":"array","items":{"type":"string","description":"Collection ID"},"description":"Filter by array of collection IDs"},"resourceIds":{"type":"array","items":{"type":"string","description":"Resource ID"},"description":"Filter by array of resource IDs"},"names":{"type":"array","items":{"type":"string","description":"Entity name"},"description":"Filter by array of entity names"},"fqdns":{"type":"array","items":{"type":"string","description":"Fully qualified domain name"},"description":"Filter by array of fully qualified domain names"},"buckets":{"type":"array","items":{"type":"string","description":"Bucket"},"description":"Filter by array of buckets"},"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 entities"},"page":{"type":"integer","minimum":1,"default":1,"description":"Page number for pagination (starts from 1)"},"perPage":{"type":"integer","minimum":1,"maximum":10000,"default":100,"description":"Number of items per page (max 1000)"}},"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"},"name":{"type":"string"},"type":{"type":"string"},"fqdn":{"type":"string"},"fqdnDisplay":{"type":"string"},"rootId":{"type":"string"},"parentId":{"type":"string"},"resourceId":{"type":"string"},"resourceName":{"type":"string"},"dataCollections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Data collection identifier"}},"additionalProperties":false}},"profilingInfo":{"type":"object","properties":{"_id":{"type":"string"},"connectionStringType":{"type":"string"},"dbtype":{"type":"string"},"bindType":{"type":"string"},"lastUpdate":{"type":"string","format":"date-time"},"inputFilter":{"type":"object","additionalProperties":true},"stats":{"type":"object","additionalProperties":true,"properties":{"rowCount":{"type":"integer"},"nullCount":{"type":"integer"},"blankCount":{"type":"integer"},"min":{"type":"number"},"max":{"type":"number"},"nonNullCount":{"type":"integer"},"average":{"type":"number"},"stdev":{"type":"number"},"density":{"type":"number","description":"Density"},"selectivity":{"type":"number","description":"Selectivity"},"uniqueness":{"type":"number","description":"Uniqueness"},"lexicalMin":{"type":"string","description":"Lexical minimum"},"lexicalMax":{"type":"string","description":"Lexical maximum"}}},"bitset":{"type":"string"},"bitsetCardinality":{"type":"integer"},"bitsetTotalCount":{"type":"integer"},"bitsetSerializedBytes":{"type":"integer"},"bitsetEncodedBytes":{"type":"string"},"bitcount":{"type":"string"},"bitcountCardinality":{"type":"integer"},"bitcountTotalCount":{"type":"integer"},"bitcountSerializedBytes":{"type":"integer"},"bitcountEncodedBytes":{"type":"string"},"hll":{"type":"string"},"hllBytes":{"type":"integer"},"dataSampling":{"type":"object","additionalProperties":true,"properties":{"sample":{"type":"object","additionalProperties":true,"properties":{"filename":{"type":"string"},"maxCount":{"type":"integer"},"count":{"type":"integer"}}}}},"patternAnalysis":{"type":"object","additionalProperties":true,"properties":{"ok":{"type":"boolean"},"targetCount":{"type":"integer"},"failCount":{"type":"integer"},"lengthMax":{"type":"integer"},"uppercaseRatioThreshold":{"type":"number"},"totalSamples":{"type":"integer"},"discardedSamples":{"type":"integer"},"patterns":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"pattern":{"type":"string"},"sample":{"type":"string"},"counter":{"type":"integer"},"mins":{"type":"string"},"maxs":{"type":"string"}}}},"patternCandidates":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"compactPattern":{"type":"string"},"match":{"type":"number"},"loose":{"type":"string"},"caseSensitive":{"type":"string"},"rangeSensitive":{"type":"string"},"strict":{"type":"string"}}}}}},"sampleValues":{"type":"array","items":{"type":"string"}},"countDistinct":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"value":{"type":"string"},"count":{"type":"integer"}}}}}}},"required":["_id","name","type","fqdn","rootId","resourceId","dataCollections","profilingInfo"]}},"pageInfo":{"type":"object","properties":{"currentPage":{"type":"integer"},"perPage":{"type":"integer"},"totalCount":{"type":"integer"},"pageCount":{"type":"integer"}}}},"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/v1/pdc-api-ref-v1/data-entities.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.