For the complete documentation index, see llms.txt. This page is also available as Markdown.

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

Name
Description

RequestType : RequestTypeChoose

Select request type to show correct editor for input.

Possible values:

  • CustomRequest: Custom request.

  • CreateWorkOrder: Generate service request.

  • GenerateServiceRequest: Create work order.

  • GetWorkOrder: Get work order by its ID.

  • UpdateWorkOrder: Update work order with given ID.

  • DeleteWorkOrder: Delete work order with given ID.

  • GetServiceRequest: Get service request by its ID.

  • UpdateServiceRequest: Update service request with given ID.

  • DeleteServiceRequest: Delete service request with given ID.

Default: - Example: CustomRequest

BaseUrl : String

IBM Maximo base URL.

Default: http://localhost:7001/ Example: http://localhost:7001/

Resource : String

IBM Maximo resource to request.

Default: /os/mxapiasset Example: /os/mxapiasset

Payload : Object

The payload text to be sent with the request.

Default: - Example: { "Body": "Message" }

Method : HttpMethod

HTTP method to use for the request.

Possible values:

  • GET: HTTP method to use for the request.

  • POST: HTTP method to use for the request.

  • PUT: HTTP method to use for the request.

  • PATCH: HTTP method to use for the request.

  • DELETE: HTTP method to use for the request.

Default: GET Example: GET

🗝ApiKey : String

API key for authentication.

Default: - Example: api-key

WorkOrderDescription : String

Description for the new work order.

Default: - Example: Fix HVAC system

ServiceRequestDescription : String

Description for the service request.

Default: - Example: Request for office equipment

ReportedBy : String

The person who reported the issue.

Default: - Example: john.doe

WorkOrderLocation : String

Location for new work order.

Default: - Example: PLANT1

ServiceRequestLocation : String

Identifies the ticket's location.

Default: - Example: OFFICE1

WorkOrderAssetNum : String

Asset number associated with the work order.

Default: - Example: ASSET001

ServiceRequestAssetNum : String

Asset number associated with the service request.

Default: - Example: ASSET002

Site : String

Site associated with the work order.

Default: - Example: BEDFORD

ScheduledStart : String

Scheduled start time for the work order.

Default: - Example: 01/01/2024 08:00:00

ReportedDate : String

Reported date for the breakdown work order.

Default: - Example: 01/01/2024 00:00:00

WorkOrderId : String

Reported date for the breakdown work order.

Default: - Example: 12345

ServiceRequestId : String

Reported date for the breakdown work order.

Default: - Example: 67890

Name
Description

ThrowErrorOnFailure : Boolean

Whether to throw an exception on failure or return a result with Success = false.

Default: True Example: true

ErrorMessageOnFailure : String

Custom error message to use when an error occurs. If empty, the exception message is used.

Default: - Example: IBM Maximo request failed

Task Result

Name
Description

Success : Boolean

True if the request was successful. False otherwise. Example: true

Response : Object

Response message as JToken, if the request was successful. Example: { some: "value" }

Error : String

Error message, if the request was not successful. Example: Error message

Task Changelog

Changelog is not available for this Task.

Last updated

Was this helpful?