Jump to

• Request
• Response

Update one demand

patch

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

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=
• TransactionId(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=

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Customer: string
  Title: Customer

  Maximum Length: 4000

  Name of the customer associated with the sales order or forecast.
• CustomerSite: string
  Title: Customer Site

  Maximum Length: 4000

  Code associated with a specific customer ship-to location.
• DemandClassCode: string
  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.
• FirmDate: string (date)
  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.
• FirmPlannedType: integer (int32)
  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.
• FirmQuantity: number
  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.
• ImplementDate: string (date)
  Title: Implement Date

  Date when the order is implemented.
• ImplementDemandClass: string
  Title: Implement Demand Class

  Maximum Length: 30

  Demand class associated with the order that will be used when the order is released.
• ImplementedQuantity: number
  Title: Implemented Quantity

  Cumulative quantity that has been released to date.
• ImplementFirm: integer
  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.
• ImplementQuantity: number
  Title: Implement Quantity

  Order quantity for the released order.
• ImplementShipDate: string (date)
  Title: Implement Ship Date

  Date when the order is shipped.
• ImplementShipMethod: string
  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.
• ImplementShippingMethod: string
  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.
• MarkForReleaseOption: string
  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.
• ReleaseStatus: integer
  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.
• ShipMethod: string
  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.
• ShippingMethod: string
  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.
• SourceOrganization: string
  Title: Source Organization

  Maximum Length: 49

  Organization that will source the order.
• Supplier: string
  Title: Supplier

  Maximum Length: 4000

  Name of the source supplier.
• SupplierSite: string
  Title: Supplier Site

  Maximum Length: 4000

  Abbreviation that indicates the specific supplier ship-from location.
• UsingAssembly: string
  Title: Using Assembly

  Maximum Length: 4000

  For component demands, this field refers to the assembly item that uses this item as a component.

{
    "type":"object",
    "properties":{
        "ImplementedQuantity":{
            "title":"Implemented Quantity",
            "type":"number",
            "description":"Cumulative quantity that has been released to date.",
            "nullable":true
        },
        "ShipMethod":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "ShippingMethod":{
            "title":"Shipping Method",
            "maxLength":4000,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "UsingAssembly":{
            "title":"Using Assembly",
            "maxLength":4000,
            "type":"string",
            "description":"For component demands, this field refers to the assembly item that uses this item as a component.",
            "nullable":true
        },
        "FirmDate":{
            "title":"Firm Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true
        },
        "Customer":{
            "title":"Customer",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the customer associated with the sales order or forecast.",
            "nullable":true
        },
        "ImplementDate":{
            "title":"Implement Date",
            "type":"string",
            "description":"Date when the order is implemented.",
            "format":"date",
            "nullable":true
        },
        "FirmPlannedType":{
            "title":"Firm Status",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "CustomerSite":{
            "title":"Customer Site",
            "maxLength":4000,
            "type":"string",
            "description":"Code associated with a specific customer ship-to location.",
            "nullable":true
        },
        "ImplementQuantity":{
            "title":"Implement Quantity",
            "type":"number",
            "description":"Order quantity for the released order.",
            "nullable":true
        },
        "ImplementShipDate":{
            "title":"Implement Ship Date",
            "type":"string",
            "description":"Date when the order is shipped.",
            "format":"date",
            "nullable":true
        },
        "ImplementShipMethod":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "FirmQuantity":{
            "title":"Firm Quantity",
            "type":"number",
            "description":"Fixed quantity of demand. This attribute value can't be changed by planning and is only populated when the firm status is firm.",
            "nullable":true
        },
        "SourceOrganization":{
            "title":"Source Organization",
            "maxLength":49,
            "type":"string",
            "description":"Organization that will source the order.",
            "nullable":true
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":4000,
            "type":"string",
            "description":"Abbreviation that indicates the specific supplier ship-from location.",
            "nullable":true
        },
        "DemandClassCode":{
            "title":"Demand Class",
            "maxLength":400,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "ImplementFirm":{
            "title":"Implement Firm",
            "type":"integer",
            "description":"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.",
            "nullable":true
        },
        "ReleaseStatus":{
            "title":"Release Status",
            "type":"integer",
            "description":"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.",
            "nullable":true
        },
        "MarkForReleaseOption":{
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the source supplier.",
            "nullable":true
        },
        "ImplementShippingMethod":{
            "title":"Implement Shipping Method",
            "maxLength":400,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "ImplementDemandClass":{
            "title":"Implement Demand Class",
            "maxLength":30,
            "type":"string",
            "description":"Demand class associated with the order that will be used when the order is released.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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

• Action: string
  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.
• BucketType: string
  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.
• Buyer: string
  Title: Buyer

  Read Only: true

  Name of the buyer associated with the item.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the order.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the order.
• Customer: string
  Title: Customer

  Maximum Length: 4000

  Name of the customer associated with the sales order or forecast.
• CustomerSite: string
  Title: Customer Site

  Maximum Length: 4000

  Code associated with a specific customer ship-to location.
• DemandClass: string
  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.
• DemandClassCode: string
  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.
• DestinationTimeZone: string
  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.
• DestOrgCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the destination organization of an order.
• FirmDate: string (date)
  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.
• FirmPlannedType: integer (int32)
  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.
• FirmQuantity: number
  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.
• FirmStatus: string
  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.
• FulfillmentLine: integer
  Title: Fulfillment Line

  Read Only: true

  Fulfillment line number associated with a sales order.
• ImplementDate: string (date)
  Title: Implement Date

  Date when the order is implemented.
• ImplementDemandClass: string
  Title: Implement Demand Class

  Maximum Length: 30

  Demand class associated with the order that will be used when the order is released.
• ImplementedQuantity: number
  Title: Implemented Quantity

  Cumulative quantity that has been released to date.
• ImplementFirm: integer
  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.
• ImplementFirmOption: string
  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.
• ImplementQuantity: number
  Title: Implement Quantity

  Order quantity for the released order.
• ImplementShipDate: string (date)
  Title: Implement Ship Date

  Date when the order is shipped.
• ImplementShipMethod: string
  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.
• ImplementShippingMethod: string
  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.
• ImplementSourceOrganization: string
  Title: Implement Source Organization

  Read Only: true

  Maximum Length: 100

  Source organization for the released order.
• Item: string
  Title: Item

  Maximum Length: 300

  Name of the item associated with the demand.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Description of the item associated with the demand.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the demand was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the demand.
• LatestAcceptableDate: string (date)
  Title: Latest Acceptable Date

  Read Only: true

  Date beyond which the demand line must not be promised.
• LineNumber: string
  Title: Line Number

  Read Only: true

  Maximum Length: 100

  Line number associated with the demand.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Lot: string
  Title: Lot

  Read Only: true

  Lot number associated with an expired on-hand lot.
• MakeOrBuy: string
  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.
• MarkForReleaseOption: string
  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.
• MaterialAvailableDate: string (date)
  Title: Material Available Date

  Read Only: true

  Date when the total quantity is available.
• Message: string
  Read Only: true

  Text of the error message, if any, encountered when creating or updating a demand.
• NeedByDate: string (date)
  Title: Need-by Date

  Read Only: true

  Date by when the demand quantity is needed.
• OldDueDate: string (date)
  Title: Old Due Date

  Read Only: true

  Date when the demand quantity was originally due. This attribute value is extracted from the source application.
• OrderDateType: string
  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.
• OrderDateTypeCode: integer
  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.
• OrderNumber: string
  Title: Order Number

  Read Only: true

  Maximum Length: 4000

  Order number associated with the sales order.
• OrderQuantity: number
  Title: Order Quantity

  Read Only: true

  Quantity associated with the demand.
• OrderType: integer (int32)
  Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
• OrderTypeText: string
  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.
• Organization: string
  Title: Organization

  Maximum Length: 49

  Name of the organization associated with the order.
• OrganizationTimeZone: string
  Title: Organization Time Zone

  Read Only: true

  Maximum Length: 100

  Time zone of the organization associated with the demand.
• OrgCurrencyCode: string
  Read Only: true

  Maximum Length: 100

  Abbreviation that identifies the base currency of the organization.
• OriginalItemQuantity: number
  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.
• OriginalNeedByDate: string (date)
  Title: Original Need-by Date

  Read Only: true

  Date when the order is needed. This value is extracted from the source application.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.
• PlannedArrivalDate: string (date)
  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.
• Planner: string
  Title: Planner

  Read Only: true

  Maximum Length: 10

  Abbreviation that identifies the planner responsible for the item.
• PlannerDescription: string
  Title: Planner Description

  Read Only: true

  Maximum Length: 100

  Description of the planner responsible for the item.
• PlanningMakeBuyCode: integer
  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.
• QuantityByDueDate: number
  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.
• ReleaseErrors: string
  Read Only: true

  Maximum Length: 400

  Errors that are generated in the release process.
• ReleaseStatus: integer
  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.
• ReleaseStatusText: string
  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.
• RequestedItem: string
  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.
• ScheduledArrivalDate: string (date)
  Title: Scheduled Arrival Date

  Read Only: true

  Date when the demand has been scheduled to arrive at a customer site.
• ScheduledShipDate: string (date)
  Title: Scheduled Ship Date

  Read Only: true

  Date when the demand has been scheduled to be shipped.
• ScheduleName: string
  Title: Schedule Name

  Read Only: true

  Maximum Length: 4000

  Name of the supply or demand schedule associated with an order.
• SegmentName: string
  Title: Segment

  Read Only: true

  Maximum Length: 120

  Name of the segment used for a set of items.
• SellingPrice: number
  Read Only: true

  Selling price of an item on the order line.
• ShipCalendar: string
  Read Only: true

  Maximum Length: 15

  Shipping calendar associated with the order.
• ShipMethod: string
  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.
• ShippingMethod: string
  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.
• ShipTo: string
  Title: Ship To

  Read Only: true

  Maximum Length: 4000

  Abbreviation that indicates the specific ship-to location.
• SimulationSetId: integer (int64)
  Value that uniquely identifies the simulation set used in the plan, if any.
• SourceOrder: string
  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.
• SourceOrderLine: string
  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.
• SourceOrganization: string
  Title: Source Organization

  Maximum Length: 49

  Organization that will source the order.
• SourceTimeZone: string
  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.
• SuggestedDueDate: string (date)
  Title: Suggested Due Date

  Read Only: true

  Date when the demand is recommended to be completed.
• SuggestedOrderDate: string (date)
  Title: Suggested Order Date

  Read Only: true

  Date when the order is recommended to be placed.
• SuggestedShipDate: string (date)
  Title: Suggested Ship Date

  Read Only: true

  Date when the order is recommended to be shipped.
• Supplier: string
  Title: Supplier

  Maximum Length: 4000

  Name of the source supplier.
• SupplierSite: string
  Title: Supplier Site

  Maximum Length: 4000

  Abbreviation that indicates the specific supplier ship-from location.
• TransactionId: integer (int64)
  Value that uniquely identifies the demand. This value is internally generated by the application.
• TransitLeadTime: number
  Title: Transit Lead Time

  Read Only: true

  Number of days that the demand is in transit between two locations.
• UnitNumber: string
  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.
• UOM: string
  Read Only: true

  Maximum Length: 200

  Name of the unit of measure that's associated with the order quantity.
• UOMCode: string
  Title: UOM

  Read Only: true

  Abbreviation that identifies the unit of measure associated with the order quantity.
• UsingAssembly: string
  Title: Using Assembly

  Maximum Length: 4000

  For component demands, this field refers to the assembly item that uses this item as a component.
• Zone: string
  Title: Zone

  Read Only: true

  Maximum Length: 400

  Region or zone where the demand quantity is being shipped.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the order.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannedArrivalDate":{
            "title":"Planned Arrival Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipMethod":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ShippingMethod":{
            "title":"Shipping Method",
            "maxLength":4000,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "FirmDate":{
            "title":"Firm Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Customer":{
            "title":"Customer",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the customer associated with the sales order or forecast.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduledShipDate":{
            "title":"Scheduled Ship Date",
            "type":"string",
            "description":"Date when the demand has been scheduled to be shipped.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedItem":{
            "title":"Requested Item",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the item that was originally requested which, due to item substitution, can be different from the item used to fulfill the demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "title":"Order Number",
            "maxLength":4000,
            "type":"string",
            "description":"Order number associated with the sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderTypeText":{
            "title":"Order Type",
            "maxLength":4000,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "BucketType":{
            "title":"Bucket Type",
            "maxLength":7,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestOrgCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the destination organization of an order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaterialAvailableDate":{
            "title":"Material Available Date",
            "type":"string",
            "description":"Date when the total quantity is available.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSite":{
            "title":"Customer Site",
            "maxLength":4000,
            "type":"string",
            "description":"Code associated with a specific customer ship-to location.",
            "nullable":true,
            "x-queryable":true
        },
        "Item":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "description":"Name of the item associated with the demand.",
            "nullable":true,
            "x-queryable":true
        },
        "ImplementShipDate":{
            "title":"Implement Ship Date",
            "type":"string",
            "description":"Date when the order is shipped.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "OrderType":{
            "type":"integer",
            "description":"Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "DestinationTimeZone":{
            "title":"Destination Time Zone",
            "maxLength":100,
            "type":"string",
            "description":"Time zone associated with the entity that's receiving the order. The destination entity can be a customer or an organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuggestedOrderDate":{
            "title":"Suggested Order Date",
            "type":"string",
            "description":"Date when the order is recommended to be placed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementFirm":{
            "title":"Implement Firm",
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ReleaseStatus":{
            "title":"Release Status",
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReleaseErrors":{
            "maxLength":400,
            "type":"string",
            "description":"Errors that are generated in the release process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledArrivalDate":{
            "title":"Scheduled Arrival Date",
            "type":"string",
            "description":"Date when the demand has been scheduled to arrive at a customer site.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementShippingMethod":{
            "title":"Implement Shipping Method",
            "maxLength":400,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure associated with the order quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LatestAcceptableDate":{
            "title":"Latest Acceptable Date",
            "type":"string",
            "description":"Date beyond which the demand line must not be promised.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementedQuantity":{
            "title":"Implemented Quantity",
            "type":"number",
            "description":"Cumulative quantity that has been released to date.",
            "nullable":true,
            "x-queryable":true
        },
        "UsingAssembly":{
            "title":"Using Assembly",
            "maxLength":4000,
            "type":"string",
            "description":"For component demands, this field refers to the assembly item that uses this item as a component.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentName":{
            "title":"Segment",
            "maxLength":120,
            "type":"string",
            "description":"Name of the segment used for a set of items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementDate":{
            "title":"Implement Date",
            "type":"string",
            "description":"Date when the order is implemented.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrder":{
            "title":"Source Order",
            "maxLength":50,
            "type":"string",
            "description":"Value that identifies the order number in the source application against which fulfillment line has been created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrderLine":{
            "title":"Source Order Line",
            "maxLength":50,
            "type":"string",
            "description":"Value that identifies the order line number in the source application against which fulfillment line has been created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuggestedDueDate":{
            "title":"Suggested Due Date",
            "type":"string",
            "description":"Date when the demand is recommended to be completed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SellingPrice":{
            "type":"number",
            "description":"Selling price of an item on the order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand. This value is internally generated by the application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Lot":{
            "title":"Lot",
            "type":"string",
            "description":"Lot number associated with an expired on-hand lot.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ImplementSourceOrganization":{
            "title":"Implement Source Organization",
            "maxLength":100,
            "type":"string",
            "description":"Source organization for the released order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementShipMethod":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":4000,
            "type":"string",
            "description":"Abbreviation that indicates the specific supplier ship-from location.",
            "nullable":true,
            "x-queryable":true
        },
        "MarkForReleaseOption":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SuggestedShipDate":{
            "title":"Suggested Ship Date",
            "type":"string",
            "description":"Date when the order is recommended to be shipped.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SimulationSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the simulation set used in the plan, if any.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UnitNumber":{
            "title":"Unit Number",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningMakeBuyCode":{
            "title":"Make or Buy",
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MakeOrBuy":{
            "maxLength":200,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Action":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "title":"Organization",
            "maxLength":49,
            "type":"string",
            "description":"Name of the organization associated with the order.",
            "nullable":true,
            "x-queryable":true
        },
        "Message":{
            "type":"string",
            "description":"Text of the error message, if any, encountered when creating or updating a demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTimeZone":{
            "title":"Source Time Zone",
            "maxLength":100,
            "type":"string",
            "description":"Time zone associated with the entity that's sourcing the order. The sourcing entity can be a supplier or an organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OldDueDate":{
            "title":"Old Due Date",
            "type":"string",
            "description":"Date when the demand quantity was originally due. This attribute value is extracted from the source application.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OriginalNeedByDate":{
            "title":"Original Need-by Date",
            "type":"string",
            "description":"Date when the order is needed. This value is extracted from the source application.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReleaseStatusText":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Buyer":{
            "title":"Buyer",
            "type":"string",
            "description":"Name of the buyer associated with the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the item associated with the demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line Number",
            "maxLength":100,
            "type":"string",
            "description":"Line number associated with the demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderQuantity":{
            "title":"Order Quantity",
            "type":"number",
            "description":"Quantity associated with the demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementQuantity":{
            "title":"Implement Quantity",
            "type":"number",
            "description":"Order quantity for the released order.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrganization":{
            "title":"Source Organization",
            "maxLength":49,
            "type":"string",
            "description":"Organization that will source the order.",
            "nullable":true,
            "x-queryable":true
        },
        "FirmStatus":{
            "maxLength":200,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FulfillmentLine":{
            "title":"Fulfillment Line",
            "type":"integer",
            "description":"Fulfillment line number associated with a sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the source supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalItemQuantity":{
            "title":"Original Item Quantity",
            "type":"number",
            "description":"Demand quantity of the original item, which may be different from the order quantity, if substitution is allowed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderDateType":{
            "title":"Order Date Type",
            "maxLength":4000,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgCurrencyCode":{
            "maxLength":100,
            "type":"string",
            "description":"Abbreviation that identifies the base currency of the organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransitLeadTime":{
            "title":"Transit Lead Time",
            "type":"number",
            "description":"Number of days that the demand is in transit between two locations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Zone":{
            "title":"Zone",
            "maxLength":400,
            "type":"string",
            "description":"Region or zone where the demand quantity is being shipped.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmPlannedType":{
            "title":"Firm Status",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlannerDescription":{
            "title":"Planner Description",
            "maxLength":100,
            "type":"string",
            "description":"Description of the planner responsible for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandClass":{
            "maxLength":34,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementFirmOption":{
            "maxLength":200,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleName":{
            "title":"Schedule Name",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the supply or demand schedule associated with an order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipCalendar":{
            "maxLength":15,
            "type":"string",
            "description":"Shipping calendar associated with the order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOM":{
            "maxLength":200,
            "type":"string",
            "description":"Name of the unit of measure that's associated with the order quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderDateTypeCode":{
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmQuantity":{
            "title":"Firm Quantity",
            "type":"number",
            "description":"Fixed quantity of demand. This attribute value can't be changed by planning and is only populated when the firm status is firm.",
            "nullable":true,
            "x-queryable":true
        },
        "NeedByDate":{
            "title":"Need-by Date",
            "type":"string",
            "description":"Date by when the demand quantity is needed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationTimeZone":{
            "title":"Organization Time Zone",
            "maxLength":100,
            "type":"string",
            "description":"Time zone of the organization associated with the demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandClassCode":{
            "title":"Demand Class",
            "maxLength":400,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "Planner":{
            "title":"Planner",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the planner responsible for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipTo":{
            "title":"Ship To",
            "maxLength":4000,
            "type":"string",
            "description":"Abbreviation that indicates the specific ship-to location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementDemandClass":{
            "title":"Implement Demand Class",
            "maxLength":30,
            "type":"string",
            "description":"Demand class associated with the order that will be used when the order is released.",
            "nullable":true,
            "x-queryable":true
        },
        "QuantityByDueDate":{
            "title":"Quantity by Due Date",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the demand was most recently updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top