Create
post
/fscmRestApi/resources/11.13.18.05/unitsOfMeasure
Request
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.
-
Upsert-Mode: string
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
Root Schema : schema
Type:
Show Source
object-
BaseUnitFlag(required): boolean
Maximum Length:
1 -
Description: string
Title:
UOM DescriptionMaximum Length:50 -
DFF: array
DFF
-
DisableDate: string
(date)
Title:
End Date -
intraclassConversions: array
intraclassConversions
-
StandardConversion(required): number
Title:
Conversion -
StandardConversionEndDate: string
(date)
Title:
End Date -
translatedData: array
translatedData
-
UOM(required): string
Title:
UOM NameMaximum Length:25 -
UOMClass(required): string
Title:
Class NameMaximum Length:10 -
UOMCode(required): string
Title:
UOM CodeMaximum Length:3 -
UOMId: integer
(int64)
-
UOMPluralDescription: string
Title:
Plural DescriptionMaximum Length:50 -
UOMReciprocalDescription: string
Title:
Reciprocal DescriptionMaximum Length:50
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
ContextMaximum Length:30Context -
__FLEX_Context_DisplayValue: string
Title:
ContextContext -
UnitOfMeasureId: integer
(int64)
Nested Schema : schema
Type:
Show Source
object-
IntraclassConversion: number
Title:
Conversion -
IntraclassConversionEndDate: string
(date)
Title:
End Date -
InventoryItemId: integer
(int64)
Nested Schema : unitsOfMeasure-translatedData-item-post-request
Type:
Show Source
object-
Description: string
Title:
DescriptionMaximum Length:50 -
Language: string
Maximum Length:
4 -
SourceLang: string
Maximum Length:
4 -
UnitOfMeasure: string
Title:
UOM NameMaximum Length:25 -
UOMPluralDescription: string
Title:
Plural DescriptionMaximum Length:50 -
UOMReciprocalDescription: string
Title:
Reciprocal DescriptionMaximum Length:50
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 : unitsOfMeasure-item-response
Type:
Show Source
object-
BaseUnitFlag: boolean
Maximum Length:
1 -
CreatedBy: string
Read Only:
trueMaximum Length:64 -
CreationDate: string
(date-time)
Read Only:
true -
DerivedUnitParentCode: string
Read Only:
trueMaximum Length:3 -
Description: string
Title:
UOM DescriptionMaximum Length:50 -
DFF: array
DFF
-
DisableDate: string
(date)
Title:
End Date -
GlobalAttributeCategory: string
Read Only:
trueMaximum Length:150 -
intraclassConversions: array
intraclassConversions
-
LastUpdateDate: string
(date-time)
Read Only:
true -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OkeiCode: string
Read Only:
trueMaximum Length:150 -
StandardConversion: number
Title:
Conversion -
StandardConversionEndDate: string
(date)
Title:
End Date -
translatedData: array
translatedData
-
UOM: string
Title:
UOM NameMaximum Length:25 -
UOMClass: string
Title:
Class NameMaximum Length:10 -
UOMClassCode: string
Title:
Class CodeRead Only:trueMaximum Length:10 -
UOMClassName: string
Title:
Class NameRead Only:trueMaximum Length:10 -
UOMCode: string
Title:
UOM CodeMaximum Length:3 -
UOMId: integer
(int64)
-
UOMPluralDescription: string
Title:
Plural DescriptionMaximum Length:50 -
UOMReciprocalDescription: string
Title:
Reciprocal DescriptionMaximum Length:50
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : unitsOfMeasure-DFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
ContextMaximum Length:30Context -
__FLEX_Context_DisplayValue: string
Title:
ContextContext -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
UnitOfMeasureId: integer
(int64)
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 : unitsOfMeasure-intraclassConversions-item-response
Type:
Show Source
object-
ConversionId: integer
(int64)
Read Only:
true -
CreatedBy: string
Read Only:
trueMaximum Length:64 -
CreationDate: string
(date-time)
Read Only:
true -
IntraclassConversion: number
Title:
Conversion -
IntraclassConversionEndDate: string
(date)
Title:
End Date -
InventoryItemId: integer
(int64)
-
ItemNumber: string
Read Only:
true -
LastUpdateDate: string
(date-time)
Read Only:
true -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : unitsOfMeasure-translatedData-item-response
Type:
Show Source
object-
Description: string
Title:
DescriptionMaximum Length:50 -
Language: string
Maximum Length:
4 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SourceLang: string
Maximum Length:
4 -
UnitOfMeasure: string
Title:
UOM NameMaximum Length:25 -
UOMPluralDescription: string
Title:
Plural DescriptionMaximum Length:50 -
UOMReciprocalDescription: string
Title:
Reciprocal DescriptionMaximum Length:50
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- DFF
-
Parameters:
- UOMCode:
$request.path.UOMCode
- UOMCode:
- intraclassConversions
-
Parameters:
- UOMCode:
$request.path.UOMCode
- UOMCode:
- translatedData
-
Parameters:
- UOMCode:
$request.path.UOMCode
- UOMCode:
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" : [ {
...
} ]
}