Rulebase

Rulebase Work Item Imports API

The Work Item Imports API from Rulebase — 4 operation(s) for work item imports.

GitHub OpenAPI

Operations 4

POST /work_item_imports/preview Create work item imports preview #
POST /work_item_imports/confirm Create work item imports confirm #
POST /work_item_imports Create work item imports #
GET /work_item_imports/{id} Get work item imports by id #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/rulebase/openapi/rulebase-work-item-imports-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-qa-agent-evaluation-scorecard-criterion-result-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-linked-activity-thread-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-scorecard-form-params-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-evaluation-schedule-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-practice-simulation-attempt-schema.json
📊
JSONSchema
https://artifacts.apis.io/rulebase/json-schema/rulebase-practice-simulation-dry-run-schema.json

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/rulebase:rulebase-work-item-imports-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

rulebase-work-item-imports-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Rulebase API2 Work Item Imports API
  version: 0.0.1
tags:
- name: Work Item Imports
paths:
  /work_item_imports/preview:
    post:
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    format: binary
                target_work_item_id:
                  type: string
                  format: uuid
      responses:
        '200':
          description: Agent-generated work item import preview stream
          content:
            text/event-stream:
              schema:
                type: string
      tags:
      - Work Item Imports
      summary: Create work item imports preview
      x-summary-source: derived
      operationId: postWorkItemImportsPreview
      x-operation-id-source: derived
  /work_item_imports/confirm:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                preview:
                  type: object
                  properties:
                    version:
                      type: number
                      enum:
                      - 1
                    files:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                            minLength: 1
                          role:
                            type: string
                            enum:
                            - work_items
                            - events
                            - mixed
                            - ignored
                          notes:
                            type: string
                            minLength: 1
                        required:
                        - name
                        - role
                        - notes
                    mappings:
                      type: array
                      items:
                        type: object
                        properties:
                          source_file:
                            type: string
                            minLength: 1
                          source_field:
                            type: string
                            minLength: 1
                          target_field:
                            type: string
                            minLength: 1
                          notes:
                            type: string
                            minLength: 1
                        required:
                        - source_file
                        - source_field
                        - target_field
                    work_items:
                      type: array
                      items:
                        type: object
                        properties:
                          external_id:
                            type: string
                            minLength: 1
                          agent:
                            type: object
                            properties:
                              email:
                                type: string
                                format: email
                              name:
                                type: string
                                minLength: 1
                              external_id:
                                type: string
                                minLength: 1
                            default: {}
                          type:
                            type: string
                            minLength: 1
                          status:
                            type: string
                            enum:
                            - pending
                            - in_progress
                            - completed
                            - cancelled
                          completed_at:
                            type: string
                            nullable: true
                            format: date-time
                          custom_attributes:
                            type: object
                            additionalProperties:
                              nullable: true
                            default: {}
                          source:
                            type: object
                            properties:
                              file:
                                type: string
                                minLength: 1
                              row:
                                type: integer
                                minimum: 0
                                exclusiveMinimum: true
                            required:
                            - file
                        required:
                        - external_id
                        - source
                    events:
                      type: array
                      items:
                        type: object
                        properties:
                          external_id:
                            type: string
                            minLength: 1
                          work_item_external_id:
                            type: string
                            minLength: 1
                          actor:
                            type: object
                            nullable: true
                            properties:
                              email:
                                type: string
                                format: email
                              name:
                                type: string
                                minLength: 1
                              external_id:
                                type: string
                                minLength: 1
                          content:
                            type: string
                            nullable: true
                          occurred_at:
                            type: string
                            nullable: true
                            format: date-time
                          source:
                            type: object
                            properties:
                              file:
                                type: string
                                minLength: 1
                              row:
                                type: integer
                                minimum: 0
                                exclusiveMinimum: true
                            required:
                            - file
                        required:
                        - external_id
                        - work_item_external_id
                        - actor
                        - content
                        - occurred_at
                        - source
                    warnings:
                      type: array
                      items:
                        type: object
                        properties:
                          code:
                            type: string
                            minLength: 1
                          message:
                            type: string
                            minLength: 1
                          source_file:
                            type: string
                            minLength: 1
                          source_row:
                            type: integer
                            minimum: 0
                            exclusiveMinimum: true
                        required:
                        - code
                        - message
                  required:
                  - version
                  - files
                  - mappings
                  - work_items
                  - events
                  - warnings
                target_work_item_id:
                  type: string
                  format: uuid
              required:
              - preview
      responses:
        '201':
          description: Work items and events imported
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      work_items:
                        type: integer
                        minimum: 0
                      events:
                        type: integer
                        minimum: 0
                      work_item_ids:
                        type: array
                        items:
                          type: string
                          format: uuid
                    required:
                    - work_items
                    - events
                    - work_item_ids
                required:
                - data
        '422':
          description: Preview could not be imported
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Work Item Imports
      summary: Create work item imports confirm
      x-summary-source: derived
      operationId: postWorkItemImportsConfirm
      x-operation-id-source: derived
  /work_item_imports:
    post:
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
      responses:
        '201':
          description: Work item import accepted
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      status:
                        type: string
                        enum:
                        - pending
                        - processing
                        - completed
                        - completed_with_errors
                        - failed
                      total_rows:
                        type: integer
                      succeeded_rows:
                        type: integer
                      failed_rows:
                        type: integer
                      error:
                        type: string
                        nullable: true
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                    required:
                    - id
                    - status
                    - total_rows
                    - succeeded_rows
                    - failed_rows
                    - error
                    - created_at
                    - updated_at
                required:
                - data
        '413':
          description: File too large
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '422':
          description: Invalid upload
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Work Item Imports
      summary: Create work item imports
      x-summary-source: derived
      operationId: postWorkItemImports
      x-operation-id-source: derived
  /work_item_imports/{id}:
    get:
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Work item import
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      status:
                        type: string
                        enum:
                        - pending
                        - processing
                        - completed
                        - completed_with_errors
                        - failed
                      total_rows:
                        type: integer
                      succeeded_rows:
                        type: integer
                      failed_rows:
                        type: integer
                      error:
                        type: string
                        nullable: true
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                    required:
                    - id
                    - status
                    - total_rows
                    - succeeded_rows
                    - failed_rows
                    - error
                    - created_at
                    - updated_at
                required:
                - data
        '404':
          description: Work item import not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
      tags:
      - Work Item Imports
      summary: Get work item imports by id
      x-summary-source: derived
      operationId: getWorkItemImportsById
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Rulebase organization API key