API Reference — Data Queries

naftiko: 1.0.0-alpha2
info:
  label: API Reference — Data Queries
  description: 'API Reference — Data Queries. 4 operations. Lead operation: Submit a data query. Self-contained Naftiko capability
    covering one Zuora business surface.'
  tags:
  - Zuora
  - Data Queries
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZUORA_API_KEY: ZUORA_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-data-queries
    baseUri: https://rest.zuora.com
    description: API Reference — Data Queries business capability. Self-contained, no shared references.
    resources:
    - name: query-jobs
      path: /query/jobs
      operations:
      - name: postdataqueryjob
        method: POST
        description: Submit a data query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: string
          required: true
      - name: getdataqueryjobs
        method: GET
        description: List data query jobs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: queryStatus
          in: query
          type: string
          description: Filters the list of query jobs by status.
        - name: pageSize
          in: query
          type: integer
          description: The number of records returned per page in the response.
    - name: query-jobs-job-id
      path: /query/jobs/{job-id}
      operations:
      - name: getdataqueryjob
        method: GET
        description: Retrieve a data query job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: job-id
          in: path
          type: string
          description: Internal identifier of the query job.
          required: true
      - name: deletedataqueryjob
        method: DELETE
        description: Cancel a data query job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: job-id
          in: path
          type: string
          description: Internal identifier of the query job.
          required: true
  exposes:
  - type: rest
    namespace: v1-data-queries-rest
    port: 8080
    description: REST adapter for API Reference — Data Queries. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/query/jobs
      name: query-jobs
      description: REST surface for query-jobs.
      operations:
      - method: POST
        name: postdataqueryjob
        description: Submit a data query
        call: v1-data-queries.postdataqueryjob
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getdataqueryjobs
        description: List data query jobs
        call: v1-data-queries.getdataqueryjobs
        with:
          queryStatus: rest.queryStatus
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/query/jobs/{job-id}
      name: query-jobs-job-id
      description: REST surface for query-jobs-job-id.
      operations:
      - method: GET
        name: getdataqueryjob
        description: Retrieve a data query job
        call: v1-data-queries.getdataqueryjob
        with:
          job-id: rest.job-id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletedataqueryjob
        description: Cancel a data query job
        call: v1-data-queries.deletedataqueryjob
        with:
          job-id: rest.job-id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-data-queries-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — Data Queries. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: submit-data-query
      description: Submit a data query
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: v1-data-queries.postdataqueryjob
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-data-query-jobs
      description: List data query jobs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-data-queries.getdataqueryjobs
      with:
        queryStatus: tools.queryStatus
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-data-query-job
      description: Retrieve a data query job
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-data-queries.getdataqueryjob
      with:
        job-id: tools.job-id
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-data-query-job
      description: Cancel a data query job
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v1-data-queries.deletedataqueryjob
      with:
        job-id: tools.job-id
      outputParameters:
      - type: object
        mapping: $.