Maximo Open Forum

Hi Everyone,

When I call MAS 9 OSLC API in Postman, I'm getting HTML response instead of JSON/XML.

Example:
https://mydomain/maximo/oslc/os/mxapiasset?lean=1

It seems to return a login/error HTML page instead of API data.

Has anyone faced this in MAS 9?
Could you please advise on it?

Thanks!

Replace the /oslc route with /api and use an API Key in the header. Example:

GET https://mydomain/maximo/api/os/mxapiasset?lean=1&oslc.pageSize=10&oslc.select=assetnum,siteid,description
apikey: xxxxxxxxxx

Hope this helps.

Hi Alex, Thanks for the response.

The maximo/api/os is working. Do you know why OSLC isn't working in MAS

GET https://mydomain/maximo/api/os/mxapiasset?lean=1&oslc.pageSize=10&oslc.select=assetnum,siteid,descriptionapikey: xxxxxxxxxx

The /api route is unprotected so that it can operate in a stateless, session-less manner. The /oslc route is protected in that you need an authenticated session. So theoretically you can use the /oslc route if you have a set of cookies from an authenticated session that you pass as headers to the request.

The majority of the API use cases I've seen are integration use cases and therefore the /api route makes the most sense. However, if you are developing a user interface where a user logs in and performs transactions outside of Maximo, you would likely want to use the /oslc route.

Hope that helps,

GET https://mydomain/maximo/api/os/mxapiasset?lean=1&oslc.pageSize=10&oslc.select=assetnum,siteid,descriptionapikey: xxxxxxxxxx

Hi Munikrishnan, 

Bruno Portaluri's Maximo Dev's post, "MIF vs OSLC vs REST vs JSON APIs on the "very insightful explanation by Steven Shull on MoreMaximo forum about of the different types of REST APIs available in Maximo" provides the answer to your question.

In IBM Maximo Asset Management, the Consumed By field in the Object Structures application dictates which internal module or framework is authorized to use that specific object structure.<sources-carousel-inline ng-version="0.0.0-PLACEHOLDER" _nghost-ng-c3214874120=""> </sources-carousel-inline>

By defining the "consumer," Maximo isolates the object structure's purpose and dynamically adjusts its behavior, visibility, and available configuration options to fit the specific needs of that module. 

Maximo's "Consumed By" Values

• INTEGRATION: This is the most common value. It makes the object structure available to the Maximo Integration Framework (MIF). It allows the structure to be used for enterprise services, publish channels, standard REST APIs, flat-file (CSV) imports/exports, and web services exchanging data with external systems.

• REPORTING: Exposes the object structure to Maximo's reporting ecosystem. It allows the structure to be used as a Report Object Structure (ROS) for creating Ad Hoc (QBR) reports, downloading Work Center data sets, or integrating with BI tools like Cognos.

• MIGRATIONMGR: Assigns the object structure to the Migration Manager application. This is used strictly to package, export, and promote configuration data (such as workflows, application design changes, or domains) between different Maximo environments (e.g., moving from Development to Production).

• OSLC: Makes the object structure available as an OSLC (Open Services for Lifecycle Collaboration) resource. This is heavily used in Maximo Anywhere, Work Centers, and modern Maximo Application Suite (MAS) integrations for lightweight, RESTful data interactions. 

------------------------------
Fredrick Ndwaru
Perpetual Ignition Inc.
------------------------------

GET https://mydomain/maximo/api/os/mxapiasset?lean=1&oslc.pageSize=10&oslc.select=assetnum,siteid,descriptionapikey: xxxxxxxxxx

Also, in MAS, Object Structure security is enforced, so make sure to explicitly configure object structure security for the object structure you're using (mxapiasset) and grant the sig options to the user, who's API key you're using for authentication.