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

Acadia Work Instructions API

Manage digital work instructions and task lists

Acadia Work Instructions API is one of 5 APIs that Acadia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Work Instructions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

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

Requests are made against a single base URL, https://api.acadia-software.com/v1.

3 operations 2 paths 5 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.acadia-software.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Acadia Work Instructions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — JWT Bearer token for API authentication

Paths & Operations 3

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

Work Instructions 3

Manage digital work instructions and task lists

GET
/work-instructions
Acadia List Work Instructions
listWorkInstructions 4 params → 200401
POST
/work-instructions
Acadia Create Work Instruction
createWorkInstruction body → 201400401
GET
/work-instructions/{id}
Acadia Get Work Instruction
getWorkInstruction 1 param → 200404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are WorkInstruction (9 properties), WorkInstructionList (4 properties), CreateWorkInstructionRequest (4 properties), WorkInstructionStep (3 properties). Each schema is shown below with its type and property counts.

WorkInstruction
object
A digital work instruction document
9 properties
WorkInstructionStep
object
A single step within a work instruction
3 properties
CreateWorkInstructionRequest
object
Request body for creating a work instruction
4 properties 2 required
WorkInstructionList
object
Paginated list of work instructions
4 properties
ErrorResponse
object
Error response
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

acadia-work-instructions-api-openapi.yml Raw ↑

Other APIs Acadia publishes across the network.

Acadia Employees API
Acadia Quizzes API
Acadia Roles API
Acadia Skills API