Discovery - Query
Abrufen von Daten mithilfe der Suche.
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
endpoint
|
path | True |
string |
|
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
continuationToken |
string |
Das Token, das zum Abrufen des nächsten Datenbatches verwendet wird. Der Standardwert "Null" zum Abrufen des ersten Batches und gibt in jeder Antwort ein neues Token zurück, es sei denn, es sind keine weiteren Daten vorhanden. |
facets |
Die Facetten für die Suche. Hier finden Sie Beispiele für die Verwendung unterstützter Facetten. |
|
filter |
Der Filter für die Suche. Siehe Beispiele für die Verwendung unterstützter Filter. |
|
keywords |
string |
Die Schlüsselwörter, die auf alle durchsuchbaren Felder angewendet werden. |
limit |
integer |
Der Grenzwert für die Anzahl des Suchergebnisses. Der Standardwert ist 50; Der Höchstwert ist 1000. |
orderby |
Orderby[] |
Die Sortierreihenfolge von Suchergebnissen kann mehrere Felder angeben. |
taxonomySetting |
Die Taxonomieeinstellung für die Suche. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Die Anforderung war erfolgreich. |
|
Other Status Codes |
Eine unerwartete Fehlerantwort. |
Sicherheit
OAuth2Auth
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
https://purview.azure.net/.default |
Beispiele
Discovery_Query
Beispielanforderung
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"
}
}
]
}
Beispiel für eine Antwort
{
"@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
Beispielanforderung
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"
}
]
}
}
Beispiel für eine Antwort
{
"@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
Beispielanforderung
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://"
}
]
}
]
}
}
Beispiel für eine Antwort
{
"@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
Beispielanforderung
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"
}
]
}
}
Beispiel für eine Antwort
{
"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
Beispielanforderung
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"
}
]
}
}
Beispiel für eine Antwort
{
"@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
Beispielanforderung
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"
}
]
}
}
Beispiel für eine Antwort
{
"@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
Beispielanforderung
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"classification": "MICROSOFT.PERSONAL.EMAIL",
"includeSubClassifications": true
}
}
Beispiel für eine Antwort
{
"@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
Beispielanforderung
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"collectionId": "collectionName"
}
}
Beispiel für eine Antwort
{
"@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
Beispielanforderung
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
}
]
}
Beispiel für eine Antwort
{
"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
Beispielanforderung
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"and": [
{
"fileExtension": "txt"
}
]
}
}
Beispiel für eine Antwort
{
"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
Beispielanforderung
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"
}
}
]
}
Beispiel für eine Antwort
{
"@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
Beispielanforderung
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"and": [
{
"id": "bfecbcc3-1838-45fe-96d6-112de8a170f9"
}
]
}
}
Beispiel für eine Antwort
{
"@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
Beispielanforderung
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"not": {
"classification": "MICROSOFT.SYSTEM.TEMP_FILE"
}
}
}
Beispiel für eine Antwort
{
"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
Beispielanforderung
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"
}
]
}
}
Beispiel für eine Antwort
{
"@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
Beispielanforderung
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"
}
}
]
}
Beispiel für eine Antwort
{
"@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
Beispielanforderung
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"
}
}
]
}
Beispiel für eine Antwort
{
"@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
Beispielanforderung
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"
}
}
]
}
Beispiel für eine Antwort
{
"@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
Beispielanforderung
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"
}
]
}
}
Beispiel für eine Antwort
{
"@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
Beispielanforderung
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"
}
}
}
}
Beispiel für eine Antwort
{
"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
Beispielanforderung
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>"
}
]
}
}
Beispiel für eine Antwort
{
"@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
Beispielanforderung
POST {endpoint}/datamap/api/search/query?api-version=2023-09-01
{
"keywords": null,
"limit": 10,
"filter": {
"and": [
{
"entityType": "azure_blob_path",
"includeSubTypes": false
}
]
}
}
Beispiel für eine Antwort
{
"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": []
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Atlas |
Eine Fehlerantwort des Diensts |
Contact |
Der Kontakt im Such- und Vorschlagsergebnis. |
Query |
Die Suchabfrage der erweiterten Suchanforderung. |
Query |
Das Ergebnis des Suchergebnisses. |
Search |
Der Inhalt eines Suchfacet-Ergebniselements. |
Search |
Der Inhalt eines Suchfacet-Ergebniselements. |
Search |
Eine Facettenliste, die aus Indexfeldern assetType, classification, contactId und label besteht. Wenn das Facet in der Anforderung angegeben wird, wird der Wert des Facets als Element von @search.facetszurückgegeben. |
Search |
Die Sortierkriterien |
Search |
Eine Hervorhebungsliste, die aus Indexfeldern id, qualifiedName, name, description, entityType besteht. Wenn die Schlüsselwort (keyword) in diesen Feldern angezeigt wird, wird der Wert des Felds, der mit einer Hervorhebungsmarkierung angefügt ist, als Element von @search.highlightszurückgegeben. |
Search |
Das Wertelement des Suchergebnisses. |
Search |
Sortierreihenfolge suchen |
Search |
Taxonomieeinstellung für Die Suchanforderung |
Term |
Der Kontext. |
AtlasErrorResponse
Eine Fehlerantwort des Diensts
Name | Typ | Beschreibung |
---|---|---|
errorCode |
string |
Der Fehlercode. |
errorMessage |
string |
Die Fehlermeldung. |
requestId |
string |
Die Anforderungs-ID. |
ContactSearchResultValue
Der Kontakt im Such- und Vorschlagsergebnis.
Name | Typ | Beschreibung |
---|---|---|
contactType |
string |
Der Typ des Kontakts. Dabei kann es sich um einen Experten oder Einen Besitzer für eine Entität handeln. Es kann Expert oder Steward für einen Glossarbegriff sein. |
id |
string |
Die GUID des Kontakts. |
info |
string |
Die Beschreibung des Kontakts. |
QueryOptions
Die Suchabfrage der erweiterten Suchanforderung.
Name | Typ | Beschreibung |
---|---|---|
continuationToken |
string |
Das Token, das zum Abrufen des nächsten Datenbatches verwendet wird. Der Standardwert "Null" zum Abrufen des ersten Batches und gibt in jeder Antwort ein neues Token zurück, es sei denn, es sind keine weiteren Daten vorhanden. |
facets |
Die Facetten für die Suche. Hier finden Sie Beispiele für die Verwendung unterstützter Facetten. |
|
filter |
Der Filter für die Suche. Siehe Beispiele für die Verwendung unterstützter Filter. |
|
keywords |
string |
Die Schlüsselwörter, die auf alle durchsuchbaren Felder angewendet werden. |
limit |
integer |
Der Grenzwert für die Anzahl des Suchergebnisses. Der Standardwert ist 50; Der Höchstwert ist 1000. |
orderby |
Orderby[] |
Die Sortierreihenfolge von Suchergebnissen kann mehrere Felder angeben. |
taxonomySetting |
Die Taxonomieeinstellung für die Suche. |
QueryResult
Das Ergebnis des Suchergebnisses.
Name | Typ | Beschreibung |
---|---|---|
@search.count |
integer |
Die Gesamtzahl der Suchergebnisse (nicht die Anzahl der Dokumente auf einer einzelnen Seite). |
@search.count.approximate |
boolean |
"True", wenn "@search.count" ein ungefährer Wert ist und umgekehrt. |
@search.facets |
Eine Facettenliste, die aus Indexfeldern assetType, classification, contactId und label besteht. Wenn das Facet in der Anforderung angegeben wird, wird der Wert des Facets als Element von @search.facetszurückgegeben. |
|
continuationToken |
string |
Das Token, das zum Abrufen des nächsten Datenbatches verwendet wird. Fehlt, wenn keine weiteren Daten vorhanden sind. |
value |
Suchergebniswert |
SearchFacetItem
Der Inhalt eines Suchfacet-Ergebniselements.
Name | Typ | Beschreibung |
---|---|---|
count |
integer |
Die Anzahl des Facettenelements. |
facet |
string |
Der Name des Facetelements. |
sort |
Definieren der Sortierkriterien für Elemente |
SearchFacetItemValue
Der Inhalt eines Suchfacet-Ergebniselements.
Name | Typ | Beschreibung |
---|---|---|
count |
integer |
Die Anzahl des Facettenelements. |
value |
string |
Der Name des Facetelements. |
SearchFacetResultValue
Eine Facettenliste, die aus Indexfeldern assetType, classification, contactId und label besteht. Wenn das Facet in der Anforderung angegeben wird, wird der Wert des Facets als Element von @search.facetszurückgegeben.
Name | Typ | Beschreibung |
---|---|---|
assetType |
Ressourcentyp |
|
classification |
Klassifizierung |
|
contactId |
Kontakt-ID |
|
contactType |
Kontakttyp |
|
entityType |
Entitätstyp |
|
glossaryType |
Glossartyp |
|
label |
Bezeichnung |
|
term |
Begriff |
|
termStatus |
Begriffs-status |
|
termTemplate |
Begriffsvorlage |
SearchFacetSort
Die Sortierkriterien
Name | Typ | Beschreibung |
---|---|---|
count |
Reihenfolge nach Anzahl |
|
value |
Reihenfolge nach Wert |
SearchHighlights
Eine Hervorhebungsliste, die aus Indexfeldern id, qualifiedName, name, description, entityType besteht. Wenn die Schlüsselwort (keyword) in diesen Feldern angezeigt wird, wird der Wert des Felds, der mit einer Hervorhebungsmarkierung angefügt ist, als Element von @search.highlightszurückgegeben.
Name | Typ | Beschreibung |
---|---|---|
description |
string[] |
BESCHREIBUNG |
entityType |
string[] |
Entitätstyp |
id |
string[] |
Id |
name |
string[] |
Name |
qualifiedName |
string[] |
Qualifizierter Name |
SearchResultValue
Das Wertelement des Suchergebnisses.
Name | Typ | Beschreibung |
---|---|---|
@search.highlights |
Eine Hervorhebungsliste, die aus Indexfeldern id, qualifiedName, name, description, entityType besteht. Wenn die Schlüsselwort (keyword) in diesen Feldern angezeigt wird, wird der Wert des Felds, der mit einer Hervorhebungsmarkierung angefügt ist, als Element von @search.highlightszurückgegeben. |
|
@search.score |
number |
Die von der Suchmaschine berechnete Suchbewertung. Die Ergebnisse werden standardmäßig nach Suchergebnis sortiert. |
assetType |
string[] |
Die Ressourcentypen des Medienobjekts. |
classification |
string[] |
Die Klassifizierungen des Datensatzes. |
contact |
Die Kontakte des Medienobjekts. |
|
createTime |
integer |
Die Erstellungszeit des Datensatzes. Das Unix-Epochenformat. |
description |
string |
Die Beschreibung des Medienobjekts. |
endorsement |
string |
Die Billigung des Vermögenswerts. |
entityType |
string |
Der Typname des Medienobjekts. |
glossary |
string |
Der Glossarname des Begriffs. |
glossaryType |
string |
Der Typname des Begriffs. Könnte AtlasGlossary, AtlasGlossaryTerm oder AtlasGlossaryCategory sein. |
id |
string |
Die GUID des Datensatzes. |
label |
string[] |
Die Bezeichnungen des Medienobjekts. |
longDescription |
string |
Die Definition des Begriffs. |
name |
string |
Der Name des Datensatzes. |
objectType |
string |
Der Objekttyp des Datensatzes. Der Objekttyp ist die Eigenschaft der obersten Ebene, um zu unterscheiden, ob ein Datensatz ein Medienobjekt oder ein Begriff ist. |
owner |
string |
Der Besitzer des Datensatzes. |
qualifiedName |
string |
Der qualifizierte Name des Datensatzes. |
term |
Die dem Medienobjekt zugewiesenen Begriffe. |
|
termStatus |
string |
Die status des Begriffs. |
termTemplate |
string[] |
Der begriffsvorlagennamen, der vom Begriff verwendet wird. |
updateTime |
integer |
Der Zeitpunkt der letzten Aktualisierung des Datensatzes. Das Unix-Epochenformat. |
SearchSortOrder
Sortierreihenfolge suchen
Name | Typ | Beschreibung |
---|---|---|
asc |
string |
Aufsteigende Reihenfolge zum Sortieren verwenden |
desc |
string |
Absteigende Reihenfolge zum Sortieren verwenden |
SearchTaxonomySetting
Taxonomieeinstellung für Die Suchanforderung
Name | Typ | Beschreibung |
---|---|---|
assetTypes |
string[] |
Ressourcentypen |
facet |
Der Inhalt eines Suchfacet-Ergebniselements. |
TermSearchResultValue
Der Kontext.
Name | Typ | Beschreibung |
---|---|---|
glossaryName |
string |
Der Name des Glossars, das den Begriff enthält. |
guid |
string |
Die GUID des Begriffs. |
name |
string |
Der Name des Begriffs. |