Get all group totals for a plan, supplier, supplier site, and organization
get
fscmRestApi/resources/11.13.18.05/buyerPlanningTotals/buyerPlanningGroupTotals
In order to retrieve group totals, the q parameter with specified PlanId, SupplierId, SupplierSiteId and OrganizationId is required. For example, /fscmRestApi/scp/buyerPlanningSupplies?q=PlanId= and SupplierId= and SupplierSiteId= and OrganizationId=.
Request
Query Parameters
-
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 are 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 are 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 are considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
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 -
onlyData: boolean
The resource item payload is 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 is 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 isn't 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 doesn't 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
- application/vnd.oracle.adf.resourcecollection+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 doesn't specify this header in the request the server will pick a default version for the API.
Nested Schema : buyerPlanningGroupTotals-getAll-allOf[0]
Type:
Show Source
object
-
items: array
Items
Title:
Items
The items in the collection.
Nested Schema : CollectionProperties
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.
-
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 : buyerPlanningGroupTotals-getAll-response
Type:
Show Source
object
-
CurrencyCode: string
Title:
Currency Code
Abbreviation??that??identifies??the currency for the release group. -
NumberOfOrders: integer
(int64)
Title:
Number of orders
Number of orders for the release group. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization associated with the order.
-
PlanId: integer
(int64)
Value that uniquely identifies the plan.
-
ReleaseGroupCode: string
Title:
Release Group Code
Abbreviation that??identifies??a??custom??grouping??created??in??buyer??planning??used??by??procurement??in??the??purchase??order??creation??process. -
SupplierId: integer
(int64)
Value that uniquely identifies the source supplier.
-
SupplierSiteId: integer
(int64)
Value that uniquely identifies the specific supplier site from where the item is being sourced.
-
TotalSavings: number
(double)
Title:
Total Savings
Sum of all price savings for the release group. -
TotalVolume: number
(double)
Title:
Total Volume
Sum of the volumes for all items in a release group. -
TotalVolumeUOM: string
Title:
Total volume UOM
Unit of measure to use for the release group's total volume. -
TotalVolumeUOMCode: string
Title:
Total volume UOM code
Unit of measure code to use for the release group's total volume. -
TotalWeight: number
(double)
Title:
Total Weight
Sum of the weights for all items in a release group. -
TotalWeightUOM: string
Title:
Total Weight UOM
Unit of measure to use for the release group's total weight. -
TotalWeightUOMCode: string
Title:
Total Weight UOM code
Unit of measure code to use for the release group's total weight.
Nested Schema : ItemProperties
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : buyerPlanningGroupTotals-getAll-item-response-allOf[2]
Type:
object
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all group totals for a plan, supplier, supplier site, and organization.
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/buyerPlanningGroupTotals"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/buyerPlanningGroupTotals?q=PlanId =PlanId AND SupplierId=SupplierId AND SupplierSiteId={SupplierSiteId} AND OrganizationId=OrganizationId"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "items": [ { "ReleaseGroupCode": "BP_TESTCODE1", "NumberOfOrders": 3, "TotalSavings": 0, "CurrencyCode": "USD", "TotalWeight": -99999999999999, "TotalWeightUOM": null, "TotalWeightUOMCode": "-1", "TotalVolume": -99999999999999, "TotalVolumeUOM": null, "TotalVolumeUOMCode": "-1", "PlanId": "300100573650296", "SupplierId": "2736183", "SupplierSiteId": "7463786", "OrganizationId": "147201", "RangeFilterDate": null }, { "ReleaseGroupCode": "ORA_UNGROUPED_ORDERS", "NumberOfOrders": 5, "TotalSavings": 0, "CurrencyCode": "USD", "TotalWeight": 0, "TotalWeightUOM": null, "TotalWeightUOMCode": "-1", "TotalVolume": 0, "TotalVolumeUOM": null, "TotalVolumeUOMCode": "-1", "PlanId": "300100573650296", "SupplierId": "2736183", "SupplierSiteId": "7463786", "OrganizationId": "147201", "RangeFilterDate": null }, { "ReleaseGroupCode": "ORA_ALL_ORDERS", "NumberOfOrders": 8, "TotalSavings": 0, "CurrencyCode": "USD", "TotalWeight": -99999999999999, "TotalWeightUOM": null, "TotalWeightUOMCode": "-1", "TotalVolume": -99999999999999, "TotalVolumeUOM": null, "TotalVolumeUOMCode": "-1", "PlanId": "300100573650296", "SupplierId": "2736183", "SupplierSiteId": "7463786", "OrganizationId": "147201", "RangeFilterDate": null } ], "count": 3, "hasMore": false }