共用方式為

Discovery - Query

  • 參考
服務:
Purview
API 版本:
2023-09-01

使用搜尋取得數據。

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

URI 參數

名稱 位於 必要 類型 Description
endpoint
 path True

string (uri)

api-version
 query True

string

minLength: 1

要用於這項作業的 API 版本。

要求本文

名稱 類型 Description
continuationToken

string

用來取得下一批數據的令牌。 默認為 『Null』 以取得第一個批次，而且會在每個響應中傳回新的令牌，除非沒有其他數據。
facets

SearchFacetItem[]

搜尋的 Facet。 如需支援Facet的使用方式，請參閱範例。
filter

搜尋的篩選條件。 如需使用支持的篩選條件，請參閱範例。
keywords

string

套用至所有可搜尋欄位的關鍵詞。
limit

integer (int32)

搜尋結果數目的限制。 預設值為 50;最大值為 1000。
orderby

Orderby[]

搜尋結果的排序順序可以指定多個字段。
taxonomySetting

SearchTaxonomySetting

搜尋的分類設定。

回應

名稱 類型 Description
200 OK

QueryResult

要求已成功。
Other Status Codes

AtlasErrorResponse

未預期的錯誤回應。

安全性

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
https://purview.azure.net/.default

範例

Discovery_Query
Discovery_Query_And
Discovery_Query_AndOrNested
Discovery_Query_AssetType
Discovery_Query_Attribute
Discovery_Query_BusinessMetadataAttribute
Discovery_Query_Classification
Discovery_Query_Collection
Discovery_Query_Facet
Discovery_Query_FileExtension
Discovery_Query_GlossaryTerm
Discovery_Query_Id
Discovery_Query_Not
Discovery_Query_ObjectType
Discovery_Query_PaginationContinuationPage
Discovery_Query_PaginationFirstPage
Discovery_Query_PaginationLastPage
Discovery_Query_SystemTime
Discovery_Query_Taxonomy
Discovery_Query_TermAssignment
Discovery_Query_Type

Discovery_Query

範例要求

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"
      }
    }
  ]
}

範例回覆

狀態碼:
200 
{
  "@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

範例要求

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"
      }
    ]
  }
}

範例回覆

狀態碼:
200 
{
  "@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

範例要求

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://"
          }
        ]
      }
    ]
  }
}

範例回覆

狀態碼:
200 
{
  "@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

範例要求

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"
      }
    ]
  }
}

範例回覆

狀態碼:
200 
{
  "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

範例要求

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"
      }
    ]
  }
}

範例回覆

狀態碼:
200 
{
  "@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

範例要求

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"
      }
    ]
  }
}

範例回覆

狀態碼:
200 
{
  "@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

範例要求

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "limit": 10,
  "filter": {
    "classification": "MICROSOFT.PERSONAL.EMAIL",
    "includeSubClassifications": true
  }
}

範例回覆

狀態碼:
200 
{
  "@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

範例要求

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "limit": 10,
  "filter": {
    "collectionId": "collectionName"
  }
}

範例回覆

狀態碼:
200 
{
  "@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

範例要求

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
    }
  ]
}

範例回覆

狀態碼:
200 
{
  "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

範例要求

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "limit": 10,
  "filter": {
    "and": [
      {
        "fileExtension": "txt"
      }
    ]
  }
}

範例回覆

狀態碼:
200 
{
  "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

範例要求

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"
      }
    }
  ]
}

範例回覆

狀態碼:
200 
{
  "@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

範例要求

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "limit": 10,
  "filter": {
    "and": [
      {
        "id": "bfecbcc3-1838-45fe-96d6-112de8a170f9"
      }
    ]
  }
}

範例回覆

狀態碼:
200 
{
  "@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

範例要求

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "limit": 10,
  "filter": {
    "not": {
      "classification": "MICROSOFT.SYSTEM.TEMP_FILE"
    }
  }
}

範例回覆

狀態碼:
200 
{
  "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

範例要求

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"
      }
    ]
  }
}

