Discovery - Query
Obtenir des données à l’aide de la recherche.
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
|
api-version
|
query | True |
string |
Version de l’API à utiliser pour cette opération. |
Corps de la demande
Nom | Type | Description |
---|---|---|
continuationToken |
string |
Jeton utilisé pour obtenir le lot suivant de données. Valeur par défaut « Null » pour obtenir le premier lot, et retourne un nouveau jeton dans chaque réponse, sauf s’il n’y a plus de données. |
facets |
Facettes de la recherche. Consultez des exemples d’utilisation des facettes prises en charge. |
|
filter |
Filtre de la recherche. Consultez des exemples d’utilisation des filtres pris en charge. |
|
keywords |
string |
Mots clés appliqués à tous les champs pouvant faire l’objet d’une recherche. |
limit |
integer |
Limite du nombre de résultats de la recherche. la valeur par défaut est 50 ; la valeur maximale est 1 000. |
orderby |
Orderby[] |
L’ordre de tri des résultats de la recherche, peut spécifier plusieurs champs. |
taxonomySetting |
Paramètre de taxonomie pour la recherche. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
La demande a réussi. |
|
Other Status Codes |
Réponse d’erreur inattendue. |
Sécurité
OAuth2Auth
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
https://purview.azure.net/.default |
Exemples
Discovery_Query
Exemple de requête
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"
}
}
]
}
Exemple de réponse
{
"@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
Exemple de requête
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"
}
]
}
}
Exemple de réponse
{
"@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
Exemple de requête
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://"
}
]
}
]
}
}
Exemple de réponse
{
"@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
Exemple de requête
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"
}
]
}
}
Exemple de réponse
{
"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
Exemple de requête
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"
}
]
}
}
Exemple de réponse
{
"@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
Exemple de requête
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"
}
]
}
}
Exemple de réponse
{
"@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
Exemple de requête
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"classification": "MICROSOFT.PERSONAL.EMAIL",
"includeSubClassifications": true
}
}
Exemple de réponse
{
"@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
Exemple de requête
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"collectionId": "collectionName"
}
}
Exemple de réponse
{
"@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
Exemple de requête
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
}
]
}
Exemple de réponse
{
"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
Exemple de requête
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"and": [
{
"fileExtension": "txt"
}
]
}
}
Exemple de réponse
{
"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
Exemple de requête
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"
}
}
]
}
Exemple de réponse
{
"@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
Exemple de requête
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"and": [
{
"id": "bfecbcc3-1838-45fe-96d6-112de8a170f9"
}
]
}
}
Exemple de réponse
{
"@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
Exemple de requête
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"not": {
"classification": "MICROSOFT.SYSTEM.TEMP_FILE"
}
}
}
Exemple de réponse
{
"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
Exemple de requête
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"
}
]
}
}
Exemple de réponse
{
"@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
Exemple de requête
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"
}
}
]
}
Exemple de réponse
{
"@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
Exemple de requête
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"
}
}
]
}
Exemple de réponse
{
"@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
Exemple de requête
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"
}
}
]
}
Exemple de réponse
{
"@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
Exemple de requête
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"
}
]
}
}
Exemple de réponse
{
"@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
Exemple de requête
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"
}
}
}
}
Exemple de réponse
{
"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
Exemple de requête
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>"
}
]
}
}
Exemple de réponse
{
"@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
Exemple de requête
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"and": [
{
"entityType": "azure_blob_path",
"includeSubTypes": false
}
]
}
}
Exemple de réponse
{
"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": []
}
]
}
Définitions
Nom | Description |
---|---|
Atlas |
Réponse d’erreur du service |
Contact |
Contact dans le résultat de la recherche et de la suggestion. |
Query |
Requête de recherche de la demande de recherche avancée. |
Query |
Résultat du résultat de la recherche. |
Search |
Contenu d’un élément de résultat de la facette de recherche. |
Search |
Contenu d’un élément de résultat de la facette de recherche. |
Search |
Liste de facettes qui se compose des champs d’index assetType, classification, contactId et label. Lorsque la facette est spécifiée dans la requête, la valeur de la facette est retournée en tant qu’élément de @search.facets. |
Search |
Critères de tri |
Search |
Liste en surbrillance qui se compose de champs d’index id ,qualifiedName, name, description, entityType. Lorsque le mot clé apparaît dans ces champs, la valeur du champ, attachée avec la marque d’accentuation, est retournée en tant qu’élément de @search.highlights. |
Search |
Élément de valeur du résultat de la recherche. |
Search |
Ordre de tri de recherche |
Search |
Paramètre de taxonomie pour la demande de recherche |
Term |
Contexte. |
AtlasErrorResponse
Réponse d’erreur du service
Nom | Type | Description |
---|---|---|
errorCode |
string |
Code d'erreur. |
errorMessage |
string |
Message d’erreur. |
requestId |
string |
ID de demande. |
ContactSearchResultValue
Contact dans le résultat de la recherche et de la suggestion.
Nom | Type | Description |
---|---|---|
contactType |
string |
Type du contact. Il peut s’agir d’un expert ou d’un propriétaire pour une entité. Il peut être Expert ou Steward pour un terme de glossaire. |
id |
string |
GUID du contact. |
info |
string |
Description du contact. |
QueryOptions
Requête de recherche de la demande de recherche avancée.
Nom | Type | Description |
---|---|---|
continuationToken |
string |
Jeton utilisé pour obtenir le lot suivant de données. Par défaut« Null » pour obtenir le premier lot, et retourne un nouveau jeton dans chaque réponse, sauf s’il n’y a plus de données. |
facets |
Facettes de la recherche. Consultez des exemples d’utilisation des facettes prises en charge. |
|
filter |
Filtre de la recherche. Consultez des exemples d’utilisation des filtres pris en charge. |
|
keywords |
string |
Mots clés appliqués à tous les champs pouvant faire l’objet d’une recherche. |
limit |
integer |
Limite du nombre de résultats de la recherche. la valeur par défaut est 50 ; la valeur maximale est 1000. |
orderby |
Orderby[] |
L’ordre de tri des résultats de la recherche peut spécifier plusieurs champs. |
taxonomySetting |
Paramètre de taxonomie pour la recherche. |
QueryResult
Résultat du résultat de la recherche.
Nom | Type | Description |
---|---|---|
@search.count |
integer |
Nombre total de résultats de recherche (et non le nombre de documents dans une seule page). |
@search.count.approximate |
boolean |
'True' si '@search.count' est une valeur approximative et vice versa. |
@search.facets |
Liste de facettes qui se compose des champs d’index assetType, classification, contactId et label. Lorsque la facette est spécifiée dans la requête, la valeur de la facette est retournée en tant qu’élément de @search.facets. |
|
continuationToken |
string |
Jeton utilisé pour obtenir le lot suivant de données. Absent s’il n’y a plus de données. |
value |
Valeur du résultat de recherche |
SearchFacetItem
Contenu d’un élément de résultat de la facette de recherche.
Nom | Type | Description |
---|---|---|
count |
integer |
Nombre de l’élément de facette. |
facet |
string |
Nom de l’élément de facette. |
sort |
Définir les critères de tri pour les éléments |
SearchFacetItemValue
Contenu d’un élément de résultat de la facette de recherche.
Nom | Type | Description |
---|---|---|
count |
integer |
Nombre de l’élément de facette. |
value |
string |
Nom de l’élément de facette. |
SearchFacetResultValue
Liste de facettes qui se compose des champs d’index assetType, classification, contactId et label. Lorsque la facette est spécifiée dans la requête, la valeur de la facette est retournée en tant qu’élément de @search.facets.
Nom | Type | Description |
---|---|---|
assetType |
Type de ressource |
|
classification |
classification ; |
|
contactId |
ID de contact |
|
contactType |
Type de contact |
|
entityType |
Type d'entité |
|
glossaryType |
Type de glossaire |
|
label |
Étiquette |
|
term |
Terme |
|
termStatus |
Status terme |
|
termTemplate |
Modèle de terme |
SearchFacetSort
Critères de tri
Nom | Type | Description |
---|---|---|
count |
Classer par nombre |
|
value |
Ordre par valeur |
SearchHighlights
Liste en surbrillance qui se compose de champs d’index id ,qualifiedName, name, description, entityType. Lorsque le mot clé apparaît dans ces champs, la valeur du champ, attachée avec la marque d’accentuation, est retournée en tant qu’élément de @search.highlights.
Nom | Type | Description |
---|---|---|
description |
string[] |
Description |
entityType |
string[] |
Type d'entité |
id |
string[] |
Id |
name |
string[] |
Nom |
qualifiedName |
string[] |
Nom qualifié |
SearchResultValue
Élément de valeur du résultat de la recherche.
Nom | Type | Description |
---|---|---|
@search.highlights |
Liste en surbrillance qui se compose de champs d’index id ,qualifiedName, name, description, entityType. Lorsque le mot clé apparaît dans ces champs, la valeur du champ, attachée avec la marque d’accentuation, est retournée en tant qu’élément de @search.highlights. |
|
@search.score |
number |
Score de recherche calculé par le moteur de recherche. Les résultats sont classés par défaut par score de recherche. |
assetType |
string[] |
Types de ressources de la ressource. |
classification |
string[] |
Classifications de l’enregistrement. |
contact |
Contacts de la ressource. |
|
createTime |
integer |
Heure de création de l’enregistrement. Format d’époque Unix. |
description |
string |
Description de la ressource. |
endorsement |
string |
Approbation de la ressource. |
entityType |
string |
Nom de type de la ressource. |
glossary |
string |
Nom du glossaire du terme. |
glossaryType |
string |
Nom de type du terme. Peut être AtlasGlossary, AtlasGlossaryTerm ou AtlasGlossaryCategory. |
id |
string |
GUID de l’enregistrement. |
label |
string[] |
Étiquettes de la ressource. |
longDescription |
string |
Définition du terme. |
name |
string |
Nom de l'enregistrement. |
objectType |
string |
Type d’objet de l’enregistrement. Le type d’objet est la propriété de niveau supérieur permettant de distinguer si un enregistrement est une ressource ou un terme. |
owner |
string |
Propriétaire de l’enregistrement. |
qualifiedName |
string |
Nom qualifié de l’enregistrement. |
term |
Termes attribués à la ressource. |
|
termStatus |
string |
Status du terme. |
termTemplate |
string[] |
Noms de modèles de termes utilisés par le terme. |
updateTime |
integer |
Heure de la dernière mise à jour de l’enregistrement. Format d’époque Unix. |
SearchSortOrder
Ordre de tri de recherche
Nom | Type | Description |
---|---|---|
asc |
string |
Utiliser l’ordre croissant pour le tri |
desc |
string |
Utiliser l’ordre décroissant pour le tri |
SearchTaxonomySetting
Paramètre de taxonomie pour la demande de recherche
Nom | Type | Description |
---|---|---|
assetTypes |
string[] |
Types de ressources |
facet |
Contenu d’un élément de résultat de la facette de recherche. |
TermSearchResultValue
Contexte.
Nom | Type | Description |
---|---|---|
glossaryName |
string |
Nom du glossaire qui contient le terme. |
guid |
string |
GUID du terme. |
name |
string |
Nom du terme. |