Jump to

• Request
• Response

Generates the payload that can be consumed by the Generative AI completions REST to assist in summarizing the work performed on asset or item in the work order.

post

/fscmRestApi/resources/11.13.18.05/maintenanceWorkOrders/{WorkOrderId}/action/generateRepairSummaryPromptParams

Gathers work order details including the work performed on an asset, and transforms the information into a string that can be sent as a payload to the Generative AI completions REST. The completions REST can then use this payload to assist in authoring a work summary note for the work order.

Request

Path Parameters

• WorkOrderId(required): integer(int64)
  Value that uniquely identifies the work order. This attribute is read-only. The value of this attribute is derived from the work order number when the application creates the work order.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• assetId: number

{
    "type":"object",
    "properties":{
        "assetId":{
            "type":"number",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  If the action completes successfully, then generateRepairSummaryPromptParams returns a string representing the payload that can be sent to the Generative AI completions REST.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"If the action completes successfully, then generateRepairSummaryPromptParams returns a string representing the payload that can be sent to the Generative AI completions REST."
        }
    },
    "additionalProperties":false
}

Back to Top