IBM Control Desk on Cloud

https://www.ibm.com/docs/en/cdoc
Admin
IBM Control Desk on Cloud is an IT service management platform for managing IT assets, configuration...
Tokens:1,218,107
Snippets:12,786
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### IBM Control Desk REST API: GET Method Request Examples

Source: https://www.ibm.com/docs/en/cdoc/index_topic=smqu-service-methods-that-use-http-get-query-resources

Illustrates the HTTP GET requests used to invoke methods for querying resources in the IBM Control Desk REST API. It shows examples for both simple resource retrieval and filtered queries, including the use of the '_qop' parameter and custom filter parameters.

```http
GET maxrest/rest/mbo/maxlogger?_qop=getLoggerList HTTP/1.1
```

```http
GET maxrest/rest/mbo/maxlogger?_qop=getFilteredLoggers&~someFilter=yourFilterValue HTTP/1.1
```

--------------------------------

### Run Integration Composer Installer (Shell Script)

Source: https://www.ibm.com/docs/en/cdoc/index_topic=composer-installing-unix

This command initiates the Integration Composer installation process in console mode. Console mode allows for a text-based, step-by-step installation where the user is prompted for input.

```shell
sh ./setup.bin -i console
```

--------------------------------

### IBM Control Desk REST API: Example GET Request for Business Object

Source: https://www.ibm.com/docs/en/cdoc/index_topic=api-get-method

This example demonstrates how to retrieve a specific business object resource using the GET method in the IBM Control Desk REST API. It includes the request URI and the expected XML response structure.

```http
GET /maxrest/rest/mbo/asset/123
```

```xml
<?xml version="1.0" encoding="UTF-8" ?> 
  <ASSET xmlns="http://www.ibm.com/maximo"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ASSETNUM>11200</ASSETNUM> 
    <SERIALNUM>3481-52</SERIALNUM> 
    <ASSETTAG>3751</ASSETTAG> 
    <LOCATION>BR200</LOCATION> 
    <DESCRIPTION>HVAC System- 50 Ton Cool Cap/ 450000 Btu Heat Cap</DESCRIPTION> 
    <ASSETUID>123</ASSETUID> 
    .
    .
  </ASSET>
```

--------------------------------

### GET Incident Resource

Source: https://www.ibm.com/docs/en/cdoc/index_topic=products-providing-ticket-data-other

Describes the requirements and provides an example for making an HTTP GET request to retrieve an Incident resource URI from Control Desk.

```APIDOC
## GET /<incident_resource_uri>

### Description
Retrieves the details of a specific Incident resource.

### Method
GET

### Endpoint
/websites/ibm_en_cdoc/api/incidents/{incident_id}

### Parameters
#### Path Parameters
- **incident_id** (string) - Required - The unique identifier of the incident.

#### Query Parameters
None

#### Request Body
None

### Request Example
```
GET /websites/ibm_en_cdoc/api/incidents/INC0010001 HTTP/1.1
Host: example.com
Accept: application/json
```

### Response
#### Success Response (200)
- **ticketid** (string) - The unique ID of the ticket.
- **status** (string) - The current status of the ticket.
- **description** (string) - A detailed description of the incident.

#### Response Example
```json
{
  "ticketid": "INC0010001",
  "status": "Open",
  "description": "Server is down."
}
```
```

--------------------------------

### Make Installation File Executable (Shell Script)

Source: https://www.ibm.com/docs/en/cdoc/index_topic=composer-installing-unix

This command is used to grant execute permissions to the Integration Composer binary installation file, setup.bin. This is a prerequisite before running the installation program from the command line.

```shell
chmod +x setup.bin
```

--------------------------------

### Querying Resources with HTTP GET

Source: https://www.ibm.com/docs/en/cdoc/index_topic=smqu-service-methods-that-use-http-get-query-resources

This section details how to use the HTTP GET method with the IBM Control Desk REST API to query resources. It explains how method names starting with 'get' are mapped to GET requests and how to pass parameters for filtering and specifying operations.

```APIDOC
## GET /maxrest/rest/mbo/{mboName}

### Description
This endpoint allows you to retrieve a collection of business objects or specific business objects using HTTP GET requests. Method names in the service that start with 'get' are typically mapped to this endpoint. Query parameters can be used to specify operations and filters.

### Method
GET

### Endpoint
`/maxrest/rest/mbo/{mboName}`

### Parameters
#### Query Parameters
- **_qop** (string) - Required - Specifies the annotated operation name or method name to execute. For example, `getLoggerList` or `getFilteredLoggers`.
- **~parameterName** (string) - Optional - Used to pass parameters to methods that accept them. The parameter name is prefixed with a tilde (~). For example, `~someFilter`.

### Request Example
To retrieve a list of MAXLOGGER business objects:
```
GET maxrest/rest/mbo/maxlogger?_qop=getLoggerList HTTP/1.1
```

To retrieve a filtered list of loggers using a specific filter:
```
GET maxrest/rest/mbo/maxlogger?_qop=getFilteredLoggers&~someFilter=... HTTP/1.1
```

### Response
#### Success Response (200)
Returns a collection of business objects in the configured representation.

#### Response Example
```json
{
  "example": "[Collection of business objects in JSON or other configured representation]"
}
```
```

--------------------------------

### Configure JVM Startup Parameters for Memory Allocation

Source: https://www.ibm.com/docs/en/cdoc/index_topic=imports-server-configuration

Example of JVM startup parameters to allocate minimum and maximum heap space, and set the MaxPermSize. These settings help prevent out-of-memory errors for the application server processing software catalog data.

```Shell
-Xms512m -Xmx1028m -XX:MaxPermSize=256m
```

--------------------------------

### GET Request with sorting by location

Source: https://www.ibm.com/docs/en/cdoc/index_topic=method-orderbyasc-parameter

This GET request retrieves a list of assets and sorts them by the 'location' field in ascending order. It fetches 20 items starting from the 20th item.

```http
GET /maxrest/rest/mbo/asset?_maxItems=20&_rsStart=20&_orderbyasc=location
```

--------------------------------

### Add TADDM 7.2.x JARs to Product Installation Tree

Source: https://www.ibm.com/docs/en/cdoc/index_topic=overview-configuring-integration-taddm-72x

This step involves creating a new directory within the product installation tree and copying the TADDM 7.2.x API client JARs into it. This makes the JARs available to the product's runtime environment.

```Shell
Create directory: _product_home_\maximo\applications\maximo\lib\taddm
Copy C:\temp\taddm_72x_jars\platform-model.jar to _product_home_\maximo\applications\maximo\lib\taddm
Copy C:\temp\taddm_72x_jars\taddm-api-client.jar to _product_home_\maximo\applications\maximo\lib\taddm
```

--------------------------------

### HTTP GET Request for Incident Resource

Source: https://www.ibm.com/docs/en/cdoc/index_topic=products-get-incident

This snippet demonstrates how to make an HTTP GET request to retrieve incident data. It specifies the 'Accept' header to ensure the response is in JSON format. The example URI points to a specific incident resource.

```HTTP
GET http://localhost:7001/maximo/oslc/os/oslcincident/_SU5DSURFTlQvMTAxMA--
Accept: application/json
```
Tokens:
Raw