Querying Service Request (SR) record from Maximo via Maximo Integration Framework
2 Contents • API SR Schema • API Service for SR • Assumptions • Sample XML Response for statuses NEW, RESOLVED, CANCELLED and CLOSED • Sample XML Response for SR with Multiple Attachments • Account to use • POSTMAN Setup & Querying records using HTTPPOST • References
3 API SR Schema To view the schema for the Out-Of-The-Box (OOTB) SR API, below are the URLs: APMC Test Environment https://apmc-test.maximo.com/meaweb/schema/common/mos/MXAPISR.xsd APMC Production Environment https://apmc.maximo.com/meaweb/schema/common/mos/MXAPISR.xsd This XML API SR Schema uses to format the message and its also contains the fields to be used.
4 API Service for SR For the external system to be able to send inbound transactions to Maximo, an API Service is needed. Maximo API Service URL is in below thru HTTP Post communication method: APMC Test Environment https://apmc-test.maximo.com/meaweb/os/MXAPISR APMC Prod Environment https://apmc.maximo.com/meaweb/os/MXAPISR The URL contains the hostname to where the transaction will be sent, and the Object (Data) Structure being used for the SR API.
5 Assumptions These Attributes should be aligned with the external system to be able to query Service Request records from Maximo. APMC to make sure that data is aligned in the following: • SR number
6 Sample Query XML <max:QueryMXAPISR xmlns:max="http://www.ibm.com/maximo"> <max:MXAPISRQuery> <max:SR> <max:TICKETID>{SR NUMBER}</max:TICKETID> </max:SR> </max:MXAPISRQuery> </max:QueryMXAPISR>
7 Account to use Maximo has system users specifically for integration only consult your APMC PMP System Administrators for your username and password.
8 POSTMAN Setup 1. Provide API Service URL and set the request action to POST 2. On the Header tab, add a new Header MAXAUTH type with value set as [USERNAME]:[PASSWORD] and encoded in Base64. 2.1 Sample free base64 encoder: http://www.motobit.com/util/base64-decoder-encoder.asp 2.2 Sample user account and password before Base64 encryption: maximo.user:mypassword123 2.2 Sample user account and password after Base64 encryption: bWF4aW1vLnVzZXI6bXlwYXNzd29yZDEyMw== 1 2 Pre Production/Test URL: https://apmc-test.maximo.com/meaweb/os/MXAPISR Production URL: https://apmc.maximo.com/meaweb/os/MXAPISR
9 POSTMAN Setup 3. Go to Headers tab, add a Header with Content-Type key and Value “application/xml” 3 Pre Production/Test URL: https://apmc-test.maximo.com/meaweb/os/MXAPISR Production URL: https://apmc.maximo.com/meaweb/os/MXAPISR
1 0 POSTMAN Setup 4 5 6 4. Go to the Body tab. 5. Select the “raw” option 6. Provide the XML for the query transaction Pre Production/Test URL: https://apmc-test.maximo.com/meaweb/os/MXAPISR Production URL: https://apmc.maximo.com/meaweb/os/MXAPISR
1 1 POSTMAN Setup 7. Click Send button 8. Select XML option 9. Query result will be displayed on the response body 7 8 9 Pre Production/Test URL: https://apmc-test.maximo.com/meaweb/os/MXAPISR Production URL: https://apmc.maximo.com/meaweb/os/MXAPISR
1 2 Sample XML response from SR Query with status NEW The queries’ XML response contains the Service Request details and information. Sample XML File Link: Sample_XML_response_NEW
1 3 Sample XML response from SR Query with status RESOLVED The queries’ XML response contains the Service Request details and information. Sample XML File Link: Sample_XML_response_RESOLVED
1 4 Sample XML response from SR Query with status CLOSED The queries’ XML response contains the Service Request details and information. Sample XML File Link: Sample_XML_response_CLOSED
1 5 Sample XML response from SR Query with status CANCELLED The queries’ XML response contains the Service Request details and information. Sample XML File Link: Sample_XML_response_CANCELLED
1 6 Sample XML response from SR Query with Multiple Attachments The queries’ XML response contains the Service Request details and information.
1 7
1 8
1 9 Sample XML File Link: Sample_XML_response_ Multiple_Attachments
2 0 Reference/s Maximo Integration Guide https://www-01.ibm.com/support/docview.wss?uid=swg21380484&aid=1 POSTMAN Platform https://www.postman.com/downloads/