Create validation
/fscmRestApi/resources/11.13.18.05/validatePickedQuantities
Request
-
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.
- application/json
object
-
ErrorCode: string
Abbreviation that identifies the message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Code attribute is empty.
-
ErrorExplanation: string
Message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Explanation attribute is empty.
-
PickedQuantity: number
Picked quantity to confirm in the primary unit of measure that the item uses.
-
PickSlip: integer
Value that uniquely identifies the pick slip.
-
PickSlipLine: integer
Value that uniquely identifies one line on the pick slip.
-
ReturnStatus: string
Status returned by the application when validating the quantity. Valid values are SUCCESS, ERROR, and WARNING. SUCCESS: the application successfully validated the quantity for the transaction. ERROR: this validation failed. WARNING: the validation found a potential problem, but allows the transaction to continue.
-
SecondaryPickedQuantity: number
Picked quantity to confirm in the secondary unit of measure that the item uses.
Response
- application/json
Default Response
-
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.
object
-
ErrorCode: string
Abbreviation that identifies the message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Code attribute is empty.
-
ErrorExplanation: string
Message that describes the error that occurred when validating the quantity. If the Return Status attribute contains a value of SUCCESS, then the Error Explanation attribute is empty.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PickedQuantity: number
Picked quantity to confirm in the primary unit of measure that the item uses.
-
PickSlip: integer
Value that uniquely identifies the pick slip.
-
PickSlipLine: integer
Value that uniquely identifies one line on the pick slip.
-
ReturnStatus: string
Status returned by the application when validating the quantity. Valid values are SUCCESS, ERROR, and WARNING. SUCCESS: the application successfully validated the quantity for the transaction. ERROR: this validation failed. WARNING: the validation found a potential problem, but allows the transaction to continue.
-
SecondaryPickedQuantity: number
Picked quantity to confirm in the secondary unit of measure that the item uses.
array
Links
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to validate all picked quantities.
Example cURL Command
Use the following cURL command to submit a request on the REST resource. This example picks validates picked quantities for pick slip 1114157, on pick slip line 1, for a picked quantity of 6:
curl -u username:password –X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "servername/fscmRestApi/resources/version/validatePickedQuantities"
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.
{ "PickSlip" : 1114157 , "PickSlipLine" : 1 , "PickedQuantity" : 6 }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "PickSlip" : 1114157, "PickSlipLine" : 1, "PickedQuantity" : 6, "SecondaryPickedQuantity" : 1, "ReturnStatus" : "Error", "ErrorCode" : "INV_DEVIATION_ERROR", "ErrorExplanation" : "The quantity 1 must be less than or equal to the allowed deviation .51." }