Get all pegging relationships
get
/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/peggingRelationships
Request
Path Parameters
-
PlanId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 supply and demand pegging.
Finder Variables- PeggingId; integer; Value that uniquely identifies the supply and demand pegging relationship.
- PlanId; integer; Value that uniquely identifies the production schedule.
- findByGroupCode Finds the pegging records for tasks included in the group by group code.
Finder Variables- GroupCode; string;
- findByGroupId Finds the pegging records for tasks included in the group by primary key.
Finder Variables- GroupId; integer;
- findDownstreamByOnHandInventoryItem Finds downstream demand for on-hand quantity by item number.
Finder Variables- ItemCode; string;
- findDownstreamByOnHandInventoryItemId Finds downstream demand for on-hand quantity by the unique identifier of the item.
Finder Variables- InventoryItemId; integer;
- findDownstreamByOnHoldLot Finds downstream demand by item inventory code and on-hold lot.
Finder Variables- ItemCode; string;
- LotNumber; string;
- findDownstreamByOnHoldLotAndItemId Finds downstream demand by the unique identifier of the item and on-hold lot.
Finder Variables- InventoryItemId; integer;
- LotNumber; string;
- findDownstreamBySupply Finds downstream demand and supply by item supply.
Finder Variables- SupplyLineItemNumber; string;
- SupplyNumber; string;
- findDownstreamBySupplyId Finds downstream demand by the unique identifier of the supply.
Finder Variables- SupplyId; integer;
- findDownstreamByWorkOrder Finds downstream supply by work order number.
Finder Variables- FromWorkOrderNumber; string;
- findDownstreamByWorkOrderId Finds downstream demand by the unique identifier of the work order.
Finder Variables- FromWorkOrderId; integer;
- findDownstreamByWorkOrderOperation Finds downstream demand by operation code.
Finder Variables- FromOperationSequenceNumber; number;
- FromResourceSequenceNumber; integer;
- FromWorkOrderNumber; string;
- findDownstreamByWorkOrderOperationId Finds downstream demand by the unique identifier of the work order operation.
Finder Variables- FromResourceSequenceNumber; integer;
- FromWorkOrderOperationId; integer;
- findUpstreamByDemand Finds upstream supply by demand.
Finder Variables- DemandLineItemNumber; string;
- DemandNumber; string;
- findUpstreamByDemandId Finds upstream supply by the unique identifier of the demand.
Finder Variables- DemandId; integer;
- findUpstreamByWorkOrder Finds upstream supply by work order number.
Finder Variables- ToWorkOrderNumber; string;
- findUpstreamByWorkOrderId Finds upstream supply by the unique identifier of the work order.
Finder Variables- ToWorkOrderId; integer;
- findUpstreamByWorkOrderOperation Finds upstream supply by operation code.
Finder Variables- ToOperationSequenceNumber; number;
- ToResourceSequenceNumber; integer;
- ToWorkOrderNumber; string;
- findUpstreamByWorkOrderOperationId Finds upstream supply by the unique identifier of the work order operation.
Finder Variables- ToResourceSequenceNumber; integer;
- ToWorkOrderOperationId; integer;
- PrimaryKey Finds supply and demand pegging.
-
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:- ConsumeByDurationResourceCode; string; Abbreviation that identifies the principal resource of a work center in an operation that consumes the supply.
- ConsumeByDurationResourceId; number; Value that uniquely identifies the principal resource that consumes the supply.
- ConsumeById; integer; Value that uniquely identifies the demand that consumes the supply.
- ConsumeByOperationCode; string; Abbreviation that identifies the operation that consumes the supply.
- ConsumeByOperationName; string; Name of the operation that consumes the supply.
- ConsumeByOperationSequenceNumber; number; Number of the operation sequence that consumes the supply.
- ConsumeByResourceSequenceNumber; integer; Number of the resource sequence that consumes the supply.
- ConsumeByType; string; The type of demand that consumes the supply.
- ConsumeByWorkCenterCode; string; Abbreviation that identifies the work center that consumes the supply.
- ConsumeByWorkCenterId; integer; Value that uniquely identifies the work center that consumes the supply. It's a primary key of the work center.
- ConsumeByWorkOrderId; integer; Value that uniquely identifies the work order that consumes the supply.
- ConsumeByWorkOrderNumber; string; Number of the work order that consumes the supply.
- ConsumeDate; string; The date when the demand consumes the supply.
- DemandLineItemNumber; string; Number of the demand line item that consumes the supply.
- DemandNumber; string; Number of the demand that consumes the supply.
- InventoryItemId; integer; Value that uniquely identifies the inventory item.
- ItemCode; string; Abbreviation that identifies the item.
- LotNumber; string; Number that identifies the inventory lot.
- PeggingDepth; integer; The depth at which the pegging record falls in the pegging hierarchy.
- PeggingId; integer; Value that uniquely identifies the supply and demand pegging relationship.
- PlanId; integer; Value that uniquely identifies the production schedule.
- Quantity; number; Quantity that's pegged for the supply and demand.
- SupplyByDurationResourceCode; string; Abbreviation that identifies the principal resource in an operation of the supply that??s consumed.
- SupplyByDurationResourceId; number; Value that uniquely identifies the principal resource of the supply that??s consumed.
- SupplyById; integer; Value that uniquely identifies the supply that's consumed.
- SupplyByOperationCode; string; Abbreviation that uniquely identifies the operation code of the supply that's consumed.
- SupplyByOperationName; string; Name of the operation of the supply that's consumed.
- SupplyByOperationSequenceNumber; number; Number of the operation sequence of the supply that's consumed.
- SupplyByResourceSequenceNumber; integer; Number of the resource sequence of the supply that's consumed.
- SupplyByType; string; The type of supply that's consumed.
- SupplyByWorkCenterCode; string; Abbreviation that identifies the work center of the supply that??s consumed.
- SupplyByWorkCenterId; integer; Value that uniquely identifies the work center of the supply that's consumed. It's a primary key of the work center.
- SupplyByWorkOrderId; integer; Value that uniquely identifies the work order that's consumed.
- SupplyByWorkOrderNumber; string; Number of the work order that's consumed.
- SupplyDate; string; The date when the supply is available to the demand.
- SupplyLineItemNumber; string; Number of the supply line item that's consumed.
- SupplyNumber; string; Number of the supply that's consumed.
- UOMCode; string; Abbreviation that identifies the unit of measure.
- UnitOfMeasure; string; Name of the unit of measure.
-
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 : productionSchedulingPlans-peggingRelationships
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 : productionSchedulingPlans-peggingRelationships-item-response
Type:
Show Source
object
-
ConsumeByDurationResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the principal resource of a work center in an operation that consumes the supply. -
ConsumeByDurationResourceId: number
Read Only:
true
Value that uniquely identifies the principal resource that consumes the supply. -
ConsumeById: integer
(int64)
Read Only:
true
Value that uniquely identifies the demand that consumes the supply. -
ConsumeByOperationCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the operation that consumes the supply. -
ConsumeByOperationName: string
Read Only:
true
Maximum Length:120
Name of the operation that consumes the supply. -
ConsumeByOperationSequenceNumber: number
Read Only:
true
Number of the operation sequence that consumes the supply. -
ConsumeByResourceSequenceNumber: integer
Read Only:
true
Number of the resource sequence that consumes the supply. -
ConsumeByType: string
Read Only:
true
Maximum Length:30
The type of demand that consumes the supply. -
ConsumeByWorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center that consumes the supply. -
ConsumeByWorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center that consumes the supply. It's a primary key of the work center. -
ConsumeByWorkOrderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order that consumes the supply. -
ConsumeByWorkOrderNumber: string
Read Only:
true
Maximum Length:300
Number of the work order that consumes the supply. -
ConsumeDate: string
(date-time)
Read Only:
true
The date when the demand consumes the supply. -
DemandLineItemNumber: string
Read Only:
true
Maximum Length:150
Number of the demand line item that consumes the supply. -
DemandNumber: string
Read Only:
true
Maximum Length:240
Number of the demand that consumes the supply. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory item. -
ItemCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Read Only:
true
Maximum Length:80
Number that identifies the inventory lot. -
PeggingDepth: integer
Read Only:
true
The depth at which the pegging record falls in the pegging hierarchy. -
PeggingId: integer
Read Only:
true
Value that uniquely identifies the supply and demand pegging relationship. -
PlanId: integer
(int64)
Read Only:
true
Value that uniquely identifies the production schedule. -
Quantity: number
Read Only:
true
Quantity that's pegged for the supply and demand. -
SupplyByDurationResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the principal resource in an operation of the supply that??s consumed. -
SupplyByDurationResourceId: number
Read Only:
true
Value that uniquely identifies the principal resource of the supply that??s consumed. -
SupplyById: integer
(int64)
Read Only:
true
Value that uniquely identifies the supply that's consumed. -
SupplyByOperationCode: string
Read Only:
true
Maximum Length:300
Abbreviation that uniquely identifies the operation code of the supply that's consumed. -
SupplyByOperationName: string
Read Only:
true
Maximum Length:120
Name of the operation of the supply that's consumed. -
SupplyByOperationSequenceNumber: number
Read Only:
true
Number of the operation sequence of the supply that's consumed. -
SupplyByResourceSequenceNumber: integer
Read Only:
true
Number of the resource sequence of the supply that's consumed. -
SupplyByType: string
Read Only:
true
Maximum Length:30
The type of supply that's consumed. -
SupplyByWorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center of the supply that??s consumed. -
SupplyByWorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center of the supply that's consumed. It's a primary key of the work center. -
SupplyByWorkOrderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order that's consumed. -
SupplyByWorkOrderNumber: string
Read Only:
true
Maximum Length:300
Number of the work order that's consumed. -
SupplyDate: string
(date-time)
Read Only:
true
The date when the supply is available to the demand. -
SupplyLineItemNumber: string
Read Only:
true
Maximum Length:150
Number of the supply line item that's consumed. -
SupplyNumber: string
Read Only:
true
Maximum Length:240
Number of the supply that's consumed. -
UnitOfMeasure: string
Read Only:
true
Maximum Length:25
Name of the unit of measure. -
UOMCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the unit of measure.
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.