16 Comments

1. 

   John Harper

   September 11, 2019 at 2:21 pm

   any way to capture the jsession id and run a get oslc/logout for that session for high volume of call?

   • Log in to Reply
   • Link
   • 

     Alex Walter

     September 17, 2019 at 8:42 am

     The JSESSIONID can be captured via the Set-Cookie header in the response from the oslc/login call. When you are finished with the session call the oslc/logout with those credentials.

     • Log in to Reply
     • Link
2. 

   sun

   October 21, 2019 at 7:19 pm

   Thanks for explaining how to encode the login & password. I’m going to try using CURL and see if I can login and retrieve results via a URL.

   • Log in to Reply
   • Link
3. 

   TANWEER

   December 5, 2019 at 5:35 am

   Hi Alex
   i am using REST API in the LDAP enabled environment ,which needs  Basic Authentication . i have written the below code but form data is not passing to maximo where as a blank service request record created.

   where as if i pass data in url using &, it creates the record with data. but large data cannot be passed in this manner since there is limitation of url size. following is the code i have written to pass form data , can you suggest why form data is not passing.

   body
   {
   direction:ltr;text-align:left;
   }
   .row
   {
   display:block; padding:10px;    
   }

     function CallWebAPI() {
       var formData = new FormData(document.forms.myForm);
           
       var XHR = new XMLHttpRequest();
          
       });

       // Set up our request
       XHR.open(“POST”, “http://controldesk.local/maxrest/rest/os/MYSR”);
         XHR.setRequestHeader(‘Authorization’,’Basic cG14aW50OlBAc3N3MHJkMTA=’);

       // The data sent is what the user provided in the form
       XHR.send(formData);
     }
    
     // Access the form element…
       

   Basic Authentication Using JavaScript

    
     DESCRIPTION:
    
    
    
     INTERNALPRIORITY:
    
    
    
    
     civilid:
    
    

    

   Thanks & Regards

   Tanweer

   • Log in to Reply
   • Link
   • 

     Alex Walter

     January 15, 2020 at 12:23 pm

     Make sure you don’t have a CORS issue going on with XHR requests.
     https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS

     • Log in to Reply
     • Link
     • 

       Nonitha

       May 2, 2020 at 4:53 am

       Is it possible to read the content of the JSON body from automation script?
       request.getQueryParam() is to read query parameters and request.getHeaderParams() is to read header parameters.
       Is there any method to read body content from the JSON API?
       Because passing parameters in URL has many restrictions.

       Thanks
       Nonitha

       • Log in to Reply
       • Link
       • 

         Alex Walter

         May 18, 2020 at 12:54 pm

         There is a request.readRequestBody() method that returns a byte array.

         Hope that helps,
         Alex

         • Log in to Reply
         • Link
4. 

   Ed Matthews

   April 29, 2020 at 9:20 am

   Hi Bob,

   I’ve heard it’s best to move to the json syntax for its power and flexibility, but the rest message format returned is preferable to the URIs for the case I’m solutioning.
   Is there a way to use the json api syntax but to get an output like that of the rest api, that is, the data not the URIs?
   It seems maybe possible using {*} for each object, I will work on that option, but that appears to make the query URLs more complex, given the integration object itself that I’m using contains the attribution an external system wants to use, so setting the query syntax to use {*} from the top object down following the whole object structure is redundant.

   Wondering what I may be missing.

   • Log in to Reply
   • Link
5. 

   Ed Matthews

   April 29, 2020 at 9:32 am

   If you have the other comment I just sent this below provides some more detail but not the answer.
   In the ibm guide available here:
   https://developer.ibm.com/static/site-id/155/maximodev/restguide/Maximo_Nextgen_REST_API.html#_querying_maximo_asset_management_by_using_the_rest_api

   it says,

   “Just getting the links to the member resources may not be very exciting or useful. Rather than traversing individual URIs for details, the oslc.select clause is used to get more details inlined in this JSON response.

   GET /oslc/os/mxasset?oslc.pageSize=10&oslc.select=assetnum,location,description,status”

   In the article example above, how would you / could you use the json api to get the same result as
   http://maximo_host/maxrest/rest/os/mxperson/88?_format=json&_compact=1 ?

   Trying to understand better the advantages and tradeoffs of using
   maximo/oslc/os vs maxrest/rest/os

   Thanks,
   Ed

   • Log in to Reply
   • Link
   • 

     Alex Walter

     May 17, 2020 at 3:37 pm

     Biggest advantages are: 1) the ability to dynamically pull data based on information that may not necessarily be listed in the Object Structure, 2) more fine-grained control of filtering and sorting, 3) the ability to support paging through sets of data, and 4) continuing feature enhancements and support from IBM. The REST API is static and will not continue to be developed, where the JSON API is being updated with each new release of Maximo.

     Hope this helps,
     Alex

     • Log in to Reply
     • Link
