Get all demands
get
/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/demandEvents
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 Find demand events according to the primary key.
Finder Variables- DemandId; integer; Value the uniquely identifies the demand.
- PlanId; integer; Value that uniquely identifies the production schedule.
- PrimaryKey Find demand events 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:- AvailableDate; string; Date when the demand line-item engine is scheduled.
- CustomerName; string; Name of the customer with the demand.
- CustomerNumber; string; Number of the customer with the demand.
- DemandHeaderId; integer; Value that uniquely identifies the demand header.
- DemandId; integer; Value the uniquely identifies the demand.
- DemandLineItemNumber; string; Number that identifies the line of the demand.
- DemandNumber; string; Number that identifies the demand.
- DemandPriority; number; Priority of the demand.
- DemandStatus; string; User defined status of the line-item. Valid values include Approved or OnHold.
- DemandType; string; Type of demand order. Valid values include Order, Forecast, and Safety.
- EarliestDate; string; Date when the user created the earliest demand.
- FolderPath; string; Path where the demand is located.
- InventoryItemId; integer; Value that uniquely identifies the inventory item.
- ItemCode; string; Abbreviation that identifies the item.
- ItemDescription; string; Description of the item of the demand.
- LatestDate; string; Date when the user created the most recent demand.
- OrderClass; string; Order class of the demand. Valid values include HotOrder, Committed, and Uncommitted.
- PlanId; integer; Value that uniquely identifies the production schedule.
- Precision; integer; Display precision of the demand line item.
- Quantity; number; Quantity for the demand line-item.
- RequestDate; string; Date when the demand is requested.
- ReservationsFlag; boolean; Contains one of the following values: Y or N. If Y, then the demand order has reservations for this line-item. If N, then the demand order doesn't have reservations for this line-item. This attribute doesn't have a default value.
- SatisfactionDate; string; Date when the demand line-item is satisfied.
- ShipCompleteFlag; boolean; Contains one of the following values: Y or N. If Y, then shipping is complete on the demand order. If N, then shipping isn't complete on the demand order. This attribute doesn't have a default value.
- ShipToAddress; string; Address to ship to of the demand order which can contain multiple lines.
- TargetCompletionDate; string; Date when the demand line-item completion is targeted.
- TransferOrderHeaderId; integer; Value that uniquely identifies the transfer order.
- 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(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 : productionSchedulingPlans-demandEvents
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-demandEvents-item-response
Type:
Show Source
object
-
AvailableDate: string
(date-time)
Date when the demand line-item engine is scheduled.
-
CustomerName: string
Maximum Length:
300
Name of the customer with the demand. -
CustomerNumber: string
Maximum Length:
240
Number of the customer with the demand. -
DemandHeaderId: integer
(int64)
Value that uniquely identifies the demand header.
-
DemandId: integer
(int64)
Value the uniquely identifies the demand.
-
DemandLineItemNumber: string
Maximum Length:
150
Number that identifies the line of the demand. -
DemandNumber: string
Maximum Length:
240
Number that identifies the demand. -
DemandPriority: number
Priority of the demand.
-
DemandStatus: string
Maximum Length:
30
User defined status of the line-item. Valid values include Approved or OnHold. -
DemandType: string
Maximum Length:
30
Type of demand order. Valid values include Order, Forecast, and Safety. -
EarliestDate: string
(date-time)
Date when the user created the earliest demand.
-
FolderPath: string
Maximum Length:
300
Path where the demand is located. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the item. -
ItemDescription: string
Read Only:
true
Maximum Length:500
Description of the item of the demand. -
LatestDate: string
(date-time)
Date when the user created the most recent demand.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderClass: string
Maximum Length:
20
Order class of the demand. Valid values include HotOrder, Committed, and Uncommitted. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
Precision: integer
(int64)
Read Only:
true
Display precision of the demand line item. -
Quantity: number
Quantity for the demand line-item.
-
RequestDate: string
(date-time)
Date when the demand is requested.
-
ReservationsFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then the demand order has reservations for this line-item. If N, then the demand order doesn't have reservations for this line-item. This attribute doesn't have a default value. -
SatisfactionDate: string
(date-time)
Date when the demand line-item is satisfied.
-
ShipCompleteFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then shipping is complete on the demand order. If N, then shipping isn't complete on the demand order. This attribute doesn't have a default value. -
ShipToAddress: string
Maximum Length:
240
Address to ship to of the demand order which can contain multiple lines. -
TargetCompletionDate: string
(date-time)
Date when the demand line-item completion is targeted.
-
TransferOrderHeaderId: integer
(int64)
Value that uniquely identifies the transfer order.
-
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.