1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. SCM Common
  4. Units of Measure

Get all units of measure

get

/fscmRestApi/resources/11.13.18.05/unitsOfMeasure

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:

    • ActiveUomFinder: Finds units of measure that are active as of date.
      Finder Variables:
      • DisableDate; string; Value that removes units of measure that have been disabled prior to this date.
    • PrimaryKey: Finds unit of measures according to the primary key.
      Finder Variables:
      • UOMId; integer; Value that uniquely identifies the unit of measure. It is a primary key that the application generates when it creates a unit.
    • UomCodeFinder: Finds unit of measures according to the primary key.
      Finder Variables:
      • UOMCode; string; Primary key that uniquely identifies the unit of measure. This attribute is required.
    • UomFinder: Finds unit of measures according to the user-specified key.
      Finder Variables:
      • UOM; string; Name of the unit of measure.
      • UOMClass; string; Class that categorizes the unit of measure.
      • UOMCode; string; User-specified key that uniquely identifies the unit of measure.
  • 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:
    • BaseUnitFlag; boolean; Contains one of the following values: true or false. If true, then the unit of measure is the base unit of the class, typically the smallest unit within the class. If false, then the unit is not the base unit. All conversions within a class are made through the base unit. The default value is false.
    • CreatedBy; string; User who created the record.
    • CreationDate; string; Date and time when the user created the record.
    • DerivedUnitParentCode; string; User-supplied short code that identifies the parent unit of measure for derived units used in a packaging string.
    • Description; string; Description of the unit of measure.
    • DisableDate; string; Date when the unit of measure is no longer active.
    • GlobalAttributeCategory; string; Category name of the global descriptive flexfield that the unit of measure references.
    • LastUpdateDate; string; Date and time when the user most recently updated the record.
    • LastUpdatedBy; string; User who most recently updated the record.
    • OkeiCode; string; Global descriptive flexfield for the Russia OKEI identification of the unit of measure.
    • StandardConversion; number; Rate of conversion between the unit of measure and the base unit of the class. This attribute is required.
    • StandardConversionEndDate; string; Date when the standard conversion for the unit of measure is no longer active.
    • UOM; string; Name of the unit of measure. This attribute is required.
    • UOMClass; string; Class that categorizes the unit of measure. Either this attribute or the UOMClassName is required when creating a new unit. The value of this attribute is the value of the ClassId attribute of the unitOfMeasureClasses instance.
    • UOMClassName; string; Name of the class that categorizes the unit of measure. Either this attribute or the UOMClass is required when creating a new unit.
    • UOMCode; string; User-supplied short code that identifies the unit of measure. This attribute is required.
    • UOMId; integer; Value that uniquely identifies the unit of measure. It is a value that the application generates when it creates a unit.
    • UOMPluralDescription; string; Description of the plural value of the unit of measure. For example: Feet is the plural value for the Foot unit of measure.
    • UOMReciprocalDescription; string; Description of how to process the unit of measure so that the quantity that results from dividing it equals one. For example: Per Month is the reciprocal display for a service that uses the Month unit of measure.
  • 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 : unitsOfMeasure
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : unitsOfMeasure-item-response
Type: object
Show Source
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the unit of measure is the base unit of the class, typically the smallest unit within the class. If false, then the unit is not the base unit. All conversions within a class are made through the base unit. The default value is false.
  • Read Only: true
    Maximum Length: 64
    User who created the record.
  • Read Only: true
    Date and time when the user created the record.
  • Read Only: true
    Maximum Length: 3
    User-supplied short code that identifies the parent unit of measure for derived units used in a packaging string.
  • Title: Description
    Maximum Length: 50
    Description of the unit of measure.
  • Flexfields for Units of Measure
    Title: Flexfields for Units of Measure
    The Flexfields for Units of Measure resource manages the descriptive flexfields for the unit of measure.
  • Title: End Date
    Date when the unit of measure is no longer active.
  • Read Only: true
    Maximum Length: 150
    Category name of the global descriptive flexfield that the unit of measure references.
  • Unit of Measure Intraclass Conversions
    Title: Unit of Measure Intraclass Conversions
    The Unit of Measure Intraclass Conversions resource gets the intraclass conversion rate for an item between a unit of measure and the base unit in the same class. The intraclass conversion supersedes the standard conversion rate.
  • 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
  • Read Only: true
    Maximum Length: 150
    Global descriptive flexfield for the Russia OKEI identification of the unit of measure.
  • Title: Conversion
    Rate of conversion between the unit of measure and the base unit of the class. This attribute is required.
  • Title: End Date
    Date when the standard conversion for the unit of measure is no longer active.
  • Translated Data for Units of Measure
    Title: Translated Data for Units of Measure
    The Translated Data for Units of Measure resource gets all translated names and descriptions for a specific unit of measure.
  • Maximum Length: 25
    Name of the unit of measure. This attribute is required.
  • Title: Class Name
    Maximum Length: 10
    Class that categorizes the unit of measure. Either this attribute or the UOMClassName is required when creating a new unit. The value of this attribute is the value of the ClassId attribute of the unitOfMeasureClasses instance.
  • Name of the class that categorizes the unit of measure. Either this attribute or the UOMClass is required when creating a new unit.
  • Title: UOM Code
    Maximum Length: 3
    User-supplied short code that identifies the unit of measure. This attribute is required.
  • Value that uniquely identifies the unit of measure. It is a value that the application generates when it creates a unit.
  • Title: Plural Description
    Maximum Length: 50
    Description of the plural value of the unit of measure. For example: Feet is the plural value for the Foot unit of measure.
  • Title: Reciprocal Description
    Maximum Length: 50
    Description of how to process the unit of measure so that the quantity that results from dividing it equals one. For example: Per Month is the reciprocal display for a service that uses the Month unit of measure.
