IBM Control Desk
21 min
the ibm control desk connector allows you to retrieve, create and update incident information from ibm control desk using the ibm control desk incidents api asset configuration this connector allows to integrate with ibm control desk using two different authentication methods basic using username and password basic token using an api token documentation api keys configuration https //www ibm com/docs/en/control desk/7 6 1 x?topic=components api keys ibm control desk documentation https //www ibm com/docs/en/control desk/7 6 1 x?topic=products providing ticket data other configurations http basic authentication authenticates using username and password configuration parameters parameter description type required url a url to the target host ie https //myibmcontroldeskhost com https //myibmcontroldeskhost com string required username username string required password password string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional http bearer authentication authenticates using bearer token configuration parameters parameter description type required url a url to the target host ie https //myibmcontroldeskhost com https //myibmcontroldeskhost com string required token the api key string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions create incident create an incident endpoint url /maximo/oslc/os/oslcincident method post input argument name type required description dcterms\ title string optional parameter for create incident prefixes object optional parameter for create incident dcterms string optional parameter for create incident headers object optional http headers for the request accept string optional parameter for create incident output parameter type description status code number http status code of the response reason string response reason phrase headers object http headers for the request content length number response content date string date value etag string output field etag location string output field location x powered by string output field x powered by example \[ { "status code" 200, "reason" "ok", "headers" { "content length" 0, "date" "tue, 10 mar 2015 15 00 00 gmt", "etag" " 1269179891", "location" "http //localhost 7001/maximo/oslc/os/oslcincident/ su5dsurftlqvmteyoq ", "x powered by" "servlet/2 5 jsp/2 1" } } ] get incident get an incident endpoint url /maximo/oslc/os/oslcincident/{{incidentid}} method get input argument name type required description headers object optional http headers for the request accept string optional parameter for get incident incidentid string required incident id output parameter type description status code number http status code of the response reason string response reason phrase headers object http headers for the request details object output field details rdf\ type array type of the resource rdf\ resource string output field rdf \ resource prefixes object output field prefixes rdf string output field rdf dcterms string output field dcterms oslc string output field oslc sccd string output field sccd oslc\ shortid string unique identifier oslc\ modifiedby object output field oslc \ modifiedby rdf\ resource string output field rdf \ resource dcterms\ creator object output field dcterms \ creator rdf\ resource string output field rdf \ resource dcterms\ created string output field dcterms \ created dcterms\ title string output field dcterms \ title rdf\ about string output field rdf \ about dcterms\ identifier string unique identifier dcterms\ modified string output field dcterms \ modified sccd\ status object status value rdf\ resource string output field rdf \ resource example \[ { "status code" 200, "reason" "ok", "headers" null, "details" { "rdf\ type" \[], "prefixes" {}, "oslc\ shortid" "1011", "oslc\ modifiedby" {}, "dcterms\ creator" {}, "dcterms\ created" "2013 07 02t16 43 31 04 00", "dcterms\ title" "my new incident", "rdf\ about" "http //localhost/maximo/oslc/os/oslcincident/ wysojylieloq0leru5uxs8xmdi026", "dcterms\ identifier" "61", "dcterms\ modified" "2013 07 02t16 43 31 04 00", "sccd\ status" {} } } ] get incidents get multiple incidents endpoint url /maximo/oslc/os/oslcincident method get input argument name type required description oslc where string optional parameter for get incidents oslc select string optional parameter for get incidents headers object optional http headers for the request accept string optional parameter for get incidents output parameter type description status code number http status code of the response reason string response reason phrase headers object http headers for the request details object output field details prefixes object output field prefixes rdf string output field rdf dcterms string output field dcterms oslc string output field oslc rdfs string output field rdfs rdfs\ member array output field rdfs \ member dcterms\ title string output field dcterms \ title rdf\ about string output field rdf \ about rdf\ about string output field rdf \ about example \[ { "status code" 200, "reason" "ok", "headers" null, "details" { "prefixes" {}, "rdfs\ member" \[], "rdf\ about" "http //localhost/maximo/oslc/os/oslcincident" } } ] update incident update an incident endpoint url /maximo/oslc/os/oslcincident/{{incidentid}} method post input argument name type required description incidentid string required unique identifier dcterms\ title string optional parameter for update incident sccd\ status object optional status value rdf\ resource string optional parameter for update incident prefixes object optional parameter for update incident sccd string optional parameter for update incident dcterms string optional parameter for update incident headers object optional http headers for the request x method override string optional http method to use accept string optional parameter for update incident output parameter type description status code number http status code of the response reason string response reason phrase headers object http headers for the request content length number response content date string date value etag string output field etag x powered by string output field x powered by example \[ { "status code" 204, "reason" "ok", "headers" { "content length" 0, "date" "tue, 10 mar 2015 15 00 00 gmt", "etag" " 1269180946", "x powered by" "servlet/2 5 jsp/2 1" } } ]