Maximo API Explorer

Browse, test, and scaffold IBM Maximo REST APIs — directly from VS Code. No AI agent required.

What is this?

Maximo API Explorer is a VS Code extension for developers building applications on top of IBM Maximo Application Suite (MAS) or IBM Maximo 7.6.x. It gives you a full API development toolkit in your sidebar:

🔍 Browse every Object Structure available on your Maximo instance
🧪 Test OSLC queries and raw HTTP requests interactively
⚡ Scaffold self-contained Carbon Design System HTML apps seeded with live Maximo data
✏️ CRUD — create, update, delete records and trigger workflow actions
{ } Snippets — generate API call code in cURL, Python, JavaScript, TypeScript, Java
📋 Multi-environment — switch between DEV, QA, STAGING, PROD with one click
🤝 Works alongside the IBM Maximo MCP Extension for AI integration

Works in: VS Code, IBM Bob IDE, Cursor AI, Windsurf, Antigravity, and any VS Code-compatible IDE.

Features

The main entry point is a compact tabbed sidebar webview:

Tab	Contents
Setup	Connection status, Connect/Re-connect/Disconnect, Manage Systems badge
Tools	Quick-launch cards for API Tester, Scaffold, CRUD, Diagnostics (shown when connected)
Docs	IBM REST API docs, GitHub, extension settings

🌐 Connection & Multi-Environment Management

Manage multiple Maximo systems — DEV, QA, STAGING, PROD profiles each with their own URL and API key
Smart connect flow — if no systems are configured, opens the Environment Manager directly
First-environment auto-activate — saves the first environment as the default and prompts to connect
Cross-extension credential sync — automatically reads credentials from the companion maximo-mcp extension so you don't configure twice
SSL verification toggle — disable for self-signed dev certificates

🔍 Object Structures Browser

Browse all available Maximo Object Structures in a sidebar tree (MXWO, MXASSET, MXSR, MXLABOR, MXINVENTORY, MXPO, MXPR, MXPERSON, MXLOCATION, MXITEM, MXDOMAIN, and hundreds more)
Expand any OS to see its Attributes (name, type, maxLength, description) and Relationships (child & reference links)
Search / filter Object Structures by name or description
Right-click context menu — Test Endpoint, Generate Snippet, View Attributes, Copy URL, Export, Quick Seed

🧪 API Endpoint Tester (Webview Panel)

A full interactive tester with four tabs:

Tab	What it does
OSLC Query	Visual form: `oslc.where`, `oslc.select`, `oslc.orderBy`, `oslc.pageSize`, lean mode
Raw Request	Freeform GET / POST / PUT / PATCH / DELETE with custom headers and body
Schema	Load and explore Object Structure field schemas from live data
Examples	Carbon Design System app template previews and generators

⚡ Live Seed & Scaffold App Generator

Generate a complete, self-contained Carbon Design HTML app seeded with live Maximo data — no build step, no framework, just open index.html in a browser.

Webview panel UI (not a wizard — everything on one screen):

8 clickable Object Structure preset cards — MXWO, MXASSET, MXSR, MXLABOR, MXINVENTORY, MXLOCATION, MXITEM, MXPO
OSLC Where clause with quick-fill pills: WAPPR, APPR+BEDFORD, Priority 1, In Progress
Field selection with preset pills: Work Order defaults, Asset defaults, SR defaults
Record count — 5 / 10 / 20 / 50 records
3 visual theme cards — 🌙 Carbon Dark · ☀️ Carbon Light · 💙 IBM Blue
Full-width launch button with live status feedback (connecting → generating → done / error)
Output: maximo-<os>-scaffold/index.html with sortable table, search, status badges

✏️ CRUD Operations Studio

A webview dashboard for write operations against any Object Structure:

Create records (POST)
Update records (PATCH via x-method-override)
Delete records (DELETE)
Trigger workflow actions (POST with action= parameter)
JSON payload editor with field suggestions

`{ }` Code Snippet Generator

Generate ready-to-run API call code in 5 languages:

