API Reference — subpackage_bulkSync.subpackage_bulkSync/executions

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_bulkSync.subpackage_bulkSync/executions
  description: 'API Reference — subpackage_bulkSync.subpackage_bulkSync/executions. 8 operations. Lead operation: List Bulk
    Sync Execution Status. Self-contained Naftiko capability covering one Polytomic business surface.'
  tags:
  - Polytomic
  - subpackage_bulkSync.subpackage_bulkSync/executions
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    POLYTOMIC_API_KEY: POLYTOMIC_API_KEY
capability:
  consumes:
  - type: http
    namespace: polytomic-subpackage-bulksync-subpackage-bulksync-executions
    baseUri: https://app.polytomic.com
    description: API Reference — subpackage_bulkSync.subpackage_bulkSync/executions business capability. Self-contained, no
      shared references.
    resources:
    - name: api-bulk-syncs-status
      path: /api/bulk/syncs/status
      operations:
      - name: liststatus
        method: GET
        description: List Bulk Sync Execution Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: all
          in: query
          type: boolean
          description: When true, return status for every sync in the caller's organization. Overrides any sync_id values.
        - name: active
          in: query
          type: boolean
          description: When true, return status only for active syncs in the caller's organization. Overrides any sync_id
            values.
        - name: sync_id
          in: query
          type: array
          description: Return status for the specified bulk sync. Repeat the parameter to target multiple syncs. Ignored if
            all or active is true.
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    - name: api-bulk-syncs-id-executions
      path: /api/bulk/syncs/{id}/executions
      operations:
      - name: list
        method: GET
        description: List Bulk Sync Executions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Unique identifier of the bulk sync.
          required: true
        - name: page_token
          in: query
          type: string
          description: Pagination cursor returned in the previous response. Omit on the first request.
        - name: only_terminal
          in: query
          type: boolean
          description: When true, only return executions that have finished. Terminal executions are ordered by updated_at.
        - name: ascending
          in: query
          type: boolean
          description: When true, return executions from oldest to newest. Default is newest first.
        - name: limit
          in: query
          type: integer
          description: Maximum number of executions to return. Capped at 100.
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    - name: api-bulk-syncs-id-executions-exec_id
      path: /api/bulk/syncs/{id}/executions/{exec_id}
      operations:
      - name: get
        method: GET
        description: Get Bulk Sync Execution
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Unique identifier of the bulk sync.
          required: true
        - name: exec_id
          in: path
          type: string
          description: Unique identifier of the execution.
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    - name: api-bulk-syncs-id-executions-exec_id-cancel
      path: /api/bulk/syncs/{id}/executions/{exec_id}/cancel
      operations:
      - name: cancel
        method: POST
        description: Cancel Bulk Sync Execution
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The bulk sync ID.
          required: true
        - name: exec_id
          in: path
          type: string
          description: The execution ID to cancel.
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    - name: api-bulk-syncs-sync_id-executions-execution_id-consolelog
      path: /api/bulk/syncs/{sync_id}/executions/{execution_id}/consolelog
      operations:
      - name: getconsolelogs
        method: GET
        description: Get Bulk Execution Console Logs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sync_id
          in: path
          type: string
          required: true
        - name: execution_id
          in: path
          type: string
          required: true
        - name: limit
          in: query
          type: integer
          description: Maximum number of entries to return. Values above the logger retention limit are capped to 50.
        - name: after
          in: query
          type: string
          description: Return only entries newer than this cursor.
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    - name: api-bulk-syncs-sync_id-executions-execution_id-logs
      path: /api/bulk/syncs/{sync_id}/executions/{execution_id}/logs
      operations:
      - name: getlogs
        method: GET
        description: Get Bulk Sync Execution Logs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sync_id
          in: path
          type: string
          description: Unique identifier of the bulk sync.
          required: true
        - name: execution_id
          in: path
          type: string
          description: Unique identifier of the execution whose log files should be listed.
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    - name: api-bulk-syncs-sync_id-executions-execution_id-logs-export
      path: /api/bulk/syncs/{sync_id}/executions/{execution_id}/logs/export
      operations:
      - name: exportlogs
        method: POST
        description: Export Sync Logs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sync_id
          in: path
          type: string
          description: Unique identifier of the bulk sync.
          required: true
        - name: execution_id
          in: path
          type: string
          description: Unique identifier of the execution whose logs should be exported.
          required: true
        - name: notify
          in: query
          type: boolean
          description: Send a notification to the user when the logs are ready for download.
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    - name: api-bulk-syncs-sync_id-executions-execution_id-schemas-schema_id-consolelog
      path: /api/bulk/syncs/{sync_id}/executions/{execution_id}/schemas/{schema_id}/consolelog
      operations:
      - name: getschemaconsolelogs
        method: GET
        description: Get Bulk Schema Execution Console Logs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sync_id
          in: path
          type: string
          required: true
        - name: execution_id
          in: path
          type: string
          required: true
        - name: schema_id
          in: path
          type: string
          description: Schema identifier for schema-scoped console logs.
          required: true
        - name: limit
          in: query
          type: integer
          description: Maximum number of entries to return. Values above the logger retention limit are capped to 50.
        - name: after
          in: query
          type: string
          description: Return only entries newer than this cursor.
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    authentication:
      type: bearer
      token: '{{env.POLYTOMIC_API_KEY}}'
  exposes:
  - type: rest
    namespace: polytomic-subpackage-bulksync-subpackage-bulksync-executions-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_bulkSync.subpackage_bulkSync/executions. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/bulk/syncs/status
      name: api-bulk-syncs-status
      description: REST surface for api-bulk-syncs-status.
      operations:
      - method: GET
        name: liststatus
        description: List Bulk Sync Execution Status
        call: polytomic-subpackage-bulksync-subpackage-bulksync-executions.liststatus
        with:
          all: rest.all
          active: rest.active
          sync_id: rest.sync_id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/bulk/syncs/{id}/executions
      name: api-bulk-syncs-id-executions
      description: REST surface for api-bulk-syncs-id-executions.
      operations:
      - method: GET
        name: list
        description: List Bulk Sync Executions
        call: polytomic-subpackage-bulksync-subpackage-bulksync-executions.list
        with:
          id: rest.id
          page_token: rest.page_token
          only_terminal: rest.only_terminal
          ascending: rest.ascending
          limit: rest.limit
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/bulk/syncs/{id}/executions/{exec-id}
      name: api-bulk-syncs-id-executions-exec-id
      description: REST surface for api-bulk-syncs-id-executions-exec_id.
      operations:
      - method: GET
        name: get
        description: Get Bulk Sync Execution
        call: polytomic-subpackage-bulksync-subpackage-bulksync-executions.get
        with:
          id: rest.id
          exec_id: rest.exec_id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/bulk/syncs/{id}/executions/{exec-id}/cancel
      name: api-bulk-syncs-id-executions-exec-id-cancel
      description: REST surface for api-bulk-syncs-id-executions-exec_id-cancel.
      operations:
      - method: POST
        name: cancel
        description: Cancel Bulk Sync Execution
        call: polytomic-subpackage-bulksync-subpackage-bulksync-executions.cancel
        with:
          id: rest.id
          exec_id: rest.exec_id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/bulk/syncs/{sync-id}/executions/{execution-id}/consolelog
      name: api-bulk-syncs-sync-id-executions-execution-id-consolelog
      description: REST surface for api-bulk-syncs-sync_id-executions-execution_id-consolelog.
      operations:
      - method: GET
        name: getconsolelogs
        description: Get Bulk Execution Console Logs
        call: polytomic-subpackage-bulksync-subpackage-bulksync-executions.getconsolelogs
        with:
          sync_id: rest.sync_id
          execution_id: rest.execution_id
          limit: rest.limit
          after: rest.after
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/bulk/syncs/{sync-id}/executions/{execution-id}/logs
      name: api-bulk-syncs-sync-id-executions-execution-id-logs
      description: REST surface for api-bulk-syncs-sync_id-executions-execution_id-logs.
      operations:
      - method: GET
        name: getlogs
        description: Get Bulk Sync Execution Logs
        call: polytomic-subpackage-bulksync-subpackage-bulksync-executions.getlogs
        with:
          sync_id: rest.sync_id
          execution_id: rest.execution_id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/bulk/syncs/{sync-id}/executions/{execution-id}/logs/export
      name: api-bulk-syncs-sync-id-executions-execution-id-logs-export
      description: REST surface for api-bulk-syncs-sync_id-executions-execution_id-logs-export.
      operations:
      - method: POST
        name: exportlogs
        description: Export Sync Logs
        call: polytomic-subpackage-bulksync-subpackage-bulksync-executions.exportlogs
        with:
          sync_id: rest.sync_id
          execution_id: rest.execution_id
          notify: rest.notify
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/bulk/syncs/{sync-id}/executions/{execution-id}/schemas/{schema-id}/consolelog
      name: api-bulk-syncs-sync-id-executions-execution-id-schemas-schema-id-consolelog
      description: REST surface for api-bulk-syncs-sync_id-executions-execution_id-schemas-schema_id-consolelog.
      operations:
      - method: GET
        name: getschemaconsolelogs
        description: Get Bulk Schema Execution Console Logs
        call: polytomic-subpackage-bulksync-subpackage-bulksync-executions.getschemaconsolelogs
        with:
          sync_id: rest.sync_id
          execution_id: rest.execution_id
          schema_id: rest.schema_id
          limit: rest.limit
          after: rest.after
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: polytomic-subpackage-bulksync-subpackage-bulksync-executions-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_bulkSync.subpackage_bulkSync/executions. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: list-bulk-sync-execution-status
      description: List Bulk Sync Execution Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-bulksync-subpackage-bulksync-executions.liststatus
      with:
        all: tools.all
        active: tools.active
        sync_id: tools.sync_id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: list-bulk-sync-executions
      description: List Bulk Sync Executions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-bulksync-subpackage-bulksync-executions.list
      with:
        id: tools.id
        page_token: tools.page_token
        only_terminal: tools.only_terminal
        ascending: tools.ascending
        limit: tools.limit
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: get-bulk-sync-execution
      description: Get Bulk Sync Execution
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-bulksync-subpackage-bulksync-executions.get
      with:
        id: tools.id
        exec_id: tools.exec_id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-bulk-sync-execution
      description: Cancel Bulk Sync Execution
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: polytomic-subpackage-bulksync-subpackage-bulksync-executions.cancel
      with:
        id: tools.id
        exec_id: tools.exec_id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: get-bulk-execution-console-logs
      description: Get Bulk Execution Console Logs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-bulksync-subpackage-bulksync-executions.getconsolelogs
      with:
        sync_id: tools.sync_id
        execution_id: tools.execution_id
        limit: tools.limit
        after: tools.after
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: get-bulk-sync-execution-logs
      description: Get Bulk Sync Execution Logs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-bulksync-subpackage-bulksync-executions.getlogs
      with:
        sync_id: tools.sync_id
        execution_id: tools.execution_id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: export-sync-logs
      description: Export Sync Logs
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: polytomic-subpackage-bulksync-subpackage-bulksync-executions.exportlogs
      with:
        sync_id: tools.sync_id
        execution_id: tools.execution_id
        notify: tools.notify
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: get-bulk-schema-execution-console
      description: Get Bulk Schema Execution Console Logs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-bulksync-subpackage-bulksync-executions.getschemaconsolelogs
      with:
        sync_id: tools.sync_id
        execution_id: tools.execution_id
        schema_id: tools.schema_id
        limit: tools.limit
        after: tools.after
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.