Update details of one supplier exception
patch
/fscmRestApi/resources/11.13.18.05/supplyPlans/{PlanId}/child/SupplierExceptions/{SupplierExceptionsUniqID}
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=
-
SupplierExceptionsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PlanId and ExceptionDetailId ---for the Supplier Exceptions resource and used to uniquely identify an instance of Supplier Exceptions. The client should not generate the hash key value. Instead, the client should query on the Supplier Exceptions collection resource with a filter on the primary key values in order to navigate to a specific instance of Supplier Exceptions.
For example: SupplierExceptions?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-SupplierExceptions-item-response
Type:
Show Source
object
-
ActionTaken: integer
(int64)
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. -
AdditionalCapacityRequiredByDateOfSupplierCapacityConstraint: number
Read Only:
true
Additional capacity required by the item supplier and supplier site combination by date of the supplier capacity constraint in the supplier exception. -
AvailableCapacity: number
Read Only:
true
Available capacity of the item supplier and supplier site combination in the supplier exception. -
Category: string
Read Only:
true
Maximum Length:4000
Category of the item in the supplier exception. -
DateOfSupplierCapacityConstraint: string
(date)
Read Only:
true
Date of the supplier capacity constraint in the supplier exception. -
Exception: string
Title:
Exception
Read Only:true
Maximum Length:29
Name of an exception. -
ExceptionDetailId: integer
Read Only:
true
Value that uniquely identifies the supplier 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 supplier exception. -
FromDate: string
(date)
Read Only:
true
From date of the supplier capacity overload in the supplier exception. -
InventoryItemId: integer
Read Only:
true
Number that uniquely identifies the item in the supplier exception. -
Item: string
Title:
Item
Read Only:true
Maximum Length:4000
Name of the item in the supplier exception. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:4000
Description of the item in the supplier exception. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the exception detail was last updated. -
LastUpdatedBy: string
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. -
Notes: integer
(int64)
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 -
OverloadPercent: number
Read Only:
true
Percentage of supplier capacity overload in the supplier exception. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the plan in which exception is generated. -
Planner: string
Read Only:
true
Maximum Length:10
Name of the planner associated with the item in the exception. -
PlannerDescription: string
Read Only:
true
Maximum Length:4000
Description of the planner associated with the item in the exception. -
RequiredCapacity: number
Read Only:
true
Required supplier capacity of the item supplier and supplier site combination in the supplier exception. -
Supplier: string
Title:
Supplier
Read Only:true
Maximum Length:4000
Name of the supplier in the supplier exception. -
SupplierAvailability: number
Read Only:
true
Supplier availability in the supplier exception. -
SupplierCapacityBySupplierCapacityConstraintDate: number
Read Only:
true
Supplier capacity required by date of supplier capacity constraint in the supplier exception. -
SupplierId: integer
Read Only:
true
Number that uniquely identifies the supplier in the supplier exception. -
SupplierSite: string
Title:
Supplier Site
Read Only:true
Maximum Length:4000
Name of the supplier site in the supplier exception. -
SupplierSiteId: integer
Read Only:
true
Number that uniquely identifies the supplier site in the supplier exception. -
ToDate: string
(date)
Read Only:
true
To date of the supplier capacity overload in the supplier 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.