Get details of one supply exception
get
/fscmRestApi/resources/11.13.18.05/demandAndSupplyPlans/{PlanId}/child/SupplyExceptions/{SupplyExceptionsUniqID}
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=
-
SupplyExceptionsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PlanId and ExceptionDetailId ---for the Supply Exceptions resource and used to uniquely identify an instance of Supply Exceptions. The client should not generate the hash key value. Instead, the client should query on the Supply Exceptions collection resource with a filter on the primary key values in order to navigate to a specific instance of Supply Exceptions.
For example: SupplyExceptions?q=PlanId=<value1>;ExceptionDetailId=<value2>
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-SupplyExceptions-item-response
Type:
Show Source
object-
ActionTaken: integer
(int64)
Title:
Action TakenRead Only:trueContains 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. -
AlternateBOM: string
Title:
Alternate BOMRead Only:trueMaximum Length:4000Name of the alternate bill of material in the supply exception. -
AlternateBOMId: integer
Read Only:
trueNumber that uniquely identifies the alternate bill of material in the supply exception. -
AlternateFacilityRank: number
Title:
Alternate Facility RankRead Only:trueNumber that represents the alternate facility rank from the sourcing rule used in the supply in the exception. -
AlternateResourceUsage: number
Title:
Alternate Resource RequirementRead Only:trueNumber that represents the usage of an alternate resource in the supply in the exception. -
AlternateRouting: string
Title:
Alternate RoutingRead Only:trueMaximum Length:4000Name of the alternate routing or work definition in the supply exception. -
AlternateRoutingId: integer
Read Only:
trueNumber that uniquely identifies the alternate routing or work definition in the supply exception. -
AlternateSupplier: string
Title:
Alternate SupplierRead Only:trueMaximum Length:4000Name of the alternate supplier in the supply exception. -
AlternateSupplierId: integer
Read Only:
trueNumber that uniquely identifies the alternate supplier in the supply exception. -
AlternateSupplierRank: number
Title:
Alternate Supplier RankRead Only:trueNumber that represents the alternate supplier rank in the supply exception. -
AlternateSupplierSite: string
Title:
Alternate Supplier SiteRead Only:trueMaximum Length:4000Name of the alternate supplier site in the supply exception. -
AlternateSupplierSiteId: integer
Read Only:
trueNumber that uniquely identifies the alternate supplier site in the supply exception. -
Category: string
Title:
CategoryRead Only:trueMaximum Length:4000Category of the item in the supply exception. -
CompressionDays: number
Title:
Compression DaysRead Only:trueNumber that represents the compression days of the supply in the exception. -
CompressionRatio: number
Title:
Compression RatioRead Only:trueCompression ratio of the supply in the exception. -
CurrencyCode: string
Title:
CurrencyRead Only:trueMaximum Length:4000Code for the currency of the supply's organization in the exception. -
DaysPastDue: number
Title:
Days Past DueRead Only:trueNumber that represents the number of days the supply is past due based on the plan start date in the exception. -
Exception: string
Title:
ExceptionRead Only:trueMaximum Length:15Name of an exception. -
ExceptionDetailId: integer
Read Only:
trueValue that uniquely identifies the supply exception detail. -
ExceptionId: integer
Read Only:
trueNumber that uniquely identifies an exception. -
ExceptionStoreId: integer
(int64)
Read Only:
trueValue that uniquely identifies the stored supply exception. -
FirmPlannedType: integer
Title:
Firm StatusRead Only:trueIndicates whether the resource requirement is marked as firm. -
FirmStatus: string
Maximum Length:
4000Status that indicates whether the order is firm or not in the exception. Valid values include Firm and Not firm. -
FromDate: string
(date)
Title:
From DateRead Only:trueFrom date in the supply exception. -
InventoryItemId: integer
Read Only:
trueNumber that uniquely identifies the item in the supply exception. -
Item: string
Title:
ItemRead Only:trueMaximum Length:300Name of the item in the supply exception. -
ItemDescription: string
Title:
Item DescriptionRead Only:trueMaximum Length:240Description of the item in the supply 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. -
LotNumber: string
Title:
Lot NumberRead Only:trueMaximum Length:80Lot number of the on-hand supply in the supply exception. -
Notes: integer
(int64)
Title:
NotesContains information created or updated for an exception detail represented as notes. -
OldDueDate: string
(date)
Title:
Old Due DateRead Only:trueOld due date of the supply order in the supply exception. -
OrderDate: string
(date)
Title:
Order DateRead Only:trueSupply order date in the exception. -
OrderLineNumber: string
Title:
Order Line NumberRead Only:trueMaximum Length:50Line number of the supply in the exception. -
OrderNumber: string
Title:
Order NumberRead Only:trueMaximum Length:240Order number of the supply in the exception. -
OrderStartDate: string
(date)
Title:
Order Start DateRead Only:trueStart date of the supply order in the supply exception. -
OrderValue: number
Title:
Order ValueRead Only:trueOrder value of the supply in the exception. -
Organization: string
Title:
OrganizationRead Only:trueMaximum Length:4000Name of the organization of the supply in the supply exception. -
OrganizationId: integer
Read Only:
trueValue that uniquely identifies the organization of the supply in the supply exception. -
PlanId: integer
Read Only:
trueValue that uniquely identifies the plan in which exception is generated. -
Planner: string
Title:
PlannerRead Only:trueMaximum Length:10Name of the planner associated with the item in the exception. -
PlannerDescription: string
Title:
Planner DescriptionRead Only:trueMaximum Length:4000Description of the planner associated with the item in the exception. -
PlanningAttribute10: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 10 associated with the supply 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 supply in the exception in an attribute-based plan. -
PlanningAttribute11: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 11 associated with the supply 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 supply in the exception in an attribute-based plan. -
PlanningAttribute12: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 12 associated with the supply 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 supply in the exception in an attribute-based plan. -
PlanningAttribute13: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 13 associated with the supply 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 supply in the exception in an attribute-based plan. -
PlanningAttribute14: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 14 associated with the supply 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 supply in the exception in an attribute-based plan. -
PlanningAttribute15: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 15 associated with the supply 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 supply in the exception in an attribute-based plan. -
PlanningAttribute3: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 3 associated with the supply 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 supply in the exception in an attribute-based plan. -
PlanningAttribute4: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 4 associated with the supply 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 supply in the exception in an attribute-based plan. -
PlanningAttribute5: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 5 associated with the supply 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 supply in the exception in an attribute-based plan. -
PlanningAttribute6: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 6 associated with the supply 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 supply in the exception in an attribute-based plan. -
PlanningAttribute7: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 7 associated with the supply 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 supply in the exception in an attribute-based plan. -
PlanningAttribute8: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 8 associated with the supply 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 supply in the exception in an attribute-based plan. -
PlanningAttribute9: string
Read Only:
trueMaximum Length:4000Value that identifies planning attribute number 9 associated with the supply 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 supply in the exception in an attribute-based plan. -
PlanStartDate: string
(date)
Title:
Plan Start DateRead Only:trueStart date of the plan the exception is generated in. -
PrimaryItem: string
Title:
Primary ItemRead Only:trueMaximum Length:300Name of the primary item in the supply exception. -
PrimaryResourceRequirement: number
Title:
Primary Resource RequirementRead Only:trueResource requirement of the primary resource of the supply in the exception. -
ProjectGroupValue: string
Read Only:
trueMaximum Length:4000Value that identifies the project group associated with the supply in the exception of an attribute-based plan. -
ProjectGroupValueId: integer
(int64)
Read Only:
trueValue that uniquely identifies the ID of the project group associated with the supply in the exception in an attribute-based plan. -
ProjectValue: string
Read Only:
trueMaximum Length:4000Value that identifies the project associated with the supply in the exception of an attribute-based plan. -
ProjectValueId: integer
(int64)
Read Only:
trueValue that uniquely identifies the ID of the project associated with the supply in the exception of an attribute-based plan. -
Quantity: number
Title:
QuantityRead Only:trueNumber that represents the quantity of the supply in the supply exception. -
RescheduledDays: number
Title:
Reschedule DaysRead Only:trueNumber that represents rescheduled days for the supply in the exception. -
ResourceCode: string
Title:
ResourceRead Only:trueMaximum Length:4000Code of the supply's resource in the supply exception. -
ResourceId: integer
Read Only:
trueValue that uniquely identifies the supply's resource in the supply exception. -
ShipMethod: string
Title:
Shipping MethodRead Only:trueMaximum Length:4000Name of the ship method associated with the supply in the supply exception. -
SourceOrganization: string
Title:
Source OrganizationRead Only:trueMaximum Length:4000Name of the source organization of the supply in the supply exception. -
SourceOrganizationId: integer
Read Only:
trueValue that uniquely identifies the source organization of the supply in the supply exception. -
StoreKey: string
Read Only:
trueMaximum Length:240Name of the store key in the supply exception. -
SubInventory: string
Title:
SubinventoryRead Only:trueMaximum Length:80Name of the subinventory of supply in the supply exception. -
SubstituteComponent: string
Title:
Substitute ComponentRead Only:trueMaximum Length:300Name of the substitute component in the supply exception. -
SubstituteResourceCode: string
Title:
Alternate ResourceRead Only:trueMaximum Length:4000Code of the supply's alternate resource in the supply exception. -
SubstituteResourceId: integer
Read Only:
trueValue that uniquely identifies the supply's alternate resource in the supply exception. -
Supplier: string
Title:
SupplierRead Only:trueMaximum Length:4000Name of the supplier in the supply exception. -
SupplierId: integer
Read Only:
trueNumber that uniquely identifies the supplier in the supply exception. -
SupplierSite: string
Title:
Supplier SiteRead Only:trueMaximum Length:4000Name of the supplier site in the supply exception. -
SupplierSiteId: integer
Read Only:
trueNumber that uniquely identifies the supplier site in the supply exception. -
SupplyOrderType: string
Title:
Supply Order TypeRead Only:trueMaximum Length:4000Type of supply order in the exception, such as a planned order or transfer order. -
TaskValue: string
Read Only:
trueMaximum Length:4000Value that identifies the task associated with the supply 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 supply in the exception of an attribute-based plan. -
ToDate: string
(date)
Title:
To DateRead Only:trueTo date of the supply in the supply exception. -
TransactionId: integer
Read Only:
trueValue that uniquely identifies the supply in the supply exception. -
WorkCenter: string
Title:
Work CenterRead Only:trueMaximum Length:4000Code of the work center of the supply's resource in the supply exception. -
WorkCenterId: integer
Read Only:
trueValue that uniquely identifies the work center of the supply's resource in the supply 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.