Jump to

• Request
• Response
• Examples

Create one unit of measure

post

/fscmRestApi/resources/11.13.18.05/unitsOfMeasure

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

• BaseUnitFlag(required): boolean
  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.
• Description: string
  Title: Description

  Maximum Length: 50

  Description of the unit of measure.
• DFF: array 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.
• DisableDate: string (date)
  Title: End Date

  Date when the unit of measure is no longer active.
• intraclassConversions: array 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.
• StandardConversion(required): number
  Title: Conversion

  Rate of conversion between the unit of measure and the base unit of the class. This attribute is required.
• StandardConversionEndDate: string (date)
  Title: End Date

  Date when the standard conversion for the unit of measure is no longer active.
• translatedData: array 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.
• UOM(required): string
  Maximum Length: 25

  Name of the unit of measure. This attribute is required.
• UOMClass(required): string
  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.
• UOMCode(required): string
  Title: UOM Code

  Maximum Length: 3

  User-supplied short code that identifies the unit of measure. This attribute is required.
• UOMId: integer (int64)
  Value that uniquely identifies the unit of measure. It is a value that the application generates when it creates a unit.
• UOMPluralDescription: string
  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.
• UOMReciprocalDescription: string
  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.

{
    "required":[
        "BaseUnitFlag",
        "StandardConversion",
        "UOM",
        "UOMClass",
        "UOMCode"
    ],
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"50",
            "type":"string",
            "description":"Description of the unit of measure.",
            "nullable":true
        },
        "DFF":{
            "title":"Flexfields for Units of Measure",
            "type":"array",
            "description":"The Flexfields for Units of Measure resource manages the descriptive flexfields for the unit of measure.",
            "items":{
                "$ref":"#/components/schemas/unitsOfMeasure-DFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "intraclassConversions":{
            "title":"Unit of Measure Intraclass Conversions",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/unitsOfMeasure-intraclassConversions-item-post-request"
            }
        },
        "StandardConversionEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the standard conversion for the unit of measure is no longer active.",
            "format":"date",
            "nullable":true
        },
        "translatedData":{
            "title":"Translated Data for Units of Measure",
            "type":"array",
            "description":"The Translated Data for Units of Measure resource gets all translated names and descriptions for a specific unit of measure.",
            "items":{
                "$ref":"#/components/schemas/unitsOfMeasure-translatedData-item-post-request"
            }
        },
        "UOMReciprocalDescription":{
            "title":"Reciprocal Description",
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "UOM":{
            "maxLength":"25",
            "type":"string",
            "description":"Name of the unit of measure. This attribute is required.",
            "nullable":false,
            "x-hints":{
                "controlType":"edit"
            }
        },
        "BaseUnitFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "StandardConversion":{
            "title":"Conversion",
            "type":"number",
            "description":"Rate of conversion between the unit of measure and the base unit of the class. This attribute is required.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "StandardConversionEndDate"
                ]
            }
        },
        "UOMPluralDescription":{
            "title":"Plural Description",
            "maxLength":"50",
            "type":"string",
            "description":"Description of the plural value of the unit of measure. For example: Feet is the plural value for the Foot unit of measure.",
            "nullable":true
        },
        "DisableDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the unit of measure is no longer active.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "UOMId":{
            "type":"integer",
            "description":"Value that uniquely identifies the unit of measure. It is a value that the application generates when it creates a unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "UOMClass":{
            "title":"Class Name",
            "maxLength":"10",
            "type":"string",
            "description":"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.",
            "nullable":false
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"User-supplied short code that identifies the unit of measure. This attribute is required.",
            "nullable":false
        }
    }
}

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

• Array of: object schema

{
    "title":"Flexfields for Units of Measure",
    "type":"array",
    "description":"The Flexfields for Units of Measure resource manages the descriptive flexfields for the unit of measure.",
    "items":{
        "$ref":"#/components/schemas/unitsOfMeasure-DFF-item-post-request"
    },
    "x-cardinality":"1"
}

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

• Array of: object schema

{
    "title":"Unit of Measure Intraclass Conversions",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/unitsOfMeasure-intraclassConversions-item-post-request"
    }
}

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

• Array of: object unitsOfMeasure-translatedData-item-post-request

