Create conversions
/fscmRestApi/resources/11.13.18.05/unitOfMeasureConversions
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
-
ConversionFactor: number
The calculated rate of conversion to convert a FromUOM value to the ToUOM value. For example, you can have a FromUOM of Dozen and a ToUOM of Each. The calculated rate for the conversion factor would be 12.
-
FromUOM: string
The name of the unit of measure the conversion is from. This attribute is required.
-
ItemId: string
The value that uniquely identifies the inventory item that this conversion calculation is for. If you include this attribute, and if a conversion exists for this item, then this API will use the item conversion values when converting FromUOM to ToUOM.
-
ReturnMessage: string
A message that includes details about errors that occurred during the calculation of the conversion factor. The errors mostly occur due to missing conversions for the specified item.
-
ReturnStatus: string
The status of whether the conversion factor was successfully created based on the input values for FromUOM and ToUOM and the optional item identifier. Contains one of the following values: true or false. If true, then the conversion factor was successfully calculated. If false, then the conversion failed to calculate.
-
ToUOM: string
The name of the unit of measure the conversion is being made to. This attribute is required.
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
-
ConversionFactor: number
The calculated rate of conversion to convert a FromUOM value to the ToUOM value. For example, you can have a FromUOM of Dozen and a ToUOM of Each. The calculated rate for the conversion factor would be 12.
-
FromUOM: string
The name of the unit of measure the conversion is from. This attribute is required.
-
ItemId: string
The value that uniquely identifies the inventory item that this conversion calculation is for. If you include this attribute, and if a conversion exists for this item, then this API will use the item conversion values when converting FromUOM to ToUOM.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReturnMessage: string
A message that includes details about errors that occurred during the calculation of the conversion factor. The errors mostly occur due to missing conversions for the specified item.
-
ReturnStatus: string
The status of whether the conversion factor was successfully created based on the input values for FromUOM and ToUOM and the optional item identifier. Contains one of the following values: true or false. If true, then the conversion factor was successfully calculated. If false, then the conversion failed to calculate.
-
ToUOM: string
The name of the unit of measure the conversion is being made to. This attribute is required.
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 create one conversion rate when converting from one unit of measure to another unit of measure.
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/unitOfMeasureConversions"
Example Request Body 1
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.
{ "FromUOM": "C12", "ToUOM": "Ea" }
Example Response Body 1
The following example includes the contents of the response body in JSON format:
{ "FromUOM" : "C12", "ToUOM"" : "Ea", "ConversionFactor" : 12, "ReturnMessage" : "Conversion Factor Obtained Successfully", "ReturnStatus" : "SUCCESS", "ItemId" : null, ... }
Example Request Body 2
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.
{ "FromUOM": "CSE", "ToUOM": "EA", "ItemId" : "100000012013473" }
Example Response Body 2
The following example includes the contents of the response body in JSON format:
{ "FromUOM" : "CSE", "ToUOM" : "EA", "ConversionFactor" : 1, "ReturnMessage" : "Conversion Factor Obtained Successfully", "ReturnStatus" : "SUCCESS", "ItemId" : "100000012013473", ... }