1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. SCM Common
  4. Unit of Measure Classes

Get all unit of measure classes

get

/fscmRestApi/resources/11.13.18.05/unitOfMeasureClasses

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • ClassCodeFinder: Find unit of measure classes according to the user-specified code.
      Finder Variables:
      • ClassCode; string; The user-specified code that identifies the unit of measure class.
    • PrimaryKey: Find unit of measure classes according to the user-specified code.
      Finder Variables:
      • ClassId; string; 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 parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BaseUOMCode; string; The user supplied short code that identifies the base unit of measure for the class.
    • BaseUOMDescription; string; The description of the base unit of measure for the class.
    • BaseUnitOfMeasure; string; The name of the base unit of measure for the class.
    • ClassCode; string; The user-supplied code that identifies the class. It is a unique value entered by the user. This attribute is required.
    • ClassDescription; string; The description of the unit of measure class.
    • ClassId; string; The value that uniquely identifies the unit of measure class. It is a primary key that the application generates when it creates a class.
    • ClassName; string; The name of the unit of measure class. It is a unique value. This attribute is required.
    • CreatedBy; string; User who created the record.
    • CreationDate; string; Date and time when the user created the record.
    • EndDate; string; The date when the unit of measure class no longer supports the creation of new units within it.
    • LastUpdateDate; string; Date and time when the user most recently updated the record.
    • LastUpdatedBy; string; User who most recently updated the record.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.

There's no request body for this operation.

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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested 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 get all unit of measure classes.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/unitOfMeasureClasses"

Example Response Body

The following shows an example of the response body in JSON format.

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