Update a supply event
patch
/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/supplyEvents/{supplyEventsUniqID}
Request
Path Parameters
-
PlanId(required): integer(int64)
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=
-
supplyEventsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PlanId and SupplyId ---for the Supply Events resource and used to uniquely identify an instance of Supply Events. The client should not generate the hash key value. Instead, the client should query on the Supply Events collection resource with a filter on the primary key values in order to navigate to a specific instance of Supply Events.
For example: supplyEvents?q=PlanId=<value1>;SupplyId=<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
Root Schema : schema
Type:
Show Source
object
-
EarliestDate: string
(date-time)
Date when the item can be supplied at the earliest.
-
FolderPath: string
Maximum Length:
300
Path where the supply is located. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
LatestDate: string
(date-time)
Date and time when the item can be supplier at the latest.
-
OriginAddress: string
Maximum Length:
240
Origin address of the supply. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
Quantity: number
Quantity of the supply line item.
-
RequestDate: string
(date-time)
Date when the supply is requested.
-
RequestDateOverride: string
(date-time)
Date when the supply is requested. This attribute overrides the request date value that??s inherited from the RequestDate attribute.
-
ReservationsFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then the demand order has reservations for this line item. If N, then the demand order doesn't have reservations for this line item. This attribute doesn't have a default value. -
SelectedDate: string
(date-time)
Date when the supply is expected to be available.
-
SupplierName: string
Maximum Length:
300
Name of the supplier. -
SupplierNumber: string
Maximum Length:
240
Number that identifies the supplier. -
SupplyHeaderId: integer
(int64)
Value that uniquely identifies the supply header.
-
SupplyId: integer
(int64)
Value that uniquely identifies the supplier.
-
SupplyLineItemNumber: string
Maximum Length:
150
Number that identifies the supply line item. -
SupplyNumber: string
Maximum Length:
240
Number that uniquely identifies the supplier. -
SupplyStatus: string
Maximum Length:
30
User-defined status of the line item. Valid values include Approved and OnHold. -
SupplyType: string
Maximum Length:
30
Type of the supply order. -
TransferOrderHeaderId: integer
(int64)
Value that uniquely identifies the transfer order.
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 : productionSchedulingPlans-supplyEvents-item-response
Type:
Show Source
object
-
EarliestDate: string
(date-time)
Date when the item can be supplied at the earliest.
-
FolderPath: string
Maximum Length:
300
Path where the supply is located. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the item. -
ItemDescription: string
Read Only:
true
Maximum Length:500
Description of the item for the supply. -
LatestDate: string
(date-time)
Date and time when the item can be supplier at the latest.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginAddress: string
Maximum Length:
240
Origin address of the supply. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
Precision: integer
(int64)
Read Only:
true
Display precision of the supply line item. -
Quantity: number
Quantity of the supply line item.
-
RequestDate: string
(date-time)
Date when the supply is requested.
-
RequestDateOverride: string
(date-time)
Date when the supply is requested. This attribute overrides the request date value that??s inherited from the RequestDate attribute.
-
ReservationsFlag: boolean
Maximum Length:
1
Contains one of the following values: Y or N. If Y, then the demand order has reservations for this line item. If N, then the demand order doesn't have reservations for this line item. This attribute doesn't have a default value. -
SelectedDate: string
(date-time)
Date when the supply is expected to be available.
-
SupplierName: string
Maximum Length:
300
Name of the supplier. -
SupplierNumber: string
Maximum Length:
240
Number that identifies the supplier. -
SupplyHeaderId: integer
(int64)
Value that uniquely identifies the supply header.
-
SupplyId: integer
(int64)
Value that uniquely identifies the supplier.
-
SupplyLineItemNumber: string
Maximum Length:
150
Number that identifies the supply line item. -
SupplyNumber: string
Maximum Length:
240
Number that uniquely identifies the supplier. -
SupplyStatus: string
Maximum Length:
30
User-defined status of the line item. Valid values include Approved and OnHold. -
SupplyType: string
Maximum Length:
30
Type of the supply order. -
TransferOrderHeaderId: integer
(int64)
Value that uniquely identifies the transfer order.
-
UnitOfMeasure: string
Read Only:
true
Maximum Length:25
Name of the unit of measure. -
UOMCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the unit of measure.
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.