Update one demand

patch

/fscmRestApi/resources/11.13.18.05/replenishmentPlans/{PlanId}/child/PlanningDemands/{TransactionId}

Request

Path Parameters
  • 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=
  • 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=
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Customer
    Maximum Length: 4000
    Name of the customer associated with the sales order or forecast.
  • Title: Customer Site
    Maximum Length: 4000
    Code associated with a specific customer ship-to location.
  • Title: Demand Class
    Maximum Length: 400
    Code that identifies the demand class associated with the order. A list of accepted values is defined in the MSC_SR_LOOKUP_VALUES_TL table where LOOKUP_TYPE is DEMAND_CLASS.
  • Title: Firm Date
    Date when the demand is due. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm.
  • Title: Firm Status
    Value that indicates whether the demand is firmed or not. Valid values are 1 or 2. If 1, then the demand is firm. If 2, then the demand isn't firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
  • Title: Firm Quantity
    Fixed quantity of demand. This attribute value can't be changed by planning and is only populated when the firm status is firm.
  • Title: Implement Date
    Date when the order is implemented.
  • Title: Implement Demand Class
    Maximum Length: 30
    Demand class associated with the order that will be used when the order is released.
  • Title: Implemented Quantity
    Cumulative quantity that has been released to date.
  • Title: Implement Firm
    Value that indicates whether the order is firm or not. Valid values are 1: Firm and 2: Not Firm. A list of accepted values is defined in the lookup type MSC_YES_NO.
  • Title: Implement Quantity
    Order quantity for the released order.
  • Title: Implement Ship Date
    Date when the order is shipped.
  • Maximum Length: 30
    Value that identifies the shipping method used when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
  • Title: Implement Shipping Method
    Maximum Length: 400
    Value that indicates the shipping method used to ship the order when the order is released, or is a concatenation of carrier name, method of transportation, and service level used when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
  • Value that indicates the release status of the order. Valid values are 1: Marked For Release, 2: Not Marked For Release. When marking or not marking orders for release, the request body must include only the MarkForReleaseOption attribute.
  • Title: Release Status
    Code that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.
  • Maximum Length: 30
    Value that indicates the shipping method associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
  • Title: Shipping Method
    Maximum Length: 4000
    Value that indicates the shipping method used to ship the order, or is a concatenation of carrier name, method of transportation, and service level associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
  • Title: Source Organization
    Maximum Length: 49
    Organization that will source the order.
  • Title: Supplier
    Maximum Length: 4000
    Name of the source supplier.
  • Title: Supplier Site
    Maximum Length: 4000
    Abbreviation that indicates the specific supplier ship-from location.
  • Title: Using Assembly
    Maximum Length: 4000
    For component demands, this field refers to the assembly item that uses this item as a component.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : replenishmentPlans-PlanningDemands-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 80
    Value that indicates the type of recommended change made by the planning engine to the supply or demand. Valid values include None, Cancel, Reschedule in, Reschedule out, Release, Release reservation, and Reschedule and release reservation. A list of accepted values is defined in the lookup type ORA_MSC_ACTIONS.
  • Title: Bucket Type
    Read Only: true
    Maximum Length: 7
    Time bucket used for forecast demands. Valid values include Day, Month, Period, or Week. A list of accepted values is defined in the lookup types ORA_MSC_TIME_LEVELS_GREGORIAN and ORA_MSC_TIME_LEVELS_MFG.
  • Title: Buyer
    Read Only: true
    Name of the buyer associated with the item.
  • Read Only: true
    Maximum Length: 64
    User who created the order.
  • Read Only: true
    Date when the user created the order.
  • Title: Customer
    Maximum Length: 4000
    Name of the customer associated with the sales order or forecast.
  • Title: Customer Site
    Maximum Length: 4000
    Code associated with a specific customer ship-to location.
  • Read Only: true
    Maximum Length: 34
    Classification of demand used to track and consume different types of demand. Review and update the value for this attribute using the Manage Demand Classes task.
  • Title: Demand Class
    Maximum Length: 400
    Code that identifies the demand class associated with the order. A list of accepted values is defined in the MSC_SR_LOOKUP_VALUES_TL table where LOOKUP_TYPE is DEMAND_CLASS.
  • Title: Destination Time Zone
    Read Only: true
    Maximum Length: 100
    Time zone associated with the entity that's receiving the order. The destination entity can be a customer or an organization.
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the destination organization of an order.
  • Title: Firm Date
    Date when the demand is due. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm.
  • Title: Firm Status
    Value that indicates whether the demand is firmed or not. Valid values are 1 or 2. If 1, then the demand is firm. If 2, then the demand isn't firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
  • Title: Firm Quantity
    Fixed quantity of demand. This attribute value can't be changed by planning and is only populated when the firm status is firm.
  • Read Only: true
    Maximum Length: 200
    Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
  • Title: Fulfillment Line
    Read Only: true
    Fulfillment line number associated with a sales order.
  • Title: Implement Date
    Date when the order is implemented.
  • Title: Implement Demand Class
    Maximum Length: 30
    Demand class associated with the order that will be used when the order is released.
  • Title: Implemented Quantity
    Cumulative quantity that has been released to date.
  • Title: Implement Firm
    Value that indicates whether the order is firm or not. Valid values are 1: Firm and 2: Not Firm. A list of accepted values is defined in the lookup type MSC_YES_NO.
  • Read Only: true
    Maximum Length: 200
    Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
  • Title: Implement Quantity
    Order quantity for the released order.
  • Title: Implement Ship Date
    Date when the order is shipped.
  • Maximum Length: 30
    Value that identifies the shipping method used when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
  • Title: Implement Shipping Method
    Maximum Length: 400
    Value that indicates the shipping method used to ship the order when the order is released, or is a concatenation of carrier name, method of transportation, and service level used when the order is released. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
  • Title: Implement Source Organization
    Read Only: true
    Maximum Length: 100
    Source organization for the released order.
  • Title: Item
    Maximum Length: 300
    Name of the item associated with the demand.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the item associated with the demand.
  • Read Only: true
    Date when the demand was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the demand.
  • Title: Latest Acceptable Date
    Read Only: true
    Date beyond which the demand line must not be promised.
  • Title: Line Number
    Read Only: true
    Maximum Length: 100
    Line number associated with the demand.
  • Links
  • Title: Lot
    Read Only: true
    Lot number associated with an expired on-hand lot.
  • Read Only: true
    Maximum Length: 200
    Value that indicates whether the item is a manufactured item or a purchased item. Valid values include Make or Buy. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY.
  • Value that indicates the release status of the order. Valid values are 1: Marked For Release, 2: Not Marked For Release. When marking or not marking orders for release, the request body must include only the MarkForReleaseOption attribute.
  • Title: Material Available Date
    Read Only: true
    Date when the total quantity is available.
  • Read Only: true
    Text of the error message, if any, encountered when creating or updating a demand.
  • Title: Need-by Date
    Read Only: true
    Date by when the demand quantity is needed.
  • Title: Old Due Date
    Read Only: true
    Date when the demand quantity was originally due. This attribute value is extracted from the source application.
  • Title: Order Date Type
    Read Only: true
    Maximum Length: 4000
    Value that indicates the date specified by the customer. This attribute applies only to sales orders. Valid values include Ship date or Arrival date. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_DATE_TYPE_CODE.
  • Read Only: true
    Value that indicates the date specified by the customer. This attribute applies only to sales orders. Valid values include: 1 where customer has specified a requested ship date or 2 where customer has specified a requested arrival date. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_DATE_TYPE_CODE.
  • Title: Order Number
    Read Only: true
    Maximum Length: 4000
    Order number associated with the sales order.
  • Title: Order Quantity
    Read Only: true
    Quantity associated with the demand.
  • Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
  • Title: Order Type
    Maximum Length: 4000
    Value that indicates the type of order such as sales order or forecast. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
  • Title: Organization
    Maximum Length: 49
    Name of the organization associated with the order.
  • Title: Organization Time Zone
    Read Only: true
    Maximum Length: 100
    Time zone of the organization associated with the demand.
  • Read Only: true
    Maximum Length: 100
    Abbreviation that identifies the base currency of the organization.
  • Title: Original Item Quantity
    Read Only: true
    Demand quantity of the original item, which may be different from the order quantity, if substitution is allowed.
  • Title: Original Need-by Date
    Read Only: true
    Date when the order is needed. This value is extracted from the source application.
  • Value that uniquely identifies the plan.
  • Title: Planned Arrival Date
    Read Only: true
    Date when the item will arrive. The attribute value is calculated using the suggested ship date, carrier calendar, in-transit lead time, and the receiving calendar.
  • Title: Planner
    Read Only: true
    Maximum Length: 10
    Abbreviation that identifies the planner responsible for the item.
  • Title: Planner Description
    Read Only: true
    Maximum Length: 100
    Description of the planner responsible for the item.
  • Title: Make or Buy
    Read Only: true
    Abbreviation that indicates whether the item is manufactured or purchased. Valid values are 1 or 2. If 1, then the item is a manufactured item. If 2, then the item is a purchased item. A list of accepted values is defined in the lookup type ORA_MSC_PLANNING_MAKE_BUY.
  • Title: Quantity by Due Date
    Read Only: true
    Quantity that can be provided by the due date. For example, the order quantity may be 100 units, but only 50 units may be available by the due date.
  • Read Only: true
    Maximum Length: 400
    Errors that are generated in the release process.
  • Title: Release Status
    Code that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.
  • Read Only: true
    Maximum Length: 80
    Value that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.
  • Title: Requested Item
    Read Only: true
    Maximum Length: 4000
    Name of the item that was originally requested which, due to item substitution, can be different from the item used to fulfill the demand.
  • Title: Scheduled Arrival Date
    Read Only: true
    Date when the demand has been scheduled to arrive at a customer site.
  • Title: Scheduled Ship Date
    Read Only: true
    Date when the demand has been scheduled to be shipped.
  • Title: Schedule Name
    Read Only: true
    Maximum Length: 4000
    Name of the supply or demand schedule associated with an order.
  • Title: Segment
    Read Only: true
    Maximum Length: 120
    Name of the segment used for a set of items.
  • Read Only: true
    Selling price of an item on the order line.
  • Read Only: true
    Maximum Length: 15
    Shipping calendar associated with the order.
  • Maximum Length: 30
    Value that indicates the shipping method associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
  • Title: Shipping Method
    Maximum Length: 4000
    Value that indicates the shipping method used to ship the order, or is a concatenation of carrier name, method of transportation, and service level associated with the order. Review and update the value for this attribute using the Maintain Supply Network Model task, and the Interlocation Shipping Networks tab.
  • Title: Ship To
    Read Only: true
    Maximum Length: 4000
    Abbreviation that indicates the specific ship-to location.
  • Value that uniquely identifies the simulation set used in the plan, if any.
  • Title: Source Order
    Read Only: true
    Maximum Length: 50
    Value that identifies the order number in the source application against which fulfillment line has been created.
  • Title: Source Order Line
    Read Only: true
    Maximum Length: 50
    Value that identifies the order line number in the source application against which fulfillment line has been created.
  • Title: Source Organization
    Maximum Length: 49
    Organization that will source the order.
  • Title: Source Time Zone
    Read Only: true
    Maximum Length: 100
    Time zone associated with the entity that's sourcing the order. The sourcing entity can be a supplier or an organization.
  • Title: Suggested Due Date
    Read Only: true
    Date when the demand is recommended to be completed.
  • Title: Suggested Order Date
    Read Only: true
    Date when the order is recommended to be placed.
  • Title: Suggested Ship Date
    Read Only: true
    Date when the order is recommended to be shipped.
  • Title: Supplier
    Maximum Length: 4000
    Name of the source supplier.
  • Title: Supplier Site
    Maximum Length: 4000
    Abbreviation that indicates the specific supplier ship-from location.
  • Value that uniquely identifies the demand. This value is internally generated by the application.
  • Title: Transit Lead Time
    Read Only: true
    Number of days that the demand is in transit between two locations.
  • Title: Unit Number
    Read Only: true
    Maximum Length: 30
    Number that uniquely identifies the bill of material to be used for building a specific model or unit number effectivity-controlled item. This attribute is also known as End Item Unit Number.
  • Read Only: true
    Maximum Length: 200
    Name of the unit of measure that's associated with the order quantity.
  • Title: UOM
    Read Only: true
    Abbreviation that identifies the unit of measure associated with the order quantity.
  • Title: Using Assembly
    Maximum Length: 4000
    For component demands, this field refers to the assembly item that uses this item as a component.
  • Title: Zone
    Read Only: true
    Maximum Length: 400
    Region or zone where the demand quantity is being shipped.
Back to Top