Get all associated segment price lists
get
/fscmRestApi/resources/11.13.18.05/pricingStrategies/{PricingStrategyId}/child/associatedSegmentPriceLists
Request
Path Parameters
-
PricingStrategyId(required): integer(int64)
Value that uniquely identifies the pricing strategy.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 associated segment price lists according to the primary key.
Finder Variables:- PricingStrategyDetailId; integer; Value that uniquely identifies the associated segment price lists.
- findByPriceListAndAssociationDates: Finds associated segment price lists according to the price list name and association dates.
Finder Variables:- AssociationEndDate; string; Date when the price list association becomes inactive.
- AssociationPrecedence; integer; Value that indicates the association precedence.
- AssociationStartDate; string; Date when the price list association becomes active.
- PriceListName; string; Name of the price list.
- PrimaryKey: Finds associated segment price lists 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
You can use these queryable attributes to filter this collection resource using the q query parameter:- AssociationEndDate; string; Date when the association of the price list to the pricing strategy becomes inactive.
- AssociationPrecedence; integer; Precedence of the association of the price list to the pricing strategy.
- AssociationStartDate; string; Date when the association of the price list to the pricing strategy becomes active.
- BusinessUnit; string; Name of the business unit.
- BusinessUnitId; integer; Value that uniquely identifies the business unit.
- CreatedBy; string; User who created the record.
- CreationDate; string; Date and time when the user created the record.
- Currency; string; Currency that the price list uses.
- CurrencyCode; string; Abbreviation that identifies the currency of the price list.
- Description; string; Description of the price list.
- EndDate; string; Date when the price list becomes inactive.
- LastUpdateDate; string; Date and time when the user most recently updated the record.
- LastUpdatedBy; string; User who most recently updated the record.
- PriceListId; integer; Value that uniquely identifies the price list.
- PriceListName; string; Name of the price list.
- PricingStrategyDetailId; integer; Value that uniquely identifies the pricing strategy detail.
- PricingStrategyId; integer; Value that uniquely identifies the pricing strategy.
- StartDate; string; Date when the price list becomes active.
- Status; string; Status that indicates whether this price list is approved.
- StatusCode; string; Abbreviation that identifies the approval status of the price list.
-
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
-
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:
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 : pricingStrategies-associatedSegmentPriceLists
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 : pricingStrategies-associatedSegmentPriceLists-item-response
Type:
Show Source
object
-
AssociationEndDate: string
(date-time)
Title:
End Date
Date when the association of the price list to the pricing strategy becomes inactive. -
AssociationPrecedence: integer
Precedence of the association of the price list to the pricing strategy.
-
AssociationStartDate: string
(date-time)
Title:
Start Date
Date when the association of the price list to the pricing strategy becomes active. -
BusinessUnit: string
Read Only:
true
Name of the business unit. -
BusinessUnitId: integer
(int64)
Read Only:
true
Value that uniquely identifies the business unit. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
Currency: string
Read Only:
true
Currency that the price list uses. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the currency of the price list. -
Description: string
Read Only:
true
Maximum Length:1000
Description of the price list. -
DFF: array
Flexfields for Associated Segment Price Lists
Title:
Flexfields for Associated Segment Price Lists
The Flexfields for Associated Segment Price Lists resource associates descriptive flexfield segments and their values with a pricing strategy detail. -
EndDate: string
(date-time)
Title:
End Date
Read Only:true
Date when the price list becomes inactive. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PriceListId: integer
(int64)
Value that uniquely identifies the price list.
-
PriceListName: string
Name of the price list.
-
priceLists: array
Price Lists
Title:
Price Lists
The Price Lists resource manages price lists of products and services. -
PricingStrategyDetailId: integer
(int64)
Value that uniquely identifies the pricing strategy detail.
-
PricingStrategyId: integer
(int64)
Read Only:
true
Value that uniquely identifies the pricing strategy. -
StartDate: string
(date-time)
Title:
Start Date
Read Only:true
Date when the price list becomes active. -
Status: string
Read Only:
true
Status that indicates whether this price list is approved. -
StatusCode: string
Title:
Status
Read Only:true
Maximum Length:30
Abbreviation that identifies the approval status of the price list.
Nested Schema : Flexfields for Associated Segment Price Lists
Type:
array
Title:
Flexfields for Associated Segment Price Lists
The Flexfields for Associated Segment Price Lists resource associates descriptive flexfield segments and their values with a pricing strategy detail.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Price Lists
Type:
array
Title:
Price Lists
The Price Lists resource manages price lists of products and services.
Show Source
Nested Schema : pricingStrategies-associatedSegmentPriceLists-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
Descriptive flexfield context name for the pricing strategy header. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PricingStrategyDetailId: integer
(int64)
Value that uniquely identifies the pricing strategy detail to which the descriptive flexfields belong.
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.
Nested Schema : pricingStrategies-associatedSegmentPriceLists-priceLists-item-response
Type:
Show Source
object
-
EndDate: string
(date-time)
Title:
End Date
Date when the price list becomes inactive. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PriceListId: integer
(int64)
Value that uniquely identifies the price list.
-
PriceListName: string
Title:
Name
Maximum Length:80
Name of the price list. -
StartDate: string
(date-time)
Title:
Start Date
Date when the price list becomes active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all associated segment price lists.
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/pricingStrategies/PricingStrategyId/child/associatedSegmentPriceLists"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "PricingStrategyDetailId": 300100195449163, "PricingStrategyId": 300100195448908, "PriceListName": "Corporate Segment Price List", "PriceListId": 300100071623855, "Description": "Segment price list with all the charges", "BusinessUnit": "Vision Operations", "BusinessUnitId": 204, "Currency": "US Dollar", "CurrencyCode": "USD", "Status": "Approved", "StatusCode": "APPROVED", "StartDate": "2009-01-01T09:00:00+00:00", "EndDate": null, "AssociationStartDate": "2015-12-03T02:56:00+00:00", "AssociationEndDate": null, "AssociationPrecedence": 1, "CreationDate": "2020-02-18T08:43:42+00:00", "CreatedBy": "PRICING_MGR_OPERATIONS", "LastUpdateDate": "2020-02-18T08:43:43.031+00:00", "LastUpdatedBy": "PRICING_MGR_OPERATIONS" }, { ... } ] }