{
    "title":"Translated Data for Units of Measure",
    "type":"array",
    "description":"The Translated Data for Units of Measure resource gets all translated names and descriptions for a specific unit of measure.",
    "items":{
        "$ref":"#/components/schemas/unitsOfMeasure-translatedData-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 30

  Descriptive flexfield context name for units of measure.
• __FLEX_Context_DisplayValue: string
  Title: Context
• UnitOfMeasureId: integer (int64)
  Value that uniquely identifies the unit of measure. It is a value that the application generates when it creates a unit. This attribute maps to the UOMId parameter in the root resource.

{
    "type":"object",
    "properties":{
        "UnitOfMeasureId":{
            "type":"integer",
            "description":"Value that uniquely identifies the unit of measure. It is a value that the application generates when it creates a unit. This attribute maps to the UOMId parameter in the root resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for units of measure.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• IntraclassConversion: number
  Title: Conversion

  Rate of conversion between the unit of measure and the base unit of the class for the specified inventory item. This attribute is required.
• IntraclassConversionEndDate: string (date)
  Title: End Date

  Date when the unit of measure intraclass conversion is no longer available.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item that the intraclass conversion is being defined for. This attribute is required.

{
    "type":"object",
    "properties":{
        "IntraclassConversion":{
            "title":"Conversion",
            "type":"number",
            "description":"Rate of conversion between the unit of measure and the base unit of the class for the specified inventory item. This attribute is required.",
            "nullable":false
        },
        "IntraclassConversionEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the unit of measure intraclass conversion is no longer available.",
            "format":"date",
            "nullable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item that the intraclass conversion is being defined for. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : unitsOfMeasure-translatedData-item-post-request

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 50

  Description of the unit of measure.
• Language: string
  Maximum Length: 4

  Indicates the code of the language into which the contents of the translatable columns are translated.
• SourceLang: string
  Maximum Length: 4

  Indicates the code of the language in which the contents of the translatable columns were originally created.
• UnitOfMeasure: string
  Title: UOM Name

  Maximum Length: 25

  Name of the unit of measure.
• UOMPluralDescription: string
  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.
• UOMReciprocalDescription: string
  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.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"50",
            "type":"string",
            "description":"Description of the unit of measure.",
            "nullable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":false
        },
        "Language":{
            "maxLength":"4",
            "type":"string",
            "description":"Indicates the code of the language into which the contents of the translatable columns are translated.",
            "nullable":false
        },
        "SourceLang":{
            "maxLength":"4",
            "type":"string",
            "description":"Indicates the code of the language in which the contents of the translatable columns were originally created.",
            "nullable":false
        },
        "UOMPluralDescription":{
            "title":"Plural Description",
            "maxLength":"50",
            "type":"string",
            "description":"Description of the plural value of the unit of measure. For example: Feet is the plural value for the Foot unit of measure.",
            "nullable":true
        },
        "UOMReciprocalDescription":{
            "title":"Reciprocal Description",
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "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:
  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 : unitsOfMeasure-item-response

Type: object

Show Source

• BaseUnitFlag: boolean
  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.
• 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.
• DerivedUnitParentCode: string
  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.
• Description: string
  Title: Description

  Maximum Length: 50

  Description of the unit of measure.
• DFF: array 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.
• DisableDate: string (date)
  Title: End Date

  Date when the unit of measure is no longer active.
• GlobalAttributeCategory: string
  Read Only: true

  Maximum Length: 150

  Category name of the global descriptive flexfield that the unit of measure references.
• intraclassConversions: array 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.
• 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.
• OkeiCode: string
  Read Only: true

  Maximum Length: 150

  Global descriptive flexfield for the Russia OKEI identification of the unit of measure.
• StandardConversion: number
  Title: Conversion

  Rate of conversion between the unit of measure and the base unit of the class. This attribute is required.
• StandardConversionEndDate: string (date)
  Title: End Date

  Date when the standard conversion for the unit of measure is no longer active.
• translatedData: array 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.
• UOM: string
  Maximum Length: 25

  Name of the unit of measure. This attribute is required.
• UOMClass: string
  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.
• UOMClassCode: string
  Title: Class Code

  Read Only: true

  Maximum Length: 10

  User-supplied code that identifies the class of the unit of measure.
• UOMClassName: string
  Title: Class Name

  Read Only: true

  Maximum Length: 10

  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
  Title: UOM Code

  Maximum Length: 3

  User-supplied short code that identifies the unit of measure. This attribute is required.
• UOMId: integer (int64)
  Value that uniquely identifies the unit of measure. It is a value that the application generates when it creates a unit.
• UOMPluralDescription: string
  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.
• UOMReciprocalDescription: string
  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.

{
    "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
        },
        "Description":{
            "title":"Description",
            "maxLength":"50",
            "type":"string",
            "description":"Description of the unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "DFF":{
            "title":"Flexfields for Units of Measure",
            "type":"array",
            "description":"The Flexfields for Units of Measure resource manages the descriptive flexfields for the unit of measure.",
            "items":{
                "$ref":"#/components/schemas/unitsOfMeasure-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "intraclassConversions":{
            "title":"Unit of Measure Intraclass Conversions",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/unitsOfMeasure-intraclassConversions-item-response"
            }
        },
        "GlobalAttributeCategory":{
            "maxLength":"150",
            "type":"string",
            "description":"Category name of the global descriptive flexfield that the unit of measure references.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "FND_ACFF_VF":"c",
                "FND_ACFF_FlexfieldCode":"RCS_UNITS_OF_MEASURE",
                "FND_ACFF_ApplicationID":"10108",
                "FND_ACFF_ModelID":"DFF_RCS_RCS_5FUNITS_5FOF_5FMEASURE_RCS_5FUNITS_5FOF_5FMEASURE_5FB_5FGFF_INV_5FUNITS_5FOF_5FMEASURE_5FB",
                "FND_ACFF_ApplicationShortName":"RCS"
            },
            "x-queryable":true
        },
        "StandardConversionEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the standard conversion for the unit of measure is no longer active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "translatedData":{
            "title":"Translated Data for Units of Measure",
            "type":"array",
            "description":"The Translated Data for Units of Measure resource gets all translated names and descriptions for a specific unit of measure.",
            "items":{
                "$ref":"#/components/schemas/unitsOfMeasure-translatedData-item-response"
            }
        },
        "UOMClassCode":{
            "title":"Class Code",
            "maxLength":"10",
            "type":"string",
            "description":"User-supplied code that identifies the class of the unit of measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMReciprocalDescription":{
            "title":"Reciprocal Description",
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMClassName":{
            "title":"Class Name",
            "maxLength":"10",
            "type":"string",
            "description":"Name of the class that categorizes the unit of measure. Either this attribute or the UOMClass is required when creating a new unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UOM":{
            "maxLength":"25",
            "type":"string",
            "description":"Name of the unit of measure. This attribute is required.",
            "nullable":false,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "OkeiCode":{
            "maxLength":"150",
            "type":"string",
            "description":"Global descriptive flexfield for the Russia OKEI identification of the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "FND_ACFF_VF_GlobalAttributeCategory__RCS_UOM_OKEI_CODE":"c"
            },
            "x-queryable":true
        },
        "BaseUnitFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "StandardConversion":{
            "title":"Conversion",
            "type":"number",
            "description":"Rate of conversion between the unit of measure and the base unit of the class. This attribute is required.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "StandardConversionEndDate"
                ]
            },
            "x-queryable":true
        },
        "UOMPluralDescription":{
            "title":"Plural Description",
            "maxLength":"50",
            "type":"string",
            "description":"Description of the plural value of the unit of measure. For example: Feet is the plural value for the Foot unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "DerivedUnitParentCode":{
            "maxLength":"3",
            "type":"string",
            "description":"User-supplied short code that identifies the parent unit of measure for derived units used in a packaging string.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DisableDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the unit of measure is no longer active.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "UOMId":{
            "type":"integer",
            "description":"Value that uniquely identifies the unit of measure. It is a value that the application generates when it creates a unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UOMClass":{
            "title":"Class Name",
            "maxLength":"10",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"User-supplied short code that identifies the unit of measure. This attribute is required.",
            "nullable":false,
            "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 : 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

• Array of: object unitsOfMeasure-DFF-item-response

{
    "title":"Flexfields for Units of Measure",
    "type":"array",
    "description":"The Flexfields for Units of Measure resource manages the descriptive flexfields for the unit of measure.",
    "items":{
        "$ref":"#/components/schemas/unitsOfMeasure-DFF-item-response"
    },
    "x-cardinality":"1"
}

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

• Array of: object unitsOfMeasure-intraclassConversions-item-response

{
    "title":"Unit of Measure Intraclass Conversions",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/unitsOfMeasure-intraclassConversions-item-response"
    }
}

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 : 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

• Array of: object unitsOfMeasure-translatedData-item-response

{
    "title":"Translated Data for Units of Measure",
    "type":"array",
    "description":"The Translated Data for Units of Measure resource gets all translated names and descriptions for a specific unit of measure.",
    "items":{
        "$ref":"#/components/schemas/unitsOfMeasure-translatedData-item-response"
    }
}

Nested Schema : unitsOfMeasure-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 30

  Descriptive flexfield context name for units of measure.
• __FLEX_Context_DisplayValue: string
  Title: Context
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• UnitOfMeasureId: integer (int64)
  Value that uniquely identifies the unit of measure. It is a value that the application generates when it creates a unit. This attribute maps to the UOMId parameter in the root resource.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UnitOfMeasureId":{
            "type":"integer",
            "description":"Value that uniquely identifies the unit of measure. It is a value that the application generates when it creates a unit. This attribute maps to the UOMId parameter in the root resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for units of measure.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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."
        }
    }
}

Nested Schema : unitsOfMeasure-intraclassConversions-item-response

Type: object

Show Source

• ConversionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the unit of measure intraclass conversion. It is a value that the application generates when it creates a unit. This attribute is required.
• 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.
• IntraclassConversion: number
  Title: Conversion

  Rate of conversion between the unit of measure and the base unit of the class for the specified inventory item. This attribute is required.
• IntraclassConversionEndDate: string (date)
  Title: End Date

  Date when the unit of measure intraclass conversion is no longer available.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item that the intraclass conversion is being defined for. This attribute is required.
• ItemNumber: string
  Read Only: true

  Alphanumeric name that uniquely identifies the item that the intraclass 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.

{
    "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
        },
        "ItemNumber":{
            "type":"string",
            "description":"Alphanumeric name that uniquely identifies the item that the intraclass conversion is being defined for. Either this attribute or InventoryItemId is required.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IntraclassConversion":{
            "title":"Conversion",
            "type":"number",
            "description":"Rate of conversion between the unit of measure and the base unit of the class for the specified inventory item. This attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "ConversionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the unit of measure intraclass conversion. It is a value that the application generates when it creates a unit. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item that the intraclass conversion is being defined for. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IntraclassConversionEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the unit of measure intraclass conversion is no longer available.",
            "format":"date",
            "nullable":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 : unitsOfMeasure-translatedData-item-response

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 50

  Description of the unit of measure.
• Language: string
  Maximum Length: 4

  Indicates the code of the language into which the contents of the translatable columns are translated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SourceLang: string
  Maximum Length: 4

  Indicates the code of the language in which the contents of the translatable columns were originally created.
• UnitOfMeasure: string
  Title: UOM Name

  Maximum Length: 25

  Name of the unit of measure.
• UOMPluralDescription: string
  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.
• UOMReciprocalDescription: string
  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.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"50",
            "type":"string",
            "description":"Description of the unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":false,
            "x-queryable":true
        },
        "Language":{
            "maxLength":"4",
            "type":"string",
            "description":"Indicates the code of the language into which the contents of the translatable columns are translated.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":"4",
            "type":"string",
            "description":"Indicates the code of the language in which the contents of the translatable columns were originally created.",
            "nullable":false,
            "x-queryable":true
        },
        "UOMPluralDescription":{
            "title":"Plural Description",
            "maxLength":"50",
            "type":"string",
            "description":"Description of the plural value of the unit of measure. For example: Feet is the plural value for the Foot unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMReciprocalDescription":{
            "title":"Reciprocal Description",
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":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"
    }
}

Links

DFF

Operation: /fscmRestApi/resources/11.13.18.05/unitsOfMeasure/{UOMCode}/child/DFF

Parameters:

• UOMCode: $request.path.UOMCode

The Flexfields for Units of Measure resource manages the descriptive flexfields for the unit of measure.

intraclassConversions

Operation: /fscmRestApi/resources/11.13.18.05/unitsOfMeasure/{UOMCode}/child/intraclassConversions

Parameters:

• UOMCode: $request.path.UOMCode

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.

translatedData

Operation: /fscmRestApi/resources/11.13.18.05/unitsOfMeasure/{UOMCode}/child/translatedData

Parameters:

• UOMCode: $request.path.UOMCode

The Translated Data for Units of Measure resource gets all translated names and descriptions for a specific unit of measure.

Back to Top

Examples

This example describes how to create one 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/unitsOfMeasure"

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.

Authorization: user/passwordContent Type: application/json 
Operation: POST 
{  
   "UOMCode" : "EA", 
   "UOMClass" : 3222, 
   "UOM" : "Each", 
   "Description" : "Each", 
   "UOMReciprocalDescription" : "Per Unit", 
   "UOMPluralDescription" : "Each", 
   "BaseUnitFlag" : true, 
   "DisableDate" : null, 
   "StandardConversion" : 1, 
   "StandardConversionEndDate" : null 
}

Example Response Body

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

{ 
  "UOMId" : 300100132065443, 
  "UOMCode" : "EA", 
  "UOMClass" : "3222", 
  "UOM" : "Each", 
  "Description" : "Each", 
  "UOMReciprocalDescription" : "Per Unit", 
  "UOMPluralDescription" : "Each", 
  "BaseUnitFlag" : true, 
  "DisableDate" : null, 
  "StandardConversion" : 1, 
  "StandardConversionEndDate" : null, 
  "GlobalAttributeCategory" : null, 
  "OkeiCode" : null, 
  "links" : [ {
  ...
  } ] 
} 

Back to Top