IBM Control Desk

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 https //www ibm com/docs/en/control desk/7 6 1 x?topic=components api keys 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 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 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 headers object optional http headers for the request headers accept string optional http headers for the request dcterms\ title string optional parameter for create incident prefixes object optional parameter for create incident prefixes dcterms string optional parameter for create incident input example {"json body" {"dcterms\ title" "my new incident","prefixes" {"dcterms" "http //purl org/dc/terms/"}},"headers" {"accept" "application/json"}} 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 headers content length number http headers for the request headers date string http headers for the request headers etag string http headers for the request headers location string http headers for the request headers x powered by string http headers for the request output 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 headers accept string optional http headers for the request path parameters incidentid string required incident id input example {"headers" {"accept" "application/json"}} 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 details rdf\ type array type of the resource details rdf\ type rdf\ resource string type of the resource details prefixes object output field details prefixes details prefixes rdf string output field details prefixes rdf details prefixes dcterms string output field details prefixes dcterms details prefixes oslc string output field details prefixes oslc details prefixes sccd string output field details prefixes sccd details oslc\ shortid string unique identifier details oslc\ modifiedby object output field details oslc \ modifiedby details oslc\ modifiedby rdf\ resource string output field details oslc \ modifiedby rdf \ resource details dcterms\ creator object output field details dcterms \ creator details dcterms\ creator rdf\ resource string output field details dcterms \ creator rdf \ resource details dcterms\ created string output field details dcterms \ created details dcterms\ title string output field details dcterms \ title details rdf\ about string output field details rdf \ about details dcterms\ identifier string unique identifier details dcterms\ modified string output field details dcterms \ modified details sccd\ status object status value details sccd\ status rdf\ resource string status value output example {"status code" 200,"reason" "ok","headers"\ null,"details" {"rdf\ type" \[{}],"prefixes" {"rdf" "http //www w3 org/1999/02/22 rdf syntax ns#","dcterms" "http //purl org/dc/terms/","oslc" "http //open services net/ns/core#","sccd" "http //jazz net/ns/ism/helpdesk/sccd#"},"oslc\ shortid" "1011","oslc\ modifiedby" {"rdf\ resource" "http //localhost/maximo/oslc/os/sccdoslcperson/ tufyqurnsu4 "},"dcterms\ creator" {"rdf\ resource" "http //localhost/maximo/oslc/os/sccdoslcperson/ tufyqurnsu4 "},"dcterms\ creat get incidents get multiple incidents endpoint url /maximo/oslc/os/oslcincident method get input argument name type required description parameters oslc where string optional parameters for the get incidents action parameters oslc select string optional parameters for the get incidents action headers object optional http headers for the request headers accept string optional http headers for the request input example {"parameters" {"oslc where" "dcterms\ title='my new incident'","oslc select" "dcterms\ title"},"headers" {"accept" "application/json"}} 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 details prefixes object output field details prefixes details prefixes rdf string output field details prefixes rdf details prefixes dcterms string output field details prefixes dcterms details prefixes oslc string output field details prefixes oslc details prefixes rdfs string output field details prefixes rdfs details rdfs\ member array output field details rdfs \ member details rdfs\ member dcterms\ title string output field details rdfs \ member dcterms \ title details rdfs\ member rdf\ about string output field details rdfs \ member rdf \ about details rdf\ about string output field details rdf \ about output example {"status code" 200,"reason" "ok","headers"\ null,"details" {"prefixes" {"rdf" "http //www w3 org/1999/02/22 rdf syntax ns#","dcterms" "http //purl org/dc/terms/","oslc" "http //open services net/ns/core#","rdfs" "http //www w3 org/2000/01/rdf schema#"},"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 path parameters incidentid string required parameters for the update incident action headers object optional http headers for the request headers x method override string optional http headers for the request headers accept string optional http headers for the request dcterms\ title string optional parameter for update incident sccd\ status object optional status value sccd\ status rdf\ resource string optional status value prefixes object optional parameter for update incident prefixes sccd string optional parameter for update incident prefixes dcterms string optional parameter for update incident input example {"json body" {"dcterms\ title" "my new incident updated","sccd\ status" {"rdf\ resource" "http //localhost 7001/maximo/oslc/os/sccdoslcsyndomain/ su5dsurftlrtvefuvvmvuvvfvuvel35ovuxmfi9 tlvmth4vfk5vtex l1fvrvvfra "},"prefixes" {"sccd" "http //jazz net/ns/ism/helpdesk/sccd#","dcterms" "http //purl org/dc/terms/"}},"path parameters" {"incidentid" " su5dsurftlqvmteyoq "},"headers" {"x method override" "patch","accept" "application/json"}} 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 headers content length number http headers for the request headers date string http headers for the request headers etag string http headers for the request headers x powered by string http headers for the request output 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"}} response headers header description example content type the media type of the resource application/json date the date and time at which the message was originated thu, 01 jan 2024 00 00 00 gmt