Swagger JSON and UI

This section describes the generated swagger JSON for maximo restful apis based on metadata of object structures, api routes and system apis.

In IBM Maximo Manage, the swagger JSON is created by utilizing system metadata following the OAS3 standard. It describes the standard APIs for integration Object Structures, System APIs like auto scripts with the common query parameters, object schemas (if applicable) and possible responses.

The response is large and will take some time to generate. By default it will contain swagger json for all of the integration object structures in Manage.

If you need the swagger for certain object structure like MXAPIASSET, here is the example,

The object structures are grouped by module like ASSET, PURCHASE. To get swagger JSON for certain module,

By default, the common OS actions are excluded due to the size. To include all actions,

You can access the Swagger user interface to view and test the RESTful APIs by accessing following url in browser,

Note, you will need to login the system before accessing the swagger UI.

The major APIs are also grouped by module, to access the module view, try: