Get all lines
get
/fscmRestApi/resources/11.13.18.05/publicShoppingListLines
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds public shopping list lines according to the primary key.
Finder Variables:- PublicShoppingListLineId; integer; Value that uniquely identifies the public shopping list line.
- findByAgreement: Finds public shopping list lines according to the agreement.
Finder Variables:- Agreement; string; Number that identifies the source agreement referenced by the public shopping list line.
- AgreementLine; integer; Number that identifies the line of the source agreement referenced by the public shopping list line.
- findByItem: Finds public shopping list lines according to the item.
Finder Variables:- InventoryOrganization; string; Name of the inventory organization.
- Item; string; Name of the item.
- findByPublicShoppingList: Finds public shopping list lines according to the public shopping list.
Finder Variables:- ProcurementBU; string; Name of the procurement business unit in which the public shopping list is created.
- PublicShoppingList; string; Name of the public shopping list.
- PrimaryKey: Finds public shopping list lines according to the primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2 -
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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 : publicShoppingListLines
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicShoppingListLines-item-response
Type:
Show Source
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.
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 get all lines.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/publicShoppingListLines"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/publicShoppingListLines?finder=findByAgreement;Agreement='1000537'"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "PublicShoppingListHeaderId": 300100003481973, "PublicShoppingList": "PORFUS_PuL1", "PublicShoppingListDescription": "PORFUS_PuL1", "PublicShoppingListEndDate": null, "PublicShoppingListStartDate": "2011-12-01", "PublicShoppingListLineId": 300100003481988, "Sequence": null, "LineType": "Goods", "ItemId": 100000013574113, "Item": "zPOR-SCH005_Dell_Inspiron_1525", "ItemRevision": null, "ItemDescription": "PORSCH00501 BPA2 Inspiron 1525 Laptop", "CategoryName": "Electrical Equipment_32", "CategoryId": "32", "SuggestedQuantity": 1, "UOM": "Each", "Price": 1000, "CurrencyCode": "USD", "Amount": 1000, "Supplier": "CV_SuppA00", "SupplierItem": "PORSCH00501 BPA2 SI", "AgreementLineId": 300100003264772, "Agreement": "1000537", "AgreementLine": 1, "Buyer": "Mancia,Mathew", "NegotiatedFlag": true, "NegotiationRequiredFlag": null, "CreatedBy": "CVRQST05", "CreationDate": "2011-12-01T18:15:47.251+00:00", "LastUpdateDate": "2011-12-01T18:17:41.882+00:00", "LastUpdatedBy": "CVRQST05", "InventoryOrganizationId": 204, "InventoryOrganization": "Vision Operations", "IndexSyncPendingFlag": false, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100003481988", "name": "publicShoppingListLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100003481988", "name": "publicShoppingListLines", "kind": "item" } ] }, { "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "PublicShoppingListHeaderId": 300100003481973, "PublicShoppingList": "PORFUS_PuL1", "PublicShoppingListDescription": "PORFUS_PuL1", "PublicShoppingListEndDate": null, "PublicShoppingListStartDate": "2011-12-01", "PublicShoppingListLineId": 300100003481987, "Sequence": null, "LineType": "Goods", "ItemId": -2, "Item": null, "ItemRevision": null, "ItemDescription": "PORSCH00501 BPA2 USB Drive One Time Item", "CategoryName": "Electrical Equipment_32", "CategoryId": "32", "SuggestedQuantity": 2, "UOM": "Each", "Price": 25, "CurrencyCode": "USD", "Amount": 50, "Supplier": "CV_SuppA00", "SupplierItem": "PORSCH005 BPA2 Item #3 SP", "AgreementLineId": 300100003264897, "Agreement": "1000537", "AgreementLine": 3, "Buyer": "Mancia,Mathew", "NegotiatedFlag": true, "NegotiationRequiredFlag": null, "CreatedBy": "CVRQST05", "CreationDate": "2011-12-01T18:15:47+00:00", "LastUpdateDate": "2011-12-01T18:17:41.872+00:00", "LastUpdatedBy": "CVRQST05", "InventoryOrganizationId": 204, "InventoryOrganization": "Vision Operations", "IndexSyncPendingFlag": false, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100003481987", "name": "publicShoppingListLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100003481987", "name": "publicShoppingListLines", "kind": "item" } ] } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines", "name": "publicShoppingListLines", "kind": "collection" } ] }