Update details of one supply exception
patch
/fscmRestApi/resources/11.13.18.05/supplyPlans/{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>
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.
Supported Media Types
- application/json
Response
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-SupplyExceptions-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. -
AlternateBOM: string
Title:
Alternate BOM
Read Only:true
Maximum Length:4000
Name of the alternate bill of material in the supply exception. -
AlternateBOMId: integer
Read Only:
true
Number that uniquely identifies the alternate bill of material in the supply exception. -
AlternateFacilityRank: number
Title:
Alternate Facility Rank
Read Only:true
Number that represents the alternate facility rank from the sourcing rule used in the supply in the exception. -
AlternateResourceUsage: number
Title:
Alternate Resource Requirement
Read Only:true
Number that represents the usage of an alternate resource in the supply in the exception. -
AlternateRouting: string
Title:
Alternate Routing
Read Only:true
Maximum Length:4000
Name of the alternate routing or work definition in the supply exception. -
AlternateRoutingId: integer
Read Only:
true
Number that uniquely identifies the alternate routing or work definition in the supply exception. -
AlternateSupplier: string
Title:
Alternate Supplier
Read Only:true
Maximum Length:4000
Name of the alternate supplier in the supply exception. -
AlternateSupplierId: integer
Read Only:
true
Number that uniquely identifies the alternate supplier in the supply exception. -
AlternateSupplierRank: number
Title:
Alternate Supplier Rank
Read Only:true
Number that represents the alternate supplier rank in the supply exception. -
AlternateSupplierSite: string
Title:
Alternate Supplier Site
Read Only:true
Maximum Length:4000
Name of the alternate supplier site in the supply exception. -
AlternateSupplierSiteId: integer
Read Only:
true
Number that uniquely identifies the alternate supplier site in the supply exception. -
Category: string
Title:
Category
Read Only:true
Maximum Length:4000
Category of the item in the supply exception. -
CompressionDays: number
Title:
Compression Days
Read Only:true
Number that represents the compression days of the supply in the exception. -
CompressionRatio: number
Title:
Compression Ratio
Read Only:true
Compression ratio of the supply in the exception. -
CurrencyCode: string
Title:
Currency
Read Only:true
Maximum Length:4000
Code for the currency of the supply's organization in the exception. -
DaysPastDue: number
Title:
Days Past Due
Read Only:true
Number that represents the number of days the supply is past due based on the plan start date in the exception. -
Exception: string
Title:
Exception
Read Only:true
Maximum Length:15
Name of an exception. -
ExceptionDetailId: integer
Read Only:
true
Value that uniquely identifies the supply exception detail. -
ExceptionId: integer
Read Only:
true
Number that uniquely identifies an exception. -
ExceptionStoreId: integer
(int64)
Read Only:
true
Value that uniquely identifies the stored supply exception. -
FirmStatus: number
Title:
Firm Status
Read Only:true
Status that indicates whether the order is firm or not in the exception. Valid values include Firm and Not firm. -
FromDate: string
(date)
Title:
From Date
Read Only:true
From date in the supply exception. -
InventoryItemId: integer
Read Only:
true
Number that uniquely identifies the item in the supply exception. -
Item: string
Title:
Item
Read Only:true
Maximum Length:300
Name of the item in the supply exception. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item in the supply 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
Lot number of the on-hand supply in the supply exception. -
Notes: integer
(int64)
Title:
Notes
Read Only:true
Contains information created or updated for an exception detail represented as notes. -
OldDueDate: string
(date)
Title:
Old Due Date
Read Only:true
Old due date of the supply order in the supply exception. -
OrderDate: string
(date)
Title:
Order Date
Read Only:true
Supply order date in the exception. -
OrderLineNumber: string
Title:
Order Line Number
Read Only:true
Maximum Length:50
Line number of the supply in the exception. -
OrderNumber: string
Title:
Order Number
Read Only:true
Maximum Length:240
Order number of the supply in the exception. -
OrderStartDate: string
(date)
Title:
Order Start Date
Read Only:true
Start date of the supply order in the supply exception. -
OrderValue: number
Title:
Order Value
Read Only:true
Order value of the supply in the exception. -
Organization: string
Title:
Organization
Read Only:true
Maximum Length:4000
Name of the organization of the supply in the supply exception. -
OrganizationId: integer
Read Only:
true
Value that uniquely identifies the organization of the supply in the supply 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. -
PlanningAttribute10: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 10 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute11: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 11 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute12: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 12 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute13: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 13 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute14: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 14 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute15: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 15 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute3: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 3 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute4: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 4 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute5: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 5 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute6: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 6 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute7: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 7 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute8: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 8 associated with the supply in the exception in an attribute-based plan. -
PlanningAttribute9: string
Read Only:
true
Maximum Length:4000
Value that identifies planning attribute number 9 associated with the supply in the exception in an attribute-based plan. -
PlanStartDate: string
(date)
Title:
Plan Start Date
Read Only:true
Start date of the plan the exception is generated in. -
PrimaryResourceRequirement: number
Title:
Primary Resource Requirement
Read Only:true
Resource requirement of the primary resource of the supply in the exception. -
ProjectGroupValue: string
Read Only:
true
Maximum Length:4000
Value that identifies the project group associated with the supply in the exception of an attribute-based plan. -
ProjectValue: string
Read Only:
true
Maximum Length:4000
Value that identifies the project associated with the supply in the exception of an attribute-based plan. -
Quantity: number
Title:
Quantity
Read Only:true
Number that represents the quantity of the supply in the supply exception. -
RescheduledDays: number
Title:
Reschedule Days
Read Only:true
Number that represents rescheduled days for the supply in the exception. -
ResourceCode: string
Title:
Resource
Read Only:true
Maximum Length:4000
Code of the supply's resource in the supply exception. -
ResourceId: integer
Read Only:
true
Value that uniquely identifies the supply's resource in the supply exception. -
ShipMethod: string
Title:
Shipping Method
Read Only:true
Maximum Length:4000
Name of the ship method associated with the supply in the supply exception. -
SourceOrganization: string
Title:
Source Organization
Read Only:true
Maximum Length:4000
Name of the source organization of the supply in the supply exception. -
SourceOrganizationId: integer
Read Only:
true
Value that uniquely identifies the source organization of the supply in the supply exception. -
StoreKey: string
Read Only:
true
Maximum Length:240
Name of the store key in the supply exception. -
SubInventory: string
Title:
Subinventory
Read Only:true
Maximum Length:80
Name of the subinventory of supply in the supply exception. -
SubstituteResourceCode: string
Title:
Alternate Resource
Read Only:true
Maximum Length:4000
Code of the supply's alternate resource in the supply exception. -
SubstituteResourceId: integer
Read Only:
true
Value that uniquely identifies the supply's alternate resource in the supply exception. -
Supplier: string
Title:
Supplier
Read Only:true
Maximum Length:4000
Name of the supplier in the supply exception. -
SupplierId: integer
Read Only:
true
Number that uniquely identifies the supplier in the supply exception. -
SupplierSite: string
Title:
Supplier Site
Read Only:true
Maximum Length:4000
Name of the supplier site in the supply exception. -
SupplierSiteId: integer
Read Only:
true
Number that uniquely identifies the supplier site in the supply exception. -
SupplyOrderType: string
Title:
Supply Order Type
Read Only:true
Maximum Length:4000
Type of supply order in the exception, such as a planned order or transfer order. -
TaskValue: string
Read Only:
true
Maximum Length:4000
Value that identifies the task associated with the supply in the exception in an attribute-based plan. -
ToDate: string
(date)
Title:
To Date
Read Only:true
To date of the supply in the supply exception. -
TransactionId: integer
Read Only:
true
Value that uniquely identifies the supply in the supply exception. -
WorkCenter: string
Title:
Work Center
Read Only:true
Maximum Length:4000
Code of the work center of the supply's resource in the supply exception. -
WorkCenterId: integer
Read Only:
true
Value that uniquely identifies the work center of the supply's resource in the supply 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.