Supergood | IBM Maximo Application Suite API

Supergood | IBM Maximo Application Suite API

Programmatically access IBM Maximo Application Suite asset data, work orders, inventory balances, inspections, and meter readings with a stable REST API. Supergood builds and operates production-grade, unofficial Maximo integrations so your team can automate maintenance and supply chain workflows without heavy custom engineering.

Plain English: IBM Maximo Application Suite is enterprise asset management software used by asset-intensive industries (utilities, manufacturing, oil & gas, transportation, facilities) to manage assets, maintenance, work orders, inventory, purchasing, and inspections. An unofficial API lets you programmatically pull assets, locations, work orders, service requests, meters, inventory balances, purchase orders, and documents—and push new work orders, status changes, meter readings, and inventory transactions back into Maximo.

For a tech company integrating with Maximo, this means you can ingest real-time maintenance and asset data to power dashboards, trigger preventive maintenance from IoT telemetry, sync POs/receipts with ERP (e.g., SAP, Oracle), enrich your platform with assignments and schedules, attach inspection artifacts, and keep GIS, analytics, and workforce tools in sync. You can auto-create work orders from sensor alerts, update statuses when technicians complete tasks, reconcile storeroom balances, and export history for compliance.

What is IBM Maximo Application Suite?

IBM Maximo Application Suite (https://www.ibm.com/products/maximo) is a cloud-based and on-prem enterprise asset management (EAM) suite that consolidates asset registry, maintenance planning and execution, inventory and procurement, inspections, health and monitoring, and reliability workflows. Operations, maintenance, and supply chain teams use Maximo to register assets and locations, manage preventive and corrective work, assign labor and crews, process purchase orders and invoices, track storeroom balances and issues/returns/transfers, capture meter readings and condition data, and handle service requests—often with add-ons like Spatial (GIS), Monitor, Predict, and Mobile.

Core product areas include:

  • Asset & Location Management (Assets, Locations, Classifications, Meters, Specifications)
  • Work Management (Work Orders, Tasks, Job Plans, Preventive Maintenance, Assignments, Labor)
  • Inventory & Procurement (Items, Storerooms, Inventory Balances, Issues/Returns, PRs/POs, Vendors)
  • Service & Inspections (Service Requests/Tickets, Inspections, Checklists, Failure Reporting)
  • Reliability & Monitoring (Condition Monitoring, Meter Readings, Alerts, Asset Health)

Common data entities:

  • Organizations and Sites (multi-entity scoping & data separation)
  • Users/People, Labor, Crews, Crafts, Work Groups (security and assignments)
  • Assets and Locations (IDs, status, classification, specs, hierarchy)
  • Work Orders (wonum, status, worktype, assets/locations, tasks, materials, labor)
  • Job Plans and PMs (standard tasks, materials, scheduling rules)
  • Service Requests/Tickets (SR/INC, priorities, ownership)
  • Inventory Items and Storerooms (balances, lots, reservations)
  • Procurement (PRs/POs, vendors, receipts, invoices)
  • Meters and Readings (continuous/gauge/character), Failure Codes (problem/cause/remedy)

The Maximo Integration Challenge

Maximo is mission-critical, but turning intricate, portal-first workflows into reliable API automation is non-trivial:

  • Integration framework complexity: MIF object structures, OSLC resources, and REST endpoints vary by version and configuration; coverage for some modules can be partial or opinionated
  • Security and scoping: Organizations/sites, security groups, signature options (eSig), and status synonyms (WAPPR/APPR/INPRG/COMP/CAN) must be respected to avoid rejections
  • Authentication: SSO (SAML/OIDC), enterprise MFA, and session lifecycles complicate headless automation
  • Data shape and volume: Deeply related objects (tasks, materials, labor, failure hierarchies) with large datasets (10k+ WOs) require careful pagination and normalization
  • Exports and reporting: Ad-hoc CSV/report exports (BIRT) are brittle for system-to-system sync; bulk historical extracts can be slow or rate-limited
  • Customization drift: Domains, crossover fields, automation scripts (Jython), and conditional UI can change required fields and validation rules unexpectedly
  • Cost/licensing considerations: App points/licensing and API throughput controls can constrain polling strategies and backfills

How Supergood Creates Maximo APIs

Supergood reverse-engineers authenticated browser flows and MIF/REST interactions to deliver a resilient API endpoint layer for your Maximo tenant.

  • Handles username/password, SSO/OAuth, and MFA (SMS, email, TOTP) securely
  • Maintains session continuity with automated refresh and change detection
  • Normalizes responses so you can integrate once and rely on consistent objects across modules
  • Aligns with customer entitlements, org/site scoping, and role-based permissions to ensure compliant access
  • Captures signature options and audit fields when status changes require eSig

Use Cases

Asset, Location & Workforce Data Sync

  • Mirror assets, locations, and crews into your internal systems
  • Keep asset status, criticality, and specs current for analytics and GIS
  • Normalize org/site identifiers for multi-tenant operations

Work Management Automation

  • Auto-create work orders from IoT alerts and inspection failures
  • Push status updates, assignments, and actuals from your field app
  • Attach photos, forms, and documents and link to external references

Inventory & Procurement

  • Reconcile storeroom balances and reservations with your ERP/WMS
  • Generate purchase requests and purchase orders from planned materials
  • Track receipts and issues against work orders for cost accuracy

Condition Monitoring & Compliance

  • Stream meter readings and condition data to trigger PMs or alerts
  • Export work history, approvals, and signature artifacts for audits
  • Build health and reliability dashboards combining Maximo + sensor data

Available Endpoints

Authentication

POST /sessions: Establish a session using credentials. Supergood manages MFA (SMS, email, TOTP) and SSO/OAuth when enabled. Returns a short-lived auth token maintained by the platform.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/sessions \
  --header 'Authorization: Basic <Base64 encoded token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "username": "[email protected]",
    "password": "<password>",
    "mfa": { "type": "totp", "code": "123456" }
  }'