Language	Library
cURL	Shell
Python	`requests`
JavaScript	`fetch`
TypeScript	`fetch` with typed interfaces
Java	`HttpClient` (Java 11+)

Snippets include authentication headers, OSLC parameters, error handling, and result parsing. Insert at cursor injects directly into your active editor file.

📊 Diagnostics & Health Check

Full-screen diagnostics panel showing:

Connection status and latency
Authentication method and API key validation
SSL certificate verification status
Individual endpoint health checks (/whoami, /os, /os/mxdomain)

📤 Export for AI Agents

Export Project Context — writes schemas, endpoints, and docs into a .maximo/ directory as AI_CONTEXT.md — ready to feed to Copilot, Cursor, Windsurf, or any AI assistant
Export Single OS — quick-export any Object Structure with schema + all snippet languages

Getting Started

1. Install

Search Maximo API Explorer in the VS Code Marketplace / Open VSX, or:

code --install-extension maximo-api-explorer-0.18.0.vsix

2. Configure a Maximo System

Click the Maximo API Explorer icon in the Activity Bar
Click Add System & Connect (if no systems configured) or Connect
In the Environment Manager panel: enter a name (e.g. DEV), your Maximo URL, and API Key
Click Save — the system is automatically set as default
Click Connect Now in the notification, or click Connect in the sidebar

Tip: If you already have the IBM Maximo MCP Extension installed and configured, credentials are synced automatically.

3. Browse & Test

The Object Structures tree populates after connecting
Click any OS to open the API Tester panel
Right-click for context actions (test, snippet, seed, export)

4. Generate a Scaffold App

Click ⚡ Scaffold in the sidebar Tools tab, or run Maximo: Live Seed & Scaffold from the Command Palette
Select an Object Structure preset card or type any OS name
Optionally add a where-clause filter and field selection
Click 🚀 Generate Live Seed & Scaffold App
Choose a save folder — index.html opens immediately in your editor

OSLC Query Reference

Parameter	Description	Example
`oslc.where`	Filter records	`status="APPR" and siteid="BEDFORD"`
`oslc.select`	Fields to return	`wonum,description,status,siteid`
`oslc.orderBy`	Sort order (prefix `-` = descending)	`-reportdate`
`oslc.pageSize`	Max records per page	`20`
`lean=1`	Simplified JSON without OSLC metadata	—

Common filter patterns:

status="WAPPR"
status="APPR" and siteid="BEDFORD"
wopriority<=2
description like "%pump%"
reportdate>="2024-01-01T00:00:00-00:00"
status="APPR" or status="INPRG"

Extension Settings

Setting	Default	Description
`maximoExplorer.url`	`""`	Base URL (e.g. `https://your-host.com/maximo`)
`maximoExplorer.activeEnvironment`	`""`	Active environment profile name
`maximoExplorer.environments`	`[]`	Array of DEV/QA/PROD profile objects
`maximoExplorer.authMethod`	`"apikey"`	`apikey` · `basic` · `oauth`
`maximoExplorer.lean`	`true`	Lean responses (no OSLC metadata)
`maximoExplorer.defaultPageSize`	`20`	Default records per query
`maximoExplorer.sslVerify`	`true`	SSL cert verification (disable for self-signed)

Commands

Command	Description
`Maximo: Connect to Instance`	Connect to a Maximo system
`Maximo: Disconnect`	Disconnect and clear credentials
`Maximo: Refresh Object Structures`	Re-discover Object Structures
`Maximo: Search Object Structures`	Filter the tree
`Maximo: Test API Endpoint`	Open the interactive API tester
`Maximo: Live Seed & Scaffold`	Open the scaffold app generator panel
`Maximo: Generate Code Snippet`	Generate API call code
`Maximo: Insert API Snippet at Cursor`	Inject snippet into editor
`Maximo: Open CRUD Operations Studio`	Open write-operations panel
`Maximo: Run System Diagnostics & Health Check`	Full health check
`Maximo: Open System Environment Manager`	Manage DEV/QA/PROD profiles
`Maximo: Generate Carbon App`	Generate a static app template
`Maximo: Export Project Context for AI`	Export schemas for AI agents
`Maximo: Export Object Structure`	Export a single OS
`Maximo: Toggle CORS Development Proxy`	Start/stop local CORS proxy

Works Great With

IBM Maximo MCP Extension — the companion extension that connects IBM Maximo to AI assistants (GitHub Copilot, Cursor AI, IBM Bob, Windsurf, Antigravity, Claude Desktop) via the Model Context Protocol (MCP). The two extensions share credentials automatically.

Architecture

VS Code / IBM Bob / Cursor / Windsurf
┌──────────────────────────────────────────────────┐
│  Maximo API Explorer Extension                    │
│                                                   │
│  ┌────────────────┐  ┌──────────────────────────┐ │
│  │ Sidebar Webview│  │  Webview Panels           │ │
│  │ (Setup/Tools/  │  │  • API Endpoint Tester    │ │
│  │  Docs tabs)    │  │  • Scaffold Generator     │ │
│  └───────┬────────┘  │  • CRUD Studio            │ │
│          │           │  • Diagnostics            │ │
│  ┌───────┴──────────┐│  • Environment Manager    │ │
│  │ Tree Providers   ││                           │ │
│  │ • Connection     │└──────────┬────────────────┘ │
│  │ • Object Structs │           │                  │
│  │ • API Endpoints  │           │                  │
│  └───────┬──────────┘           │                  │
│          └──────────┬───────────┘                  │
│               ┌─────┴──────┐                       │
│               │MaximoClient│                       │
│               │AuthManager │                       │
│               │ApiDiscovery│                       │
│               └─────┬──────┘                       │
└─────────────────────┼──────────────────────────────┘
                      │ HTTPS / OSLC REST API
              ┌───────┴────────────┐
              │   Maximo Server    │
              │  (MAS / 7.6.x)     │
              └────────────────────┘

Requirements

IBM Maximo Application Suite (MAS 8.x / 9.x) or IBM Maximo 7.6.1+
REST API enabled and accessible from your network
API Key or basic auth credentials with MAXEVERYONE or appropriate security groups
VS Code 1.90.0 or later (or compatible IDE)
No Node.js, no build tools, no AI assistant required

License

Apache-2.0 — see LICENSE

Author

Markus van Kempen — IBM Maximo AI Integration
GitHub · Open VSX · Issues

Maximo API Explorer — IBM Maximo REST API Browser, Tester & Scaffold Generator

Markus van Kempen

Maximo API Explorer

What is this?

Features

🔬 Sidebar Panel — Setup · Tools · Docs

🌐 Connection & Multi-Environment Management

🔍 Object Structures Browser

🧪 API Endpoint Tester (Webview Panel)

⚡ Live Seed & Scaffold App Generator

✏️ CRUD Operations Studio

`{ }` Code Snippet Generator

📊 Diagnostics & Health Check

📤 Export for AI Agents

Getting Started

1. Install

2. Configure a Maximo System

3. Browse & Test

4. Generate a Scaffold App

OSLC Query Reference

Extension Settings

Commands

Works Great With

Architecture

Requirements

License

Author

Maximo API Explorer — IBM Maximo REST API Browser, Tester & Scaffold Generator

Markus van Kempen

Maximo API Explorer

What is this?

Features

🔬 Sidebar Panel — Setup · Tools · Docs

🌐 Connection & Multi-Environment Management

🔍 Object Structures Browser

🧪 API Endpoint Tester (Webview Panel)

⚡ Live Seed & Scaffold App Generator

✏️ CRUD Operations Studio

{ } Code Snippet Generator

📊 Diagnostics & Health Check

📤 Export for AI Agents

Getting Started

1. Install

2. Configure a Maximo System

3. Browse & Test

4. Generate a Scaffold App

OSLC Query Reference

Extension Settings

Commands

Works Great With

Architecture

Requirements

License

Author

`{ }` Code Snippet Generator