Get exception details of one item exception
get
/fscmRestApi/resources/11.13.18.05/supplyPlans/{PlanId}/child/ItemExceptions/{ItemExceptionsUniqID}
Request
Path Parameters
-
ItemExceptionsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PlanId and ExceptionDetailId ---for the Item Exceptions resource and used to uniquely identify an instance of Item Exceptions. The client should not generate the hash key value. Instead, the client should query on the Item Exceptions collection resource with a filter on the primary key values in order to navigate to a specific instance of Item Exceptions.
For example: ItemExceptions?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:
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-ItemExceptions-item-response
Type:
Show Source
object
-
ActionTaken: integer
(int64)
Title:
Action Taken
Read Only:true
Contains 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. -
Category: string
Title:
Category
Read Only:true
Maximum Length:4000
Category of the 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. -
CurrencyCode: string
Title:
Currency
Read Only:true
Maximum Length:4000
Code for the currency of the demand's organization in the exception. -
DaysOfExcess: number
Title:
Days of Excess
Read Only:true
Number of days of excess inventory calculated by the plan in an item with excess inventory exception. -
DaysOfShortage: number
Title:
Days of Shortage
Read Only:true
Number of days of shortage of supply for an item calculated by the plan in an items with a shortage exception. -
Exception: string
Title:
Exception
Read Only:true
Maximum Length:34
Name of an exception. -
ExceptionDetailId: integer
Read Only:
true
Value that uniquely identifies the item exception detail. -
ExceptionId: integer
Read Only:
true
Number that uniquely identifies an exception. -
ExceptionQuantity: number
Title:
Exception Quantity
Read Only:true
Number that represents the quantity of supply in an item exception. This represents the shortage quantity in the item with a shortage exception, the quantity below safety sock in items below safety stock, the quantity of excess in item with excess inventory exception, and the expired quantity in items with expired lot exception. -
ExceptionStoreId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item stored item exception. -
ExpirationDate: string
(date)
Title:
Expiration Date
Read Only:true
Date of expiration of an on hand lot in items with expired lot exceptions. -
FromDate: string
(date)
Title:
From Date
Read Only:true
Effective start date of an exception detail calculated by the plan. -
InventoryItemId: integer
Read Only:
true
Value that uniquely identifies the item in the exception. -
Item: string
Title:
Item
Read Only:true
Maximum Length:4000
Name of the item in the exception. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:4000
Description of the item in the demand in the exception. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the exception detail was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Name of the user who last updated the exception detail. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Title:
Lot Number
Read Only:true
Maximum Length:80
Name of the lot of the on hand in an exception detail. -
Notes: integer
(int64)
Title:
Notes
Read Only:true
Contains information created or updated for an exception detail represented as notes. -
Organization: string
Title:
Organization
Read Only:true
Maximum Length:4000
Name of the organization of an item for which an exception was calculated by the plan. -
OrganizationId: integer
Read Only:
true
Value that uniquely identifies the organization of an item in the exception -
PlanId: integer
Read Only:
true
Value that uniquely identifies the plan in which exception is generated. -
Planner: string
Title:
Planner
Read Only:true
Maximum Length:10
Name of the planner associated with the item in the exception. -
PlannerDescription: string
Title:
Planner Description
Read Only:true
Maximum Length:4000
Description of the planner associated with the item in the exception. -
ProjectedAvailableBalance: number
Title:
Projected Available Balance
Read Only:true
Number that represents the projected available balance of the item in the exception. -
SafetyStockTarget: number
Title:
Safety Stock Target
Read Only:true
Number that represents the target level of the safety stock for an item in an organization in the exception. -
SubInventoryCode: string
Title:
Subinventory
Read Only:true
Maximum Length:80
Name of the subinventory of on hand for an item in exception. -
ToDate: string
(date)
Title:
To Date
Read Only:true
Effective end date of an exception detail calculated by the plan. -
ValueOfShortage: number
Title:
Value of Shortage
Read Only:true
Name that represents the value of the shortage quantity of supply for an item that's in an exception.
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.