Create lines
/fscmRestApi/resources/11.13.18.05/publicShoppingListLines
Request
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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.
- application/json
object
-
Agreement: string
Title:
Agreement
Number that identifies the source agreement referenced by the public shopping list line. -
AgreementLine: number
Title:
Agreement Line
Number that identifies the line of the source agreement referenced by the public shopping list line. -
AgreementLineId: integer
(int64)
Title:
Agreement Line ID
Value that uniquely identifies the line of the source agreement referenced by the public shopping list line. -
Item: string
Name of the item of the public shopping list line.
-
ItemId: integer
(int64)
Value that uniquely identifies the item.
-
ProcurementBU: string
Title:
Procurement BU
Name of the procurement business unit in which the public shopping list is created. -
ProcurementBUId: integer
Value that uniquely identifies the procurement business unit in which the public shopping list is created.
-
PublicShoppingList: string
Name of the public shopping list.
-
PublicShoppingListHeaderId: integer
(int64)
Value that uniquely identifies the public shopping list.
-
Sequence: number
Order in which the items are displayed to the preparer or requester.
-
SuggestedQuantity: number
Quantity suggested by the catalog administrator to the preparer or requester.
Response
- application/json
Default Response
-
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.
object
-
Agreement: string
Title:
Agreement
Number that identifies the source agreement referenced by the public shopping list line. -
AgreementLine: number
Title:
Agreement Line
Number that identifies the line of the source agreement referenced by the public shopping list line. -
AgreementLineId: integer
(int64)
Title:
Agreement Line ID
Value that uniquely identifies the line of the source agreement referenced by the public shopping list line. -
Amount: number
Read Only:
true
Total amount of the shopping list line. -
Buyer: string
Title:
Buyer
Read Only:true
Maximum Length:240
Name of the buyer in the referencing agreement. -
CategoryId: string
Read Only:
true
Maximum Length:255
Value that uniquely identifies the purchasing category. -
CategoryName: string
Title:
Category Name
Read Only:true
Maximum Length:255
Name of the purchasing category that is used to classify the purchase being made. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the public shopping list lines. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the public shopping list lines. -
CurrencyCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the shopping list line currency. -
IndexSyncPendingFlag: boolean
Title:
Synchronization Pending
Read Only:true
Contains one of the following values: Y or N. If Y then updates are available for publishing for shopping. If N, then updates are not available for publishing for shopping. The default value is N. -
InventoryOrganization: string
Read Only:
true
Maximum Length:255
Name of the organization in which the item is defined. -
InventoryOrganizationId: integer
Read Only:
true
Value that uniquely identifies the organization in which the item is defined. -
Item: string
Name of the item of the public shopping list line.
-
ItemDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the Item. -
ItemId: integer
(int64)
Value that uniquely identifies the item.
-
ItemRevision: string
Title:
Revision
Read Only:true
Maximum Length:18
Revision of the Item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the public shopping list lines. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the public shopping list lines. -
LineType: string
Title:
Line Type
Read Only:true
Maximum Length:30
Value that indicates if the line is of goods or services. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NegotiatedFlag: boolean
Title:
Negotiated
Read Only:true
Maximum Length:1
Contains one of the following values: Y or N. If Y, then the price on the public shopping line is agreed on in advance between the buying company and the supplier. If N, then the price is not agreed on in advance. This attribute does not have a default value. -
NegotiationRequiredFlag: boolean
Title:
Negotiation Required
Read Only:true
Maximum Length:1
Contains one of the following values: Y or N. If Y, then a sourcing negotiation is required. If N, then sourcing negotiation is not required. This attribute does not have a default value. -
Price: number
Read Only:
true
Price of the Item. -
ProcurementBU: string
Title:
Procurement BU
Name of the procurement business unit in which the public shopping list is created. -
ProcurementBUId: integer
Value that uniquely identifies the procurement business unit in which the public shopping list is created.
-
PublicShoppingList: string
Name of the public shopping list.
-
PublicShoppingListDescription: string
Read Only:
true
Maximum Length:250
Description of the public shopping list. -
PublicShoppingListEndDate: string
(date)
Read Only:
true
Date and time when the public shopping list is inactivated. -
PublicShoppingListHeaderId: integer
(int64)
Value that uniquely identifies the public shopping list.
-
PublicShoppingListLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the public shopping list line. -
PublicShoppingListStartDate: string
(date)
Read Only:
true
Date and time when the public shopping list is activated. -
Sequence: number
Order in which the items are displayed to the preparer or requester.
-
SuggestedQuantity: number
Quantity suggested by the catalog administrator to the preparer or requester.
-
Supplier: string
Title:
Supplier
Read Only:true
Maximum Length:360
Name of the supplier in the referencing agreement. -
SupplierItem: string
Title:
Supplier Item
Read Only:true
Maximum Length:300
Value that identifies the supplier or code for the goods or services added from agreement. -
UOM: string
Read Only:
true
Maximum Length:255
Unit of measure of the item quantity.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to create lines.
Example 1 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/publicShoppingListLines"
Example 1 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.
{ "ProcurementBU": "Vision Operations", "PublicShoppingList": "MP_PSL02", "Item": "RCV-100", "SuggestedQuantity": 9 }
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "PublicShoppingListHeaderId": 300100187519046, "PublicShoppingList": "MP_PSL02", "PublicShoppingListDescription": "MP_PSL02 VO Desc", "PublicShoppingListEndDate": null, "PublicShoppingListStartDate": "2020-07-24", "PublicShoppingListLineId": 300100197614441, "Sequence": null, "LineType": null, "ItemId": 663907, "Item": "RCV-100", "ItemRevision": null, "ItemDescription": "Plain Item", "CategoryName": null, "CategoryId": null, "SuggestedQuantity": 9, "UOM": null, "Price": null, "CurrencyCode": null, "Amount": null, "Supplier": null, "SupplierItem": null, "AgreementLineId": -2, "Agreement": null, "AgreementLine": null, "Buyer": null, "NegotiatedFlag": null, "NegotiationRequiredFlag": null, "CreatedBy": "CVRQST01", "CreationDate": "2020-08-20T03:24:17+00:00", "LastUpdateDate": "2020-08-20T03:24:17.251+00:00", "LastUpdatedBy": "CVRQST01", "InventoryOrganizationId": null, "InventoryOrganization": null, "IndexSyncPendingFlag": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614441", "name": "publicShoppingListLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614441", "name": "publicShoppingListLines", "kind": "item" } ] }
Example 2 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.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version"
Example 2 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.
{ "parts": [ { "id": "part0", "path": "/publicShoppingListLines", "operation": "create", "payload": { "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "PublicShoppingList": "POR_PSL01", "Sequence": null, "Item": "CoolingPad 9", "SuggestedQuantity": 1, "Agreement": "1002641", "AgreementLine": 5 } }, { "id": "part1", "path": "/publicShoppingListLines", "operation": "create", "payload": { "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "PublicShoppingList": "POR_PSL01", "Sequence": 1, "ItemId": 100100106982337, "SuggestedQuantity": 4 } }, { "id": "part2", "path": "/publicShoppingListLines", "operation": "create", "payload": { "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "PublicShoppingList": "POR_PSL01", "Agreement": "1002258", "AgreementLine": 2 } }, { "id": "part3", "path": "/publicShoppingListLines", "operation": "create", "payload": { "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "PublicShoppingList": "POR_PSL01", "Sequence": 4, "AgreementLineId": 100000020118480, "Agreement": "1000529", "AgreementLine": 2 } } ] }
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{ "parts": [ { "id": "part0", "path": "https://servername/fscmRestApi/resources/version/publicShoppingListLines", "operation": "create", "payload": { "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "PublicShoppingListHeaderId": 300100188021751, "PublicShoppingList": "POR_PSL01", "PublicShoppingListDescription": "Test PSL", "PublicShoppingListEndDate": null, "PublicShoppingListStartDate": "2020-08-11", "PublicShoppingListLineId": 300100197614437, "Sequence": null, "LineType": "Goods", "ItemId": 100100106982346, "Item": "CoolingPad 9", "ItemRevision": null, "ItemDescription": "PORSHO Agreement Item 19", "CategoryName": "Miscellaneous_1", "CategoryId": "1", "SuggestedQuantity": 1, "UOM": "Each", "Price": 5119, "CurrencyCode": "USD", "Amount": 5119, "Supplier": "CV_SuppA01", "SupplierItem": "SItem2", "AgreementLineId": 519018, "Agreement": "1002641", "AgreementLine": 5120, "Buyer": "PON00020, PRC", "NegotiatedFlag": true, "NegotiationRequiredFlag": null, "CreatedBy": "CVRQST01", "CreationDate": "2020-08-20T03:22:56+00:00", "LastUpdateDate": "2020-08-20T03:22:57.161+00:00", "LastUpdatedBy": "CVRQST01", "InventoryOrganizationId": 204, "InventoryOrganization": "Vision Operations", "IndexSyncPendingFlag": true, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614437", "name": "publicShoppingListLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614437", "name": "publicShoppingListLines", "kind": "item" } ] } }, { "id": "part1", "path": "https://servername/fscmRestApi/resources/version/publicShoppingListLines", "operation": "create", "payload": { "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "PublicShoppingListHeaderId": 300100188021751, "PublicShoppingList": "POR_PSL01", "PublicShoppingListDescription": "Test PSL", "PublicShoppingListEndDate": null, "PublicShoppingListStartDate": "2020-08-11", "PublicShoppingListLineId": 300100197614438, "Sequence": 1, "LineType": null, "ItemId": 100100106982337, "Item": "CoolingPad 19", "ItemRevision": null, "ItemDescription": "PORSHO MasterItem 19", "CategoryName": "Miscellaneous_1", "CategoryId": "1", "SuggestedQuantity": 4, "UOM": "Each", "Price": 5018, "CurrencyCode": "USD", "Amount": 20072, "Supplier": null, "SupplierItem": null, "AgreementLineId": -2, "Agreement": null, "AgreementLine": null, "Buyer": null, "NegotiatedFlag": null, "NegotiationRequiredFlag": null, "CreatedBy": "CVRQST01", "CreationDate": "2020-08-20T03:22:56.253+00:00", "LastUpdateDate": "2020-08-20T03:22:57.178+00:00", "LastUpdatedBy": "CVRQST01", "InventoryOrganizationId": 204, "InventoryOrganization": "Vision Operations", "IndexSyncPendingFlag": true, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614438", "name": "publicShoppingListLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614438", "name": "publicShoppingListLines", "kind": "item" } ] } }, { "id": "part2", "path": "https://servername/fscmRestApi/resources/version/publicShoppingListLines", "operation": "create", "payload": { "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "PublicShoppingListHeaderId": 300100188021751, "PublicShoppingList": "POR_PSL01", "PublicShoppingListDescription": "Test PSL", "PublicShoppingListEndDate": null, "PublicShoppingListStartDate": "2020-08-11", "PublicShoppingListLineId": 300100197614439, "Sequence": null, "LineType": "Goods", "ItemId": 663908, "Item": "RCV-101", "ItemRevision": null, "ItemDescription": "Lot Item", "CategoryName": "Miscellaneous_1", "CategoryId": "1", "SuggestedQuantity": 1, "UOM": "Each", "Price": 10, "CurrencyCode": "USD", "Amount": 10, "Supplier": "CV_SuppA01", "SupplierItem": null, "AgreementLineId": 385370, "Agreement": "1002258", "AgreementLine": 2, "Buyer": "Furey,Clare", "NegotiatedFlag": true, "NegotiationRequiredFlag": null, "CreatedBy": "CVRQST01", "CreationDate": "2020-08-20T03:22:56.772+00:00", "LastUpdateDate": "2020-08-20T03:22:57.179+00:00", "LastUpdatedBy": "CVRQST01", "InventoryOrganizationId": 204, "InventoryOrganization": "Vision Operations", "IndexSyncPendingFlag": true, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614439", "name": "publicShoppingListLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614439", "name": "publicShoppingListLines", "kind": "item" } ] } }, { "id": "part3", "path": "https://servername/fscmRestApi/resources/version/publicShoppingListLines", "operation": "create", "payload": { "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "PublicShoppingListHeaderId": 300100188021751, "PublicShoppingList": "POR_PSL01", "PublicShoppingListDescription": "Test PSL", "PublicShoppingListEndDate": null, "PublicShoppingListStartDate": "2020-08-11", "PublicShoppingListLineId": 300100197614440, "Sequence": 4, "LineType": "Fixed Price Services", "ItemId": -2, "Item": null, "ItemRevision": null, "ItemDescription": "Item 02", "CategoryName": "Miscellaneous_1", "CategoryId": "1", "SuggestedQuantity": null, "UOM": null, "Price": null, "CurrencyCode": "USD", "Amount": 100, "Supplier": "General Electric", "SupplierItem": null, "AgreementLineId": 100000020118480, "Agreement": "1000529", "AgreementLine": 2, "Buyer": "Furey,Clare", "NegotiatedFlag": true, "NegotiationRequiredFlag": null, "CreatedBy": "CVRQST01", "CreationDate": "2020-08-20T03:22:56.972+00:00", "LastUpdateDate": "2020-08-20T03:22:57.182+00:00", "LastUpdatedBy": "CVRQST01", "InventoryOrganizationId": 204, "InventoryOrganization": "Vision Operations", "IndexSyncPendingFlag": true, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614440", "name": "publicShoppingListLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614440", "name": "publicShoppingListLines", "kind": "item" } ] } } ] }