Jump to

• Request
• Response
• Examples

Reschedule one maintenance work order at the midpoint

post

/fscmRestApi/resources/11.13.18.05/maintenanceWorkOrders/action/midpointRescheduleWorkOrderOperation

Performs midpoint rescheduling for the maintenance work order. If the plant must perform midpoint rescheduling, then the client sends the operation, date, and one of the following scheduling options. 1, operation start date: the application sets the schedule date to the start date of the operation. 2, operation completion date: the application sets the schedule date to the completion date of the operation. The application then backward schedules the resources for operations that already occurred, and forward schedules the resources for subsequent operations. The application uses the work order operation as an anchor so that it can reschedule the resource according to the date that you specify. It uses this anchor as a stable, single reference point so that it can accurately reschedule the operations.

Request

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

• operationId: number
  Value that uniquely identifies the maintenance work order operation that anchors rescheduling.
• scheduleDate: string (date-time)
  Schedule date for the action of the operation that the application is anchoring. This date is one of the following values. 1: if the scheduling option equals the operation start date, then the application sets the schedule date to the operation start date. 2: if the scheduling option equals the operation completion date, then the application sets the schedule date to the operation completion date.
• scheduleOption: number
  Contains one of the following values. 1: assign the scheduleDate to the start date for the anchor operation. 2: assign the scheduleDate to the completion date for the anchor operation.

{
    "type":"object",
    "properties":{
        "scheduleOption":{
            "type":"number",
            "description":"Contains one of the following values. 1: assign the scheduleDate to the start date for the anchor operation. 2: assign the scheduleDate to the completion date for the anchor operation.",
            "nullable":true
        },
        "scheduleDate":{
            "type":"string",
            "description":"Schedule date for the action of the operation that the application is anchoring. This date is one of the following values. 1: if the scheduling option equals the operation start date, then the application sets the schedule date to the operation start date. 2: if the scheduling option equals the operation completion date, then the application sets the schedule date to the operation completion date.",
            "format":"date-time",
            "nullable":true
        },
        "operationId":{
            "type":"number",
            "description":"Value that uniquely identifies the maintenance work order operation that anchors rescheduling.",
            "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 midpointRescheduleWorkOrderOperation returns the identification of the maintenance work order.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"If the action completes successfully, then midpointRescheduleWorkOrderOperation returns the identification of the maintenance work order."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

This example describes how to reschedule one maintenance work order at the midpoint.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/maintenanceWorkOrders"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
"name": "midpointRescheduleWorkOrderOperation",
"parameters":
[
{
"operationId":300100169479987
},
{
"scheduleOption":1
},
{
"scheduleDate":"2020-05-02T05:29:00-07:00"
}
]
 
}

Back to Top