Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qubiqle batch API

The batch API from Qubiqle — 3 operation(s) for batch.

Qubiqle batch API is one of 9 APIs that Qubiqle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include batch. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.ottimate.com/v1, https://sandbox-api.ottimate.com/v1.

3 operations 3 paths 9 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.ottimate.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Qubiqle batch API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuth2).

  • OAuth2 — OAuth2 authentication flows. Auth server URLs will vary by environment

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

batch 3
GET
/batch/{id}/progress
Poll batch progress
get-batch-id-progress 4 params → 200401403
GET
/batch/{id}/results
Retrieve batch results
get-batch-id-results 4 params → 200401403
GET
/batch
List batches
get-batch-root 10 params → 200400401

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are BatchProgressResponse (9 properties), BatchGetResponsesContentApplicationJsonSchemaResultsItems (8 properties), ErrorResponse (4 properties), BatchResultsResponse (3 properties). Each schema is shown below with its type and property counts.

BatchResultsResponseResultsItems
object
3 properties 1 required
BatchProgressResponseStatus
string
processing while tasks are running; completed when all tasks have finished (regardless of individual success/failure)
BatchGetParametersStatus
string
ErrorResponse
object
4 properties 2 required
BatchGetResponsesContentApplicationJsonSchemaResultsItemsStatus
string
processing while tasks are running; completed when all tasks have finished
BatchGetResponsesContentApplicationJsonSchemaResultsItems
object
8 properties 7 required
Batch_get_batch_root_Response_200
object
2 properties
BatchResultsResponse
object
3 properties 3 required
BatchProgressResponse
object
9 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qubiqle-batch-api-openapi.yml Raw ↑

Other APIs Qubiqle publishes across the network.

Qubiqle accounts API
Qubiqle catalog API
Qubiqle dimensions API
Qubiqle invoices API
Qubiqle oauth API
Qubiqle purchaseOrders API
Qubiqle receipts API
Qubiqle vendors API