Jump to

• Request
• Response
• Examples

Create one interclass conversion

post

/fscmRestApi/resources/11.13.18.05/unitOfMeasureClasses/{ClassCode}/child/interclassConversions

Request

Path Parameters

• ClassCode(required): string
  The user-supplied code that identifies the class. It is a unique value entered by the user. This attribute is required.

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• FromUOMClassId: string
  Maximum Length: 10

  The value that uniquely identifies the unit of measure class. This attribute always references the parent resource instance. For a specific inventory item, interclass conversions are always between two classes, from one class to another class. When creating new interclass conversions, the FromUOMCode and FromUOMClassId attributes are not required.
• FromUOMCode: string
  Maximum Length: 3

  The user-supplied short code that identifies the base unit of measure of a class. This attribute always references the parent resource instance. For a specific inventory item, interclass conversions are always between two classes, from one class to another class. When creating new interclass conversions, the FromUOMCode and FromUOMClassId attributes are not required.
• InterclassConversion: number
  Title: Conversion

  The rate of conversion between the FromUOMClass and the ToUOMClass, for the specified inventory item. This attribute is required.
• InterclassConversionEndDate: string (date)
  Title: End Date

  The date when the unit of measure interclass conversion is no longer available.
• InventoryItemId: integer (int64)
  The value that uniquely identifies the inventory item that the interclass conversion is being defined for. Either this attribute or ItemNumber is required.
• ItemNumber: string
  The alphanumeric name that uniquely identifies the item that the interclass conversion is being defined for. Either this attribute or InventoryItemId is required.
• ToUOMClassId: string
  Maximum Length: 10

  The value that uniquely identifies the unit of measure class. For a specific inventory item, interclass conversions are always between two classes, from one class to another class. When creating new interclass conversions, either the ToUOMCode or the ToUOMClassId attribute is required.
• ToUOMCode: string
  Maximum Length: 3

  The user-supplied short code that identifies the base unit of measure of a class. For a specific inventory item, interclass conversions are always between two classes, from one class to another class. When creating new interclass conversions, either the ToUOMCode or the ToUOMClassId attribute is required.

