Get late demand analysis for all end demands
get
/fscmRestApi/resources/11.13.18.05/supplyPlans/{PlanId}/child/AnalyzingLateDemands
Request
Path Parameters
-
PlanId(required): integer
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 the constrained supply path using the primary key.
Finder Variables- EndDemandId; integer; End demand identifier to uniquely identify the constrained supply path.
- PlanId; integer; Plan identifier to uniquely identify the constrained supply path.
- TransactionId; integer; Supply identifier to uniquely identify the constrained supply path.
- PrimaryKey Finds the constrained supply path using 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:- AssemblyItemName; string; Item name of the final assembly on which there is an end demand.
- Category; string; Name of the category to which the item is assigned.
- ComponentName; string; Component name of the final assembly.
- CustomerName; string; Customer name on the demand order.
- DemandItemId; integer; Unique identifier of the assembly item.
- DemandOrderNumber; string; Order number for an end demand.
- DemandOrderType; integer; Order type of an end demand.
- DemandOrderTypeText; string; Name of the order type of an end demand. For example, sales order or forecast.
- DemandOrgCurrencyCode; string; Currency code for demanded item organization.
- DemandOrganizationCode; string; Organization code of the final assembly.
- DemandOrganizationId; integer; Unique identifier for the organization of final assembly.
- DemandPriority; number; Demand priority of the end demand.
- DemandSuggestedDueDate; string; Demand due date of the end demand.
- DemandValue; number; Demand value of the end demand.
- DestSupplyOrderNumber; string; Order number of the direct parent supply.
- EarliestStartDate; string; Earliest date that a supply can start.
- EndDemandId; integer; Unique identifier for the end demand.
- EndSupplyOrderNumber; string; Order number of the supply pegged to end demand.
- FirmPlannedType; integer; Indicates whether a supply order is firm. Valid values are 1 and 2.
- FirmStatus; string; Indicates whether a supply order is firm. Valid values are firm or not firm.
- InventoryItemId; integer; Unique identifier of an inventory item.
- ItemStructureLevel; integer; Item structure level of a subassembly or component. For final assembly, the level is 0.
- LatestStartDatePegSup; string; Latest date that a supply order can start.
- MostCriticalPath; integer; Most critical supply path for the end demand that's satisfied late.
- MtqSupplyDate; string; Date that the minimum transfer quantity supply is produced.
- NeedByDate; string; Date that the supply order is required.
- OrderQuantity; number; Order quantity for the supply order.
- OrderType; integer; Order type of the supply order.
- OrderTypeText; string; Name of the supply order types, such as planned order, work order, and so on.
- OrganizationId; integer; Unique value for an organization.
- OverrideDemandPriority; number; Overridden demand priority.
- PlanId; integer; Unique identifier for a plan name.
- PlannerCode; string; User name of the planner.
- ScheduleCompressionDays; number; Number of days a supply is compressed.
- SharedSupply; integer; Indicates whether this supply is shared among many demands. Valid values are 1 or 2.
- SharedSupplyText; string; Indicates whether this supply is shared among many demands. Valid values are yes or no.
- SlackDays; integer; Number of slack days.
- SourceVendorName; string; Supplier name for the supply order.
- SourceVendorSiteCode; string; Identifies the sites belonging to the supplier.
- SuggestedDueDate; string; Suggested due date of the supply.
- SupplierId; integer; Unique identifier for a supplier.
- SupplierSiteId; integer; Unique identifier for a supplier site.
- SupplyOrderNumber; string; Order number of a supply.
- SupplyOrganizationCode; string; Organization code of the supply.
- TransactionId; integer; Unique identifier of a supply.
-
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 : supplyPlans-AnalyzingLateDemands
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 : supplyPlans-AnalyzingLateDemands-item-response
Type:
Show Source
object
-
AssemblyItemName: string
Read Only:
true
Maximum Length:300
Item name of the final assembly on which there is an end demand. -
Category: string
Read Only:
true
Maximum Length:400
Name of the category to which the item is assigned. -
ComponentName: string
Read Only:
true
Maximum Length:4000
Component name of the final assembly. -
CustomerName: string
Read Only:
true
Maximum Length:4000
Customer name on the demand order. -
DemandItemId: integer
(int64)
Read Only:
true
Unique identifier of the assembly item. -
DemandOrderNumber: string
Read Only:
true
Maximum Length:4000
Order number for an end demand. -
DemandOrderType: integer
Read Only:
true
Order type of an end demand. -
DemandOrderTypeText: string
Read Only:
true
Maximum Length:4000
Name of the order type of an end demand. For example, sales order or forecast. -
DemandOrganizationCode: string
Read Only:
true
Maximum Length:49
Organization code of the final assembly. -
DemandOrganizationId: integer
Read Only:
true
Unique identifier for the organization of final assembly. -
DemandOrgCurrencyCode: string
Read Only:
true
Maximum Length:4000
Currency code for demanded item organization. -
DemandPriority: number
Read Only:
true
Demand priority of the end demand. -
DemandSuggestedDueDate: string
(date)
Read Only:
true
Demand due date of the end demand. -
DemandValue: number
Read Only:
true
Demand value of the end demand. -
DestSupplyOrderNumber: string
Read Only:
true
Maximum Length:4000
Order number of the direct parent supply. -
EarliestStartDate: string
(date)
Read Only:
true
Earliest date that a supply can start. -
EndDemandId: integer
(int64)
Read Only:
true
Unique identifier for the end demand. -
EndSupplyOrderNumber: string
Read Only:
true
Maximum Length:4000
Order number of the supply pegged to end demand. -
FirmPlannedType: integer
Read Only:
true
Indicates whether a supply order is firm. Valid values are 1 and 2. -
FirmStatus: string
Read Only:
true
Maximum Length:4000
Indicates whether a supply order is firm. Valid values are firm or not firm. -
InventoryItemId: integer
(int64)
Read Only:
true
Unique identifier of an inventory item. -
ItemStructureLevel: integer
(int32)
Read Only:
true
Item structure level of a subassembly or component. For final assembly, the level is 0. -
LatestStartDatePegSup: string
(date)
Read Only:
true
Latest date that a supply order can start. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MostCriticalPath: integer
(int32)
Read Only:
true
Most critical supply path for the end demand that's satisfied late. -
MtqSupplyDate: string
(date)
Read Only:
true
Date that the minimum transfer quantity supply is produced. -
NeedByDate: string
(date)
Read Only:
true
Date that the supply order is required. -
OrderQuantity: number
Read Only:
true
Order quantity for the supply order. -
OrderType: integer
Read Only:
true
Order type of the supply order. -
OrderTypeText: string
Read Only:
true
Maximum Length:4000
Name of the supply order types, such as planned order, work order, and so on. -
OrganizationId: integer
(int64)
Read Only:
true
Unique value for an organization. -
OverrideDemandPriority: number
Read Only:
true
Overridden demand priority. -
PlanId: integer
(int64)
Read Only:
true
Unique identifier for a plan name. -
PlannerCode: string
Read Only:
true
Maximum Length:4000
User name of the planner. -
ScheduleCompressionDays: number
Read Only:
true
Number of days a supply is compressed. - SharedSupply: integer
- SharedSupplyText: string
-
SlackDays: integer
Read Only:
true
Number of slack days. -
SourceVendorName: string
Read Only:
true
Maximum Length:4000
Supplier name for the supply order. -
SourceVendorSiteCode: string
Read Only:
true
Maximum Length:4000
Identifies the sites belonging to the supplier. -
SuggestedDueDate: string
(date)
Read Only:
true
Suggested due date of the supply. -
SupplierId: integer
(int64)
Read Only:
true
Unique identifier for a supplier. -
SupplierSiteId: integer
(int64)
Read Only:
true
Unique identifier for a supplier site. -
SupplyOrderNumber: string
Read Only:
true
Maximum Length:4000
Order number of a supply. -
SupplyOrganizationCode: string
Read Only:
true
Maximum Length:4000
Organization code of the supply. -
TransactionId: integer
(int64)
Read Only:
true
Unique identifier of a supply.
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.