Create one unit of measure class

post

/fscmRestApi/resources/11.13.18.05/unitOfMeasureClasses

Request

Header Parameters
  • 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".
  • 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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Flexfields for Unit of Measure Classes
Type: array
Title: Flexfields for Unit of Measure Classes
The Flexfields for Unit of Measure Classes resource manages the descriptive flexfields for the unit of measure class.
Show Source
Nested Schema : Unit of Measure Interclass Conversions
Type: array
Title: Unit of Measure Interclass Conversions
The Unit of Measure Interclass Conversions resource gets the interclass conversion rate for an item between two unit of measure classes.
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Context
    Maximum Length: 30
    Descriptive flexfield context name for unit of measure classes.
  • Title: Context
  • Maximum Length: 10
    The value that uniquely identifies the unit of measure class. It is a primary key that the application generates when it creates a class. This attribute maps to the ClassId parameter in the root resource.
Nested Schema : schema
Type: object
Show Source
  • 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.
  • 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.
  • Title: Conversion
    The rate of conversion between the FromUOMClass and the ToUOMClass, for the specified inventory item. This attribute is required.
  • Title: End Date
    The date when the unit of measure interclass conversion is no longer available.
  • The value that uniquely identifies the inventory item that the interclass conversion is being defined for. Either this attribute or ItemNumber is required.
  • The alphanumeric name that uniquely identifies the item that the interclass conversion is being defined for. Either this attribute or InventoryItemId is required.
  • 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.
  • 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.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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-item-response
Type: object
Show Source
Nested Schema : Flexfields for Unit of Measure Classes
Type: array
Title: Flexfields for Unit of Measure Classes
The Flexfields for Unit of Measure Classes resource manages the descriptive flexfields for the unit of measure class.
Show Source
Nested Schema : Unit of Measure Interclass Conversions
Type: array
Title: Unit of Measure Interclass Conversions
The Unit of Measure Interclass Conversions resource gets the interclass conversion rate for an item between two unit of measure classes.
Show Source
Nested Schema : unitOfMeasureClasses-DFF-item-response
Type: object
Show Source
  • Title: Context
    Maximum Length: 30
    Descriptive flexfield context name for unit of measure classes.
  • Title: Context
  • Links
  • Maximum Length: 10
    The value that uniquely identifies the unit of measure class. It is a primary key that the application generates when it creates a class. This attribute maps to the ClassId parameter in the root resource.
Nested Schema : unitOfMeasureClasses-interclassConversions-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who created the record.
  • Read Only: true
    Date and time when the user created the record.
  • 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.
  • 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.
  • Title: Conversion
    The rate of conversion between the FromUOMClass and the ToUOMClass, for the specified inventory item. This attribute is required.
  • Title: End Date
    The date when the unit of measure interclass conversion is no longer available.
  • 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.
  • The value that uniquely identifies the inventory item that the interclass conversion is being defined for. Either this attribute or ItemNumber is required.
  • The alphanumeric name that uniquely identifies the item that the interclass conversion is being defined for. Either this attribute or InventoryItemId is required.
  • Read Only: true
    Date and time when the user most recently updated the record.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • 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.
  • 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.
Back to Top

Examples

This example describes how to create one unit of measure class.

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"

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.

{  
    "ClassCode" : "QTY", 
    "ClassName" : "Quantity", 
    "ClassDescription" : "Units indicating a count"
}

Example Response Body

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

{ 
  "ClassCode" : "QTY", 
  "ClassId" : "3222", 
  "ClassName" : "Quantity", 
  "ClassDescription" : "Units indicating a count", 
  "EndDate" : null, 
  "links" : [ {
  ...
  } ] 
}
Back to Top