Update one covered item
patch
/fscmRestApi/resources/11.13.18.05/priceLists/{PriceListId}/child/items/{PriceListItemId}/child/coveredItems/{PriceListCoveredItemId}
Request
Path Parameters
-
PriceListCoveredItemId(required): integer(int64)
Value that uniquely identifies the price list covered item.
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
coveredCharges: array
Price List Covered Charges
Title:
Price List Covered ChargesThe Price List Covered Charges resource manages the charges of covered items in a price list. -
PriceListId: integer
(int64)
Value that uniquely identifies the price list to which the items belong.
-
PriceListItemId: integer
(int64)
Value that uniquely identifies the price list item.
Nested Schema : Price List Covered Charges
Type:
arrayTitle:
Price List Covered ChargesThe Price List Covered Charges resource manages the charges of covered items in a price list.
Show Source
Nested Schema : priceLists-items-coveredItems-coveredCharges-item-patch-request
Type:
Show Source
object-
AllowManualAdjustment: string
Maximum Length:
30Contains 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 covered item.
-
CalculationAmount: number
Title:
Calculation AmountValue of the calculation amount. -
CalculationMethod: string
Method of calculation applied to the price list covered item charges in the price list.
-
CalculationMethodCode: string
Maximum Length:
30Abbreviation that identifies the method of calculation applied to the price list covered item charges in the price list. -
chargesDFF: array
Flexfields for Price List Charges
Title:
Flexfields for Price List ChargesThe Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge. -
CoverageBasis: string
Pricing basis for the covered item.
-
CoverageBasisId: integer
(int64)
Title:
Return BasisValue that uniquely identifies the pricing basis for the covered item. -
EndDate: string
(date-time)
Date when the charge becomes inactive.
-
PricePeriodicity: string
Name of the price periodicity.
-
PricingChargeDefinition: string
Name of the pricing charge definition.
-
PricingChargeDefinitionCode: string
Abbreviation that identifies the pricing charge definition.
-
StartDate: string
(date-time)
Date when the charge becomes active.
Nested Schema : Flexfields for Price List Charges
Type:
arrayTitle:
Flexfields for Price List ChargesThe Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge.
Show Source
Nested Schema : priceLists-items-coveredItems-coveredCharges-chargesDFF-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Descriptive flexfield context name for price list charges. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value
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 : priceLists-items-coveredItems-item-response
Type:
Show Source
object-
ActionType: string
Type of action for the coverage item record. Valid values include Add, and so on. A list of accepted values is defined in the lookup type ORA_QP_ACTION_TYPES.
-
ActionTypeCode: string
Title:
Action TypeMaximum Length:30Default Value:ORA_ADDAbbreviation that identifies the type of action for the coverage item record. -
CoverageUOM: string
Unit of measure for coverage.
-
CoverageUOMCode: string
Title:
Coverage UOMMaximum Length:30Abbreviation that identifies the unit of measure for coverage. -
coveredCharges: array
Price List Covered Charges
Title:
Price List Covered ChargesThe Price List Covered Charges resource manages the charges of covered items in a price list. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
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. -
PriceListCoveredItemId: integer
(int64)
Value that uniquely identifies the price list covered item.
-
PriceListId: integer
(int64)
Value that uniquely identifies the price list to which the items belong.
-
PriceListItemId: integer
(int64)
Value that uniquely identifies the price list item.
-
PricingUOM: string
Unit of measure for pricing.
-
PricingUOMCode: string
Title:
Pricing UOMMaximum Length:30Abbreviation that identifies the unit of measure for pricing.
Nested Schema : Price List Covered Charges
Type:
arrayTitle:
Price List Covered ChargesThe Price List Covered Charges resource manages the charges of covered items in a price list.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-coveredItems-coveredCharges-item-response
Type:
Show Source
object-
AllowManualAdjustment: string
Maximum Length:
30Contains 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 covered item.
-
CalculationAmount: number
Title:
Calculation AmountValue of the calculation amount. -
CalculationMethod: string
Method of calculation applied to the price list covered item charges in the price list.
-
CalculationMethodCode: string
Maximum Length:
30Abbreviation that identifies the method of calculation applied to the price list covered item charges in the price list. -
ChargeLineNumber: integer
(int32)
Title:
Line NumberLine number of the component item charge. -
chargesDFF: array
Flexfields for Price List Charges
Title:
Flexfields for Price List ChargesThe Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge. -
CoverageBasis: string
Pricing basis for the covered item.
-
CoverageBasisId: integer
(int64)
Title:
Return BasisValue that uniquely identifies the pricing basis for the covered item. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the record was created. -
EndDate: string
(date-time)
Date when the charge becomes inactive.
-
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was most recently updated. -
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. -
ParentEntityId: integer
(int64)
Value that uniquely identifies the covered item for the covered charge.
-
PriceListChargeId: integer
(int64)
Value that uniquely identifies the charge of the price list covered item.
-
PriceListId: integer
(int64)
Value that uniquely identifies the price list.
-
PricePeriodicity: string
Name of the price periodicity.
-
PricePeriodicityCode: string
Maximum Length:
12Abbreviation 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:
arrayTitle:
Flexfields for Price List ChargesThe Flexfields for Price List Charges resource associates descriptive flexfield segments and its values with a price list charge.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : priceLists-items-coveredItems-coveredCharges-chargesDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:150Descriptive flexfield context name for price list charges. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
links: array
Links
Title:
LinksThe 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:
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.
Links
- coveredCharges
-
Parameters:
- PriceListCoveredItemId:
$request.path.PriceListCoveredItemId - PriceListId:
$request.path.PriceListId - PriceListItemId:
$request.path.PriceListItemId
The Price List Covered Charges resource manages the charges of covered items in a price list. - PriceListCoveredItemId: