Maximo REST API

Documentation for Maximo REST API

• All API calls

Make sure you're logged into maximo before you click on the above link, or else it wont work.

PDFs

• Link to all of the documents
• Maximo_NextGen_REST_API_-_nextgen.pdf
  • This is probably the one you'll use most
• Maximo JSON API Reference.pdf
• Maximo JSON API Overview.pdf
• Maximo_REST_API_Guide.pdf
• Maximo JSON API - Compare.pdf
• Maximo JSON API_Query.pdf

What is a REST API?

In simple terms, a REST (or RESTful) API allows you to query and send information to a server. In our case, we are communicating with the IKO Maximo database to do things like uploading items, uploading images, retrieving existing items, etc.

"REST" is simply a design philosophy for the API, so don't worry about it too much.

To communicate with Maximo, you will need to utilize HTTP Requests. Reading up on http requests is recommended, as this guide will only explain parts that are relevant to Maximo.

Think about requests as a way to "talk" to the server. Each "request" you send to Maximo has 4 key components:

1. Request Method The request method is a way of telling Maximo what type of request you're sending.

OK, but how do I use the API in my code?