Jump to

• Request
• Response

Replace with a substitute

post

/fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/ProcessWorkOrderMaterial/{WorkOrderOperationMaterialId}/action/replaceWithSubstitute

Replaces the work order material with a 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 a substitute item. The replaced item becomes the substitute for the new work order material.

Request

Path Parameters

• WorkOrderOperationMaterialId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• processWorkOrdersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Process Work Orders resource and used to uniquely identify an instance of Process Work Orders. The client should not generate the hash key value. Instead, the client should query on the Process Work Orders collection resource in order to navigate to a specific instance of Process Work Orders to get the hash key.

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