Jump to

• Request
• Response
• Examples

Replace with a substitute

post

/fscmRestApi/resources/11.13.18.05/workOrders/{WorkOrderId}/child/WorkOrderMaterial/{WorkOrderOperationMaterialId}/action/replaceWithSubstitute

Replaces the work order material with substitute. To replace the work order material, the client sends the substitute item identifier or substitute item number to uniquely identify the substitute item. The application then replaces the work order material with substitute item. The replaced item becomes substitute for the new work order material.

Request

Path Parameters

• WorkOrderId(required): integer(int64)
  Value that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order.
• WorkOrderOperationMaterialId(required): integer(int64)
  Value that uniquely identifies the material for the work order operation. It is a primary key that the application generates when it creates the material for the work order operation.

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

• substituteItemId: number
  Value that uniquely identifies the substitute item.
• substituteItemNumber: string
  Number that identifies the substitute item.

{
    "type":"object",
    "properties":{
        "substituteItemId":{
            "type":"number",
            "description":"Value that uniquely identifies the substitute item.",
            "nullable":true
        },
        "substituteItemNumber":{
            "type":"string",
            "description":"Number that identifies the substitute item.",
            "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 it returns a success message.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"If the action completes successfully, then it returns a success message."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

This example describes how to replace work order material with a substitute.

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.action+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/workOrders/WorkOrderId/child/WorkOrderMaterial/WorkOrderOperationMaterialId/action/replaceWithSubstitute"

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 updates.

{
    "name" : "replaceWithSubstitute",
    "parameters" : [
       {
          "substituteItemNumber": "MFG-PL-COMP1"
         }
    ]
}

Example Response Body

The following example includes the contents of the response body in JSON format:

"You have replaced MFG-PL-COMP1 with MFG-PL-COMP2 for Work Order WO123 Operation 10"

Back to Top