Example response

{
  "authToken": "eyJhbGciOi...",
  "expiresIn": 3600,
  "user": {
    "id": "u_max_3f92a1",
    "name": "Maintenance Supervisor",
    "orgs": ["EASTCO"],
    "sites": ["PLANT1", "PLANT2"],
    "entitlements": ["assets", "work_orders", "inventory", "meters"]
  }
}

POST /sessions/refresh: Refresh an existing token to keep sessions uninterrupted.

Assets

GET /assets: List assets with filters and summary details.

Query parameters

  • orgId: string
  • siteId: string
  • location: string
  • status: OPERATING | NOT_READY | DECOMMISSIONED
  • classstructureId: string
  • assetnum: string
  • updatedFrom, updatedTo: ISO 8601 timestamps
  • page, pageSize: integers for pagination

Example response

{
  "items": [
    {
      "assetId": "a_102938",
      "assetnum": "PM-CH-00421",
      "description": "Primary Chiller #1",
      "orgId": "EASTCO",
      "siteId": "PLANT1",
      "location": "BLD1-CHLRM",
      "status": "OPERATING",
      "criticality": 5,
      "classstructureId": "HVAC-CHILLER",
      "manufacturer": "Trane",
      "model": "CEN-1300",
      "serialnum": "TR-CH-2020-0098",
      "installDate": "2021-03-18",
      "ownerGroup": "FAC_MAINT",
      "priority": 3,
      "meters": [
        {"meterName": "HOURS", "type": "CONTINUOUS", "lastReading": 12560},
        {"meterName": "TEMP_SUPPLY", "type": "GAUGE", "lastReading": 42.3, "units": "F"}
      ],
      "coordinates": {"lat": 41.2565, "lng": -95.9345},
      "updatedAt": "2026-01-20T13:45:00Z"
    }
  ],
  "page": 1,
  "pageSize": 50,
  "total": 1
}

Work Orders

POST /work-orders: Create a work order with job plan, materials, and initial assignments.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/work-orders \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "orgId": "EASTCO",
    "siteId": "PLANT1",
    "description": "Investigate high vibration on pump P-201",
    "worktype": "CM",
    "status": "WAPPR",
    "assetnum": "P-201",
    "location": "BLD2-PUMP",
    "priority": 2,
    "targetStart": "2026-02-01T08:00:00Z",
    "targetFinish": "2026-02-01T12:00:00Z",
    "jobplan": "JP-VIB-INSPECT",
    "failureClass": "PUMP",
    "longDescription": "Trend shows 2x line frequency spike. Inspect coupling and bearings.",
    "assignments": [
      {"laborcode": "JSMITH", "craft": "MECH", "requiredHours": 4},
      {"crewId": "MECH_DAY_A", "requiredHours": 4}
    ],
    "materials": [
      {"itemnum": "BRG-6205-2RS", "quantity": 2, "storeroom": "MAIN_STOR", "issueOnApprove": false}
    ],
    "referenceId": "sensor-alert-8f13a2"
  }'

