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

API Keys Configuration

IBM Control Desk Documentation

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