{
    "type":"object",
    "properties":{
        "FromUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"The user-supplied short code that identifies the base unit of measure of a class. This attribute always references the parent resource instance. For a specific inventory item, interclass conversions are always between two classes, from one class to another class. When creating new interclass conversions, the FromUOMCode and FromUOMClassId attributes are not required.",
            "nullable":false
        },
        "ToUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"The user-supplied short code that identifies the base unit of measure of a class. For a specific inventory item, interclass conversions are always between two classes, from one class to another class. When creating new interclass conversions, either the ToUOMCode or the ToUOMClassId attribute is required.",
            "nullable":false
        },
        "FromUOMClassId":{
            "maxLength":10,
            "type":"string",
            "description":"The value that uniquely identifies the unit of measure class. This attribute always references the parent resource instance. For a specific inventory item, interclass conversions are always between two classes, from one class to another class. When creating new interclass conversions, the FromUOMCode and FromUOMClassId attributes are not required.",
            "nullable":false
        },
        "ToUOMClassId":{
            "maxLength":10,
            "type":"string",
            "description":"The value that uniquely identifies the unit of measure class. For a specific inventory item, interclass conversions are always between two classes, from one class to another class. When creating new interclass conversions, either the ToUOMCode or the ToUOMClassId attribute is required.",
            "nullable":false
        },
        "ItemNumber":{
            "type":"string",
            "description":"The alphanumeric name that uniquely identifies the item that the interclass conversion is being defined for. Either this attribute or InventoryItemId is required.",
            "nullable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The value that uniquely identifies the inventory item that the interclass conversion is being defined for. Either this attribute or ItemNumber is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InterclassConversion":{
            "title":"Conversion",
            "type":"number",
            "description":"The rate of conversion between the FromUOMClass and the ToUOMClass, for the specified inventory item. This attribute is required.",
            "nullable":false
        },
        "InterclassConversionEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the unit of measure interclass conversion is no longer available.",
            "format":"date",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : unitOfMeasureClasses-interclassConversions-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• FromUOMClassId: string
  Maximum Length: 10

  The value that uniquely identifies the unit of measure class. This attribute always references the parent resource instance. For a specific inventory item, interclass conversions are always between two classes, from one class to another class. When creating new interclass conversions, the FromUOMCode and FromUOMClassId attributes are not required.
• FromUOMCode: string
  Maximum Length: 3

  The user-supplied short code that identifies the base unit of measure of a class. This attribute always references the parent resource instance. For a specific inventory item, interclass conversions are always between two classes, from one class to another class. When creating new interclass conversions, the FromUOMCode and FromUOMClassId attributes are not required.
• InterclassConversion: number
  Title: Conversion

  The rate of conversion between the FromUOMClass and the ToUOMClass, for the specified inventory item. This attribute is required.
• InterclassConversionEndDate: string (date)
  Title: End Date

  The date when the unit of measure interclass conversion is no longer available.
• InterclassConversionId: integer
  Read Only: true

  The value that uniquely identifies the unit of measure interclass conversion. It is a value that the application generates when it creates an interclass conversion. This attribute is required.
• InventoryItemId: integer (int64)
  The value that uniquely identifies the inventory item that the interclass conversion is being defined for. Either this attribute or ItemNumber is required.
• ItemNumber: string
  The alphanumeric name that uniquely identifies the item that the interclass conversion is being defined for. Either this attribute or InventoryItemId is required.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ToUOMClassId: string
  Maximum Length: 10

  The value that uniquely identifies the unit of measure class. For a specific inventory item, interclass conversions are always between two classes, from one class to another class. When creating new interclass conversions, either the ToUOMCode or the ToUOMClassId attribute is required.
• ToUOMCode: string
  Maximum Length: 3

  The user-supplied short code that identifies the base unit of measure of a class. For a specific inventory item, interclass conversions are always between two classes, from one class to another class. When creating new interclass conversions, either the ToUOMCode or the ToUOMClassId attribute is required.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The value that uniquely identifies the inventory item that the interclass conversion is being defined for. Either this attribute or ItemNumber is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FromUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"The user-supplied short code that identifies the base unit of measure of a class. This attribute always references the parent resource instance. For a specific inventory item, interclass conversions are always between two classes, from one class to another class. When creating new interclass conversions, the FromUOMCode and FromUOMClassId attributes are not required.",
            "nullable":false,
            "x-queryable":true
        },
        "ToUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"The user-supplied short code that identifies the base unit of measure of a class. For a specific inventory item, interclass conversions are always between two classes, from one class to another class. When creating new interclass conversions, either the ToUOMCode or the ToUOMClassId attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "FromUOMClassId":{
            "maxLength":10,
            "type":"string",
            "description":"The value that uniquely identifies the unit of measure class. This attribute always references the parent resource instance. For a specific inventory item, interclass conversions are always between two classes, from one class to another class. When creating new interclass conversions, the FromUOMCode and FromUOMClassId attributes are not required.",
            "nullable":false,
            "x-queryable":true
        },
        "ToUOMClassId":{
            "maxLength":10,
            "type":"string",
            "description":"The value that uniquely identifies the unit of measure class. For a specific inventory item, interclass conversions are always between two classes, from one class to another class. When creating new interclass conversions, either the ToUOMCode or the ToUOMClassId attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemNumber":{
            "type":"string",
            "description":"The alphanumeric name that uniquely identifies the item that the interclass conversion is being defined for. Either this attribute or InventoryItemId is required.",
            "nullable":true,
            "x-queryable":true
        },
        "InterclassConversion":{
            "title":"Conversion",
            "type":"number",
            "description":"The rate of conversion between the FromUOMClass and the ToUOMClass, for the specified inventory item. This attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InterclassConversionEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the unit of measure interclass conversion is no longer available.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InterclassConversionId":{
            "type":"integer",
            "description":"The value that uniquely identifies the unit of measure interclass conversion. It is a value that the application generates when it creates an interclass conversion. This attribute is required.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 interclass conversion.

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/unitOfMeasureClasses/ClassCode/child/interclassConversions"

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.

{  
    "InventoryItemId" : 100000012013473, 
    "FromUOMCode" : "LB", 
    "ToUOMClassId" : "QTY", 
    "ToUOMCode" : "EA", 
    "InterclassConversion" : 1 
}

Example Response Body

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

{ 
  "InterclassConversionId" : 300100132864188, 
  "InventoryItemId" : 100000012013473, 
  "FromUOMClassId" : "MASS", 
  "FromUOMCode" : "LB", 
  "ToUOMClassId" : "QTY", 
  "ToUOMCode" : "EA", 
  "InterclassConversion" : 1, 
  "InterclassConversionEndDate" : null, 
  "ItemNumber" : "ZCST-Plain-Asset1", 
  "links" : [ { 
  ...
  } ] 
}

Back to Top