Background
Maximo 7.6.0.2 introduced a new REST API that can be accessed via .../maximo/oslc . Here's a link to the documentation on it:https://developer.ibm.com/static/site-id/155/maximodev/restguide/Maximo_Nextgen_REST_API.html
This is an all-JSON API that makes things a ton easier than it was with the older (and deprecated) XML-based REST API.
The Problem
However, that documentation is aimed at Maximo Enterprise Asset Management users and not IBM Control Desk users. That means there aren't any examples for creating incidents or service requests, for example.Why You're Here
You want an example of creating an INCIDENT in ICD, and that's what I'll provide. I'm using ICD 7.6.1.1 on WebSphere, DB2 and IBM HTTP Server, along with the sample data. That's how I have a classification ID and hierarchy structure in the example below.
Basically, the best way I've found is to use the MXOSINCIDENT object structure because it already has a bunch of relationships (including one to TICKETSPEC, so you can add specifications when creating an incident). Here are the details:
Additional header:
properties: *
BODY:
{
"reportedby":
"MXINTADM",
"description": "second
MXINCIDENT OS API",
"externalsystem":
"EVENTMANAGEMENT",
"classstructureid":
"21010405",
"ticketspec":
[{"assetattrid":
"computersystem_serialnumber","alnvalue":
"99999"}]
}
RESPONSE:
{
"affecteddate":
"2019-11-29T15:02:00-05:00",
"template": false,
"creationdate":
"2019-11-29T15:02:00-05:00",
"hierarchypath": "21 \\ 2101
\\ 210104 \\ 21010405",
"historyflag": false,
"actlabcost": 0.0,
"createwomulti_description":
"Create Multi Records",
"selfservsolaccess": false,
"outageduration": 0.0,
"ticketuid": 46,
"inheritstatus": false,
"reportdate":
"2019-11-29T15:02:00-05:00",
"class_description":
"Incident",
"description": "second
MXINCIDENT OS API",
"reportedby":
"MXINTADM",
"classificationid":
"21010405",
"sitevisit": false,
"_rowstamp":
"10009026",
"accumulatedholdtime": 0.0,
"createdby":
"MXINTADM",
"relatedrecord_collectionref":
"http://was.gulfsoft.rocks:80/maximo/oslc/os/mxosincident/_SU5DSURFTlQvMTA0MA--/incidentrelrec",
"isknownerror": false,
"affectedperson":
"MXINTADM",
"multiassetlocci_collectionref":
"http://was.gulfsoft.rocks:80/maximo/oslc/os/mxosincident/_SU5DSURFTlQvMTA0MA--/incidentmultiassetloci",
"class": "INCIDENT",
"ticketid": "1040",
"ticketspec": [
{
"localref": "http://was.gulfsoft.rocks:80/maximo/oslc/os/mxosincident/_SU5DSURFTlQvMTA0MA--/ticketspecclass/0-7",
"classstructureid":
"21010405",
"changeby":
"MXINTADM",
"changedate":
"2019-11-29T15:02:00-05:00",
"alnvalue":
"99999",
"mandatory": false,
"refobjectname":
"INCIDENT",
"ticketspecid": 7,
"assetattrid":
"COMPUTERSYSTEM_SERIALNUMBER",
"_rowstamp":
"10009029",
"refobjectid": 46,
"displaysequence": 1,
}
],
"status_description":
"New",
"externalsystem_description":
"EVENT MANAGEMENT",
"classstructureid":
"21010405",
"ticketspec_collectionref":
"http://was.gulfsoft.rocks:80/maximo/oslc/os/mxosincident/_SU5DSURFTlQvMTA0MA--/ticketspecclass",
"changeby": "MXINTADM",
"changedate":
"2019-11-29T15:02:00-05:00",
"externalsystem":
"EVENTMANAGEMENT",
"actlabhrs": 0.0,
"relatedtoglobal": false,
"hasactivity": false,
"statusdate":
"2019-11-29T15:02:00-05:00",
"createwomulti":
"MULTI",
"hassolution": false,
"virtualenv": false,
"pluspporeq": false,
"isglobal": false,
"oncallautoassign": false,
"pmscinvalid": false,
"status": "NEW"
}
Prerequisites
To successfully do the above, you do need to Configure Object Structure security: https://www.ibm.com/support/
I'm using Postman for testing, which I highly recommend: https://www.getpostman.com/downloads/
Of course you'll use some specific language (or curl) when you're doing this in production, but for testing, you want to use Postman.
A helpful link
In addition to the API documentation, this link was very helpful to me:
No comments:
Post a Comment