Update one unit of measure class
patch
/fscmRestApi/resources/11.13.18.05/unitOfMeasureClasses/{ClassCode}
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: string
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: string
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
BaseUnitOfMeasure: string
Title:
Base UOM NameMaximum Length:25The name of the base unit of measure for the class. -
BaseUOMCode: string
Title:
Base UOM CodeMaximum Length:3The user supplied short code that identifies the base unit of measure for the class. -
BaseUOMDescription: string
Title:
Base UOM DescriptionMaximum Length:50The description of the base unit of measure for the class. -
ClassDescription: string
Title:
Class DescriptionMaximum Length:50The description of the unit of measure class. -
ClassName: string
Title:
Class NameMaximum Length:10The name of the unit of measure class. It is a unique value. This attribute is required. -
DFF: array
Flexfields for Unit of Measure Classes
Title:
Flexfields for Unit of Measure ClassesThe Flexfields for Unit of Measure Classes resource manages the descriptive flexfields for the unit of measure class. -
EndDate: string
(date)
Title:
End DateThe date when the unit of measure class no longer supports the creation of new units within it. -
interclassConversions: array
Unit of Measure Interclass Conversions
Title:
Unit of Measure Interclass ConversionsThe Unit of Measure Interclass Conversions resource gets the interclass conversion rate for an item between two unit of measure classes.
Nested Schema : Flexfields for Unit of Measure Classes
Type:
arrayTitle:
Flexfields for Unit of Measure ClassesThe 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:
arrayTitle:
Unit of Measure Interclass ConversionsThe 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:
Show Source
object-
__FLEX_Context: string
Title:
ContextMaximum Length:30Descriptive flexfield context name for unit of measure classes. -
__FLEX_Context_DisplayValue: string
Title:
ContextContext
Nested Schema : schema
Type:
Show Source
object-
FromUOMClassId: string
Maximum Length:
10The 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:
3The 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:
ConversionThe rate of conversion between the FromUOMClass and the ToUOMClass, for the specified inventory item. This attribute is required. -
InterclassConversionEndDate: string
(date)
Title:
End DateThe 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:
10The 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:
3The 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.
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.
Root Schema : unitOfMeasureClasses-item-response
Type:
Show Source
object-
BaseUnitOfMeasure: string
Title:
Base UOM NameMaximum Length:25The name of the base unit of measure for the class. -
BaseUOMCode: string
Title:
Base UOM CodeMaximum Length:3The user supplied short code that identifies the base unit of measure for the class. -
BaseUOMDescription: string
Title:
Base UOM DescriptionMaximum Length:50The description of the base unit of measure for the class. -
ClassCode: string
Title:
Class CodeMaximum Length:10The user-supplied code that identifies the class. It is a unique value entered by the user. This attribute is required. -
ClassDescription: string
Title:
Class DescriptionMaximum Length:50The description of the unit of measure class. -
ClassId: string
Read Only:
trueMaximum Length:10The 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
Title:
Class NameMaximum Length:10The name of the unit of measure class. It is a unique value. This attribute is required. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the record. -
DFF: array
Flexfields for Unit of Measure Classes
Title:
Flexfields for Unit of Measure ClassesThe Flexfields for Unit of Measure Classes resource manages the descriptive flexfields for the unit of measure class. -
EndDate: string
(date)
Title:
End DateThe date when the unit of measure class no longer supports the creation of new units within it. -
interclassConversions: array
Unit of Measure Interclass Conversions
Title:
Unit of Measure Interclass ConversionsThe Unit of Measure Interclass Conversions resource gets the interclass conversion rate for an item between two unit of measure classes. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Flexfields for Unit of Measure Classes
Type:
arrayTitle:
Flexfields for Unit of Measure ClassesThe 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:
arrayTitle:
Unit of Measure Interclass ConversionsThe Unit of Measure Interclass Conversions resource gets the interclass conversion rate for an item between two unit of measure classes.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : unitOfMeasureClasses-DFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
ContextMaximum Length:30Descriptive flexfield context name for unit of measure classes. -
__FLEX_Context_DisplayValue: string
Title:
ContextContext -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
UomClass: string
Maximum Length:
10The 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 : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : unitOfMeasureClasses-interclassConversions-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the record. -
FromUOMClassId: string
Maximum Length:
10The 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:
3The 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:
ConversionThe rate of conversion between the FromUOMClass and the ToUOMClass, for the specified inventory item. This attribute is required. -
InterclassConversionEndDate: string
(date)
Title:
End DateThe date when the unit of measure interclass conversion is no longer available. -
InterclassConversionId: integer
Read Only:
trueThe 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:
trueDate and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ToUOMClassId: string
Maximum Length:
10The 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:
3The 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.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- DFF
-
Parameters:
- ClassCode:
$request.path.ClassCode
The Flexfields for Unit of Measure Classes resource manages the descriptive flexfields for the unit of measure class. - ClassCode:
- interclassConversions
-
Operation: /fscmRestApi/resources/11.13.18.05/unitOfMeasureClasses/{ClassCode}/child/interclassConversionsParameters:
- ClassCode:
$request.path.ClassCode
The Unit of Measure Interclass Conversions resource gets the interclass conversion rate for an item between two unit of measure classes. - ClassCode: