Maximo API Explorer

Discover, browse, and test IBM Maximo REST APIs directly from VS Code.

Maximo API Explorer is a Visual Studio Code extension designed for Maximo developers who build applications using the Maximo OSLC/REST API. Unlike MCP-based tools that require an AI agent, this extension works directly in your VS Code sidebar — no AI assistant needed.

Features

API Discovery & Browsing

• Browse Object Structures — Explore all available Maximo Object Structures (MXWO, MXASSET, MXSR, etc.) in a sidebar tree view
• Inspect Attributes — View attribute names, types, max lengths, and descriptions for any Object Structure
• View Relationships — See child and reference relationships between Object Structures
• Search — Filter Object Structures by name or description

Interactive API Testing

• OSLC Query Builder — Build queries visually with oslc.where, oslc.select, oslc.orderBy, and oslc.pageSize
• Raw Request Mode — Send arbitrary GET, POST, PUT, PATCH, DELETE requests
• Response Viewer — See formatted JSON responses with status codes, timing, and record counts
• Schema Inspector — Load and explore Object Structure schemas interactively

Code Snippet Generation

• Multi-Language — Generate ready-to-use code in:
  • cURL — Shell commands
  • Python — Using requests library
  • JavaScript — Using fetch API
  • TypeScript — With typed interfaces
  • Java — Using HttpClient (Java 11+)
• Insert at Cursor — Inject snippets directly into your active editor

Carbon Design System App Templates (NEW in v0.3.0)

Generate complete, ready-to-run web applications that use https://carbondesignsystem.com:

Work Order Browser

A full-featured work order management UI:

• Sortable data table with status badges and priority indicators
• Search by WO number or description, filter by status
• Create new work orders via modal form (POST API)
• Status dashboard tiles with live counts
• Detail side panel with all work order fields
• Pagination for large result sets

Asset Manager

A multi-view asset browser:

• Grid View — Visual card layout showing assets at a glance
• Table View — Classic sortable data table for dense information
• Hierarchy View — Expandable parent-child tree navigation
• Status filter and search
• Detail panel with related work orders
• Asset status dashboard

Both apps are self-contained HTML + CSS + JS — no build tools needed. Just open in a browser!

Export for AI Agents (v0.2.0)

• Export Project Context — Download schemas, endpoints, docs, and code snippets into a .maximo/ directory
• AI Context File — Auto-generated AI_CONTEXT.md to feed to Copilot, Cursor, Windsurf, or any AI assistant
• Single OS Export — Quick-export any Object Structure with schema + snippets

Authentication Management

• API Key — Header-based apikey authentication (most common)
• Basic Auth — Username/password with Base64 encoding
• OAuth 2.0 — Bearer token authentication
• Secure Storage — Credentials stored in VS Code's encrypted SecretStorage

Getting Started

1. Install the Extension

Search for Maximo API Explorer in the VS Code Extensions marketplace, or install from a .vsix file:

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

2. Connect to Maximo

1. Click the Maximo API Explorer icon in the Activity Bar (left sidebar)
2. Click the plug icon or run Maximo: Connect to Instance from the Command Palette
3. Enter your Maximo base URL (e.g. https://your-host.com/maximo)
4. Choose your authentication method and enter credentials
5. The extension will test the connection and discover available APIs

3. Explore APIs

• Object Structures view: Browse, expand, and click to open the test panel
• Right-click any Object Structure for quick actions:
  • View Attributes
  • Test Endpoint
  • Generate Code Snippet
  • Copy Endpoint URL
  • Export for AI Agent

4. Test Endpoints

The API Tester panel provides four tabs:

• OSLC Query — Build parameterized queries with the visual form
• Raw Request — Send freeform HTTP requests
• Schema — Inspect Object Structure attributes and relationships
• Examples — Browse and generate Carbon Design System app templates

5. Generate Code

Click { } Generate Snippet to create API call code in your preferred language. The generated code includes authentication headers, error handling, and result processing.

6. Generate a Carbon App (NEW)

1. Open the Examples tab in the API Tester panel, or run Maximo: Generate Carbon App from the Command Palette
2. Choose Work Order Browser or Asset Manager
3. Select a target folder
4. Open index.html in a browser, configure your Maximo URL and API key, and start browsing!

Extension Settings

Commands

OSLC Query Reference

Combining conditions:

• AND: status="APPR" and siteid="BEDFORD"
• OR: status="APPR" or status="INPRG"
• Comparison: wopriority<=2
• LIKE: description like "%pump%"

Architecture

This extension is a pure VS Code extension — no MCP server, no AI agent dependency. It communicates directly with your Maximo instance's REST API.

┌──────────────────────────────────────────┐
│  VS Code                                  │
│  ┌──────────────────────────────────────┐ │
│  │  Maximo API Explorer                 │ │
│  │  ┌────────┐  ┌──────────────────────┐│ │
│  │  │Sidebar │  │ API Tester + Examples ││ │
│  │  │TreeView│  │    WebView Panel     ││ │
│  │  └───┬────┘  └──────┬───────────────┘│ │
│  │      └──────┬────────┘                │ │
│  │      ┌──────┴───────┐                 │ │
│  │      │ MaximoClient │                 │ │
│  │      │ AuthManager  │                 │ │
│  │      │ AppGenerator │                 │ │
│  │      └──────┬───────┘                 │ │
│  └─────────────┼────────────────────────┘  │
└────────────────┼───────────────────────────┘
                 │ HTTPS
        ┌────────┴──────────┐
        │  Maximo Server     │
        │  OSLC REST API     │
        └───────────────────┘

App Templates

Work Order Browser (maximo-workorders-carbon/)

Asset Manager (maximo-assets-carbon/)

Prerequisites

• Maximo Instance with REST API enabled
• API Key or credentials with appropriate permissions
• VS Code 1.90.0 or later

Development

cd maximo-api-explorer
npm install
npm run compile

# Press F5 in VS Code to launch Extension Development Host

License

Apache-2.0 — See LICENSE for details.

Author

Markus van Kempen
IBM — Maximo AI Integration