6. 

   Mark Fresa

   May 19, 2020 at 8:14 am

   Does anyone know how to POST updates to Maximo using Postman in URL strings? Please contact me if possible. Thanks in advance.

   • Log in to Reply
   • Link
7. 

   Sreekala

   July 28, 2020 at 7:53 am

   Hi ,
   For ADFS enabled maximo environment ,GET http://maximo_host/maxrest/rest/os/mxperson?personid=CAR%
   Authorization: Basic bWF4YWRtaW46bWF4YWRtaW4= is not working.
   Getting the below error:
   function LoginErrors(){this.userNameFormatError = ‘Enter your user ID in the format \u0026quot;domain\\user\u0026quot; or \u0026quot;user@domain\u0026quot;.’; this.passwordEmpty = ‘Enter your password.’; this.passwordTooLong = ‘Password is too long (\u0026gt; 128 characters).’;}; var maxPasswordLength = 128;
   //]]>

   Any help would be appreciated

   • Log in to Reply
   • Link
8. 

   Gene

   July 28, 2020 at 5:11 pm

   How do I query the Maximo JSON API using python scripting alone? That is no PostMan?

   I have Maximo 7.6.1 and I am using basic authentication.

   I used Postman to make my Get Request, which was successful and return data, and then clicked on the “Code” button to the right to get the python script. When I use it in my IDE I get this error:

   {“Error”:{“reasonCode”:null,”message”:”Lexical error at line 1, column 13. Encountered: \”%\” (37), after : \”\””,”statusCode”:”500″}}

   Here is the python:
   import requests

   url = “http://myserver/maximo/oslc/os/mxwo”

   querystring = {“lean”:”1″,”oslc.select”:”wonum,actstart,status,description,reportedby,agx,agy”,”oslc.where”:”problemcode=%22DR07%22″,”status”:”%22APPR%22″}

   payload = “”
   headers = {
   ‘maxauth’: “mypasswordhereinbase64”,
   ‘cache-control’: “no-cache”,
   ‘Postman-Token’: “3803cf2c-5aed-4739-aab0-f5c86692f7e0”
   }

   response = requests.request(“GET”, url, data=payload, headers=headers, params=querystring)

   print(response.text)

   • Log in to Reply
   • Link
9. 

   Ronak Agrawal

   August 20, 2020 at 4:14 pm

   Hi Alex,

   How maintain the session for a user when Maximo instance uses LDAP BASIC Auth. Maintaining session workflow:
   1. Login (OSLC/login)
   2. Subsequent API calls using the Cookies (Get Object values, update object values etc..)
   3. Logout (OSLC/logout) (This is also one of the and last subsequent calls for that session).

   I am struggling in defining the Header values for the subsequent calls.

   If I put Header as :
   i. Cookie:”LtpaToken2=; JSESSIONID=” (NOTE Values are taken from initial OSLC/login Method) – The server generates another session

   ii. Two headers:
   Cookie:”LtpaToken2=”
   Cookie:”JSESSIONID=”
   Server returns 401 response

   iii. Use single Cookie for each call, with value of LtpaToken – Server generates new session
   iv. Use single Cookie for each call, with value of JSESSIONID – Server returns 401 response.

   NOTE: All the above calls are over HTTPS not HTTP.

   Please suggest with any REST Call and response example, for Session management in LDAP BASIC Auth.
   Session management for Native Auth works as you have mentioned in this post.

   Thanks

   • Log in to Reply
   • Link
10. 

    Long

    July 25, 2022 at 5:50 am

    Hi,
    I am checking the Rest API to get the workflow task is assigned to some user, by query tis object structure “/maximo/oslc/os/MXAPIWFASSIGNMENT” and condition is “?oslc.select=*&oslc.where=ownertable=”SR” and processname=”MyCompanyWR”, I can get some workflow task, but my problem is that: when i input the user for Rest API authentication, the service always return the Workflow Task which assigned to this user only. My expectation is that: I used only single service user for Rest API authentication like “MAXADMIN”, and get the user’s assigned task by condition like add to the selection condition like “oslc.select=*&oslc.where=ownertable=”SR” and processname=”MyCompanyWR” and assigncode = “MyUserOnly”..
    Thank you so much
    Long.

    • Log in to Reply
    • Link
    • 

      Bob Richardson

      July 27, 2022 at 3:14 pm

      Hi Long,

      If I understand your question, you want to return records from the MXAPIWFASSIGNMENT object structure beyond those records that are assigned to the user being used for authentication. There is a data restriction, called ASSIGNFILTER, on the MXAPIWFASSIGNMENT object structure that is likely impacting your results. If you take a look at that restriction the expression is,

      assigncode = :&PERSONID& and assignstatus in (select value from
      synonymdomain where domainid = ‘WFASGNSTATUS’ and maxvalue = ‘ACTIVE’)

      To return different results, you will likely want to duplicate this object structure and either remove or apply another expression that is more in inline with the record set you are wanting.

      • Log in to Reply
      • Link