Get all orders for a plan, supplier, supplier site, and organization
get
/fscmRestApi/resources/11.13.18.05/buyerPlanningSupplies
To retrieve orders using buyerPlanningSupplies, 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(required): 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(required): 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 -
limit(required): integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework only returns the available resources.
-
links(required): 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(required): 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(required): boolean
The resource item payload is filtered to contain only data (no links section, for example).
-
orderBy(required): 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(required): 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(required): boolean
The resource collection representation includes the "estimated row count" when "?totalResults=true", otherwise the count isn't included. The default value is "false".
Header Parameters
-
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 doesn't specify this header in the request the server picks 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(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 doesn't specify this header in the request the server picks a default version for the API.
Nested Schema : buyerPlanningSupplies-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 : buyerPlanningSupplies-getAll-response
Type:
Show Source
object
-
CarryingCost: integer
(int64)
Percent of the item's cost that represents the inventory carrying cost.
-
ConsolidatedFlag: boolean
Title:
Consolidated Flag
Indicates whether or not the order is consolidated. If the value is true, then the order is consolidated. -
ConsolidationTransactionId: integer
(int64)
Value that uniquely identifies associated consolidated orders.
-
CreatedBy: string
Title:
Created By
User who created the order. -
CreationDate: string
(date)
Title:
Creation Date
Date when the user created the order. -
EmployeeId: integer
(int64)
Value that uniquely identifies the planner associdate to the order as an employee.
-
FirmDate: string
(date)
Title:
Firm Date
Date when supply is due. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm. -
FirmQuantity: integer
(int64)
Title:
Firm Quantity
Fixed quantity of supply. This attribute value can't be changed by planning and is only populated when the firm status is firm. -
FirmStatus: string
Title:
Firm Status
Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS. -
FirmStatusCode: integer
(int64)
Title:
Firm Status Code
Abbreviation for a status that identifies whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS. -
FixedDaysOfSupply: integer
(int64)
Number of days to use to modify the size and timing of each planned order quantity.
-
FixedLotMultiplier: integer
(int64)
Multiplier to use, in units for each day, for each fixed lot quantity or each repetitive rate.
-
FixedOrderQuantity: integer
(int64)
Quantity to use to modify the size of each planned order quantity or each repetitive daily rate.
-
HasPriceBreakFlag: boolean
Title:
Has Price Break Flag
Indicates whether or not the order is associated to a purchase agreement with a price break. If the value is true, then there is an existing price break on the associated purchase agreement. -
ImplementDate: string
(date)
Title:
Implement Date
Date when the order is released. -
ImplementDockDate: string
(date)
Title:
Implement Dock Date
Date when the material should be on the receiving dock when the order is released. -
ImplementFirm: integer
(int64)
Title:
Implement Firm
Value that indicates whether the order is firm or not. Valid values are 1: Firm and 2: Not Firm. A list of accepted values is defined in the lookup type MSC_YES_NO. -
ImplementQuantity: integer
(int64)
Title:
Implement Quantity
Quantity of the order that's released. -
ImplementShipDate: string
(date)
Title:
Implement Ship Date
Date when the order is shipped. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item associated with the supply.
-
Item: string
Title:
Item Name Code
Name of the item associated with the supply. -
ItemDescription: string
Title:
Item Description Code
Description of the item that's associated with the supply. -
ItemPlanner: string
Title:
Item Planner
Abbreviation that identifies the planner responsible for the item. -
LastUpdateDate: string
(date)
Title:
Last Update Date
Date when the order was most recently updated. -
LastUpdatedBy: string
Title:
Last Update dBy
User who most recently updated the supply. -
ListPrice: integer
(int64)
Value that indicates the list price of an item in primary unit of measure.
-
MappedItemId: integer
(int64)
Value that uniquely identifies the mapped fusion item associated with the supply.
-
MappedOrganizationId: integer
(int64)
Value that uniquely identifies the mapped fusion organization associated with the order.
-
MappedSupplierId: string
Title:
Mapped Supplier Id
Value that uniquely identifies the mapped fusion source supplier. -
MarkForReleaseOption: integer
(int64)
Title:
Mark For Release Option
Value that indicates the release status of the order. Valid values are 1: Marked For Release or 2: Not Marked For Release. When marking or not marking orders for release, the request body must include only the MarkForReleaseOption attribute. -
MaximumOrderQuantity: integer
(int64)
Maximum order quantity of the item.
-
MinimumOrderQuantity: integer
(int64)
Minimum order quantity of the item.
-
NewDockDate: string
(date)
Title:
New Dock Date
Date when the order is recommended to arrive at the receiving dock. -
NewOrderQuantity: integer
(int64)
Value that identifies the order quantity in buyer planning in primary unit of measure.
-
NewShipDate: string
(date)
Title:
New Ship Date
Date when the order was originally to arrive at the receiving dock. -
ObjectVersionNumber: string
Title:
Object Version Number
Number of times the supply row was updated. This attribute is used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried. -
OldDockDate: string
(date)
Title:
Old Dock Date
Date when the order is recommended to be shipped. -
OldOrderQuantity: integer
(int64)
Value that identifies the original order quantity in buyer planning in primary unit of measure.
-
OldShipDate: string
(date)
Title:
Old Ship Date
Date when the order was originally to be shipped. -
OrderCost: integer
(int64)
Value that indicates the cost of placing an order.
-
OrderNumber: string
Title:
Order Number
Number that identifies the order associated with the supply. -
OrderType: string
Title:
Order Type Name
Type??of??order??such??as??planned??order,??purchase??order,??or??purchase??requisition.??A??list??of??accepted??values??is??defined??in??the??lookup??type??MSC_ORDER_TYPE. -
OrderTypeCode: integer
(int64)
Title:
Order Type Code
Code that indicates the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE. -
Organization: string
Title:
Organization Name
Name of the organization associated with the order. -
OrganizationCalendarCode: string
Title:
Organization Calendar Code
Abbreviation that indicates the organization's calendar. -
OrganizationCode: string
Title:
Organization Code
Abbreviation that indicates the organization associated with the order. -
OrganizationCurrency: string
Title:
Organization Currency
Value that indicates the organization's default currency. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization associated with the order.
-
PartKey1: string
Value that uniquely identifies the order based on planId, transactionID and a system generated part key.
-
PlanId: integer
(int64)
Value that uniquely identifies the plan.
-
PlanName: string
Title:
Plan Name
Name of the plan. -
PlannerCode: string
Title:
Planner Code
Abbreviation that indicates the planner associdate to the order. -
PlanningTimeFenceDays: integer
(int64)
Time horizon, in number of days, in which supply orders aren't scheduled to be due.
-
PoLineId: string
Title:
Po Line Id
Value that uniquely identifies the purchase order line. -
PoLineLocationId: integer
(int64)
Value that uniquely identifies the purchase order line location.
-
PostProcessingLeadTime: integer
(int64)
Number of days required to make an item available in inventory once the supply is complete.
-
PriceSavings: number
(float)
Value that indicates the amount of savings realized from actions taken against the order in buyer planning.
-
PrimaryUom: string
Title:
Primary Uom
Name of the primary unit of measure associated with the order quantity. -
PrimaryUomCode: string
Title:
Primary Uom Code
Abbreviation that identifies the primary unit of measure associated with the order quantity. -
ProcessingLeadTime: integer
(int64)
Number of days required to procure or manufacture an item.
-
RangeFilterDate: string
(date)
Title:
Range Filter Date
Date range used to filter orders. -
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. -
ReleaseStatus: string
Title:
Release Status
Value that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS. -
ReleaseStatusCode: string
Title:
Release Status Code
Release status of the order such as ready for release, marked for release or released. A list of accepted values is defined in the lookup type ORA_MSC_BP_RELEASE_STATUS. -
SegmentId: integer
(int64)
Value that uniquely identifies the segment.
-
SegmentName: string
Title:
Segment Name
Name of the segment used for a set of items. -
SourceUom: string
Title:
Source Uom
Unit of measure for items sourced from planning. -
SourceUomCode: string
Title:
Source Uom Code
Abbreviation that identifies the unit of measure for items sourced from planning. -
SrInstanceId: integer
(int64)
Value that uniquely identifies the source system of the order.
-
StandardCost: integer
(int64)
Value that indicates the standard cost of an item in primary unit of measure.
-
SubinventoryCode: string
Title:
Subinventory Code
Subinventory code associated with the supply. -
Supplier: string
Title:
Supplier Name
Name of the source supplier. -
SupplierId: integer
(int64)
Value that uniquely identifies the source supplier.
-
SupplierSite: string
Title:
Supplier Site Code
Abbreviation that indicates the specific supplier site from where the item is being sourced. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the specific supplier site from where the item is being sourced.
-
TransactionId: integer
(int64)
Value that uniquely identifies the supply transaction. This value is internally generated by the application.
-
UnitVolume: integer
(int64)
Volume of one item.
-
UnitWeight: integer
(int64)
Weight of one item.
-
VolumeUom: string
Title:
Volume Uom
Unit of measure to use for the item volume. -
VolumeUomCode: string
Title:
Volume Uom Code
Code that indicates the unit of measure to use for the item volume. -
WeightUom: string
Title:
Weight Uom
Unit of measure to use for the item weight. -
WeightUomCode: string
Title:
Weight Uom Code
Abbreviation that identifies the unit of measure to use for the item weight.
Nested Schema : ItemProperties
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : buyerPlanningSupplies-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