Is there any OOB logger for inbound REST API?
I'd like to capture:  requestor IP#, Header Info, Invocation Date/time, Pass/Fail.

Thanks!

------------------------------
Dianne W
------------------------------

#Maximo
#AssetandFacilitiesManagement

I'm going to assume you're talking about the new REST API (using the /maximo/oslc context and not the old /maxrest). From a logging perspective, you can use the oslc logger and it will give you most of the details that you are looking to capture. If you're on 7.6.1.1, you can use new functionality to track the REST API requests. Info on setting it up can be found here: https://www.ibm.com/support/pages/message-tracking-synchronous-requests. Be aware though, your requests will be slower because each request now has overhead to enable this tracking that has to be written to the database. It's typically better to do this "as needed" for troubleshooting rather than leaving enabled all the time. This is particularly important if you're currently using Work Centers or Anywhere, as both products utilize these APIs so you'll be logging those requests in addition to actual user REST API requests which is what most people are concerned about. 

Neither answer really handles headers though. There are some potentially useful headers but there are also some headers (such as the MAXAUTH header) that shouldn't be logged. I'm not aware of a generic way to log the headers in Maximo. Most of the time you wouldn't need the header as it'll be details like x-method-override that could be determined based on the URL context, but if you were interested in doing it for specific object structures I can build an automation script example that will log the body & headers you're interested in. 

------------------------------
Steven Shull
Director of Development
Projetech Inc
Cincinnati OH
------------------------------

Steven made some good points. In addition to what he said, if you are using WebSphere, you could investigate the access.log in IBM\HTTPServer\logs. That tends to have some of the more basic HTTP info you seem to be looking for.

------------------------------
Blessings,
Jason Uppenborn
Sr. Technical Maximo Consultant
Ontracks Consulting
------------------------------

Original Message:
Sent: Mon June 08, 2020 08:13 AM
From: Steven Shull
Subject: REST API/OSLC Default Logger.

I'm going to assume you're talking about the new REST API (using the /maximo/oslc context and not the old /maxrest). From a logging perspective, you can use the oslc logger and it will give you most of the details that you are looking to capture. If you're on 7.6.1.1, you can use new functionality to track the REST API requests. Info on setting it up can be found here: https://www.ibm.com/support/pages/message-tracking-synchronous-requests. Be aware though, your requests will be slower because each request now has overhead to enable this tracking that has to be written to the database. It's typically better to do this "as needed" for troubleshooting rather than leaving enabled all the time. This is particularly important if you're currently using Work Centers or Anywhere, as both products utilize these APIs so you'll be logging those requests in addition to actual user REST API requests which is what most people are concerned about. 

Neither answer really handles headers though. There are some potentially useful headers but there are also some headers (such as the MAXAUTH header) that shouldn't be logged. I'm not aware of a generic way to log the headers in Maximo. Most of the time you wouldn't need the header as it'll be details like x-method-override that could be determined based on the URL context, but if you were interested in doing it for specific object structures I can build an automation script example that will log the body & headers you're interested in. 

------------------------------
Steven Shull
Director of Development
Projetech Inc
Cincinnati OH
------------------------------