Nested Schema : Flexfields for Units of Measure
Type: array
Title: Flexfields for Units of Measure
The Flexfields for Units of Measure resource manages the descriptive flexfields for the unit of measure.
Show Source
Nested Schema : Unit of Measure Intraclass Conversions
Type: array
Title: Unit of Measure Intraclass Conversions
The Unit of Measure Intraclass Conversions resource gets the intraclass conversion rate for an item between a unit of measure and the base unit in the same class. The intraclass conversion supersedes the standard conversion rate.
Show Source
Nested Schema : Translated Data for Units of Measure
Type: array
Title: Translated Data for Units of Measure
The Translated Data for Units of Measure resource gets all translated names and descriptions for a specific unit of measure.
Show Source
Nested Schema : unitsOfMeasure-DFF-item-response
Type: object
Show Source
Nested Schema : unitsOfMeasure-intraclassConversions-item-response
Type: object
Show Source
Nested Schema : unitsOfMeasure-translatedData-item-response
Type: object
Show Source
  • Title: Description
    Maximum Length: 50
    Description of the unit of measure.
  • Maximum Length: 4
    Indicates the code of the language into which the contents of the translatable columns are translated.
  • Links
  • Maximum Length: 4
    Indicates the code of the language in which the contents of the translatable columns were originally created.
  • Title: UOM Name
    Maximum Length: 25
    Name of the unit of measure.
  • Title: Plural Description
    Maximum Length: 50
    Description of the plural value of the unit of measure. For example: Feet is the plural value for the Foot unit of measure.
  • Title: Reciprocal Description
    Maximum Length: 50
    Description of how to process the unit of measure so that the quantity that results from dividing it equals one. For example: Per Month is the reciprocal display for a service that uses the Month unit of measure.
Back to Top

Examples

This example describes how to get all units of measure.

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/unitsOfMeasure"

Example Response Body

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

{
  "items" : [ {
    "UOMCode" : "Min",
    "UOMClass" : "Time",
    "UOM" : "Minute",
    "Description" : "Minute",
    "UOMPluralDescription" : "Minutes",
    "UOMReciprocalDescription" : " Per Minute",
    "BaseUnitFlag" : false, 
    "DisableDate" : null,
    "OkeiCode" : null,
    "GlobalAttributeCategory" : null,
...
  }, {
...
  } ],
...
}
Back to Top