Create lines
post
/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/{InterfaceHeaderId}/child/lines
Request
Path Parameters
-
InterfaceHeaderId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
Action: string
Maximum Length:
25
Action to perform on the lines. Valid values include CREATE, UPDATE, or CANCEL. This is a mandatory attribute. -
AdjustedPrice: number
Value of the unit price after adjustment.
-
AdjustmentPercentage: number
Value by which the base price is adjusted.
-
BatchId: number
Value that uniquely identifies the external purchase prices request batch.
-
ErrorFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then an error exists in the external purchase prices requests. If false, then no error exists and the external purchase prices are imported successfully. This attribute doesn't have a default value. -
InterfaceHeaderKey: string
Maximum Length:
30
Number that uniquely identifies the external purchase prices requests. -
InterfaceLineId: integer
(int64)
Value that uniquely identifies the request line.
-
InterfaceLineKey: string
Maximum Length:
30
Number that uniquely identifies the request line. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
ItemDescription: string
Maximum Length:
240
Description of the item. -
ItemNumber: string
Maximum Length:
300
Number that uniquely identifies the item. -
LineNumber: integer
(int64)
Number that uniquely identifies the external purchase prices line.
-
LoadRequestId: number
Value that uniquely identifies the process that loaded the external purchase prices request data to the interface tables.
-
ManufacturerPartNumber: string
Maximum Length:
700
Number that uniquely identifies the manufacturer part. -
ManufacturerTradingPartnerItemId: integer
(int64)
Value that uniquely identifies the manufacturer part.
-
Price: number
Value of the unit price before adjustment.
-
PriceEndDate: string
(date)
Date when the price becomes effective.
-
PriceStartDate: string
(date)
Date when the price becomes ineffective.
-
PurchasingCategoryCode: string
Maximum Length:
820
Abbreviation that identifies the purchasing category of the manufacturer part. -
PurchasingCategoryId: integer
(int64)
Value that uniquely identifies the purchasing category.
-
SourcePurchasingCategory: string
Maximum Length:
700
Name of the purchasing category of the manufacturer. -
SourceReferenceId: string
Maximum Length:
30
Value that uniquely identifies the external purchase prices in the source system. -
SourceUnitOfMeasure: string
Maximum Length:
25
Name of the source unit of measure. -
SourceUOMQuantity: number
Quantity of the source unit of measure.
-
UnitOfMeasure: string
Title:
UOM Name
Maximum Length:25
Name of the unit of measure. -
UnitOfMeasureCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure. -
VendorItemId: integer
(int64)
Value that uniquely identifies the supplier part.
-
VendorPartNumber: string
Maximum Length:
300
Number that uniquely identifies the supplier part.
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 : externalPurchasePricesRequests-lines-item-response
Type:
Show Source
object
-
Action: string
Maximum Length:
25
Action to perform on the lines. Valid values include CREATE, UPDATE, or CANCEL. This is a mandatory attribute. -
AdjustedPrice: number
Value of the unit price after adjustment.
-
AdjustmentPercentage: number
Value by which the base price is adjusted.
-
BatchId: number
Value that uniquely identifies the external purchase prices request batch.
-
ErrorFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then an error exists in the external purchase prices requests. If false, then no error exists and the external purchase prices are imported successfully. This attribute doesn't have a default value. -
InterfaceHeaderKey: string
Maximum Length:
30
Number that uniquely identifies the external purchase prices requests. -
InterfaceLineId: integer
(int64)
Value that uniquely identifies the request line.
-
InterfaceLineKey: string
Maximum Length:
30
Number that uniquely identifies the request line. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
ItemDescription: string
Maximum Length:
240
Description of the item. -
ItemNumber: string
Maximum Length:
300
Number that uniquely identifies the item. -
LineNumber: integer
(int64)
Number that uniquely identifies the external purchase prices line.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoadRequestId: number
Value that uniquely identifies the process that loaded the external purchase prices request data to the interface tables.
-
ManufacturerPartNumber: string
Maximum Length:
700
Number that uniquely identifies the manufacturer part. -
ManufacturerTradingPartnerItemId: integer
(int64)
Value that uniquely identifies the manufacturer part.
-
Price: number
Value of the unit price before adjustment.
-
PriceEndDate: string
(date)
Date when the price becomes effective.
-
PriceStartDate: string
(date)
Date when the price becomes ineffective.
-
PurchasingCategoryCode: string
Maximum Length:
820
Abbreviation that identifies the purchasing category of the manufacturer part. -
PurchasingCategoryId: integer
(int64)
Value that uniquely identifies the purchasing category.
-
SourcePurchasingCategory: string
Maximum Length:
700
Name of the purchasing category of the manufacturer. -
SourceReferenceId: string
Maximum Length:
30
Value that uniquely identifies the external purchase prices in the source system. -
SourceUnitOfMeasure: string
Maximum Length:
25
Name of the source unit of measure. -
SourceUOMQuantity: number
Quantity of the source unit of measure.
-
UnitOfMeasure: string
Title:
UOM Name
Maximum Length:25
Name of the unit of measure. -
UnitOfMeasureCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure. -
VendorItemId: integer
(int64)
Value that uniquely identifies the supplier part.
-
VendorPartNumber: string
Maximum Length:
300
Number that uniquely identifies the supplier part.
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.
Examples
This example describes how to create request lines.
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.batch+json" -d 'request payload' server:port/fscmRestApi/resources/version
Example Request Body
The following example includes the contents of the request body in JSON format.
"{ ""parts"": [ { ""id"": ""part0"", ""path"": ""/externalPurchasePricesRequests/300100556739393/child/lines"", ""operation"": ""create"", ""payload"": { ""InterfaceHeaderKey"": ""300100556739393"", ""SourceReferenceId"": ""1000000003"", ""Action"": ""CREATE"", ""ManufacturerPartNumber"": ""MPN-1004"", ""Price"": 50.00, ""AdjustmentPercentage"": 20, ""AdjustedPrice"": 40, ""SourceUnitOfMeasure"": ""Each"", ""SourceUOMQuantity"": 1, ""ItemDescription"": ""Diclofenac Injection 25 ml"", ""PriceStartDate"": ""2021-01-01"", ""PriceEndDate"": ""2021-12-31"" } }, { ""id"": ""part1"", ""path"": ""/externalPurchasePricesRequests/300100556739393/child/lines"", ""operation"": ""create"", ""payload"": { ""InterfaceHeaderKey"": ""300100556739393"", ""SourceReferenceId"": ""1000000003"", ""Action"": ""CREATE"", ""ManufacturerPartNumber"": ""MPN-1005"", ""Price"": 50.00, ""AdjustmentPercentage"": 20, ""AdjustedPrice"": 40, ""SourceUnitOfMeasure"": ""Each"", ""SourceUOMQuantity"": 1, ""ItemDescription"": ""Methotrexate 7.5 mg"", ""PriceStartDate"": ""2021-01-01"", ""PriceEndDate"": ""2021-12-31"" } } ] } "
Example Response Body
The following example includes the contents of the response body in JSON format:
"{ ""parts"": [ { ""id"": ""part0"", ""path"": ""server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739393/child/lines"", ""operation"": ""create"", ""payload"": { ""InterfaceLineId"": 300100556739607, ""InterfaceLineKey"": ""300100556739607"", ""InterfaceHeaderKey"": ""300100556739393"", ""SourceReferenceId"": ""1000000002"", ""LineNumber"": null, ""Action"": ""CREATE"", ""VendorPartNumber"": null, ""VendorItemId"": null, ""ItemNumber"": null, ""InventoryItemId"": null, ""ManufacturerPartNumber"": ""MPN-1004"", ""ManufacturerTradingPartnerItemId"": null, ""Price"": 50, ""AdjustmentPercentage"": 20, ""AdjustedPrice"": 40, ""SourceUnitOfMeasure"": ""Each"", ""SourceUOMQuantity"": 1, ""UnitOfMeasure"": null, ""UnitOfMeasureCode"": null, ""ItemDescription"": ""Diclofenac Injection 25 ml"", ""PurchasingCategoryId"": null, ""PurchasingCategoryCode"": null, ""SourcePurchasingCategory"": null, ""PriceStartDate"": ""2021-01-01"", ""PriceEndDate"": ""2021-12-31"", ""ErrorFlag"": false, ""BatchId"": null, ""LoadRequestId"": null, ""links"": [ { ""rel"": ""self"", ""href"": ""server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739393/child/lines/300100556739607"", ""name"": ""lines"", ""kind"": ""item"", ""properties"": { ""changeIndicator"": ""ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"" } }, { ""rel"": ""canonical"", ""href"": ""server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739393/child/lines/300100556739607"", ""name"": ""lines"", ""kind"": ""item"" }, { ""rel"": ""parent"", ""href"": ""server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739393"", ""name"": ""externalPurchasePricesRequests"", ""kind"": ""item"" } ] } }, { ""id"": ""part1"", ""path"": ""server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739393/child/lines"", ""operation"": ""create"", ""payload"": { ""InterfaceLineId"": 300100556739608, ""InterfaceLineKey"": ""300100556739608"", ""InterfaceHeaderKey"": ""300100556739393"", ""SourceReferenceId"": ""1000000002"", ""LineNumber"": null, ""Action"": ""CREATE"", ""VendorPartNumber"": null, ""VendorItemId"": null, ""ItemNumber"": null, ""InventoryItemId"": null, ""ManufacturerPartNumber"": ""MPN-1005"", ""ManufacturerTradingPartnerItemId"": null, ""Price"": 50, ""AdjustmentPercentage"": 20, ""AdjustedPrice"": 40, ""SourceUnitOfMeasure"": ""Each"", ""SourceUOMQuantity"": 1, ""UnitOfMeasure"": null, ""UnitOfMeasureCode"": null, ""ItemDescription"": ""Methotrexate 7.5 mg"", ""PurchasingCategoryId"": null, ""PurchasingCategoryCode"": null, ""SourcePurchasingCategory"": null, ""PriceStartDate"": ""2021-01-01"", ""PriceEndDate"": ""2021-12-31"", ""ErrorFlag"": false, ""BatchId"": null, ""LoadRequestId"": null, ""links"": [ { ""rel"": ""self"", ""href"": ""server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739393/child/lines/300100556739608"", ""name"": ""lines"", ""kind"": ""item"", ""properties"": { ""changeIndicator"": ""ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"" } }, { ""rel"": ""canonical"", ""href"": ""server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739393/child/lines/300100556739608"", ""name"": ""lines"", ""kind"": ""item"" }, { ""rel"": ""parent"", ""href"": ""server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739393"", ""name"": ""externalPurchasePricesRequests"", ""kind"": ""item"" } ] } } ] } "