swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Discovery API
schemes:
- https
tags:
- name: Discovery
paths:
  /search/query:
    post:
      tags:
      - Discovery
      description: Gets data using search.
      operationId: microsoftAzureDiscoveryQuery
      x-ms-examples:
        Discovery_Query:
          $ref: ./examples/Discovery_Query.json
        Discovery_Query_And:
          $ref: ./examples/Discovery_Query_And.json
        Discovery_Query_Not:
          $ref: ./examples/Discovery_Query_Not.json
        Discovery_Query_AndOrNested:
          $ref: ./examples/Discovery_Query_AndOrNested.json
        Discovery_Query_SystemTime:
          $ref: ./examples/Discovery_Query_SystemTime.json
        Discovery_Query_BusinessMetadataAttribute:
          $ref: ./examples/Discovery_Query_BusinessMetadataAttribute.json
        Discovery_Query_Attribute:
          $ref: ./examples/Discovery_Query_Attribute.json
        Discovery_Query_Classification:
          $ref: ./examples/Discovery_Query_Classification.json
        Discovery_Query_FileExtension:
          $ref: ./examples/Discovery_Query_FileExtension.json
        Discovery_Query_Id:
          $ref: ./examples/Discovery_Query_Id.json
        Discovery_Query_EntityType:
          $ref: ./examples/Discovery_Query_Type.json
        Discovery_Query_AssetType:
          $ref: ./examples/Discovery_Query_AssetType.json
        Discovery_Query_Term:
          $ref: ./examples/Discovery_Query_TermAssignment.json
        Discovery_Query_Facet:
          $ref: ./examples/Discovery_Query_Facet.json
        Discovery_Query_Taxonomy:
          $ref: ./examples/Discovery_Query_Taxonomy.json
        Discovery_Query_Collection:
          $ref: ./examples/Discovery_Query_Collection.json
        Discovery_Query_GlossaryTerm:
          $ref: ./examples/Discovery_Query_GlossaryTerm.json
        Discovery_Query_ObjectType:
          $ref: ./examples/Discovery_Query_ObjectType.json
      parameters:
      - in: body
        name: searchRequest
        description: An object specifying the search criteria.
        required: true
        schema:
          $ref: '#/definitions/SearchRequest'
      - $ref: '#/parameters/purviewAPIVersion'
      responses:
        '200':
          description: OK. On successful lookup of the advanced search.
          schema:
            $ref: '#/definitions/SearchResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Search Query
  /search/suggest:
    post:
      tags:
      - Discovery
      description: Get search suggestions by query criteria.
      operationId: microsoftAzureDiscoverySuggest
      x-ms-examples:
        Discovery_Suggest:
          $ref: ./examples/Discovery_Suggest.json
      parameters:
      - in: body
        name: suggestRequest
        description: An object specifying the suggest criteria.
        required: true
        schema:
          $ref: '#/definitions/SuggestRequest'
      - $ref: '#/parameters/purviewAPIVersion'
      responses:
        '200':
          description: OK. On successful lookup of the suggestions.
          schema:
            $ref: '#/definitions/SuggestResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Search Suggest
  /browse:
    post:
      tags:
      - Discovery
      description: Browse entities by path or entity type.
      operationId: microsoftAzureDiscoveryBrowse
      x-ms-examples:
        Discovery_Browse_Path:
          $ref: ./examples/Discovery_Browse_Path.json
        Discovery_Browse_EntityType:
          $ref: ./examples/Discovery_Browse_EntityType.json
      parameters:
      - in: body
        name: browseRequest
        description: An object specifying the browse criteria.
        required: true
        schema:
          $ref: '#/definitions/BrowseRequest'
      - $ref: '#/parameters/purviewAPIVersion'
      responses:
        '200':
          description: OK. On successful get the entities to browse.
          schema:
            $ref: '#/definitions/BrowseResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Browse
  /search/autocomplete:
    post:
      tags:
      - Discovery
      description: Get auto complete options.
      operationId: microsoftAzureDiscoveryAutocomplete
      x-ms-examples:
        Discovery_AutoComplete:
          $ref: ./examples/Discovery_AutoComplete.json
      parameters:
      - in: body
        name: autoCompleteRequest
        description: An object specifying the autocomplete criteria.
        required: true
        schema:
          $ref: '#/definitions/AutoCompleteRequest'
      - $ref: '#/parameters/purviewAPIVersion'
      responses:
        '200':
          description: OK. On successful lookup of the auto complete options.
          schema:
            $ref: '#/definitions/AutoCompleteResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Search Autocomplete
