Jump to

• Request
• Response
• Examples

Create conversions

post

/fscmRestApi/resources/11.13.18.05/unitOfMeasureConversions

Request

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/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ConversionFactor: number
  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.
• FromQuantity: number
  Default Value: 1

  Value of a quantity to be converted from the FromUOM unit to the ToUOM unit. The default value is 1. If the value of FromQuantity is greater than 1, then the ToQuantity attribute will be populated with the calculated quantity.
• FromUOM: string
  Name of the unit of measure the conversion is from. This attribute is required.
• ItemId: string
  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.
• PrecisionFlag: boolean
  Default Value: true

  Contains one of the following values: true or false. If true, then the conversion calculations will be rounded to the precision stored as the value of profile option INV_QUANTITY_DECIMAL_PRECISION, that has a default value of 5. If false, then no precision is used to round the calculated value. The default value is false.
• ReturnMessage: string
  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.
• ReturnMessageCode: string
  Value of the error message if the ReturnStatus is false and the conversion failed to calculate.
• ReturnStatus: string
  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.
• ToQuantity: number
  Value of the FromQuantity multiplied by the conversion factor using precision, if requested.
• ToUOM: string
  Name of the unit of measure the conversion is being made to. This attribute is required.

{
    "type":"object",
    "properties":{
        "ReturnMessageCode":{
            "type":"string",
            "description":"Value of the error message if the ReturnStatus is false and the conversion failed to calculate.",
            "nullable":true,
            "x-queryable":false
        },
        "FromUOM":{
            "type":"string",
            "description":"Name of the unit of measure the conversion is from. This attribute is required.",
            "nullable":true,
            "x-queryable":false
        },
        "ConversionFactor":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "PrecisionFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the conversion calculations will be rounded to the precision stored as the value of profile option INV_QUANTITY_DECIMAL_PRECISION, that has a default value of 5. If false, then no precision is used to round the calculated value. The default value is false.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "ReturnStatus":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnMessage":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ToUOM":{
            "type":"string",
            "description":"Name of the unit of measure the conversion is being made to. This attribute is required.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemId":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "FromQuantity":{
            "type":"number",
            "description":"Value of a quantity to be converted from the FromUOM unit to the ToUOM unit. The default value is 1. If the value of FromQuantity is greater than 1, then the ToQuantity attribute will be populated with the calculated quantity.",
            "nullable":true,
            "default":"1",
            "x-queryable":false
        },
        "ToQuantity":{
            "type":"number",
            "description":"Value of the FromQuantity multiplied by the conversion factor using precision, if requested.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : unitOfMeasureConversions-item-response

Type: object

Show Source

• ConversionFactor: number
  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.
• FromQuantity: number
  Default Value: 1

  Value of a quantity to be converted from the FromUOM unit to the ToUOM unit. The default value is 1. If the value of FromQuantity is greater than 1, then the ToQuantity attribute will be populated with the calculated quantity.
• FromUOM: string
  Name of the unit of measure the conversion is from. This attribute is required.
• ItemId: string
  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.
• PrecisionFlag: boolean
  Default Value: true

  Contains one of the following values: true or false. If true, then the conversion calculations will be rounded to the precision stored as the value of profile option INV_QUANTITY_DECIMAL_PRECISION, that has a default value of 5. If false, then no precision is used to round the calculated value. The default value is false.
• ReturnMessage: string
  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.
• ReturnMessageCode: string
  Value of the error message if the ReturnStatus is false and the conversion failed to calculate.
• ReturnStatus: string
  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.
• ToQuantity: number
  Value of the FromQuantity multiplied by the conversion factor using precision, if requested.
• ToUOM: string
  Name of the unit of measure the conversion is being made to. This attribute is required.

{
    "type":"object",
    "properties":{
        "ReturnMessageCode":{
            "type":"string",
            "description":"Value of the error message if the ReturnStatus is false and the conversion failed to calculate.",
            "nullable":true,
            "x-queryable":false
        },
        "FromUOM":{
            "type":"string",
            "description":"Name of the unit of measure the conversion is from. This attribute is required.",
            "nullable":true,
            "x-queryable":false
        },
        "ConversionFactor":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "PrecisionFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the conversion calculations will be rounded to the precision stored as the value of profile option INV_QUANTITY_DECIMAL_PRECISION, that has a default value of 5. If false, then no precision is used to round the calculated value. The default value is false.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "ReturnStatus":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnMessage":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ToUOM":{
            "type":"string",
            "description":"Name of the unit of measure the conversion is being made to. This attribute is required.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemId":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "FromQuantity":{
            "type":"number",
            "description":"Value of a quantity to be converted from the FromUOM unit to the ToUOM unit. The default value is 1. If the value of FromQuantity is greater than 1, then the ToQuantity attribute will be populated with the calculated quantity.",
            "nullable":true,
            "default":"1",
            "x-queryable":false
        },
        "ToQuantity":{
            "type":"number",
            "description":"Value of the FromQuantity multiplied by the conversion factor using precision, if requested.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

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",
...
}

Back to Top