m3ter API — ExportJob

naftiko: 1.0.0-alpha2
info:
  label: m3ter API — ExportJob
  description: 'm3ter API — ExportJob. 2 operations. Lead operation: List Jobs. Self-contained Naftiko capability covering
    one M3ter business surface.'
  tags:
  - M3ter
  - ExportJob
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    M3TER_API_KEY: M3TER_API_KEY
capability:
  consumes:
  - type: http
    namespace: m3ter-exportjob
    baseUri: https://api.m3ter.com
    description: m3ter API — ExportJob business capability. Self-contained, no shared references.
    resources:
    - name: organizations-orgId-dataexports-jobs
      path: /organizations/{orgId}/dataexports/jobs
      operations:
      - name: listjobstatuses
        method: GET
        description: List Jobs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: UUID of the organization
          required: true
        - name: ids
          in: query
          type: array
          description: List Job entities for the given UUIDs
        - name: scheduleId
          in: query
          type: string
          description: List Job entities for the schedule UUID
        - name: status
          in: query
          type: string
          description: List Job entities for the status
        - name: dateCreatedStart
          in: query
          type: string
          description: 'Include only Job entities created on or after this date. Format: yyyy-MM-dd''T''HH:mm:ss''Z'''
        - name: dateCreatedEnd
          in: query
          type: string
          description: 'Include only Job entities created before this date. Format: yyyy-MM-dd''T''HH:mm:ss''Z'''
        - name: pageSize
          in: query
          type: integer
          description: Number of Jobs to retrieve per page
        - name: nextToken
          in: query
          type: string
          description: nextToken for multi page retrievals
    - name: organizations-orgId-dataexports-jobs-id
      path: /organizations/{orgId}/dataexports/jobs/{id}
      operations:
      - name: getjob
        method: GET
        description: Retrieve Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: UUID of the organization
          required: true
        - name: id
          in: path
          type: string
          description: The UUID of the Job to retrieve.
          required: true
    authentication:
      type: bearer
      token: '{{env.M3TER_API_KEY}}'
  exposes:
  - type: rest
    namespace: m3ter-exportjob-rest
    port: 8080
    description: REST adapter for m3ter API — ExportJob. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/organizations/{orgid}/dataexports/jobs
      name: organizations-orgid-dataexports-jobs
      description: REST surface for organizations-orgId-dataexports-jobs.
      operations:
      - method: GET
        name: listjobstatuses
        description: List Jobs
        call: m3ter-exportjob.listjobstatuses
        with:
          orgId: rest.orgId
          ids: rest.ids
          scheduleId: rest.scheduleId
          status: rest.status
          dateCreatedStart: rest.dateCreatedStart
          dateCreatedEnd: rest.dateCreatedEnd
          pageSize: rest.pageSize
          nextToken: rest.nextToken
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{orgid}/dataexports/jobs/{id}
      name: organizations-orgid-dataexports-jobs-id
      description: REST surface for organizations-orgId-dataexports-jobs-id.
      operations:
      - method: GET
        name: getjob
        description: Retrieve Job
        call: m3ter-exportjob.getjob
        with:
          orgId: rest.orgId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: m3ter-exportjob-mcp
    port: 9090
    transport: http
    description: MCP adapter for m3ter API — ExportJob. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-jobs
      description: List Jobs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-exportjob.listjobstatuses
      with:
        orgId: tools.orgId
        ids: tools.ids
        scheduleId: tools.scheduleId
        status: tools.status
        dateCreatedStart: tools.dateCreatedStart
        dateCreatedEnd: tools.dateCreatedEnd
        pageSize: tools.pageSize
        nextToken: tools.nextToken
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-job
      description: Retrieve Job
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: m3ter-exportjob.getjob
      with:
        orgId: tools.orgId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.