範例回覆

狀態碼:
200 
{
  "@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

範例要求

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"
      }
    }
  ]
}

範例回覆

狀態碼:
200 
{
  "@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

範例要求

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"
      }
    }
  ]
}

範例回覆

狀態碼:
200 
{
  "@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

範例要求

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"
      }
    }
  ]
}

範例回覆

狀態碼:
200 
{
  "@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

範例要求

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"
      }
    ]
  }
}

範例回覆

狀態碼:
200 
{
  "@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

範例要求

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"
      }
    }
  }
}

範例回覆

狀態碼:
200 
{
  "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

範例要求

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>"
      }
    ]
  }
}

範例回覆

狀態碼:
200 
{
  "@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

範例要求

POST {endpoint}/datamap/api/search/query?api-version=2023-09-01

{
  "keywords": null,
  "limit": 10,
  "filter": {
    "and": [
      {
        "entityType": "azure_blob_path",
        "includeSubTypes": false
      }
    ]
  }
}

範例回覆

狀態碼:
200 
{
  "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": []
    }
  ]
}

定義

名稱 Description
AtlasErrorResponse

來自服務的錯誤回應
ContactSearchResultValue

搜尋中的聯繫人並建議結果。
QueryOptions

進階搜尋要求的搜尋查詢。
QueryResult

搜尋結果的結果。
SearchFacetItem

搜尋 Facet 結果項目的內容。
SearchFacetItemValue

搜尋 Facet 結果項目的內容。
SearchFacetResultValue

包含索引欄位 assetType、classification、contactId 和 label 的 Facet 清單。 在要求中指定facet時，會將facet的值當做 @search.facets的專案傳回。
SearchFacetSort

排序準則
SearchHighlights

醒目提示清單，包含索引字段標識符、qualifiedName、name、description、entityType。 當關鍵詞出現在這些欄位中時，以強調標記附加的欄位值會傳回為 @search.highlights的專案。
SearchResultValue

搜尋結果的值專案。
SearchSortOrder

搜尋排序順序
SearchTaxonomySetting

搜尋要求的分類設定
TermSearchResultValue

內容。

AtlasErrorResponse

Object

來自服務的錯誤回應

名稱 類型 Description
errorCode

string

錯誤碼。
errorMessage

string

錯誤訊息。
requestId

string (uuid)

要求標識碼。

ContactSearchResultValue

Object

搜尋中的聯繫人並建議結果。

名稱 類型 Description
contactType

string

聯繫人的類型。 它可以是實體的專家或擁有者。 它可以是詞彙專家或管家。
id

string

聯繫人的 GUID。
info

string

聯繫人的描述。

QueryOptions

Object

進階搜尋要求的搜尋查詢。

名稱 類型 Description
continuationToken

string

用來取得下一批數據的令牌。 默認為 『Null』 以取得第一個批次，而且會在每個響應中傳回新的令牌，除非沒有其他數據。
facets

SearchFacetItem[]

搜尋的 Facet。 如需支援Facet的使用方式，請參閱範例。
filter

搜尋的篩選條件。 如需使用支持的篩選條件，請參閱範例。
keywords

string

套用至所有可搜尋欄位的關鍵詞。
limit

integer (int32)

搜尋結果數目的限制。 預設值為 50;最大值為 1000。
orderby

Orderby[]

搜尋結果的排序順序可以指定多個字段。
taxonomySetting

SearchTaxonomySetting

搜尋的分類設定。

QueryResult

Object

搜尋結果的結果。

名稱 類型 Description
@search.count

integer (int32)

搜尋結果的總數（不是單一頁面中的檔數目）。
@search.count.approximate

boolean

如果 '@search.count' 是近似值，則為 'True'，反之亦然。
@search.facets

SearchFacetResultValue

包含索引欄位 assetType、classification、contactId 和 label 的 Facet 清單。 在要求中指定facet時，會將facet的值當做 @search.facets的專案傳回。
continuationToken

string

用來取得下一批數據的令牌。 如果沒有其他數據，則為缺席。
value

