# Request

Required Frends version: 5.5+

Required .NET version: 6.0

Compatible Agents: Crossplatform

Source code:

{% tabs %}
{% tab title="Parameter: 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>:</li></ul><p>Select request type to show correct editor for input.</p><ul><li><code>CreateWorkOrder</code>:</li></ul><p>Select request type to show correct editor for input.</p><ul><li><code>GenerateServiceRequest</code>:</li></ul><p>Select request type to show correct editor for input.</p><ul><li><code>GetWorkOrder</code>:</li></ul><p>Select request type to show correct editor for input.</p><ul><li><code>UpdateWorkOrder</code>:</li></ul><p>Select request type to show correct editor for input.</p><ul><li><code>DeleteWorkOrder</code>:</li></ul><p>Select request type to show correct editor for input.</p><ul><li><code>GetServiceRequest</code>:</li></ul><p>Select request type to show correct editor for input.</p><ul><li><code>UpdateServiceRequest</code>:</li></ul><p>Select request type to show correct editor for input.</p><ul><li><code>DeleteServiceRequest</code>:</li></ul><p>Select request type to show correct editor for input.</p><p><br>Default: <code>-</code><br>Example: <code>-</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>:</li></ul><p>HTTP method to use for the request.</p><ul><li><code>POST</code>:</li></ul><p>HTTP method to use for the request.</p><ul><li><code>PUT</code>:</li></ul><p>HTTP method to use for the request.</p><ul><li><code>PATCH</code>:</li></ul><p>HTTP method to use for the request.</p><ul><li><code>DELETE</code>:</li></ul><p>HTTP method to use for the request.</p><p><br>Default: <code>0</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>-</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ServiceRequestDescription : `String` | <p>Description for the service request.</p><p><br>Default: <code>-</code><br>Example: <code>-</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ReportedBy : `String`                | <p>The person who reported the issue.</p><p><br>Default: <code>-</code><br>Example: <code>-</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| WorkOrderLocation : `String`         | <p>Location for new work order.</p><p><br>Default: <code>-</code><br>Example: <code>-</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ServiceRequestLocation : `String`    | <p>Identifies the ticket's location.</p><p><br>Default: <code>-</code><br>Example: <code>-</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| WorkOrderAssetNum : `String`         | <p>Asset number associated with the work order.</p><p><br>Default: <code>-</code><br>Example: <code>-</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ServiceRequestAssetNum : `String`    | <p>Asset number associated with the service request.</p><p><br>Default: <code>-</code><br>Example: <code>-</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| Site : `String`                      | <p>Site associated with the work order.</p><p><br>Default: <code>-</code><br>Example: <code>-</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ScheduledStart : `String`            | <p>Scheduled start time for the work order.</p><p><br>Default: <code>-</code><br>Example: <code>-</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ReportedDate : `String`              | <p>Reported date for the breakdown work order.</p><p><br>Default: <code>-</code><br>Example: <code>-</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| WorkOrderId : `String`               | <p>Reported date for the breakdown work order.</p><p><br>Default: <code>-</code><br>Example: <code>-</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| ServiceRequestId : `String`          | <p>Reported date for the breakdown work order.</p><p><br>Default: <code>-</code><br>Example: <code>-</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| {% endtab %}                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |

{% tab title="Result: 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>              |
| {% endtab %}        |                                                                                                              |
| {% endtabs %}       |                                                                                                              |