Jump to

• Request
• Response
• Examples

Invokes the scheduled process to pick materials.

post

/fscmRestApi/resources/11.13.18.05/workOrders/action/invokePickMaterialESS

Invokes the scheduled process to pick materials for a range of work order operations passed in the REST request. The client sends the input parameters to identify the from and to, work order operations that defines the range of operations. The application then invokes the scheduled process to pick materials for the range of operations passed in the request.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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

• fromOperationSequenceNumber: number
  Sequence that identifies the work order operation.
• organizationId: number
  Value that uniquely identifies the organization.
• toOperationSequenceNumber: number
  Sequence that identifies the work order operation.
• workCenterId: number
  Value that uniquely identifies the work center.
• workOrderIds: string
  Value that uniquely identifies the work order.

{
    "type":"object",
    "properties":{
        "organizationId":{
            "type":"number",
            "description":"Value that uniquely identifies the organization.",
            "nullable":true
        },
        "workOrderIds":{
            "type":"string",
            "description":"Value that uniquely identifies the work order.",
            "nullable":true
        },
        "workCenterId":{
            "type":"number",
            "description":"Value that uniquely identifies the work center.",
            "nullable":true
        },
        "toOperationSequenceNumber":{
            "type":"number",
            "description":"Sequence that identifies the work order operation.",
            "nullable":true
        },
        "fromOperationSequenceNumber":{
            "type":"number",
            "description":"Sequence that identifies the work order operation.",
            "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
  Value that uniquely identifies the scheduled process.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Value that uniquely identifies the scheduled process."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

This example describes how to initiate the scheduled process to pick materials for a range of work order operations passed in the REST request. The client sends the input parameters to identify the from and to work order operations that define the range of operations. The application then initiates the scheduled process to pick materials for the range of operations passed in the request.

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/workOrders/action/invokePickMaterialESS"

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": "invokePickMaterialESS",
    "parameters": [
        {
            "workOrderIds": "300100081228227, 1441"
        },
        {
            "organizationId": "207"
        },
        {
            "workCenterId": null
        },
        {
            "fromOperationSeqNumber": "10"
        },      
        {
            "toOperationSeqNumber": "20"
        }        
    ]
}

Example Response Body

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

{ 
"result": "41941" 
}

Back to Top