# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Salesforce Bulk API 2.0 Query Jobs API
  version: 1.0.0
extends: openapi/salesforce-query-jobs-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/query'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk query jobs
      effect: read
      questions:
      - Which bulk query jobs have been run in my org recently?
      - Can I filter query jobs by job type?
      instructions:
      - text: List all bulk query jobs in the org.
      - text: Show query jobs of type {job_type}, newest first.
        slots:
          job_type: query.jobType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a bulk query job
      effect: write
      questions:
      - How do I extract millions of records with a SOQL query asynchronously?
      - Can a bulk query include deleted and archived records?
      instructions:
      - text: Start a bulk {operation} job for the SOQL {soql}.
        slots:
          operation: requestBody.operation
          soql: requestBody.query
      - text: Create a query job running {soql} with {delimiter} as the column delimiter.
        slots:
          soql: requestBody.query
          delimiter: requestBody.columnDelimiter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a bulk query job
      effect: read
      questions:
      - Has query job 750... reached JobComplete yet?
      - How many records has a specific query job processed, and did it error?
      instructions:
      - text: Get the status of query job {job_id}.
        slots:
          job_id: path.jobId
      - text: Show the records processed and any error message for job {job_id}.
        slots:
          job_id: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/{jobId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a bulk query job and its results
      effect: destructive
      questions:
      - Can I delete a query job that is still running?
      - Which query job states allow deletion?
      instructions:
      - text: Delete query job {job_id} and its results.
        slots:
          job_id: path.jobId
      - text: Remove the finished bulk query job {job_id}.
        slots:
          job_id: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/{jobId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Abort a running bulk query job
      effect: destructive
      questions:
      - How do I stop a bulk query job that's taking too long?
      - Can I abort a queued query job before it starts?
      instructions:
      - text: Abort query job {job_id}.
        slots:
          job_id: path.jobId
      - text: Set the state of query job {job_id} to {state}.
        slots:
          job_id: path.jobId
          state: requestBody.state
      method: generated
      generated: '2026-09-26'