SearchResultValue[]

搜尋結果值

SearchFacetItem

Object

搜尋 Facet 結果項目的內容。

名稱 類型 Description
count

integer (int32)

Facet 專案的計數。
facet

string

Facet 項目的名稱。
sort

SearchFacetSort

定義專案的排序準則

SearchFacetItemValue

Object

搜尋 Facet 結果項目的內容。

名稱 類型 Description
count

integer (int32)

Facet 專案的計數。
value

string

Facet 項目的名稱。

SearchFacetResultValue

Object

包含索引欄位 assetType、classification、contactId 和 label 的 Facet 清單。 在要求中指定facet時，會將facet的值當做 @search.facets的專案傳回。

名稱 類型 Description
assetType

SearchFacetItemValue[]

資產類型
classification

SearchFacetItemValue[]

分類
contactId

SearchFacetItemValue[]

聯繫人標識碼
contactType

SearchFacetItemValue[]

連絡人類型
entityType

SearchFacetItemValue[]

實體類型
glossaryType

SearchFacetItemValue[]

詞彙類型
label

SearchFacetItemValue[]

標籤
term

SearchFacetItemValue[]

術語
termStatus

SearchFacetItemValue[]

字詞狀態
termTemplate

SearchFacetItemValue[]

字詞範本

SearchFacetSort

Object

排序準則

名稱 類型 Description
count

SearchSortOrder

依計數排序
value

SearchSortOrder

依值排序

SearchHighlights

Object

醒目提示清單，包含索引字段標識符、qualifiedName、name、description、entityType。 當關鍵詞出現在這些欄位中時，以強調標記附加的欄位值會傳回為 @search.highlights的專案。

名稱 類型 Description
description

string[]

描述
entityType

string[]

實體類型
id

string[]

標識碼
name

string[]

名字
qualifiedName

string[]

限定名稱

SearchResultValue

Object

搜尋結果的值專案。

名稱 類型 Description
@search.highlights

SearchHighlights

醒目提示清單，包含索引字段標識符、qualifiedName、name、description、entityType。 當關鍵詞出現在這些欄位中時，以強調標記附加的欄位值會傳回為 @search.highlights的專案。
@search.score

number (float)

搜尋引擎計算的搜尋分數。 結果預設會依搜尋分數排序。
assetType

string[]

資產的資產類型。
classification

string[]

記錄的分類。
contact

ContactSearchResultValue[]

資產的聯繫人。
createTime

integer (int64)

記錄的建立時間。 Unix epoch 格式。
description

string

資產的描述。
endorsement

string[]

資產的背書。
entityType

string

資產的類型名稱。
glossary

string

詞彙的詞彙名稱。
glossaryType

string

字詞的類型名稱。 可以是 AtlasGlossary、AtlasGlossaryTerm 或 AtlasGlossaryCategory。
id

string

記錄的 GUID。
label

string[]

資產的標籤。
longDescription

string

詞彙的定義。
name

string

記錄的名稱。
objectType

string

記錄的物件類型。 物件類型是最上層屬性，可區分記錄是資產還是字詞。
owner

string

記錄的擁有者。
qualifiedName

string

記錄的限定名稱。
term

TermSearchResultValue[]

指派給資產的詞彙。
termStatus

string

字詞的狀態。
termTemplate

string[]

字詞所使用的字詞範本名稱。
updateTime

integer (int64)

記錄的上次更新時間。 Unix epoch 格式。

SearchSortOrder

列舉型別

搜尋排序順序

值 Description
asc

使用遞增順序進行排序
desc

使用遞減順序進行排序

SearchTaxonomySetting

Object

搜尋要求的分類設定

名稱 類型 Description
assetTypes

string[]

資產類型
facet

SearchFacetItem

搜尋 Facet 結果項目的內容。

TermSearchResultValue

Object

內容。

名稱 類型 Description
glossaryName

string

包含字詞的詞彙名稱。
guid

string

詞彙的 GUID。
name

string

字詞的名稱。