1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Supply Chain Planning
  4. Supply Plans
  5. Planning Supplies

Get one supply

get

/fscmRestApi/resources/11.13.18.05/supplyPlans/{PlanId}/child/PlanningSupplies/{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=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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.

There's no request body for this operation.

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 : supplyPlans-PlanningSupplies-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 80
    Value that indicates the action recommended by planning. A list of accepted values is defined in the lookup type ORA_MSC_ACTIONS.
  • Read Only: true
    Code that indicates the type of recommended change made by the planning engine to the supply or demand. Valid values are 1: Cancel, 2: Reschedule in, 3: Reschedule out, 4: Release, 5: Release reservation, 6: None, and 7: Reschedule and release reservation. A list of accepted values is defined in the lookup ORA_MSC_ACTIONS.
  • Maximum Length: 4000
    Name of the alternate bill of material.
  • Read Only: true
    Maximum Length: 4000
    Indicates whether the planned order uses an alternate facility. Valid values are Yes or No. If Yes, then the planned order uses an alternate facility. If No, then the planned order doesn't use an alternate facility. Only applicable for constrained plans.
  • Read Only: true
    Maximum Length: 4000
    Indicates whether the planned order uses an alternate resource. Valid values are Yes or No. If Yes, then the planned order uses an alternate resource. If No, then the planned order doesn't use an alternate resource. Only applicable for constrained plans.
  • Maximum Length: 400
    Name of a routing used for the make order.
  • Read Only: true
    Maximum Length: 4000
    Indicates whether the planned order uses an alternate supplier. Valid values are Yes or No. If Yes, then the planned order uses an alternate supplier. If No, then the planned order doesn't use an alternate supplier. Only applicable for constrained plans.
  • Read Only: true
    Maximum Length: 4000
    Indicates whether the planned order uses an alternate work definition. Valid values are Yes or No. If Yes, then the planned order uses an alternate work definition. If No, then the planned order doesn't use an alternate work definition. Only applicable for constrained plans.
  • Title: Alternate Facility Used
    Read Only: true
    Value that indicates whether the planned order uses an alternate facility or not.
  • Title: Alternate Resource Used
    Read Only: true
    Value that indicates whether the planned order uses an alternate resource or not.
  • Title: Alternate Supplier Used
    Read Only: true
    Value that indicates whether the planned order uses an alternate supplier or not.
  • Title: Alternate Work Definition Used
    Read Only: true
    Value that indicates whether the planned order uses an alternate work definition or not.
  • Title: Asset
    Read Only: true
    Maximum Length: 80
    Number that identifies the asset associated with a maintenance work order.
  • Title: Batch Quantity
    Read Only: true
    Quantity that moves through operations in a process work order.
  • Title: Batch Quantity UOM
    Read Only: true
    Maximum Length: 30
    Identifies the unit of measure for the batch quantity in a process work definition.
  • Value that uniquely identifies the sequence in which a component is used within an operation.
  • Title: Buyer-Managed Transportation
    Read Only: true
    Contains one of the following values: 1 or 2. If 1, then the buyer is responsible for the transportation of the purchased item. If 2, then the buyer isn't responsible for the transportation of the purchased item. This attribute applies only to purchased items.
  • Read Only: true
    Name of the type of item. Valid values include 1: Model, 2: Option Class, 3: Planning, 4: Standard, or 5: Product Family. A list of accepted values is defined in the lookup type ORA_MSC_BOM_ITEM_TYPE.
  • Title: Buyer
    Read Only: true
    Name of the buyer associated to the item.
  • Read Only: true
    Maximum Length: 200
    Contains one of the following values: Yes or No. If Yes, then the buyer is responsible for the transportation of the purchased item. If No, then the buyer isn't responsible for the transportation of the purchased item. This attribute applies only to purchased items.
  • Read Only: true
    Value that indicates whether the supply has been canceled.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates whether the supply has been canceled. Valid values are: Yes or No. If Yes, then the supply has been canceled. If No, then the supply hasn't been canceled.
  • Value that uniquely identifies the carrier.
  • Title: Category
    Read Only: true
    Maximum Length: 4000
    Name of the category to which the item is assigned.
  • Read Only: true
    Maximum Length: 4000
    Organization code of an organization that's modeled as a child organization with a modeled subinventory code.
  • Read Only: true
    Value that uniquely identifies the child organization.
  • Title: Completed Quantity
    Read Only: true
    Quantity of the work order that's already completed.
  • Title: Component Quantity Issued
    Read Only: true
    Quantity of a component issued to a work order.
  • Title: Compression Days
    Read Only: true
    Number of days prior to the plan start date that the order has to be scheduled to be considered on time.
  • Title: Consumption Start Date
    Read Only: true
    Date when a supply starts being consumed by demands.
  • Title: Contributes to Demand Lateness
    Read Only: true
    Indicates whether the supply is on the critical path leading to a demand that's satisfied late. Valid values are 1 or 2. If 1, then the supply is on the critical path leading to a demand that's satisfied late. If 2, then the supply isn't on the critical path leading to a demand that's satisfied late. Only applicable for constrained plans.
  • Title: Contributes to Overload
    Read Only: true
    Indicates whether the supply contributes to a capacity overload. Valid values are 1 or 2. If 1, then the supply contributes to a capacity overload. If 2, then the supply doesn't contribute to a capacity overload. Only applicable for constrained plans.
  • Read Only: true
    Meaning associated with the ContributesDmdLateness attribute. Value values are Yes and No.
  • Read Only: true
    Maximum Length: 4000
    Meaning associated with the ContributesOverload attribute. Value values are Yes and No.
  • Read Only: true
    Maximum Length: 64
    User who created the order.
  • Read Only: true
    Date when the user created the order.
  • Title: Cumulative Yield
    Read Only: true
    Name of the column that contains the cumulative yield. For example, the name of the column in the Supplies and Demands view. This column is the product of operation yields of all the operations in the work definition of an item.
  • Title: Customer
    Maximum Length: 4000
    Name of the customer associated with the drop ship purchase order.
  • Value that uniquely identifies the customer.
  • Title: Customer Site
    Maximum Length: 4000
    Code associated with a specific customer ship-to location.
  • Value that uniquely identifies the customer site.
  • Read Only: true
    Contains one of the following: yes or null. If yes, then the user has data security edit privileges. If null, then the user doesn't have data security edit privileges.
  • Title: Days Past Due
    Read Only: true
    Number of days that the supply date is in the past.
  • 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: 200
    Value that indicates where the supply is destined. A list of accepted values is defined in the lookup type ORA_MSC_DESTINATION_TYPE.
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the destination organization for an order.
  • Title: Destination Type
    Code that identifies where the supply is destined. A list of accepted values is defined in the lookup type ORA_MSC_DESTINATION_TYPE.
  • Title: Earliest Start Date
    Read Only: true
    Earliest date on which a supply can start based on the lead times of all its upstream supplies, or its planning time-fence date, or based on the constrained capacity of a resource or supplier. This date is calculated by constraint-based plans
  • Title: Expected Scrap Quantity
    Read Only: true
    Quantity of the work order or planned order that's expected to be scrapped in addition to the quantity already scrapped.
  • Read Only: true
    Maximum Length: 100
    Contains one of the following values: Yes or No. If Yes, then the transfer is to an expense destination. If No, then the transfer isn't to an expense destination.
  • Read Only: true
    Contains one of the following values: Yes or No. If Yes, then the transfer is to an expense destination. If No, then the transfer isn't to an expense destination.
  • Title: Expiration Date
    Date when the existing lot associated with the supply expires.
  • Read Only: true
    Contains one of the following values: Yes or No. If Yes, then the make order has an associated firm component. If No, then the make order doesn't have an associated firm component.
  • Title: Firm Date
    Date when supply 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 order is firmed or not. Valid values are 1 or 2. If 1, then the order is firm. If 2, then the order 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 supply. This attribute value can't be changed by planning and is only populated when the firm status is firm.
  • Read Only: true
    Contains one of the following values: Yes or No. If Yes, then the make order has an associated firm resource. If No, then the make order doesn't have an associated firm resource.
  • Date when supply begins. 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 Start Quantity
    User-specified start quantity of a supply. 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.
  • Read Only: true
    Contains one of the following values: 1 or 2. If 1, then the make order has an associated firm component. If 2, then the make order doesn't have an associated firm component.
  • Read Only: true
    Contains one of the following values: 1 or 2. If 1, then the make order has an associated firm resource. If 2, then the make order doesn't have an associated firm resource.
  • Title: Hold Date
    Read Only: true
    Date on which the on-hand inventory lot is no longer on hold.
  • Maximum Length: 100
    Name of an alternate, nonprimary item structure that will be used when the order is released.
  • Maximum Length: 100
    Name of a routing that will be used when the order is released.
  • Title: Implement Order Type
    Value that indicates the type of order to be implemented. Valid values are 1: None, 2: Purchase requisition, 3: Work order, or 5: Internal requisition. A list of accepted values is defined in the lookup type ORA_MSC_WORKBENCH_IMPLEMENT_AS.
  • Title: Implement Date
    Date when the order is released.
  • Title: Implement Dock Date
    Date when the material should be on the receiving dock 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 to use when the order is released. 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 Item Structure Name
    Maximum Length: 4000
    Name of the item structure for the order that's released.
  • Title: Implement Work Order Number
    Maximum Length: 120
    Job name of the work order to be created when the order is released.
  • Title: Implement Location
    Maximum Length: 400
    Value that identifies the deliver-to location to use when the order is released.
  • Value that uniquely identifies the deliver-to location to use when the order is released.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates the type of order to use when the order is released. A list of accepted values is defined in the lookup type ORA_MSC_WORKBENCH_IMPLEMENT_AS.
  • Title: Implement Quantity
    Quantity of the order that's released.
  • Title: Implement Ship Date
    Date when the order is shipped.
  • Maximum Length: 30
    Value that indicates the shipping method to use 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 to use when the order is released, or is a concatenation of carrier name, method of transportation, and service level to use 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
    Maximum Length: 100
    Source organization used for the order that's released.
  • Value that uniquely identifies the source organization to use when the order is released.
  • Read Only: true
    Maximum Length: 200
    Status of the order to use when the order is released. Valid Values are Unreleased or Released.
  • Title: Implement Status
    Abbreviation that identifies the status to use when the order is released. Valid values are 1 or 3. If 1, then the order isn't released. If 3, then the order is released.
  • Title: Implement Supplier
    Maximum Length: 360
    Name of the supplier for the order that's released.
  • Title: Implement Supplier Site
    Maximum Length: 300
    Abbreviation that indicates the specific supplier ship-from location to use when the order is released.
  • Value that uniquely identifies the supplier to use when the order is released.
  • Value that uniquely identifies the specific supplier ship-from location to use when the order is released.
  • Title: Implement Work Order Subtype
    Maximum Length: 40
    Value that indicates the subtype of the work order to be implemented. Valid values are 1: Standard production, 2: Repair, 3: Prototype, 4: Pilot lot, or 5: Test lot. A list of accepted values is defined in the lookup type ORA_MSC_WO_SUB_TYPE.
  • Title: Implement Work Definition Name
    Maximum Length: 4000
    Name of the work definition that's used when the order is released.
  • Read Only: true
    Maximum Length: 200
    Meaning associated with the ImplementWIPClassCode attribute.
  • Value that uniquely identifies the item.
  • Title: Item
    Maximum Length: 300
    Name of the item associated with the supply.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the item that's associated with the supply.
  • Title: Item Structure Name
    Maximum Length: 100
    Name of the item structure planned to be used for the make order.
  • Read Only: true
    Date when the order was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the supply.
  • Title: Latest Start Date
    Read Only: true
    Latest date on which a supply can start. This date is computed by offsetting the lead time of the supply from its need-by date. This date is calculated by constraint-based plans.
  • Title: Line Number
    Read Only: true
    Maximum Length: 100
    Number that identifies the order line.
  • Links
  • Title: Lot
    Read Only: true
    Maximum Length: 80
    Number that identifies the lot of the on-hand supply.
  • Read Only: true
    Maximum Length: 100
    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 or 2: Not Marked For Release. When marking or not marking orders for release, the request body must include only the MarkForReleaseOption attribute.
  • Title: Maturity Date
    Read Only: true
    Date when an inventory lot fully matures. It can then be used to fulfill demand.
  • Read Only: true
    Text of the error message, if any, encountered when creating or updating a supply.
  • Value that uniquely identifies the mode of transportation that's planned to be used to ship an order from the source organization or supplier. A list of accepted values is defined in the MSC_SR_LOOKUP_VALUES_TL table where LOOKUP_TYPE is WSH_MODE_OF_TRANSPORT.
  • Title: MTQ Supply Date
    Read Only: true
    Date when the first minimum transfer quantity supply of the upstream process is available for the downstream process.
  • Title: Need-by Date
    Read Only: true
    Date when the supply quantity is needed.
  • Title: Old Dock Date
    Read Only: true
    Date when the order was originally to arrive at the receiving dock. This attribute value is extracted from the source application.
  • Title: Old Due Date
    Read Only: true
    Date when the order was originally due. This attribute value is extracted from the source application.
  • Read Only: true
    Number that identifies the execution sequence of the operation.
  • Title: Order Number
    Read Only: true
    Maximum Length: 4000
    Number that identifies the order associated with the supply.
  • Title: Order Quantity
    Read Only: true
    Quantity associated with the supply.
  • Read Only: true
    Maximum Length: 200
    SCM Cloud transactional status of a work order, purchase order, or transfer order supplies that are referred to by the planning process.
  • 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
    Type of order such as on hand, purchase order, or work order. 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.
  • Value that uniquely identifies the organization.
  • Title: Organization Time Zone
    Read Only: true
    Maximum Length: 100
    Time zone associated with an organization.
  • Read Only: true
    Abbreviation that identifies the base currency of the organization.
  • Read Only: true
    Value that uniquely identifies the requested item.
  • Title: Requested Item
    Read Only: true
    Maximum Length: 4000
    Name of the requested item associated with the demand.
  • Title: Original Need-by Date
    Read Only: true
    Date when the order was originally needed. This value is extracted from the source application.
  • Title: Original Order Quantity
    Read Only: true
    Original quantity associated with the order. This value is extracted from the source application.
  • Title: Parent Model
    Read Only: true
    Maximum Length: 200
    Model at a higher level in a hierarchy that's used to drive the forecast of a child model, option class, or option.
  • Pegged Demands
    Title: Pegged Demands
    The Pegged Demands resource manages all the demands that are pegged to a specific planning supply at the same level.
  • Title: Pegged to Firm
    Read Only: true
    Indicates whether the supply pegs to a downstream supply that's firm. Valid values are 1 or 2. If 1, then the supply pegs to a downstream supply that's firm. If 2, then it doesn't peg to a downstream supply that's firmed.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates whether the supply pegs to a downstream supply that's firm. Valid values are: Yes or No. If Yes, then supply is pegged to a downstream supply that's firm. If No, then it isn't pegged to a downstream supply that's firmed.
  • Value that uniquely identifies the plan.
  • 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.
  • Planning Attributes
    Title: Planning Attributes
    The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.
  • 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: Process Name
    Read Only: true
    Maximum Length: 120
    Name of the manufacturing process used for this work order or planned order.
  • Value that uniquely identifies the manufacturing process that was used for the make order.
  • Maximum Length: 4000
    Value that identifies the project group.
  • Maximum Length: 4000
    Value that identifies the project.
  • Title: Promised Arrival Date
    Date when a customer has been promised the delivery of the order.
  • Title: Promised Ship Date
    Date when a customer has been promised the shipping of the order.
  • Title: Quantity in Process
    Quantity that's in the process of being released.
  • Title: Ready-to-Build Percentage
    Read Only: true
    Percent of order quantity that can be built with currently available material.
  • Read Only: true
    Number of units of an assembly item for which components are available on hand.
  • 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.
  • Read Only: true
    Abbreviation that identifies the point in time inside which planned orders with certain criteria are automatically released as work orders or purchase orders. A list of accepted values is defined in the lookup type ORA_MSC_TIME_FENCE_TYPES.
  • Read Only: true
    Work order quantity that remains to be completed.
  • Title: Requested Arrival Date
    Date when the material must arrive at the customer site.
  • 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: Requested Item Description
    Read Only: true
    Maximum Length: 4000
    Description of the item that's being requested.
  • Title: Requested Ship Date
    Date when the material must be shipped out to the customer.
  • Read Only: true
    Maximum Length: 100
    Value that indicates whether the order has been rescheduled. Contains one of the following values: Yes or No. If Yes, then the order has been rescheduled. If No, then the order hasn't been rescheduled.
  • Title: Reschedule Days
    Read Only: true
    Number of days to reschedule for a supply order. The reschedule days is the difference between the original due date and the revised due date. A negative value indicates the order is rescheduled to an earlier date.
  • Title: Rescheduled
    Value that indicates whether the order has been rescheduled or not. Contains one of the following values: 1 or 2. If 1, then the order has been rescheduled. If 2, then the order hasn't been rescheduled.
  • Read Only: true
    Value that indicates whether the supply order has been reserved to a demand. Valid values are 1 or 2. If 1, then the supply is reserved to one or more demands. If 2, then planning is suggesting that the supply be reserved to one or more demands. A list of accepted values is defined in the lookup type ORA_MSC_RESERVATION_TYPE.
  • Title: Reserved Quantity
    Read Only: true
    Quantity that's reserved against an order.
  • Value that uniquely identifies the routing that was used for the make order.
  • Read Only: true
    Text that identifies whether the row is new or modified. Valid values are yes or null. If yes, then the row is new or modified. If null, then the row isn't new or modified.
  • Title: Scheduled Ship Date
    Read Only: true
    Date when the order is scheduled to be shipped.
  • Title: Schedule Name
    Read Only: true
    Maximum Length: 4000
    Name of the supply schedule associated with an order.
  • Title: Scrapped Quantity
    Read Only: true
    Work order quantity that has been scrapped.
  • 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.
  • Value that uniquely identifies the service level to use to ship an order from the source organization or supplier. A list of accepted values is defined in the MSC_SR_LOOKUP_VALUES_TL table where LOOKUP_TYPE is WSH_SERVICE_LEVELS.
  • Title: Shared Supply
    Read Only: true
    Indicates whether the supply is shared by more than one demand. Valid values are 1 or 2. If 1, then the supply is shared by more than one demand. If 2, then the supply isn't shared.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates whether the supply is shared by more than one demand. Valid values are: Yes or No. If Yes, then supply is shared by more than one demand. If No, then it isn't shared by more than one demand.
  • Read Only: true
    Maximum Length: 15
    Shipping calendar associated with the order.
  • Maximum Length: 30
    Value that indicates the shipping method used to ship 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 identifies the specific ship-to location.
  • Value that uniquely identifies the simulation set used in the plan, if any.
  • Title: Source Organization
    Maximum Length: 49
    Organization that will source the order.
  • Value that uniquely identifies the source organization.
  • Maximum Length: 12
    Value that identifies the data table source of the supply.
  • 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.
  • Value that identifies the type of planned order to be created. Valid values are 1, 2, or 3. If 1, then a planned make order is created. If 2, then a planned buy order is created. If 3, then a planned transfer order is created.
  • Title: Start Quantity
    Quantity at the beginning of a manufacturing process.
  • Title: Subinventory
    Read Only: true
    Maximum Length: 40
    Subinventory code associated with the supply.
  • Read Only: true
    Maximum Length: 40
    Subinventory code of an organization that's a modeled as a child of a parent organization, and from which supply is recast into a modeled subinventory in its parent organization.
  • Read Only: true
    Value that uniquely identifies the substitute item.
  • Title: Substitute Component Used
    Read Only: true
    Value that indicates whether the planned order uses a substitute component or not.
  • Read Only: true
    Maximum Length: 4000
    Meaning associated with the SubstituteComponentUsed attribute. Valid values are Yes and No.
  • Title: Suggested Completion Date
    Read Only: true
    Date when the process work order or a planned order completed. This attribute is required because the primary product can be produced in an operation that's prior to the last operation of the order.
  • Title: Suggested Dock Date
    Read Only: true
    Date when the order is recommended to arrive at the receiving dock.
  • Title: Suggested Due Date
    Read Only: true
    Date when a supply is expected to be completed.
  • Title: Suggested Order Date
    Read Only: true
    Date when an order is recommended to be placed.
  • Title: Suggested Ship Date
    Read Only: true
    Date when the order is recommended to be shipped.
  • Title: Suggested Start Date
    Read Only: true
    Date when work on the order is recommended to begin.
  • Title: Supplied Item
    Read Only: true
    Maximum Length: 4000
    Name of the supplied item.
  • Title: Supplied Item Description
    Read Only: true
    Maximum Length: 4000
    Description of the supplied item.
  • Title: Supplier
    Maximum Length: 4000
    Name of the source supplier.
  • Value that uniquely identifies the supplier.
  • Title: Supplier Site
    Maximum Length: 4000
    Abbreviation that indicates the specific supplier location from where the item is being sourced.
  • Value that uniquely identifies the supplier site.
  • Maximum Length: 4000
    Value that identifies task.
  • Value that uniquely identifies the supply transaction. This value is internally generated by the application.
  • Title: Transit Lead Time
    Read Only: true
    Number of days that the supply is in transit between two locations.
  • Read Only: true
    Maximum Length: 200
    Name of the unit of measure associated with the order quantity.
  • Title: UOM
    Read Only: true
    Abbreviation that identifies the unit of measure associated with the order quantity.
  • Upstream Supplies
    Title: Upstream Supplies
    The Upstream Supplies resource manages all the supplies that are pegged to a specific planning supply at the next level upstream.
  • Title: Uses Order Modifier
    Read Only: true
    Meaning associated with the UsesOrderModifierIndicator attribute. Valid values are Yes and No.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates whether the supply quantity has been determined by applying an order modifier. Valid values are: Yes or No. If Yes, then an order modifier was applied to the supply quantity. If No, then it hasn't.
  • Read Only: true
    Code that identifies the status of the work order. A list of accepted values is defined in the lookup type ORA_MSC_WIP_JOB_STATUS.
  • Read Only: true
    Type of supply transaction created when issuing items from inventory to work orders. A list of accepted values is defined in the lookup type ORA_MSC_WIP_SUP_TYPE.
  • Title: Work Definition
    Maximum Length: 100
    Name that uniquely identifies a work definition used for a make order.
  • Read Only: true
    Maximum Length: 4000
    Type of manufacturing used for the production process. Valid values are Discrete Manufacturing and Process Manufacturing.
  • Title: Work Method
    Type of manufacturing used for the production process. Valid values are 1: Discrete Manufacturing and 2: Process Manufacturing.
  • Title: Work Order Status
    Read Only: true
    Maximum Length: 4000
    Value that indicates the status of the work order. Valid values include Unreleased, Released, Complete, or On hold. A list of accepted values is defined in the lookup type ORA_MSC_WIP_JOB_STATUS.
Nested Schema : Pegged Demands
Type: array
Title: Pegged Demands
The Pegged Demands resource manages all the demands that are pegged to a specific planning supply at the same level.
Show Source
Nested Schema : Planning Attributes
Type: array
Title: Planning Attributes
The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.
Show Source
Nested Schema : Upstream Supplies
Type: array
Title: Upstream Supplies
The Upstream Supplies resource manages all the supplies that are pegged to a specific planning supply at the next level upstream.
Show Source
Nested Schema : supplyPlans-PlanningSupplies-PeggedDemands-item-response
Type: object
Show Source
Nested Schema : supplyPlans-PlanningSupplies-PlanningAttributes-item-response
Type: object
Show Source
Nested Schema : supplyPlans-PlanningSupplies-UpstreamSupplies-item-response
Type: object
Show Source
Links
PeggedDemands
Parameters:
  • PlanId: $request.path.PlanId
  • TransactionId3: $request.path.TransactionId3
The Pegged Demands resource manages all the demands that are pegged to a specific planning supply at the same level.
PlanningAttributes
Parameters:
  • PlanId: $request.path.PlanId
  • TransactionId3: $request.path.TransactionId3
The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.
UpstreamSupplies
Parameters:
  • PlanId: $request.path.PlanId
  • TransactionId3: $request.path.TransactionId3
The Upstream Supplies resource manages all the supplies that are pegged to a specific planning supply at the next level upstream.
Back to Top

Examples

This example describes how to get one supply.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/supplyPlans/PlanId/child/PlanningSupplies/TransactionId"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/supplyPlans/300100545960039/child/PlanningSupplies/99874539"

Example Response Body

The following shows an example of the response body in JSON format.

{
    "AlternateBOMDesignator": null,
    "AlternateRoutingDesignator": "AI-ABP-5000",
    "BillSequenceId": 2772487,
    "BOMItemType": 4,
    "Buyer": null,
    "CreatedBy": "SCP_SP_USER",
    "CreationDate": "2021-06-15T09:56:02.145+00:00",
    "CustomerSite": null,
    "ItemDescription": "AI-ABP-5000",
    "DestOrgCode": null,
    "Canceled": 2,
    "ExpirationDate": null,
    "FirmDate": null,
    "FirmQuantity": null,
    "ImplementAlternateBOM": null,
    "ImplementAlternateRouting": null,
    "ImplementAs": null,
    "ImplementOrderType": null,
    "ImplementDockDate": null,
    "ImplementFirm": null,
    "ImplementFirmOption": null,
    "ImplementJobName": null,
    "ImplementQuantity": null,
    "ImplementShipDate": null,
    "ImplementShipMethod": null,
    "ImplementStatusCode": null,
    "ImplementStatus": null,
    "ImplementWIPClassCode": null,
    "ImplementWorkOrderSubtype": null,
    "ImplementedQuantity": null,
    "ImplementDate": null,
    "TransitLeadTime": null,
    "Item": "AI-ABP-5000",
    "Organization": "PDSCM1",
    "OrderTypeText": "Planned order",
    "FirmPlannedType": 2,
    "FirmStatus": "Not firm",
    "SuggestedDueDate": "2030-03-13",
    "OrderNumber": "99874539",
    "Planner": "JOHN BROWN",
    "Customer": null,
    "ReleaseStatus": 4,
    "SuggestedShipDate": null,
    "LastUpdateDate": "2021-06-15T09:56:02.145+00:00",
    "LastUpdatedBy": "SCP_SP_USER",
    "NeedByDate": "2030-03-13",
    "SuggestedDockDate": "2030-03-13",
    "SuggestedOrderDate": "2030-03-06",
    "SuggestedStartDate": "2030-03-08",
    "OldDockDate": null,
    "OldDueDate": null,
    "OrderType": 5,
    "OriginalNeedByDate": null,
    "OriginalOrderQuantity": null,
    "PlanId": 300100545960039,
    "PlanningMakeBuyCode": 1,
    "MakeOrBuy": "Make",
    "PromisedArrivalDate": null,
    "PromisedShipDate": null,
    "OrderQuantity": 10,
    "QuantityInProcess": null,
    "ReleaseErrors": null,
    "ReleaseTimeFenceCode": 4,
    "RequestedArrivalDate": null,
    "RequestedShipDate": null,
    "RescheduleDays": null,
    "Rescheduled": null,
    "ReservedQuantity": null,
    "CompressionDays": null,
    "ScheduledShipDate": null,
    "SellingPrice": null,
    "ShipCalendar": null,
    "ShipMethod": null,
    "ShippingMethod": null,
    "ShipTo": null,
    "SourceOrganization": "PDSCM1",
    "SourceTablePrimary": "MSC_SUPPLIES",
    "Supplier": null,
    "SupplierSite": null,
    "Subinventory": null,
    "TransactionId": 99874539,
    "UOMCode": "Ea",
    "UOM": "Each",
    "StartQuantity": 10,
    "WIPStatusCode": 1,
    "WorkOrderStatus": "Unreleased",
    "WIPSupplyType": 1,
    "FirmStartDate": null,
    "ReadyToBuildPercentage": 0,
    "ReadyToBuildQuantity": 0,
    "LineNumber": null,
    "SimulationSetId": -1,
    "ImplementSupplier": null,
    "ImplementSupplierSite": null,
    "BmtOption": 2,
    "BuyerManagedTransportation": "No",
    "Lot": null,
    "OrgCurrencyCode": null,
    "ModeOfTransport": null,
    "ServiceLevel": null,
    "ImplementShippingMethod": null,
    "ItemStructureName": "Primary",
    "WorkDefinition": "AI-ABP-5000",
    "ImplementItemStructure": null,
    "ImplementWorkDefinition": null,
    "DaysPastDue": null,
    "ExpenseDestinationTransfer": "No",
    "ParentModel": null,
    "CompletedQuantity": null,
    "ScrappedQuantity": null,
    "ExpectedScrapQuantity": 0,
    "FirmStartQuantity": null,
    "RemainingQuantity": 10,
    "OrganizationTimeZone": "Coordinated Universal Time",
    "PlannerDescription": "JOHN BROWN",
    "SourceTimeZone": null,
    "DestinationTimeZone": null,
    "AltFacilityUsed": 2,
    "AltSupplierUsed": 2,
    "AltWorkDefinitionUsed": 2,
    "AltResourceUsed": 2,
    "SubstituteComponentUsed": 2,
    "BatchQuantity": null,
    "SuggestedCompletionDate": "2030-03-13",
    "WorkMethodCode": 1,
    "WorkMethod": "Discrete manufacturing",
    "ProcessName": null,
    "BatchUOM": null,
    "ImplementSourceOrganization": null,
    "ProjectValue": null,
    "TaskValue": null,
    "ProjectGroupValue": null,
    "ComponentQuantityIssued": null,
    "AssetNumber": null,
    "Action": "Release",
    "ReleaseStatusText": "Release",
    "SegmentName": "AI-Hard Pegged",
    "ReservationType": null,
    "FirmComponents": null,
    "FirmResources": null,
    "SourceType": null,
    "Message": "",
    "MarkForReleaseOption": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/supplyPlans/300100545960039/child/PlanningSupplies/99874539",
            "name": "PlanningSupplies",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/supplyPlans/300100545960039/child/PlanningSupplies/99874539",
            "name": "PlanningSupplies",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/supplyPlans/300100545960039",
            "name": "supplyPlans",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/supplyPlans/300100545960039/child/PlanningSupplies/99874539/child/PeggedDemands",
            "name": "PeggedDemands",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/supplyPlans/300100545960039/child/PlanningSupplies/99874539/child/PlanningAttributes",
            "name": "PlanningAttributes",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/supplyPlans/300100545960039/child/PlanningSupplies/99874539/child/UpstreamSupplies",
            "name": "UpstreamSupplies",
            "kind": "collection"
        }
    ]
}
Back to Top