Example response

{
  "workorderId": "wo_7b1c92",
  "wonum": "131245",
  "siteId": "PLANT1",
  "status": "WAPPR",
  "createdAt": "2026-01-21T10:03:11Z"
}

Work Order Status

PATCH /work-orders/{wonum}/status: Update a work order's status with memo and optional eSig.

curl --request PATCH \
  --url https://api.supergood.ai/integrations/<integration_id>/work-orders/131245/status \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "siteId": "PLANT1",
    "status": "INPRG",
    "memo": "Tech assigned; beginning vibration inspection.",
    "reasonForChange": "dispatch",
    "eSig": {"user": "JSMITH", "comment": "Start work", "timestamp": "2026-02-01T08:05:00Z"}
  }'

Example response

{
  "wonum": "131245",
  "siteId": "PLANT1",
  "status": "INPRG",
  "statusDate": "2026-02-01T08:05:02Z",
  "updatedAt": "2026-02-01T08:05:02Z"
}

Meter Readings

POST /meter-readings: Record a new meter or condition reading for an asset or location.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/meter-readings \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "orgId": "EASTCO",
    "siteId": "PLANT1",
    "assetnum": "P-201",
    "meterName": "VIB_OVERALL",
    "type": "GAUGE",
    "reading": 7.8,
    "units": "mm/s",
    "readingDate": "2026-02-01T07:50:00Z",
    "source": "iot",
    "capturedBy": "edge-gw-12",
    "observationNotes": "High vibration prior to startup"
  }'

Example response

{
  "meterReadingId": "mr_55d0c4",
  "assetnum": "P-201",
  "meterName": "VIB_OVERALL",
  "reading": 7.8,
  "units": "mm/s",
  "createdAt": "2026-02-01T07:50:05Z"
}

Get full API Specs →


Technical Specifications

  • Authentication: Username/password with MFA (SMS, email, TOTP) and SSO/OAuth where enabled; supports service accounts or customer-managed credentials
  • Response format: JSON with consistent resource schemas and pagination across modules
  • Rate limits: Tuned for enterprise throughput while honoring customer entitlements and usage controls
  • Session management: Automatic reauth and cookie/session rotation with health checks
  • Data freshness: Near real-time retrieval of assets, work orders, inventory, and meter data
  • Security: Encrypted transport, scoped tokens, audit logging; respects Maximo org/site scoping, security groups, and signature options
  • Webhooks: Optional asynchronous delivery for long-running workflows (e.g., approvals, work status changes)

Performance Characteristics

  • Latency: Sub-second responses for list/detail queries under normal load
  • Throughput: Designed for high-volume asset and work order synchronization
  • Reliability: Retry logic, backoff, and idempotency keys minimize duplicate actions
  • Adaptation: Continuous monitoring for UI/API changes with rapid adapter updates

Getting Started

  1. Schedule Integration Assessment

Book a 30-minute session to confirm your modules, licensing, and authentication model.

  1. Supergood Builds and Validates Your API

We deliver a hardened Maximo adapter tailored to your workflows and entitlements.

  1. Deploy with Monitoring

Go live with continuous monitoring and automatic adjustments as Maximo evolves.

Schedule Integration Call →


Frequently Asked Questions

Q: Which Maximo modules can this integration cover?

Supergood supports workflows across commonly used modules such as Asset & Location Management, Work Management (Work Orders, Tasks, Job Plans, PMs), Inventory & Procurement (Items, Storerooms, PRs/POs), and Service & Inspections, subject to your licensing and entitlements. We scope coverage during integration assessment.

Q: How are MFA and SSO handled for automation?

We support username/password + MFA (SMS, email, TOTP) and can operate behind SSO/OAuth when enabled. Sessions are refreshed automatically with secure challenge handling.

Q: Can you sync purchase orders and inventory with our ERP/WMS?

Yes. We can normalize items, storerooms, PRs/POs, and receipts to match your ERP/WMS schema (e.g., SAP, Oracle) and deliver updates via webhooks or polling while complying with rate and permission constraints.

Q: Are approvals, attachments, and e-signatures supported?

Yes. We support downloading approval artifacts and uploading attachments via signed uploads, with checksum validation and time-limited URLs. When status changes require Maximo signature options, we capture and pass eSig details.


ServiceNow API - Programmatically access ServiceNow ITSM with Supergood


Ready to automate your Maximo workflows?

Supergood can have your IBM Maximo integration live in days with no ongoing engineering maintenance.

Get Started →

Read more