Get details of one demand exception
get
/fscmRestApi/resources/11.13.18.05/demandAndSupplyPlans/{PlanId}/child/DemandExceptions/{DemandExceptionsUniqID}
Request
Path Parameters
-
DemandExceptionsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PlanId and ExceptionDetailId ---for the Demand Exceptions resource and used to uniquely identify an instance of Demand Exceptions. The client should not generate the hash key value. Instead, the client should query on the Demand Exceptions collection resource with a filter on the primary key values in order to navigate to a specific instance of Demand Exceptions.
For example: DemandExceptions?q=PlanId=<value1>;ExceptionDetailId=<value2> -
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 -
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 will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context: string
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: string
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 : demandAndSupplyPlans-DemandExceptions-item-response
Type:
Show Source
object-
ActionTaken: integer
(int64)
Title:
Action TakenContains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2. -
AvailableLeadTime: number
Title:
Available Lead TimeRead Only:trueNumber that represents the available lead time of the supply in the exception. -
Category: string
Title:
CategoryRead Only:trueMaximum Length:4000Category of the demand's item in the exception. The category is derived from the default product hierarchy or any product hierarchy of the item associated in the plan's dimension catalog. -
ConstrainedDate: string
(date)
Title:
Constrained DateRead Only:trueValue that represents the constrained date of the resource or the supplier capacity in the exception. -
CurrencyCode: string
Title:
CurrencyRead Only:trueMaximum Length:4000Code for the currency of the demand's organization in the exception. -
Customer: string
Title:
CustomerRead Only:trueMaximum Length:4000Name of the customer in the demand in the exception. -
CustomerId: integer
Read Only:
trueValue that uniquely identifies the customer in the exception. -
CustomerSite: string
Title:
Customer SiteRead Only:trueMaximum Length:4000Name of the customer site in the demand in the exception. -
CustomerSiteId: integer
Read Only:
trueValue that uniquely identifies the customer site in the exception. -
DaysLate: number
Title:
Exception DaysRead Only:trueNumber that represents the number of days a demand is satisfied late or a supply pegged to a demand is late or number of days a demand is past due. Based on the exception, the days late provides the details. -
DemandClass: string
Title:
Demand ClassRead Only:trueMaximum Length:4000Demand class associated with the demand in the exception. -
DemandId: integer
Read Only:
trueValue that uniquely identifies the demand in the exception. -
DemandLineNumber: string
Title:
Demand Line NumberRead Only:trueMaximum Length:250Line number of the demand in the exception. -
DemandOrderNumber: string
Title:
Demand Order NumberRead Only:trueMaximum Length:4000Order number of the demand in the exception. -
DemandOrderType: string
Title:
Demand Order TypeRead Only:trueMaximum Length:4000Type of order of the demand in the exception. For example, the type of demand order could be a sales order or a forecast. -
DemandQuantity: number
Title:
Demand QuantityRead Only:trueQuantity of the demand in the exception. -
DemandSatisfiedDate: string
(date)
Title:
Demand Satisfied DateRead Only:trueDate in the exception when the demand quantity is completely satisfied. -
DepartmentId: integer
Read Only:
trueValue that uniquely identifies the department or the work center of a resource in the exception. -
Exception: string
Title:
ExceptionRead Only:trueMaximum Length:120Name of an exception. -
ExceptionDetailId: integer
Read Only:
trueValue that uniquely identifies the demand exception detail. -
ExceptionId: integer
Read Only:
trueNumber that uniquely identifies an exception. -
ExceptionValue: number
Title:
Exception ValueRead Only:trueNumber that represents the value of the delay, or the value of the unplanned portion, or the value of the demand quantity, or a part of the demand quantity in the exception. -
InventoryItemId: integer
Read Only:
trueValue that uniquely identifies the demand's item in the exception. -
Item: string
Title:
ItemRead Only:trueMaximum Length:4000Name of the item in the demand in the exception. -
ItemDescription: string
Title:
Item DescriptionRead Only:trueMaximum Length:4000Description of the item in the demand in the exception. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate when the exception detail was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64Name of the user who last updated the exception detail. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaturityDate: string
(date)
Title:
Maturity DateRead Only:trueDate of maturity of the supply pegged to the demand in the exception. -
MtqSupplyDate: string
(date)
Title:
MTQ Supply DateRead Only:trueThe supply date of the minimum transfer quantity (MTQ) of the supply pegged to the demand in the exception -
Notes: integer
(int64)
Title:
NotesContains information created or updated for an exception detail represented as notes. -
OrderDate: string
(date)
Title:
Order DateRead Only:trueDate of the demand in the exception. -
OrderValue: number
Title:
Order ValueRead Only:trueOrder value of the demand in the exception. -
Organization: string
Title:
OrganizationRead Only:trueMaximum Length:4000Name of the demand's organization in the exception. -
OrganizationId: integer
Read Only:
trueValue that uniquely identifies the demand's organization in the exception. -
PartialPlannedQuantity: number
Title:
Partial Planned QuantityRead Only:truePartial planned quantity of the demand in the exception. -
PeggedQuantity: number
Title:
Pegged QuantityRead Only:truePegged quantity of the supply to the demand in the exception. -
PlanId: integer
Read Only:
trueValue that uniquely identifies the plan in which exception is generated. -
PlannerCode: string
Title:
PlannerRead Only:trueMaximum Length:4000Name of the planner associated with the demand's item in the exception. -
PlannerDescription: string
Title:
Planner DescriptionRead Only:trueMaximum Length:4000Description of the planner associated with the demand's item in the exception. -
PlanningAttribute10: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 10 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute10Id: integer
(int64)
Read Only:
trueValue that uniquely identifies the ID of the planning attribute number 10 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute11: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 11 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute11Id: integer
(int64)
Read Only:
trueValue that uniquely identifies the ID of the planning attribute number 11 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute12: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 12 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute12Id: integer
(int64)
Read Only:
trueValue that uniquely identifies the ID of the planning attribute number 12 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute13: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 13 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute13Id: integer
(int64)
Read Only:
trueValue that uniquely identifies the ID of the planning attribute number 13 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute14: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 14 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute14Id: integer
(int64)
Read Only:
trueValue that uniquely identifies the ID of the planning attribute number 14 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute15: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 15 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute15Id: integer
(int64)
Read Only:
trueValue that uniquely identifies the ID of the planning attribute number 15 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute3: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 3 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute3Id: integer
(int64)
Read Only:
trueValue that uniquely identifies the ID of the planning attribute number 3 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute4: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 4 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute4Id: integer
(int64)
Read Only:
trueValue that uniquely identifies the ID of the planning attribute number 4 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute5: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 5 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute5Id: integer
(int64)
Read Only:
trueValue that uniquely identifies the ID of the planning attribute number 5 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute6: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 6 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute6Id: integer
(int64)
Read Only:
trueValue that uniquely identifies the ID of the planning attribute number 6 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute7: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 7 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute7Id: integer
(int64)
Read Only:
trueValue that uniquely identifies the ID of the planning attribute number 7 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute8: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 8 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute8Id: integer
(int64)
Read Only:
trueValue that uniquely identifies the ID of the planning attribute number 8 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute9: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 9 associated with the demand in the exception in an attribute-based plan. -
PlanningAttribute9Id: integer
(int64)
Read Only:
trueValue that uniquely identifies the ID of the planning attribute number 9 associated with the demand in the exception in an attribute-based plan. -
Priority: number
Title:
PriorityRead Only:truePriority of the demand in the exception. -
ProjectGroupValue: string
Read Only:
trueMaximum Length:4000Value that identifies the project group associated with the demand in the exception in an attribute-based plan. -
ProjectGroupValueId: integer
(int64)
Read Only:
trueValue that uniquely identifies the ID of the project group associated with the demand in the exception of an attribute-based plan. -
ProjectValue: string
Read Only:
trueMaximum Length:4000Value that identifies the project associated with the demand in the exception in an attribute-based plan. -
ProjectValueId: integer
(int64)
Read Only:
trueValue that uniquely identifies the ID of the project associated with the demand in the exception of an attribute-based plan. -
QuantityMismatch: number
Title:
Quantity MismatchRead Only:trueNumber that represents the unsatisfied quantity of the demand in the exception. -
QuantitySatisfiedByDemandDate: number
Title:
Quantity Satisfied by Demand DateRead Only:trueNumber that represents the quantity of the demand satisfied by the demand order date in the exception. -
RequiredLeadTime: number
Title:
Required Lead TimeRead Only:trueNumber that represents the lead time required by the supply pegged to the demand in the exception. -
ResourceCode: string
Title:
Resource CodeRead Only:trueMaximum Length:4000Name of the resource in the demand exception. -
ResourceId: integer
Read Only:
trueValue that uniquely identifies the resource in the demand exception. -
ResourceOrganization: string
Title:
Resource OrganizationRead Only:trueMaximum Length:4000Name of the organization of the resource in the demand exception. -
RowModified: string
Read Only:
trueMaximum Length:255Text that identifies whether the row is new or modified. Valid values are yes or null. If yes, then the row is new or modified. If null, then the row isn't new or modified. -
StartDate: string
(date)
Title:
Start DateRead Only:trueStart date in the demand exception. For example, the plan start date in the Late Replenishment for Sales Order exception. -
StoreKey: string
Read Only:
trueMaximum Length:240Name of the store key in the supply exception. -
Supplier: string
Title:
SupplierRead Only:trueMaximum Length:4000Name of the supplier in the demand exception. -
SupplierId: integer
Read Only:
trueValue that uniquely identifies the supplier in the demand exception. -
SupplierItem: string
Title:
Supplier ItemRead Only:trueMaximum Length:4000Supplier item in the demand exception. -
SupplierItemDescription: string
Title:
Supplier Item DescriptionRead Only:trueMaximum Length:4000Supplier item description in the demand exception. -
SupplierSite: string
Title:
Supplier SiteRead Only:trueMaximum Length:4000Name of the supplier site in the demand exception. -
SupplierSiteId: integer
Read Only:
trueValue that uniquely identifies the supplier site in the demand exception. -
SupplyDueDate: string
(date)
Title:
Supply Due DateRead Only:trueDue date of the supply in the demand exception. -
SupplyItem: string
Title:
Supply ItemRead Only:trueMaximum Length:4000Name of the supply's item pegged to the demand in the demand exception. -
SupplyItemDescription: string
Title:
Supply Item DescriptionRead Only:trueMaximum Length:4000Description of the supply's item pegged to the demand in the demand exception. -
SupplyLineNumber: string
Title:
Supply Line NumberRead Only:trueMaximum Length:50Line number of the supply in the demand exception. -
SupplyOrderDemandDueDate: string
(date)
Title:
Supply Order Demand Due DateRead Only:trueDue date of the supply order demand in the demand exception. -
SupplyOrderNumber: string
Title:
Supply Order NumberRead Only:trueMaximum Length:240Order number of the supply in the demand exception. -
SupplyOrderType: string
Title:
Supply Order TypeRead Only:trueMaximum Length:4000Type of order of the supply in the demand exception. For example, a planned order or a work order. -
SupplyOrganization: string
Title:
Supply OrganizationRead Only:trueMaximum Length:4000Name of the supply organization in the demand exception. -
SupplyQuantity: number
Title:
Supply QuantityRead Only:trueNumber that represents the quantity of the supply in the demand exception. -
TaskValue: string
Read Only:
trueMaximum Length:4000Value that identifies the task associated with the demand in the exception in an attribute-based plan. -
TaskValueId: integer
(int64)
Read Only:
trueValue that uniquely identifies the ID of the task associated with the demand in the exception of an attribute-based plan. -
TransactionId: integer
Read Only:
trueValue that uniquely identifies the supply in the demand exception. -
WorkCenter: string
Title:
Work CenterRead Only:trueMaximum Length:4000Name of the work center of the resource in the demand exception.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.