Create component items
post
/fscmRestApi/resources/11.13.18.05/priceLists/{PriceListId}/child/items/{PriceListItemId}/child/componentItems
Request
Path Parameters
-
PriceListId(required): integer(int64)
Value that uniquely identifies the price list.
-
PriceListItemId(required): integer(int64)
Value that uniquely identifies the price list item.
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
Root Schema : schema
Type:
Show Source
object
-
componentCharges: array
Price List Component Charges
Title:
Price List Component Charges
The Price List Component Charges resource manages the charges of component items in a price list. -
ComponentIdPath(required): string
(byte)
Hierarchy of the component item unique values from the configuration model.
-
ComponentItem: string
Name of the component item.
-
ComponentItemDescription: string
Description of the component item.
-
ComponentItemId(required): integer
(int64)
Value that uniquely identifies the component item.
-
ComponentPath: string
Hierarchy of the component item from the configuration model.
-
ComponentPathId: string
Value that uniquely identifies the hierarchy of the values of the component item from the configuration model.
-
COMPPath(required): string
(byte)
Hierarchy of the values of the component item from the configuration model.
-
LineType: string
Type of line applied to the price list component items in the price list. Valid values include Buy, Return, and so on. A list of accepted values is defined in the lookup type ORA_QP_ORDER_LINE_TYPES.
-
LineTypeCode: string
Maximum Length:
30
Default Value:ORA_BUY
Abbreviation that identifies the type of line applied to the price list component items in the price list. -
PriceListComponentItemId: integer
(int64)
Value that uniquely identifies the price list component item.
-
PriceListId(required): integer
(int64)
Value that uniquely identifies the price list to which the component items belong.
-
PriceListItemId(required): integer
(int64)
Value that uniquely identifies the price list item.
-
PricingUOM: string
Unit of measure for pricing.
-
PricingUOMCode(required): string
Maximum Length:
3
Abbreviation that identifies the unit of measure for pricing.
Nested Schema : Price List Component Charges
Type:
array
Title:
Price List Component Charges
The Price List Component Charges resource manages the charges of component items in a price list.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AllowManualAdjustment: string
Maximum Length:
30
Contains one of the following values: Y or N. If Y, then allow manual adjustments. If N, then do not allow manual adjustments. The default value is N. -
BasePrice: number
Value of the base price of the component item.
-
CalculationMethod: string
Method of calculation applied to the price list component item charges in the price list.
-
CalculationMethodCode(required): string
Maximum Length:
30
Abbreviation that identifies the method of calculation applied to the price list component item charges in the price list. -
CalculationType: string
Type of calculation applied to the price list component item charges in the price list.
-
CalculationTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of calculation applied to the price list component item charges in the price list. -
ChargeLineNumber(required): integer
(int32)
Title:
Line Number
Line number of the component item charge. -
chargesDFF: array
Flexfields for Price List Charges
Title:
Flexfields for Price List Charges
The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge. -
CostCalculationAmount: number
Title:
Cost Calculation Amount
Value of the cost calculation amount. -
EndDate: string
(date-time)
Date when the charge becomes inactive.
-
ParentEntityId(required): integer
(int64)
Value that uniquely identifies the component item for the component charge.
-
PriceListChargeId: integer
(int64)
Value that uniquely identifies the charge of the price list component item.
-
PriceListId: integer
(int64)
Value that uniquely identifies the price list.
-
PricePeriodicity: string
Name of the price periodicity.
-
PricePeriodicityCode: string
Maximum Length:
12
Abbreviation that identifies the price periodicity. -
PricingChargeDefinition: string
Name of the pricing charge definition.
-
PricingChargeDefinitionCode: string
Abbreviation that identifies the pricing charge definition.
-
PricingChargeDefinitionId(required): integer
(int64)
Value that uniquely identifies the pricing charge definition.
-
StartDate(required): string
(date-time)
Date when the charge becomes active.
Nested Schema : Flexfields for Price List Charges
Type:
array
Title:
Flexfields for Price List Charges
The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge.
Show Source
Nested Schema : priceLists-items-componentItems-componentCharges-chargesDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Descriptive flexfield context name for price list charges. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
PriceListChargeId: integer
(int64)
Value that uniquely identifies the charge of a price list item to which the descriptive flexfields belong.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : priceLists-items-componentItems-item-response
Type:
Show Source
object
-
componentCharges: array
Price List Component Charges
Title:
Price List Component Charges
The Price List Component Charges resource manages the charges of component items in a price list. -
ComponentIdPath: string
(byte)
Hierarchy of the component item unique values from the configuration model.
-
ComponentItem: string
Name of the component item.
-
ComponentItemDescription: string
Description of the component item.
-
ComponentItemId: integer
(int64)
Value that uniquely identifies the component item.
-
ComponentPath: string
Hierarchy of the component item from the configuration model.
-
ComponentPathId: string
Value that uniquely identifies the hierarchy of the values of the component item from the configuration model.
-
COMPPath: string
(byte)
Hierarchy of the values of the component item from the configuration model.
-
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 record was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LineType: string
Type of line applied to the price list component items in the price list. Valid values include Buy, Return, and so on. A list of accepted values is defined in the lookup type ORA_QP_ORDER_LINE_TYPES.
-
LineTypeCode: string
Maximum Length:
30
Default Value:ORA_BUY
Abbreviation that identifies the type of line applied to the price list component items in the price list. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PriceListComponentItemId: integer
(int64)
Value that uniquely identifies the price list component item.
-
PriceListId: integer
(int64)
Value that uniquely identifies the price list to which the component items belong.
-
PriceListItemId: integer
(int64)
Value that uniquely identifies the price list item.
-
PricingUOM: string
Unit of measure for pricing.
-
PricingUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure for pricing.
Nested Schema : Price List Component Charges
Type:
array
Title:
Price List Component Charges
The Price List Component Charges resource manages the charges of component items in a price list.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-componentItems-componentCharges-item-response
Type:
Show Source
object
-
AllowManualAdjustment: string
Maximum Length:
30
Contains one of the following values: Y or N. If Y, then allow manual adjustments. If N, then do not allow manual adjustments. The default value is N. -
BasePrice: number
Value of the base price of the component item.
-
CalculationMethod: string
Method of calculation applied to the price list component item charges in the price list.
-
CalculationMethodCode: string
Maximum Length:
30
Abbreviation that identifies the method of calculation applied to the price list component item charges in the price list. -
CalculationType: string
Type of calculation applied to the price list component item charges in the price list.
-
CalculationTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of calculation applied to the price list component item charges in the price list. -
ChargeLineNumber: integer
(int32)
Title:
Line Number
Line number of the component item charge. -
chargesDFF: array
Flexfields for Price List Charges
Title:
Flexfields for Price List Charges
The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge. -
CostCalculationAmount: number
Title:
Cost Calculation Amount
Value of the cost calculation amount. -
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 record was created. -
EndDate: string
(date-time)
Date when the charge becomes inactive.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the record was most recently updated. -
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. -
ParentEntityId: integer
(int64)
Value that uniquely identifies the component item for the component charge.
-
PriceListChargeId: integer
(int64)
Value that uniquely identifies the charge of the price list component item.
-
PriceListId: integer
(int64)
Value that uniquely identifies the price list.
-
PricePeriodicity: string
Name of the price periodicity.
-
PricePeriodicityCode: string
Maximum Length:
12
Abbreviation that identifies the price periodicity. -
PricingChargeDefinition: string
Name of the pricing charge definition.
-
PricingChargeDefinitionCode: string
Abbreviation that identifies the pricing charge definition.
-
PricingChargeDefinitionId: integer
(int64)
Value that uniquely identifies the pricing charge definition.
-
StartDate: string
(date-time)
Date when the charge becomes active.
Nested Schema : Flexfields for Price List Charges
Type:
array
Title:
Flexfields for Price List Charges
The Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-componentItems-componentCharges-chargesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Descriptive flexfield context name for price list charges. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PriceListChargeId: integer
(int64)
Value that uniquely identifies the charge of a price list item to which the descriptive flexfields belong.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- componentCharges
-
Parameters:
- PriceListComponentItemId:
$request.path.PriceListComponentItemId
- PriceListId:
$request.path.PriceListId
- PriceListItemId:
$request.path.PriceListItemId
The Price List Component Charges resource manages the charges of component items in a price list. - PriceListComponentItemId:
Examples
This example describes how to create one component item.
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/priceLists/PriceListId/child/items/PriceListItemId/child/componentItems"
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.
{ "ComponentItem": "CM93827", "PricingUOM": "Each", "LineType": "Buy", "ComponentPath": "CN92777> OC58102> OC61247" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "PriceListId": 300100149278040, "PriceListItemId": 300100149286874, "PriceListComponentItemId": 300100149286882, "ComponentItem": "CM93827", "ComponentItemId": 544, "ComponentItemDescription": "desc-DIT", "PricingUOM": "Each", "PricingUOMCode": "Ea", "LineType": "Buy", "LineTypeCode": "ORA_BUY", "ComponentPath": "CN92777> OC58102> OC61247", "ComponentPathId": " 137> 295> 301", "CreationDate": "2018-05-18T12:07:01+00:00", "CreatedBy": "PRICING_MGR_OPERATIONS", "LastUpdateDate": "2018-05-18T12:07:02.186+00:00", "LastUpdatedBy": "PRICING_MGR_OPERATIONS" }