> For the complete documentation index, see [llms.txt](https://docs.frends.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.frends.com/tasks/tasks/ibm-maximo/request.md).

# Request

Frends Task for making IBM Maximo requests.

Task version: 2.0.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

## Task Parameters

{% tabs %}
{% tab title="Input" %}

| Name                                 | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| RequestType : `RequestTypeChoose`    | <p>Select request type to show correct editor for input.</p><p>Possible values:</p><ul><li><code>CustomRequest</code>: Custom request.</li><li><code>CreateWorkOrder</code>: Generate service request.</li><li><code>GenerateServiceRequest</code>: Create work order.</li><li><code>GetWorkOrder</code>: Get work order by its ID.</li><li><code>UpdateWorkOrder</code>: Update work order with given ID.</li><li><code>DeleteWorkOrder</code>: Delete work order with given ID.</li><li><code>GetServiceRequest</code>: Get service request by its ID.</li><li><code>UpdateServiceRequest</code>: Update service request with given ID.</li><li><code>DeleteServiceRequest</code>: Delete service request with given ID.</li></ul><p><br>Default: <code>-</code><br>Example: <code>CustomRequest</code></p> |
| BaseUrl : `String`                   | <p>IBM Maximo base URL.</p><p><br>Default: <code><http://localhost:7001/></code><br>Example: <code><http://localhost:7001/></code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Resource : `String`                  | <p>IBM Maximo resource to request.</p><p><br>Default: <code>/os/mxapiasset</code><br>Example: <code>/os/mxapiasset</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Payload : `Object`                   | <p>The payload text to be sent with the request.</p><p><br>Default: <code>-</code><br>Example: <code>{ "Body": "Message" }</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| Method : `HttpMethod`                | <p>HTTP method to use for the request.</p><p>Possible values:</p><ul><li><code>GET</code>: HTTP method to use for the request.</li><li><code>POST</code>: HTTP method to use for the request.</li><li><code>PUT</code>: HTTP method to use for the request.</li><li><code>PATCH</code>: HTTP method to use for the request.</li><li><code>DELETE</code>: HTTP method to use for the request.</li></ul><p><br>Default: <code>GET</code><br>Example: <code>GET</code></p>                                                                                                                                                                                                                                                                                                                                       |
| 🗝ApiKey : `String`                  | <p>API key for authentication.</p><p><br>Default: <code>-</code><br>Example: <code>api-key</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| WorkOrderDescription : `String`      | <p>Description for the new work order.</p><p><br>Default: <code>-</code><br>Example: <code>Fix HVAC system</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ServiceRequestDescription : `String` | <p>Description for the service request.</p><p><br>Default: <code>-</code><br>Example: <code>Request for office equipment</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ReportedBy : `String`                | <p>The person who reported the issue.</p><p><br>Default: <code>-</code><br>Example: <code>john.doe</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| WorkOrderLocation : `String`         | <p>Location for new work order.</p><p><br>Default: <code>-</code><br>Example: <code>PLANT1</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ServiceRequestLocation : `String`    | <p>Identifies the ticket's location.</p><p><br>Default: <code>-</code><br>Example: <code>OFFICE1</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| WorkOrderAssetNum : `String`         | <p>Asset number associated with the work order.</p><p><br>Default: <code>-</code><br>Example: <code>ASSET001</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ServiceRequestAssetNum : `String`    | <p>Asset number associated with the service request.</p><p><br>Default: <code>-</code><br>Example: <code>ASSET002</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Site : `String`                      | <p>Site associated with the work order.</p><p><br>Default: <code>-</code><br>Example: <code>BEDFORD</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| ScheduledStart : `String`            | <p>Scheduled start time for the work order.</p><p><br>Default: <code>-</code><br>Example: <code>01/01/2024 08:00:00</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| ReportedDate : `String`              | <p>Reported date for the breakdown work order.</p><p><br>Default: <code>-</code><br>Example: <code>01/01/2024 00:00:00</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| WorkOrderId : `String`               | <p>Reported date for the breakdown work order.</p><p><br>Default: <code>-</code><br>Example: <code>12345</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ServiceRequestId : `String`          | <p>Reported date for the breakdown work order.</p><p><br>Default: <code>-</code><br>Example: <code>67890</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| {% endtab %}                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |

{% tab title="Options" %}

| Name                             | Description                                                                                                                                                                            |
| -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ThrowErrorOnFailure : `Boolean`  | <p>Whether to throw an exception on failure or return a result with Success = false.</p><p><br>Default: <code>True</code><br>Example: <code>true</code></p>                            |
| ErrorMessageOnFailure : `String` | <p>Custom error message to use when an error occurs. If empty, the exception message is used.</p><p><br>Default: <code>-</code><br>Example: <code>IBM Maximo request failed</code></p> |
| {% endtab %}                     |                                                                                                                                                                                        |
| {% endtabs %}                    |                                                                                                                                                                                        |

## Task Result

| Name                | Description                                                                                                  |
| ------------------- | ------------------------------------------------------------------------------------------------------------ |
| Success : `Boolean` | <p>True if the request was successful. False otherwise.<br>Example: <code>true</code></p>                    |
| Response : `Object` | <p>Response message as JToken, if the request was successful.<br>Example: <code>{ some: "value" }</code></p> |
| Error : `String`    | <p>Error message, if the request was not successful.<br>Example: <code>Error message</code></p>              |

## Task Changelog

Changelog is not available for this Task.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.frends.com/tasks/tasks/ibm-maximo/request.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
