Microsoft Purview · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Purview Scanning Triggers API

6 actions 6 updates phrasing extends openapi/microsoft-purview-triggers-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Purview's API. It is a proposal applied on top of the contract, not a document Microsoft Purview publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/scan/datasources/{dataSourceName}/scans/{scanName}/triggers/default'].get
$.paths['/scan/datasources/{dataSourceName}/scans/{scanName}/triggers/default'].put
$.paths['/scan/datasources/{dataSourceName}/scans/{scanName}/triggers/default'].delete
$.paths['/scan/datasources/{dataSourceName}/scans/{scanName}/triggers/default/:enable'].post
$.paths['/scan/datasources/{dataSourceName}/scans/{scanName}/triggers/default/:disable'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Purview Scanning Triggers API
  version: 1.0.0
extends: openapi/microsoft-purview-triggers-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/scan/datasources/{dataSourceName}/scans/{scanName}/triggers/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scan's schedule trigger
      effect: read
      questions:
      - When is a scan scheduled to run?
      - Can I see the recurrence trigger for a scan?
      instructions:
      - text: Show the trigger for scan {scan} on data source {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      - text: Get the schedule of {scan} on {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/datasources/{dataSourceName}/scans/{scanName}/triggers/default'].put
  update:
    x-apievangelist-phrasing:
      intent: Schedule a scan with a trigger
      effect: write
      questions:
      - How do I schedule a scan to run on a recurrence?
      - Can I replace the existing schedule on a scan?
      instructions:
      - text: Create a trigger for scan {scan} on {source} with properties {props}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
          props: requestBody.properties
      - text: Replace the scan schedule for {scan} on data source {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/datasources/{dataSourceName}/scans/{scanName}/triggers/default'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scan's schedule trigger
      effect: destructive
      questions:
      - Can I remove the recurring schedule from a scan?
      - What is the way to delete a scan trigger?
      instructions:
      - text: Delete the trigger on scan {scan} for data source {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      - text: Remove the schedule from {scan} on {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/datasources/{dataSourceName}/scans/{scanName}/triggers/default/:enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable a scan schedule
      effect: write
      questions:
      - How do I turn a paused scan schedule back on?
      - Can I resume scheduled scanning for a scan?
      instructions:
      - text: Enable the trigger for scan {scan} on data source {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      - text: Resume scheduled runs of {scan} on {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/datasources/{dataSourceName}/scans/{scanName}/triggers/default/:disable'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable a scan schedule
      effect: write
      questions:
      - How do I pause scheduled scanning without deleting the schedule?
      - Can I temporarily stop a scan from running on its recurrence?
      instructions:
      - text: Disable the trigger for scan {scan} on data source {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      - text: Pause scheduled runs of {scan} on {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      method: generated
      generated: '2026-10-01'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/microsoft-purview-triggers-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.