Create headers
post
/fscmRestApi/resources/11.13.18.05/publicShoppingLists
Request
Header Parameters
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ImageURL: string
Maximum Length:
1000
URL that locates the image representing the public shopping list. -
ProcurementBU: string
Title:
Procurement BU
Name of the procurement business unit in which the public shopping list is created. -
ProcurementBUId: integer
(int64)
Value that uniquely identifies the procurement business unit in which the public shopping list is created.
-
PublicShoppingList: string
Maximum Length:
100
Name of the public shopping list. -
PublicShoppingListDescription: string
Maximum Length:
250
Description of the public shopping list. -
PublicShoppingListEndDate: string
(date)
Date and time when the public shopping list is inactivated.
-
PublicShoppingListStartDate: string
(date)
Date and time when the public shopping list is activated.
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 : publicShoppingLists-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the public shopping list. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the public shopping list. -
ImageURL: string
Maximum Length:
1000
URL that locates the image representing the public shopping list. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the public shopping list. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the public shopping list. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProcurementBU: string
Title:
Procurement BU
Name of the procurement business unit in which the public shopping list is created. -
ProcurementBUId: integer
(int64)
Value that uniquely identifies the procurement business unit in which the public shopping list is created.
-
PublicShoppingList: string
Maximum Length:
100
Name of the public shopping list. -
PublicShoppingListDescription: string
Maximum Length:
250
Description of the public shopping list. -
PublicShoppingListEndDate: string
(date)
Date and time when the public shopping list is inactivated.
-
PublicShoppingListHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the public shopping list. -
PublicShoppingListStartDate: string
(date)
Date and time when the public shopping list is activated.
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 headers.
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/publicShoppingLists"
Example Request Body
The following example includes the contents of the request body in JSON format:
{ "ProcurementBU": "Vision Operations", "PublicShoppingList": "Office Supplies", "PublicShoppingListDescription": "General office supplies.", "PublicShoppingListEndDate": null, "PublicShoppingListStartDate": "2022-08-01" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "PublicShoppingListHeaderId": 300100559283171, "PublicShoppingList": "Office Supplies", "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "PublicShoppingListDescription": "General office supplies.", "PublicShoppingListEndDate": null, "PublicShoppingListStartDate": "2022-08-01", "CreatedBy": "CVRQST17", "CreationDate": "2022-07-21T00:27:34+00:00", "LastUpdateDate": "2022-07-21T00:27:34.020+00:00", "LastUpdatedBy": "CVRQST17", "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/publicShoppingLists/300100559283171", "name": "publicShoppingLists", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://server/fscmRestApi/resources/version/publicShoppingLists/300100559283171", "name": "publicShoppingLists", "kind": "item" } ] }