Discovery - Query
Obter dados usando a pesquisa.
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
|
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
Corpo da solicitação
Nome | Tipo | Description |
---|---|---|
continuationToken |
string |
O token usado para obter o próximo lote de dados. Padrão 'Null' para obter o primeiro lote e retornará um novo token em cada resposta, a menos que não haja mais dados. |
facets |
As facetas para pesquisa. Consulte exemplos para o uso de facetas com suporte. |
|
filter |
O filtro para a pesquisa. Veja exemplos para o uso de filtros com suporte. |
|
keywords |
string |
As palavras-chave aplicadas a todos os campos pesquisáveis. |
limit |
integer |
O limite do número do resultado da pesquisa. o valor padrão é 50; o valor máximo é 1000. |
orderby |
Orderby[] |
A ordem de classificação dos resultados da pesquisa pode especificar vários campos. |
taxonomySetting |
A configuração de taxonomia para pesquisa. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
A solicitação foi bem-sucedida. |
|
Other Status Codes |
Uma resposta de erro inesperada. |
Segurança
OAuth2Auth
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome | Description |
---|---|
https://purview.azure.net/.default |
Exemplos
Discovery_Query
Solicitação de exemplo
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"
}
}
]
}
Resposta de exemplo
{
"@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
Solicitação de exemplo
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"
}
]
}
}
Resposta de exemplo
{
"@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
Solicitação de exemplo
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://"
}
]
}
]
}
}
Resposta de exemplo
{
"@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
Solicitação de exemplo
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"
}
]
}
}
Resposta de exemplo
{
"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
Solicitação de exemplo
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"
}
]
}
}
Resposta de exemplo
{
"@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
Solicitação de exemplo
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"
}
]
}
}
Resposta de exemplo
{
"@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
Solicitação de exemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"classification": "MICROSOFT.PERSONAL.EMAIL",
"includeSubClassifications": true
}
}
Resposta de exemplo
{
"@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
Solicitação de exemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"collectionId": "collectionName"
}
}
Resposta de exemplo
{
"@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
Solicitação de exemplo
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
}
]
}
Resposta de exemplo
{
"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
Solicitação de exemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"and": [
{
"fileExtension": "txt"
}
]
}
}
Resposta de exemplo
{
"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
Solicitação de exemplo
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"
}
}
]
}
Resposta de exemplo
{
"@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
Solicitação de exemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"and": [
{
"id": "bfecbcc3-1838-45fe-96d6-112de8a170f9"
}
]
}
}
Resposta de exemplo
{
"@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
Solicitação de exemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"not": {
"classification": "MICROSOFT.SYSTEM.TEMP_FILE"
}
}
}
Resposta de exemplo
{
"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
Solicitação de exemplo
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"
}
]
}
}
Resposta de exemplo
{
"@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
Solicitação de exemplo
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"
}
}
]
}
Resposta de exemplo
{
"@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
Solicitação de exemplo
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"
}
}
]
}
Resposta de exemplo
{
"@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
Solicitação de exemplo
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"
}
}
]
}
Resposta de exemplo
{
"@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
Solicitação de exemplo
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"
}
]
}
}
Resposta de exemplo
{
"@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
Solicitação de exemplo
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"
}
}
}
}
Resposta de exemplo
{
"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
Solicitação de exemplo
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>"
}
]
}
}
Resposta de exemplo
{
"@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
Solicitação de exemplo
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"and": [
{
"entityType": "azure_blob_path",
"includeSubTypes": false
}
]
}
}
Resposta de exemplo
{
"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": []
}
]
}
Definições
Nome | Description |
---|---|
Atlas |
Uma resposta de erro do serviço |
Contact |
O contato na pesquisa e sugerem o resultado. |
Query |
A consulta de pesquisa da solicitação de pesquisa avançada. |
Query |
O resultado do resultado da pesquisa. |
Search |
O conteúdo de um item de resultado de faceta de pesquisa. |
Search |
O conteúdo de um item de resultado de faceta de pesquisa. |
Search |
Uma lista de facetas que consiste em campos de índice assetType , classification, contactId e label. Quando a faceta é especificada na solicitação, o valor da faceta é retornado como um elemento de @search.facets. |
Search |
Os critérios de classificação |
Search |
Uma lista de destaques que consiste na ID dos campos de índice , qualifiedName, name, description, entityType. Quando o palavra-chave aparece nesses campos, o valor do campo, anexado com marca de ênfase, é retornado como um elemento de @search.highlights. |
Search |
O item de valor do resultado da pesquisa. |
Search |
Ordem de classificação de pesquisa |
Search |
Configuração de taxonomia para solicitação de pesquisa |
Term |
O contexto. |
AtlasErrorResponse
Uma resposta de erro do serviço
Nome | Tipo | Description |
---|---|---|
errorCode |
string |
O código de erro. |
errorMessage |
string |
A mensagem de erro. |
requestId |
string |
A ID da solicitação. |
ContactSearchResultValue
O contato na pesquisa e sugerem o resultado.
Nome | Tipo | Description |
---|---|---|
contactType |
string |
O tipo do contato. Ele pode ser Especialista ou Proprietário de uma entidade. Pode ser Expert ou Steward para um termo glossário. |
id |
string |
O GUID do contato. |
info |
string |
A descrição do contato. |
QueryOptions
A consulta de pesquisa da solicitação de pesquisa avançada.
Nome | Tipo | Description |
---|---|---|
continuationToken |
string |
O token usado para obter o próximo lote de dados. Padrão 'Null' para obter o primeiro lote e retornará um novo token em cada resposta, a menos que não haja mais dados. |
facets |
As facetas para pesquisa. Confira exemplos para o uso de facetas com suporte. |
|
filter |
O filtro para a pesquisa. Consulte exemplos para o uso de filtros com suporte. |
|
keywords |
string |
As palavras-chave aplicadas a todos os campos pesquisáveis. |
limit |
integer |
O limite do número do resultado da pesquisa. o valor padrão é 50; o valor máximo é 1000. |
orderby |
Orderby[] |
A ordem de classificação dos resultados da pesquisa pode especificar vários campos. |
taxonomySetting |
A configuração de taxonomia para pesquisa. |
QueryResult
O resultado do resultado da pesquisa.
Nome | Tipo | Description |
---|---|---|
@search.count |
integer |
O número total de resultados da pesquisa (não o número de documentos em uma única página). |
@search.count.approximate |
boolean |
'True' se '@search.count' for um valor aproximado e vise versa. |
@search.facets |
Uma lista de facetas que consiste em campos de índice assetType , classification, contactId e label. Quando a faceta é especificada na solicitação, o valor da faceta é retornado como um elemento de @search.facets. |
|
continuationToken |
string |
O token usado para obter o próximo lote de dados. Ausente se não houver mais dados. |
value |
Valor do resultado da pesquisa |
SearchFacetItem
O conteúdo de um item de resultado de faceta de pesquisa.
Nome | Tipo | Description |
---|---|---|
count |
integer |
A contagem do item de faceta. |
facet |
string |
O nome do item de faceta. |
sort |
Definir os critérios de classificação para itens |
SearchFacetItemValue
O conteúdo de um item de resultado de faceta de pesquisa.
Nome | Tipo | Description |
---|---|---|
count |
integer |
A contagem do item de faceta. |
value |
string |
O nome do item de faceta. |
SearchFacetResultValue
Uma lista de facetas que consiste em campos de índice assetType , classification, contactId e label. Quando a faceta é especificada na solicitação, o valor da faceta é retornado como um elemento de @search.facets.
Nome | Tipo | Description |
---|---|---|
assetType |
Tipo de ativo |
|
classification |
classificação |
|
contactId |
ID de contato |
|
contactType |
Tipo de contato |
|
entityType |
Tipo de entidade |
|
glossaryType |
Tipo de glossário |
|
label |
Rótulo |
|
term |
Termo |
|
termStatus |
Termos status |
|
termTemplate |
Modelo de termo |
SearchFacetSort
Os critérios de classificação
Nome | Tipo | Description |
---|---|---|
count |
Ordenar por contagem |
|
value |
Ordem por valor |
SearchHighlights
Uma lista de destaques que consiste na ID dos campos de índice , qualifiedName, name, description, entityType. Quando o palavra-chave aparece nesses campos, o valor do campo, anexado com marca de ênfase, é retornado como um elemento de @search.highlights.
Nome | Tipo | Description |
---|---|---|
description |
string[] |
Descrição |
entityType |
string[] |
Tipo de entidade |
id |
string[] |
Id |
name |
string[] |
Nome |
qualifiedName |
string[] |
Nome qualificado |
SearchResultValue
O item de valor do resultado da pesquisa.
Nome | Tipo | Description |
---|---|---|
@search.highlights |
Uma lista de destaques que consiste na ID dos campos de índice , qualifiedName, name, description, entityType. Quando o palavra-chave aparece nesses campos, o valor do campo, anexado com marca de ênfase, é retornado como um elemento de @search.highlights. |
|
@search.score |
number |
A pontuação de pesquisa calculada pelo mecanismo de pesquisa. Os resultados são ordenados por pontuação de pesquisa por padrão. |
assetType |
string[] |
Os tipos de ativo do ativo. |
classification |
string[] |
As classificações do registro. |
contact |
Os contatos do ativo. |
|
createTime |
integer |
A hora de criação do registro. O formato de época do Unix. |
description |
string |
A descrição do ativo. |
endorsement |
string |
O endosso do ativo. |
entityType |
string |
O nome do tipo do ativo. |
glossary |
string |
O nome do glossário do termo. |
glossaryType |
string |
O nome do tipo do termo. Pode ser AtlasGlossary, AtlasGlossaryTerm ou AtlasGlossaryCategory. |
id |
string |
O GUID do registro. |
label |
string[] |
Os rótulos do ativo. |
longDescription |
string |
A definição do termo. |
name |
string |
O nome do registro. |
objectType |
string |
O tipo de objeto do registro. O tipo de objeto é a propriedade de nível superior para distinguir se um registro é um ativo ou um termo. |
owner |
string |
O proprietário do registro. |
qualifiedName |
string |
O nome qualificado do registro. |
term |
Os termos atribuídos ao ativo. |
|
termStatus |
string |
O status do termo. |
termTemplate |
string[] |
Os nomes de modelo de termo usados pelo termo. |
updateTime |
integer |
A última hora de atualização do registro. O formato de época do Unix. |
SearchSortOrder
Ordem de classificação de pesquisa
Nome | Tipo | Description |
---|---|---|
asc |
string |
Usar ordem crescente para classificação |
desc |
string |
Usar ordem decrescente para classificação |
SearchTaxonomySetting
Configuração de taxonomia para solicitação de pesquisa
Nome | Tipo | Description |
---|---|---|
assetTypes |
string[] |
Tipos de ativo |
facet |
O conteúdo de um item de resultado de faceta de pesquisa. |
TermSearchResultValue
O contexto.
Nome | Tipo | Description |
---|---|---|
glossaryName |
string |
O nome do glossário que contém o termo . |
guid |
string |
O GUID do termo. |
name |
string |
O nome do termo. |