definitions:
  SearchFacetItem:
    type: object
    properties:
      count:
        type: integer
        format: int32
        description: The count of the facet item.
      facet:
        type: string
        description: The name of the facet item.
      sort:
        type: object
    title: SearchFacetItemValue
    description: The content of a search facet result item.
  SearchResultValue:
    type: object
    properties:
      '@search.score':
        type: number
        format: float
        description: The search score calculated by the search engine. The results are ordered by search score by default.
      '@search.highlights':
        $ref: '#/definitions/SearchHighlights'
      objectType:
        type: string
        description: The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term.
      createTime:
        type: integer
        format: int64
        description: The create time of the record. The Unix epoch format.
      updateTime:
        type: integer
        format: int64
        description: The last update time of the record. The Unix epoch format.
      id:
        type: string
        description: The GUID of the record.
      name:
        type: string
        description: The name of the record.
      qualifiedName:
        type: string
        description: The qualified name of the record.
      entityType:
        type: string
        description: The type name of the asset.
      description:
        type: string
        description: The description of the asset.
      endorsement:
        type: string
        description: The endorsement of the asset.
      owner:
        type: string
        description: The owner of the record. This is an Atlas native attribute.
      classification:
        type: array
        description: The classifications of the record.
        items:
          type: string
      label:
        type: array
        description: The labels of the asset.
        items:
          type: string
      term:
        type: array
        description: The terms assigned to the asset.
        items:
          $ref: '#/definitions/TermSearchResultValue'
      contact:
        type: array
        description: The contacts of the asset.
        items:
          $ref: '#/definitions/ContactSearchResultValue'
      assetType:
        type: array
        description: The asset types of the asset.
        items:
          type: string
      glossaryType:
        type: string
        description: The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory.
      glossary:
        type: string
        description: The glossary name of the term.
      termStatus:
        type: string
        description: The status of the term.
      termTemplate:
        type: array
        description: The term template names used by the term.
        items:
          type: string
      longDescription:
        type: string
        description: The definition of the term.
    title: SearchResultValue
    description: The value item of the search result.
  ContactSearchResultValue:
    type: object
    properties:
      id:
        type: string
        description: The GUID of the contact.
      info:
        type: string
        description: The description of the contact.
      contactType:
        type: string
        description: The type of the contact. It can be Expert or Owner for an entity. It can be Expert or Steward for a glossary term.
    title: contact
    description: The contact in the search and suggest result.
  SearchHighlights:
    type: object
    description: A highlight list that consists of index fields id ,qualifiedName, name, description, entityType. When the keyword appears in those fields, the value of the field, attached with emphasis mark, is returned as an element of @search.highlights.
    properties:
      id:
        type: array
        items:
          type: string
      qualifiedName:
        type: array
        items:
          type: string
      name:
        type: array
        items:
          type: string
      description:
        type: array
        items:
          type: string
      entityType:
        type: array
        items:
          type: string
    title: SearchHighlights
  SuggestResultValue:
    type: object
    properties:
      '@search.score':
        type: number
        format: float
        description: The search score calculated by the search engine. The results are ordered by search score by default.
      '@search.text':
        type: string
        description: The target text that contains the keyword as prefix. The keyword is wrapped with emphasis mark.
      objectType:
        type: string
        description: The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term.
      createTime:
        type: integer
        format: int64
        description: The create time of the record. The Unix epoch format.
      updateTime:
        type: integer
        format: int64
        description: The last update time of the record. The Unix epoch format.
      id:
        type: string
        description: The GUID of the record.
      name:
        type: string
        description: The name of the record.
      qualifiedName:
        type: string
        description: The qualified name of the record.
      entityType:
        type: string
        description: The type name of the asset.
      description:
        type: string
        description: The description of the asset.
      endorsement:
        type: string
        description: The endorsement of the asset.
      owner:
        type: string
        description: The owner of the record. This is an Atlas native attribute.
      classification:
        type: array
        description: The classifications of the record.
        items:
          type: string
      label:
        type: array
        description: The labels of the asset.
        items:
          type: string
      term:
        type: array
        description: The terms assigned to the asset.
        items:
          $ref: '#/definitions/TermSearchResultValue'
      contact:
        type: array
        description: The contacts of the asset.
        items:
          $ref: '#/definitions/ContactSearchResultValue'
      assetType:
        type: array
        description: The asset types of the asset.
        items:
          type: string
      glossaryType:
        type: string
        description: The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory.
      glossary:
        type: string
        description: The glossary name of the term.
      termStatus:
        type: string
        description: The status of the term.
      termTemplate:
        type: array
        description: The term template names used by the term.
        items:
          type: string
      longDescription:
        type: string
        description: The definition of the term.
    title: SuggestResultValue
    description: The value item of the search suggest.
  SearchFacetResultValue:
    type: object
    properties:
      entityType:
        type: array
        items:
          $ref: '#/definitions/SearchFacetItemValue'
      assetType:
        type: array
        items:
          $ref: '#/definitions/SearchFacetItemValue'
      classification:
        type: array
        items:
          $ref: '#/definitions/SearchFacetItemValue'
      term:
        type: array
        items:
          $ref: '#/definitions/SearchFacetItemValue'
      contactId:
        type: array
        items:
          $ref: '#/definitions/SearchFacetItemValue'
      contactType:
        type: array
        items:
          $ref: '#/definitions/SearchFacetItemValue'
      label:
        type: array
        items:
          $ref: '#/definitions/SearchFacetItemValue'
      glossaryType:
        type: array
        items:
          $ref: '#/definitions/SearchFacetItemValue'
      termStatus:
        type: array
        items:
          $ref: '#/definitions/SearchFacetItemValue'
      termTemplate:
        type: array
        items:
          $ref: '#/definitions/SearchFacetItemValue'
    title: Context
    description: A facet list that consists of index fields assetType ,classification, contactId, and label. When the facet is specified in the request, the value of the facet is returned as an element of @search.facets.
  SearchFacetItemValue:
    type: object
    properties:
      count:
        type: integer
        format: int32
        description: The count of the facet item.
      value:
        type: string
        description: The name of the facet item.
    title: SearchFacetItemValue
    description: The content of a search facet result item.
  BrowseResultValue:
    type: object
    properties:
      entityType:
        type: string
        description: The type name of the record.
      id:
        type: string
        description: The GUID of the record.
      isLeaf:
        type: boolean
        description: If the record is a leaf entity.
      name:
        type: string
        description: The name of the record.
      owner:
        type: array
        description: The owners of the record.
        items:
          $ref: '#/definitions/BrowseResultOwner'
      path:
        type: string
        description: The path of the record.
      qualifiedName:
        type: string
        description: The qualified name of the record.
    title: BrowseResultValue
    description: The value item of the browse result.
  SuggestResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/SuggestResultValue'
    title: SuggestResult
    description: The result item of the search suggest.
  BrowseResult:
    type: object
    properties:
      '@search.count':
        type: integer
        format: int32
        description: The total number of browse results.
      value:
        type: array
        items:
          $ref: '#/definitions/BrowseResultValue'
    title: BrowseResult
    description: The result item of the browse request.
  AutoCompleteResultValue:
    type: object
    properties:
      text:
        type: string
        description: The completed term or phrase.
      queryPlusText:
        type: string
        description: The completed search query text.
    title: AutoCompleteResultValue
    description: The value item of the autocomplete suggest.
  AutoCompleteRequest:
    type: object
    properties:
      keywords:
        type: string
        description: The keywords applied to all fields that support autocomplete operation. It must be at least 1 character, and no more than 100 characters.
      limit:
        type: integer
        format: int32
        description: The number of autocomplete results we hope to return. The default value is 50. The value must be a number between 1 and 100.
      filter:
        type: object
        description: The filter for the autocomplete request.
    title: AutoCompleteRequest
    description: The query of autocomplete request.
  AutoCompleteResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/AutoCompleteResultValue'
    title: AutoCompleteResult
    description: The result of the autocomplete request.
  ErrorResponse:
    description: An error response from the service
    type: object
    properties:
      requestId:
        type: string
        description: The request ID.
      errorCode:
        type: string
        description: The error code.
      errorMessage:
        type: string
        description: The error message.
  SuggestRequest:
    type: object
    properties:
      keywords:
        type: string
        description: The keywords applied to all fields that support suggest operation. It must be at least 1 character, and no more than 100 characters. In the index schema we defined a default suggester which lists all the supported fields and specifies a search mode.
      limit:
        type: integer
        format: int32
        description: The number of suggestions we hope to return. The default value is 5. The value must be a number between 1 and 100.
      filter:
        type: object
        description: The filter for the search.
    title: SuggestRequest
    description: The query of suggest request.
  SearchOrderItem:
    type: object
    description: See examples for the usage of search order.
  TermSearchResultValue:
    type: object
    properties:
      name:
        type: string
        description: The name of the term.
      glossaryName:
        type: string
        description: The name of the glossary which contains the term.
      guid:
        type: string
        description: The GUID of the term.
    title: Context
    description: The context.
  SearchResult:
    type: object
    properties:
      '@search.count':
        type: integer
        format: int32
        description: The total number of search results (not the number of documents in a single page).
      '@search.facets':
        $ref: '#/definitions/SearchFacetResultValue'
      value:
        type: array
        items:
          $ref: '#/definitions/SearchResultValue'
    title: SearchResult
    description: The result of the search result.
  BrowseRequest:
    type: object
    properties:
      entityType:
        type: string
        description: The entity type to browse as the root level entry point.
      path:
        type: string
        description: The path to browse the next level child entities.
      limit:
        type: integer
        format: int32
        description: The number of browse items we hope to return. The maximum value is 10000.
      offset:
        type: integer
        format: int32
        description: The offset. The default value is 0. The maximum value is 100000.
    title: BrowseRequest
    description: The criteria of browse request.
  SearchRequest:
    type: object
    properties:
      keywords:
        type: string
        description: The keywords applied to all searchable fields.
      offset:
        type: integer
        format: int32
        description: The offset. The default value is 0. The maximum value is 100000.
      limit:
        type: integer
        format: int32
        description: The limit of the number of the search result. default value is 50; maximum value is 1000.
      orderby:
        type: array
        description: The sort order of search results, can specify multiple fields.
        items:
          $ref: '#/definitions/SearchOrderItem'
      filter:
        type: object
        description: The filter for the search. See examples for the usage of supported filters.
      facets:
        type: array
        items:
          $ref: '#/definitions/SearchFacetItem'
      taxonomySetting:
        type: object
        properties:
          assetTypes:
            type: array
            items:
              type: string
          facet:
            $ref: '#/definitions/SearchFacetItem'
    title: SearchRequest
    description: The search query of advanced search request.
  BrowseResultOwner:
    type: object
    properties:
      id:
        type: string
        description: The GUID of the owner.
      displayName:
        type: string
        description: The display name of the owner.
      mail:
        type: string
        description: The mail of the owner.
      contactType:
        type: string
        description: The contact type of the owner. The value will be Owner.
    title: BrowseResultOwner
    description: The value item of the browse owner.
parameters:
  purviewAPIVersion:
    name: api-version
    description: Version of Purview APIs
    in: query
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'