Discovery - Query
Obtener datos mediante la búsqueda.
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
|
api-version
|
query | True |
string |
Versión de API que se usará para la operación. |
Cuerpo de la solicitud
Nombre | Tipo | Description |
---|---|---|
continuationToken |
string |
Token usado para obtener el siguiente lote de datos. El valor predeterminado es "Null" para obtener el primer lote y devolverá un nuevo token en cada respuesta a menos que no haya más datos. |
facets |
Las facetas de búsqueda. Consulte ejemplos de uso de facetas admitidas. |
|
filter |
Filtro para la búsqueda. Consulte ejemplos de uso de filtros admitidos. |
|
keywords |
string |
Palabras clave aplicadas a todos los campos que se pueden buscar. |
limit |
integer |
Límite del número del resultado de búsqueda. el valor predeterminado es 50; El valor máximo es 1000. |
orderby |
Orderby[] |
El criterio de ordenación de los resultados de búsqueda puede especificar varios campos. |
taxonomySetting |
Configuración de taxonomía para la búsqueda. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
La solicitud se ha realizado correctamente. |
|
Other Status Codes |
Respuesta de error inesperada. |
Seguridad
OAuth2Auth
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
https://purview.azure.net/.default |
Ejemplos
Discovery_Query
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": "exampledata",
"filter": {
"and": [
{
"objectType": "Files"
},
{
"entityType": "azure_blob_path"
}
]
},
"limit": 10,
"orderby": [
{
"name": "ASC"
},
{
"updateTime": "DESC"
}
],
"facets": [
{
"facet": "assetType",
"count": 0,
"sort": {
"count": "desc"
}
},
{
"facet": "classification",
"count": 10,
"sort": {
"count": "desc"
}
},
{
"facet": "contactId",
"count": 10,
"sort": {
"count": "desc"
}
},
{
"facet": "label",
"count": 10,
"sort": {
"count": "desc"
}
},
{
"facet": "term",
"count": 10,
"sort": {
"count": "desc"
}
}
]
}
Respuesta de muestra
{
"@search.count": 2,
"@search.count.approximate": false,
"value": [
{
"@search.score": 1,
"id": "bfecbcc3-1838-45fe-96d6-112de8a170f9",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt",
"name": "exampledata1.txt",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
},
{
"@search.score": 1,
"id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt",
"name": "exampledata2.txt",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
}
]
}
Discovery_Query_And
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"and": [
{
"entityType": "azure_blob_path"
},
{
"attributeName": "qualifiedName",
"operator": "contains",
"attributeValue": ".csv"
}
]
}
}
Respuesta de muestra
{
"@search.count": 5,
"@search.count.approximate": false,
"value": [
{
"@search.score": 1,
"@search.highlights": {
"qualifiedName": [
"https://exampleaccount.blob.core.windows.net/examplepath/<em>csv</em>/exampledata.csv"
]
},
"id": "63b92968-c9ac-4af8-8cff-f61d147bbf88",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv",
"name": "exampledata.csv",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [
"Example.Label"
],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
},
{
"@search.score": 1,
"@search.highlights": {
"qualifiedName": [
"https://exampleaccount.blob.core.windows.net/examplepath/<em>csv</em>/AllTypes.csv"
]
},
"id": "2605db54-086d-4d6c-adb6-f0bbed6c6eab",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/AllTypes.csv",
"name": "AllTypes.csv",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [
"Example.Label"
],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
}
]
}
Discovery_Query_AndOrNested
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"and": [
{
"entityType": "azure_blob_path"
},
{
"attributeName": "qualifiedName",
"operator": "contains",
"attributeValue": ".csv"
},
{
"or": [
{
"attributeName": "name",
"operator": "eq",
"attributeValue": "exampledata.csv"
},
{
"attributeName": "qualifiedName",
"operator": "prefix",
"attributeValue": "https://"
}
]
}
]
}
}
Respuesta de muestra
{
"@search.count": 2,
"@search.count.approximate": false,
"value": [
{
"@search.score": 1,
"@search.highlights": {
"qualifiedName": [
"https://exampleaccount.blob.core.windows.net/examplepath/<em>csv</em>/exampledata.csv"
]
},
"id": "63b92968-c9ac-4af8-8cff-f61d147bbf88",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv",
"name": "exampledata.csv",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [
"Example.Label"
],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
},
{
"@search.score": 1,
"@search.highlights": {
"qualifiedName": [
"https://exampleaccount.blob.core.windows.net/examplepath/<em>csv</em>/AllTypes.csv"
],
"name": [
"<em>AllTypes.csv</em>"
]
},
"id": "2605db54-086d-4d6c-adb6-f0bbed6c6eab",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/AllTypes.csv",
"name": "AllTypes.csv",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [
"Example.Label"
],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
}
]
}
Discovery_Query_AssetType
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"or": [
{
"assetType": "SQL Server"
},
{
"assetType": "Azure SQL Server"
},
{
"assetType": "Azure SQL Database"
},
{
"assetType": "Azure SQL Data Warehouse"
},
{
"assetType": "Azure SQL Managed Instance"
},
{
"assetType": "Azure Storage Account"
},
{
"assetType": "Azure Blob Storage"
},
{
"assetType": "Azure Files"
},
{
"assetType": "Azure Table Storage"
},
{
"assetType": "Azure Data Lake Storage Gen1"
},
{
"assetType": "Azure Data Lake Storage Gen2"
},
{
"assetType": "Azure Cosmos DB"
},
{
"assetType": "Azure Data Factory"
},
{
"assetType": "Azure Cognitive Search"
},
{
"assetType": "Power BI"
},
{
"assetType": "Azure Data Explorer"
},
{
"assetType": "Amazon S3"
},
{
"assetType": "Azure Data Share"
},
{
"assetType": "Teradata"
},
{
"assetType": "SAP S4HANA"
},
{
"assetType": "SAP ECC"
},
{
"assetType": "SQL Server Integration Services"
},
{
"assetType": "hive"
},
{
"assetType": "Azure Database for MySQL"
},
{
"assetType": "Azure Database for MariaDB"
},
{
"assetType": "Azure Database for PostgreSQL"
},
{
"assetType": "Azure Synapse Analytics"
}
]
}
}
Respuesta de muestra
{
"continuationToken": "<token>",
"@search.count": 5155,
"@search.count.approximate": true,
"value": [
{
"@search.score": 1,
"id": "24c16e53-1bfd-4d6c-b4ce-b1f6f6f60000",
"qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata1",
"name": "exampledata1",
"description": null,
"owner": null,
"entityType": "azure_sql_mi_table",
"classification": [],
"label": [],
"assetType": [
"Azure SQL Managed Instance"
],
"term": [],
"contact": []
},
{
"@search.score": 1,
"id": "d7b516fc-5d38-40f8-baeb-72f6f6f60000",
"qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata2",
"name": "exampledata2",
"description": null,
"owner": null,
"entityType": "azure_sql_mi_table",
"classification": [],
"label": [],
"assetType": [
"Azure SQL Managed Instance"
],
"term": [],
"contact": []
}
]
}
Discovery_Query_Attribute
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"or": [
{
"attributeName": "name",
"operator": "eq",
"attributeValue": "exampledata.csv"
},
{
"attributeName": "createTime",
"operator": "ge",
"attributeValue": 1545580800000
},
{
"attributeName": "modifiedTime",
"operator": "timerange",
"attributeValue": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D"
}
]
}
}
Respuesta de muestra
{
"@search.count": 4,
"@search.count.approximate": false,
"value": [
{
"@search.score": 1,
"id": "63b92968-c9ac-4af8-8cff-f61d147bbf88",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv",
"name": "exampledata.csv",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [
"Example.Label"
],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
},
{
"@search.score": 1,
"id": "55b2290d-e11d-4ed2-8c7a-0d8d35eb6254",
"qualifiedName": "https://examplegen2account.dfs.core.windows.net/examplepath/csv/exampledata.csv",
"name": "exampledata.csv",
"description": null,
"owner": "$superuser",
"entityType": "azure_datalake_gen2_path",
"classification": [],
"label": [
"Example.Label"
],
"assetType": [
"Azure Data Lake Storage Gen2"
],
"term": [],
"contact": []
},
{
"@search.score": 1,
"id": "55ceaddf-30ac-40f3-b656-71f6f6f60000",
"entityType": "azure_sql_mi_table",
"name": "exampleData_v1",
"qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampleData_v1",
"assetType": [
"Azure SQL Managed Instance"
]
},
{
"@search.score": 1,
"id": "89416661-5269-4f3d-ba35-e0f6f6f60000",
"entityType": "azure_sql_mi_table",
"name": "exampleData_v2",
"qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampleData_v2",
"assetType": [
"Azure SQL Managed Instance"
]
}
]
}
Discovery_Query_BusinessMetadataAttribute
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"or": [
{
"attributeName": "<BusinessMetadataName>.<StringAttributeName>",
"operator": "eq|ne|contains|prefix",
"attributeValue": "string value"
},
{
"attributeName": "<BusinessMetadataName>.<NumberAttributeName>",
"operator": "eq|ne|gt|ge|lt|le",
"attributeValue": 123
},
{
"attributeName": "<BusinessMetadataName>.<BooleanAttributeName>",
"operator": "eq|ne",
"attributeValue": true
},
{
"attributeName": "<BusinessMetadataName>.<DateAttributeName>",
"operator": "timerange",
"attributeValue": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D"
}
]
}
}
Respuesta de muestra
{
"@search.count": 1,
"@search.count.approximate": false,
"value": [
{
"@search.score": 1,
"id": "63b92968-c9ac-4af8-8cff-f61d147bbf88",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/csv/exampledata.csv",
"name": "exampledata.csv",
"entityType": "azure_blob_path",
"objectType": "Files"
}
]
}
Discovery_Query_Classification
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"classification": "MICROSOFT.PERSONAL.EMAIL",
"includeSubClassifications": true
}
}
Respuesta de muestra
{
"@search.count": 5,
"@search.count.approximate": false,
"value": [
{
"@search.score": 1,
"id": "b9638b91-884f-4e5e-98b5-29f6f6f60000",
"qualifiedName": "mssql://exampleserver.database.windows.net/examplesqldb/examplepath/exampledata1",
"name": "exampledata1",
"description": null,
"owner": null,
"entityType": "azure_sql_table",
"classification": [
"MICROSOFT.PERSONAL.NAME",
"MICROSOFT.PERSONAL.EU.PHONE_NUMBER",
"MICROSOFT.PERSONAL.US.PHONE_NUMBER",
"MICROSOFT.PERSONAL.EMAIL"
],
"label": [],
"assetType": [
"Azure SQL Database"
],
"term": [],
"contact": []
},
{
"@search.score": 1,
"id": "01aefb9a-61cd-4a02-a572-70f6f6f60000",
"qualifiedName": "mssql://exampleserver.database.windows.net/exampledw/examplepath/exampledata2",
"name": "exampledata2",
"description": null,
"owner": null,
"entityType": "azure_sql_dw_table",
"classification": [
"MICROSOFT.GOVERNMENT.CITY_NAME",
"MICROSOFT.GOVERNMENT.US.STATE",
"MICROSOFT.PERSONAL.NAME",
"MICROSOFT.PERSONAL.EU.PHONE_NUMBER",
"MICROSOFT.PERSONAL.EMAIL"
],
"label": [],
"assetType": [
"Azure SQL Data Warehouse"
],
"term": [],
"contact": []
}
]
}
Discovery_Query_Collection
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"collectionId": "collectionName"
}
}
Respuesta de muestra
{
"@search.count": 5,
"@search.count.approximate": false,
"value": [
{
"@search.score": 1,
"id": "b9638b91-884f-4e5e-98b5-29f6f6f60000",
"qualifiedName": "mssql://exampleserver.database.windows.net/examplesqldb/examplepath/exampledata1",
"name": "exampledata1",
"description": null,
"owner": null,
"entityType": "azure_sql_table",
"classification": [
"MICROSOFT.PERSONAL.NAME",
"MICROSOFT.PERSONAL.EU.PHONE_NUMBER",
"MICROSOFT.PERSONAL.US.PHONE_NUMBER",
"MICROSOFT.PERSONAL.EMAIL"
],
"label": [],
"assetType": [
"Azure SQL Database"
],
"term": [],
"contact": []
},
{
"@search.score": 1,
"id": "01aefb9a-61cd-4a02-a572-70f6f6f60000",
"qualifiedName": "mssql://exampleserver.database.windows.net/exampledw/examplepath/exampledata2",
"name": "exampledata2",
"description": null,
"owner": null,
"entityType": "azure_sql_dw_table",
"classification": [
"MICROSOFT.GOVERNMENT.CITY_NAME",
"MICROSOFT.GOVERNMENT.US.STATE",
"MICROSOFT.PERSONAL.NAME",
"MICROSOFT.PERSONAL.EU.PHONE_NUMBER",
"MICROSOFT.PERSONAL.EMAIL"
],
"label": [],
"assetType": [
"Azure SQL Data Warehouse"
],
"term": [],
"contact": []
}
]
}
Discovery_Query_Facet
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"filter": {
"objectType": "Tables"
},
"limit": 10,
"facets": [
{
"facet": "assetType",
"count": 10
},
{
"facet": "classification",
"count": 10
},
{
"facet": "term",
"count": 10
},
{
"facet": "label",
"count": 10
}
]
}
Respuesta de muestra
{
"continuationToken": "<token>",
"@search.count": 5156,
"@search.count.approximate": false,
"@search.facets": {
"classification": [
{
"count": 8,
"value": "MICROSOFT.PERSONAL.NAME"
},
{
"count": 6,
"value": "MICROSOFT.PERSONAL.EU.PHONE_NUMBER"
},
{
"count": 5,
"value": "MICROSOFT.PERSONAL.EMAIL"
},
{
"count": 5,
"value": "MICROSOFT.PERSONAL.US.PHONE_NUMBER"
},
{
"count": 4,
"value": "MICROSOFT.GOVERNMENT.CITY_NAME"
},
{
"count": 2,
"value": "MICROSOFT.GOVERNMENT.US.STATE"
}
],
"assetType": [
{
"count": 1476,
"value": "Azure SQL Database"
},
{
"count": 1358,
"value": "Azure SQL Data Warehouse"
},
{
"count": 1331,
"value": "Azure SQL Managed Instance"
},
{
"count": 293,
"value": "Azure Data Lake Storage Gen1"
},
{
"count": 261,
"value": "Azure Blob Storage"
},
{
"count": 231,
"value": "Azure Data Lake Storage Gen2"
},
{
"count": 194,
"value": "Azure Files"
},
{
"count": 18,
"value": "Azure Cosmos DB"
}
],
"label": [
{
"count": 835,
"value": "Example.Label"
}
],
"term": [
{
"count": 1,
"value": "terma"
}
]
},
"value": [
{
"@search.score": 1,
"id": "24c16e53-1bfd-4d6c-b4ce-b1f6f6f60000",
"qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata",
"name": "exampledata",
"description": null,
"owner": null,
"entityType": "azure_sql_mi_table",
"classification": [],
"label": [],
"assetType": [
"Azure SQL Managed Instance"
],
"term": [],
"contact": []
},
{
"@search.score": 1,
"id": "d7b516fc-5d38-40f8-baeb-72f6f6f60000",
"qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata2",
"name": "exampledata2",
"description": null,
"owner": null,
"entityType": "azure_sql_mi_table",
"classification": [],
"label": [],
"assetType": [
"Azure SQL Managed Instance"
],
"term": [],
"contact": []
}
]
}
Discovery_Query_FileExtension
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"and": [
{
"fileExtension": "txt"
}
]
}
}
Respuesta de muestra
{
"continuationToken": "<token>",
"@search.count": 49,
"@search.count.approximate": false,
"value": [
{
"@search.score": 1,
"id": "bfecbcc3-1838-45fe-96d6-112de8a170f9",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.txt",
"name": "exampledata.txt",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
},
{
"@search.score": 1,
"id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.txt",
"name": "exampledata.txt",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
}
]
}
Discovery_Query_GlossaryTerm
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": "<term name>",
"limit": 10,
"filter": {
"and": [
{
"objectType": "Glossary terms"
},
{
"or": [
{
"glossaryType": "AtlasGlossary"
},
{
"glossaryType": "AtlasGlossaryTerm"
}
]
}
]
},
"facets": [
{
"facet": "termStatus",
"count": 10,
"sort": {
"count": "desc"
}
},
{
"facet": "termTemplate",
"count": 10,
"sort": {
"count": "desc"
}
}
]
}
Respuesta de muestra
{
"@search.count": 2,
"@search.count.approximate": false,
"value": [
{
"@search.score": 1,
"objectType": "Glossary terms",
"glossaryType": "AtlasGlossaryTerm",
"id": "b1e51cc4-9249-4c81-bbc7-e2f3117706f3",
"name": "termSample1",
"glossary": "DefaultGlossary",
"longDescription": "it is the definition of the term",
"termStatus": "Approved",
"termTemplate": [
"termTemplateSample"
],
"createTime": 1625819659805,
"updateTime": 1625819659805,
"qualifiedName": "termSample1@DefaultGlossary"
},
{
"@search.score": 1,
"objectType": "Glossary terms",
"glossaryType": "AtlasGlossary",
"id": "b28f35e4-fcd4-43ca-91a3-daf432c87156",
"name": "DefaultGlossary",
"longDescription": "it is the definition of the glossary",
"createTime": 1625819658745,
"updateTime": 1640656877302,
"qualifiedName": "DefaultGlossary"
}
],
"@search.facets": {
"termTemplate": [
{
"count": 1,
"value": "termTemplateSample"
}
],
"termStatus": [
{
"count": 1,
"value": "Approved"
}
]
}
}
Discovery_Query_Id
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"and": [
{
"id": "bfecbcc3-1838-45fe-96d6-112de8a170f9"
}
]
}
}
Respuesta de muestra
{
"@search.count": 1,
"@search.count.approximate": false,
"value": [
{
"@search.score": 1,
"id": "bfecbcc3-1838-45fe-96d6-112de8a170f9",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.txt",
"name": "exampledata.txt",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
}
]
}
Discovery_Query_Not
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"not": {
"classification": "MICROSOFT.SYSTEM.TEMP_FILE"
}
}
}
Respuesta de muestra
{
"continuationToken": "<token>",
"@search.count": 5158,
"@search.count.approximate": false,
"value": [
{
"@search.score": 1,
"id": "11fd6e94-2dc6-4ebd-822c-caf6f6f60000",
"qualifiedName": "mssql://exampleaccount.database.windows.net:3342/exampledb/dbo/exampledata",
"name": "exampledata",
"description": null,
"owner": null,
"entityType": "azure_sql_mi_table",
"classification": [],
"label": [],
"assetType": [
"Azure SQL Managed Instance"
],
"term": [],
"contact": []
},
{
"@search.score": 1,
"id": "1af82c87-798c-41a2-abab-93f6f6f60000",
"qualifiedName": "mssql://exampleaccount.database.windows.net:3342/exampledb/dbo/exampledata2",
"name": "exampledata2",
"description": null,
"owner": null,
"entityType": "azure_sql_mi_table",
"classification": [],
"label": [],
"assetType": [
"Azure SQL Managed Instance"
],
"term": [],
"contact": []
}
]
}
Discovery_Query_ObjectType
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"or": [
{
"objectType": "Dashboards"
},
{
"objectType": "Data pipelines"
},
{
"objectType": "Files"
},
{
"objectType": "Folders"
},
{
"objectType": "Glossary terms"
},
{
"objectType": "Reports"
},
{
"objectType": "Stored procedures"
},
{
"objectType": "Tables"
}
]
}
}
Respuesta de muestra
{
"@search.count": 2,
"@search.count.approximate": false,
"value": [
{
"@search.score": 1,
"objectType": "Tables",
"id": "24c16e53-1bfd-4d6c-b4ce-b1f6f6f60000",
"entityType": "azure_sql_mi_table",
"name": "exampledata1",
"qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampledata1",
"assetType": [
"Azure SQL Managed Instance"
]
},
{
"@search.score": 1,
"objectType": "Glossary terms",
"id": "b1e51cc4-9249-4c81-bbc7-e2f3117706f3",
"glossaryType": "AtlasGlossaryTerm",
"name": "termSample1",
"glossary": "DefaultGlossary",
"longDescription": "it is the definition of the term",
"termStatus": "Approved",
"termTemplate": [
"termTemplateSample"
],
"qualifiedName": "termSample1@DefaultGlossary"
}
]
}
Discovery_Query_PaginationContinuationPage
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": "exampledata",
"filter": {
"and": [
{
"objectType": "Files"
},
{
"entityType": "azure_blob_path"
}
]
},
"limit": 2,
"continuationToken": "<token>",
"orderby": [
{
"name": "ASC"
},
{
"updateTime": "DESC"
}
],
"facets": [
{
"facet": "assetType",
"count": 0,
"sort": {
"count": "desc"
}
},
{
"facet": "classification",
"count": 10,
"sort": {
"count": "desc"
}
},
{
"facet": "contactId",
"count": 10,
"sort": {
"count": "desc"
}
},
{
"facet": "label",
"count": 10,
"sort": {
"count": "desc"
}
},
{
"facet": "term",
"count": 10,
"sort": {
"count": "desc"
}
}
]
}
Respuesta de muestra
{
"@search.count": 6,
"@search.count.approximate": false,
"continuationToken": "<token>",
"value": [
{
"@search.score": 1,
"id": "bfecbcc3-1838-45fe-96d6-112de8a170f9",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt",
"name": "exampledata1.txt",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
},
{
"@search.score": 1,
"id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt",
"name": "exampledata2.txt",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
}
]
}
Discovery_Query_PaginationFirstPage
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": "exampledata",
"filter": {
"and": [
{
"objectType": "Files"
},
{
"entityType": "azure_blob_path"
}
]
},
"limit": 2,
"orderby": [
{
"name": "ASC"
},
{
"updateTime": "DESC"
}
],
"facets": [
{
"facet": "assetType",
"count": 0,
"sort": {
"count": "desc"
}
},
{
"facet": "classification",
"count": 10,
"sort": {
"count": "desc"
}
},
{
"facet": "contactId",
"count": 10,
"sort": {
"count": "desc"
}
},
{
"facet": "label",
"count": 10,
"sort": {
"count": "desc"
}
},
{
"facet": "term",
"count": 10,
"sort": {
"count": "desc"
}
}
]
}
Respuesta de muestra
{
"@search.count": 6,
"@search.count.approximate": false,
"continuationToken": "<token>",
"value": [
{
"@search.score": 1,
"id": "bfecbcc3-1838-45fe-96d6-112de8a170f9",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt",
"name": "exampledata1.txt",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
},
{
"@search.score": 1,
"id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt",
"name": "exampledata2.txt",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
}
]
}
Discovery_Query_PaginationLastPage
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": "exampledata",
"filter": {
"and": [
{
"objectType": "Files"
},
{
"entityType": "azure_blob_path"
}
]
},
"limit": 2,
"continuationToken": "<token>",
"orderby": [
{
"name": "ASC"
},
{
"updateTime": "DESC"
}
],
"facets": [
{
"facet": "assetType",
"count": 0,
"sort": {
"count": "desc"
}
},
{
"facet": "classification",
"count": 10,
"sort": {
"count": "desc"
}
},
{
"facet": "contactId",
"count": 10,
"sort": {
"count": "desc"
}
},
{
"facet": "label",
"count": 10,
"sort": {
"count": "desc"
}
},
{
"facet": "term",
"count": 10,
"sort": {
"count": "desc"
}
}
]
}
Respuesta de muestra
{
"@search.count": 6,
"@search.count.approximate": false,
"value": [
{
"@search.score": 1,
"id": "bfecbcc3-1838-45fe-96d6-112de8a170f9",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt",
"name": "exampledata1.txt",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
},
{
"@search.score": 1,
"id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt",
"name": "exampledata2.txt",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
}
]
}
Discovery_Query_SystemTime
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"or": [
{
"createTime": {
"operator": "lt",
"timeThreshold": 1545580800000
}
},
{
"updateTime": "LAST_24H|LAST_7D|LAST_30D|LAST_365D|MORE_THAN_365D"
}
]
}
}
Respuesta de muestra
{
"@search.count": 2,
"@search.count.approximate": false,
"value": [
{
"@search.score": 1,
"id": "55ceaddf-30ac-40f3-b656-71f6f6f60000",
"entityType": "azure_sql_mi_table",
"name": "exampleData_v1",
"qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampleData_v1",
"assetType": [
"Azure SQL Managed Instance"
]
},
{
"@search.score": 1,
"id": "89416661-5269-4f3d-ba35-e0f6f6f60000",
"entityType": "azure_sql_mi_table",
"name": "exampleData_v2",
"qualifiedName": "mssql://exampleaccount.database.windows.net:3342/examplesqlmidb/dbo/exampleData_v2",
"assetType": [
"Azure SQL Managed Instance"
]
}
]
}
Discovery_Query_Taxonomy
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": "exampledata",
"filter": {
"and": [
{
"objectType": "Files"
},
{
"not": {
"or": [
{
"attributeName": "size",
"operator": "eq",
"attributeValue": 0
},
{
"attributeName": "fileSize",
"operator": "eq",
"attributeValue": 0
}
]
}
},
{
"not": {
"classification": "MICROSOFT.SYSTEM.TEMP_FILE"
}
}
]
},
"limit": 10,
"taxonomySetting": {
"assetTypes": [
"Azure Blob Storage"
],
"facet": {
"count": 10,
"sort": {
"count": "desc"
}
}
}
}
Respuesta de muestra
{
"continuationToken": "<token>",
"@search.count": 339,
"@search.count.approximate": false,
"value": [
{
"@search.score": 1,
"id": "bfecbcc3-1838-45fe-96d6-112de8a170f9",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata1.txt",
"name": "exampledata1.txt",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
},
{
"@search.score": 1,
"id": "14d857b9-e2c1-4118-8bfa-12e53ae6ce7f",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.txt",
"name": "exampledata2.txt",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
}
]
}
Discovery_Query_TermAssignment
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": "<asset name>",
"limit": 3,
"filter": {
"or": [
{
"term": "ExampleTerm"
},
{
"term": "ExampleTerm",
"glossary": "GlossaryName"
},
{
"termGuid": "<term guid>"
}
]
}
}
Respuesta de muestra
{
"@search.count": 1,
"@search.count.approximate": false,
"value": [
{
"@search.score": 1,
"id": "b20ac13a-7883-4376-b076-bac9f8f214a8",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplecontainer",
"name": "examplecontainer",
"description": null,
"owner": null,
"entityType": "azure_blob_container",
"classification": [],
"assetType": [
"Azure Blob Storage"
],
"term": [
{
"name": "ExampleTerm",
"glossaryName": "Glossary"
}
],
"contact": [],
"label": [
"Example.Label"
]
}
]
}
Discovery_Query_Type
Solicitud de ejemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"and": [
{
"entityType": "azure_blob_path",
"includeSubTypes": false
}
]
}
}
Respuesta de muestra
{
"continuationToken": "<token>",
"@search.count": 221,
"value": [
{
"@search.score": 1,
"id": "1d797ddf-47bf-4151-8fe8-918590d62e70",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.csv",
"name": "exampledata.csv",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [
"Example.Label"
],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
},
{
"@search.score": 1,
"id": "d3e83b17-c730-4898-94c8-58579cda04f6",
"qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata2.csv",
"name": "exampledata2.csv",
"description": null,
"owner": null,
"entityType": "azure_blob_path",
"classification": [],
"label": [
"Example.Label"
],
"assetType": [
"Azure Blob Storage"
],
"term": [],
"contact": []
}
]
}
Definiciones
Nombre | Description |
---|---|
Atlas |
Una respuesta de error del servicio |
Contact |
El contacto en la búsqueda y sugiere el resultado. |
Query |
Consulta de búsqueda de solicitud de búsqueda avanzada. |
Query |
Resultado del resultado de la búsqueda. |
Search |
Contenido de un elemento de resultado de faceta de búsqueda. |
Search |
Contenido de un elemento de resultado de faceta de búsqueda. |
Search |
Lista de facetas que consta de campos de índice assetType , classification, contactId y label. Cuando se especifica la faceta en la solicitud, el valor de la faceta se devuelve como un elemento de @search.facets. |
Search |
Criterios de ordenación |
Search |
Lista de resaltado que consta del identificador de campos de índice ,qualifiedName, name, description, entityType. Cuando la palabra clave aparece en esos campos, el valor del campo, asociado con la marca de énfasis, se devuelve como un elemento de @search.highlights. |
Search |
Elemento de valor del resultado de la búsqueda. |
Search |
Criterio de ordenación de búsqueda |
Search |
Configuración de taxonomía para la solicitud de búsqueda |
Term |
Contexto. |
AtlasErrorResponse
Una respuesta de error del servicio
Nombre | Tipo | Description |
---|---|---|
errorCode |
string |
Código de error. |
errorMessage |
string |
El mensaje de error. |
requestId |
string |
El identificador de solicitud. |
ContactSearchResultValue
El contacto en la búsqueda y sugiere el resultado.
Nombre | Tipo | Description |
---|---|---|
contactType |
string |
Tipo del contacto. Puede ser Experto o Propietario de una entidad. Puede ser experto o administrador para un término de glosario. |
id |
string |
GUID del contacto. |
info |
string |
Descripción del contacto. |
QueryOptions
Consulta de búsqueda de solicitud de búsqueda avanzada.
Nombre | Tipo | Description |
---|---|---|
continuationToken |
string |
Token usado para obtener el siguiente lote de datos. El valor predeterminado "Null" para obtener el primer lote y devolverá un nuevo token en cada respuesta a menos que no haya más datos. |
facets |
Facetas de búsqueda. Consulte ejemplos de uso de facetas admitidas. |
|
filter |
Filtro de la búsqueda. Consulte ejemplos de uso de filtros admitidos. |
|
keywords |
string |
Palabras clave aplicadas a todos los campos que se pueden buscar. |
limit |
integer |
Límite del número del resultado de búsqueda. el valor predeterminado es 50; el valor máximo es 1000. |
orderby |
Orderby[] |
El criterio de ordenación de los resultados de búsqueda puede especificar varios campos. |
taxonomySetting |
Configuración de taxonomía para la búsqueda. |
QueryResult
Resultado del resultado de la búsqueda.
Nombre | Tipo | Description |
---|---|---|
@search.count |
integer |
Número total de resultados de búsqueda (no el número de documentos de una sola página). |
@search.count.approximate |
boolean |
"True" si "@search.count" es un valor aproximado y viceversa. |
@search.facets |
Lista de facetas que consta de campos de índice assetType , classification, contactId y label. Cuando se especifica la faceta en la solicitud, el valor de la faceta se devuelve como un elemento de @search.facets. |
|
continuationToken |
string |
Token usado para obtener el siguiente lote de datos. Ausente si no hay más datos. |
value |
Valor del resultado de la búsqueda |
SearchFacetItem
Contenido de un elemento de resultado de faceta de búsqueda.
Nombre | Tipo | Description |
---|---|---|
count |
integer |
Recuento del elemento de faceta. |
facet |
string |
Nombre del elemento de faceta. |
sort |
Definir los criterios de ordenación de los elementos |
SearchFacetItemValue
Contenido de un elemento de resultado de faceta de búsqueda.
Nombre | Tipo | Description |
---|---|---|
count |
integer |
Recuento del elemento de faceta. |
value |
string |
Nombre del elemento de faceta. |
SearchFacetResultValue
Lista de facetas que consta de campos de índice assetType , classification, contactId y label. Cuando se especifica la faceta en la solicitud, el valor de la faceta se devuelve como un elemento de @search.facets.
Nombre | Tipo | Description |
---|---|---|
assetType |
Tipo de recurso |
|
classification |
clasificación |
|
contactId |
Id. de contacto |
|
contactType |
Tipo de contacto |
|
entityType |
Tipo de entidad |
|
glossaryType |
Tipo de glosario |
|
label |
Etiqueta |
|
term |
Término |
|
termStatus |
Estado del término |
|
termTemplate |
Plantilla de términos |
SearchFacetSort
Criterios de ordenación
Nombre | Tipo | Description |
---|---|---|
count |
Orden por recuento |
|
value |
Orden por valor |
SearchHighlights
Lista de resaltado que consta del identificador de campos de índice ,qualifiedName, name, description, entityType. Cuando la palabra clave aparece en esos campos, el valor del campo, asociado con la marca de énfasis, se devuelve como un elemento de @search.highlights.
Nombre | Tipo | Description |
---|---|---|
description |
string[] |
Descripción |
entityType |
string[] |
Tipo de entidad |
id |
string[] |
Identificador |
name |
string[] |
Nombre |
qualifiedName |
string[] |
Nombre completo |
SearchResultValue
Elemento de valor del resultado de la búsqueda.
Nombre | Tipo | Description |
---|---|---|
@search.highlights |
Lista de resaltado que consta del identificador de campos de índice ,qualifiedName, name, description, entityType. Cuando la palabra clave aparece en esos campos, el valor del campo, asociado con la marca de énfasis, se devuelve como un elemento de @search.highlights. |
|
@search.score |
number |
Puntuación de búsqueda calculada por el motor de búsqueda. Los resultados se ordenan por puntuación de búsqueda de forma predeterminada. |
assetType |
string[] |
Los tipos de recursos del recurso. |
classification |
string[] |
Clasificaciones del registro. |
contact |
Contactos del recurso. |
|
createTime |
integer |
Hora de creación del registro. Formato de época de Unix. |
description |
string |
Descripción del recurso. |
endorsement |
string |
Aprobación del recurso. |
entityType |
string |
Nombre de tipo del recurso. |
glossary |
string |
Nombre del glosario del término. |
glossaryType |
string |
Nombre de tipo del término. Podría ser AtlasGlossary, AtlasGlossaryTerm o AtlasGlossaryCategory. |
id |
string |
GUID del registro. |
label |
string[] |
Etiquetas del recurso. |
longDescription |
string |
Definición del término. |
name |
string |
Nombre del registro. |
objectType |
string |
Tipo de objeto del registro. El tipo de objeto es la propiedad de nivel superior para distinguir si un registro es un recurso o un término. |
owner |
string |
Propietario del registro. |
qualifiedName |
string |
Nombre completo del registro. |
term |
Términos asignados al recurso. |
|
termStatus |
string |
Estado del término. |
termTemplate |
string[] |
Los nombres de plantilla de términos usados por el término . |
updateTime |
integer |
Hora de la última actualización del registro. Formato de época de Unix. |
SearchSortOrder
Criterio de ordenación de búsqueda
Nombre | Tipo | Description |
---|---|---|
asc |
string |
Usar el orden ascendente para la ordenación |
desc |
string |
Uso del orden descendente para la ordenación |
SearchTaxonomySetting
Configuración de taxonomía para la solicitud de búsqueda
Nombre | Tipo | Description |
---|---|---|
assetTypes |
string[] |
Tipos de activo |
facet |
Contenido de un elemento de resultado de faceta de búsqueda. |
TermSearchResultValue
Contexto.
Nombre | Tipo | Description |
---|---|---|
glossaryName |
string |
Nombre del glosario que contiene el término . |
guid |
string |
GUID del término. |
name |
string |
Nombre del término. |