1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Simulation Sets
  5. Planning Supplies

Get one supply

get

/fscmRestApi/resources/11.13.18.05/simulationSets/{SimulationSetId}/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 : simulationSets-PlanningSupplies-item-response
Type: object
Show Source
  • Title: Actual Start Date
    Read Only: true
    Date when the work was started, which applies to work orders in process.
  • Read Only: true
    Maximum Length: 80
    Name of the alternate bill of material.
  • Read Only: true
    Maximum Length: 30
    Name of a routing used for the make order.
  • 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
    Unit of measure for the batch quantity in a process work order.
  • Read Only: true
    Name of the buyer associated to the item.
  • Read Only: true
    Maximum Length: 400
    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.
  • Title: Completed Quantity
    Read Only: true
    Quantity of the work order that's already completed.
  • Read Only: true
    Maximum Length: 64
    User who created the order.
  • Read Only: true
    Date when the user created the order.
  • Title: Customer
    Read Only: true
    Maximum Length: 4000
    Name of the customer associated with the drop ship purchase order.
  • Title: Customer Site
    Read Only: true
    Maximum Length: 4000
    Code associated with a specific customer ship-to location.
  • Read Only: true
    Supply unit price for purchased supply.
  • 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: 400
    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: 4000
    Number that uniquely identifies the customer whose demand is being met through the drop ship supply.
  • Read Only: true
    Maximum Length: 4000
    Customer site to which the drop ship supply must be shipped to meet the demand.
  • 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: 400
    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
    Read Only: true
    Date when the existing lot associated with the supply expires.
  • 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.
  • 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: 40
    Status that indicates whether the order is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
  • Title: Hold Date
    Date on which the on-hand inventory lot is no longer on hold.
  • Read Only: true
    Maximum Length: 300
    Name of the item associated with the supply.
  • Read Only: true
    Maximum Length: 240
    Description of the item that's associated with the supply.
  • Read Only: true
    Maximum Length: 400
    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: 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: 400
    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.
  • Title: Maturity Date
    Date when an inventory lot fully matures. It can then be used to fulfill demand.
  • 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.
  • 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
    Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
  • Title: Order Type
    Read Only: true
    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.
  • Read Only: true
    Maximum Length: 49
    Name of the organization associated with the order.
  • Title: Organization Time Zone
    Read Only: true
    Maximum Length: 100
    Time zone associated with an organization.
  • 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.
  • Read Only: true
    Maximum Length: 10
    Abbreviation that identifies the planner responsible for the item.
  • Read Only: true
    Maximum Length: 400
    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.
  • 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.
  • Maximum Length: 400
    Value that identifies the project group.
  • Maximum Length: 400
    Value that identifies the project.
  • Title: Promised Arrival Date
    Read Only: true
    Date when a customer has been promised the delivery of the order.
  • Title: Promised Ship Date
    Read Only: true
    Date when a customer has been promised the shipping of the order.
  • Read Only: true
    Maximum Length: 30
    Number that identifies the receipt of the transfer order.
  • Read Only: true
    Work order quantity that remains to be completed.
  • Title: Requested Arrival Date
    Read Only: true
    Date when the material must arrive at the customer site.
  • Title: Requested Ship Date
    Read Only: true
    Date when the material must be shipped out to the customer.
  • Read Only: true
    Maximum Length: 10
    Abbreviation that identifies the revision of the inventory item.
  • Read Only: true
    Maximum Length: 120
    Number that identifies the purchase order line location information for collection at the schedule level.
  • Title: Schedule Name
    Read Only: true
    Maximum Length: 4000
    Name of the schedule associated to the supply.
  • Read Only: true
    Value that identifies the priority of the work order.
  • Title: Scrapped Quantity
    Read Only: true
    Work order quantity that has been scrapped.
  • Read Only: true
    Maximum Length: 30
    Number that identifies the shipment header of the transfer order.
  • Read Only: true
    Maximum Length: 30
    Number that identifies the shipment line of the transfer order.
  • Read Only: true
    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
    Read Only: true
    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.
  • Read Only: true
    Maximum Length: 400
    Name of the organization that will source the order.
  • Read Only: true
    Maximum Length: 10
    Abbreviation that identifies the subinventory associated with the 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
    Read Only: true
    Quantity at the beginning of a manufacturing process.
  • Title: Subinventory
    Read Only: true
    Maximum Length: 10
    Subinventory code associated with the supply.
  • 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 Dock 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: Supplier
    Read Only: true
    Maximum Length: 4000
    Name of the source supplier.
  • Title: Supplier Site
    Read Only: true
    Maximum Length: 4000
    Abbreviation that indicates the specific supplier location from where the item is being sourced.
  • Maximum Length: 400
    Value that identifies task.
  • Value that uniquely identifies the supply transaction. This value is internally generated by the application.
  • Title: Unit Number
    Read Only: true
    Maximum Length: 30
    Number that uniquely identifies the bill of material to be used for building a specific model or unit number effectivity-controlled item. This attribute is also known as End Item Unit Number.
  • Read Only: true
    Maximum Length: 40
    Name of the unit of measure associated with the order quantity.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure associated with the order quantity.
  • Read Only: true
    Abbreviation 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.
  • Read Only: true
    Maximum Length: 400
    Name that uniquely identifies a work definition used for a make order.
  • 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.
  • Read Only: true
    Work order subtype associated with the make order. A list of accepted values is defined in the lookup type ORA_MSC_WO_SUB_TYPE .
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 : simulationSets-PlanningSupplies-PlanningAttributes-item-response
Type: object
Show Source
Links
PlanningAttributes
Parameters:
  • SimulationSetId: $request.path.SimulationSetId
  • TransactionId3: $request.path.TransactionId3
The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.
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/simulationSets/SimulationSetId/child/PlanningSupplies/TransactionId"

For example, the following command gets one supply:

curl -u username:password "https://servername/fscmRestApi/resources/version/simulationSets/300100074604035/child/PlanningSupplies/80425440"

Example Response Body

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

{
	"ActualStartDate": null,
	"AlternateBOMDesignator": null,
	"AlternateRoutingDesignator": null,
	"Buyer": "Smith, Jonathan",
	"CreatedBy": "APS_ALL",
	"CreationDate": "2020-08-23T11:32:45.870-07:00",
	"Customer": null,
	"CustomerSite": null,
	"ItemDescription": "RAM - 128MB",
	"ScheduleName": "RT_MPS_P2",
	"Canceled": null,
	"ExpirationDate": null,
	"FirmDate": "2022-08-22",
	"FirmQuantity": 250,
	"Item": "CM60257",
	"Organization": "D1",
	"OrderTypeText": "Planned order",
	"FirmPlannedType": 1,
	"FirmStatus": "Firm",
	"SuggestedDueDate": "2013-04-10",
	"OrderNumber": "58275498",
	"Planner": null,
	"SuggestedShipDate": null,
	"LastUpdateDate": "2020-08-23T11:33:03.323-07:00",
	"LastUpdatedBy": "APS_ALL",
	"NeedByDate": null,
	"SuggestedDockDate": null,
	"SuggestedOrderDate": null,
	"SuggestedStartDate": null,
	"OldDockDate": null,
	"OldDueDate": null,
	"OrderType": 5,
	"OriginalNeedByDate": null,
	"OriginalOrderQuantity": null,
	"PlanningMakeBuyCode": 2,
	"MakeOrBuy": "Buy",
	"PromisedArrivalDate": null,
	"PromisedShipDate": null,
	"OrderQuantity": 20,
	"RequestedArrivalDate": null,
	"RequestedShipDate": null,
	"ShipMethod": null,
	"ShippingMethod": null,
	"SourceOrganization": null,
	"Supplier": null,
	"SupplierSite": null,
	"Subinventory": null,
	"TransactionId": 58275498,
	"UnitNumber": null,
	"UOMCode": "Ea",
	"UOM": "Each",
	"StartQuantity": null,
	"WIPStatusCode": null,
	"WorkOrderStatus": null,
	"WIPSupplyType": 3,
	"LineNumber": null,
	"BuyerManagedTransportation": null,
	"DestinationType": null,
	"Lot": null,
	"ItemStructureName": null,
	"WorkDefinition": null,
	"ExpenseDestinationTransfer": "No",
	"CompletedQuantity": null,
	"ScrappedQuantity": null,
	"ExpectedScrapQuantity": null,
	"FirmStartQuantity": null,
	"RemainingQuantity": 0,
	"OrganizationTimeZone": "Coordinated Universal Time",
	"PlannerDescription": null,
	"SourceTimeZone": null,
	"DestinationTimeZone": "Coordinated Universal Time",
	"BatchQuantity": null,
	"SuggestedCompletionDate": null,
	"ProcessName": null,
	"BatchUOM": null,
	"WorkOrderSubtype": null,
	"ProjectValue": null,
	"TaskValue": null,
	"ProjectGroupValue": null,
	"AssetNumber": null,
	"DeliveryPrice": null,
	"DropShipCustomer": null,
	"DropShipCustomerSite": null,
	"ReceiptNumber": null,
	"Revision": null,
	"ScheduleLineNumber": "101",
	"SchedulePriority": null,
	"ShipmentLineNumber": null,
	"ShipmentHeaderNumber": null,
	"SourceSubinventoryCode": null,
	"SourceType": null,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100085386158/child/PlanningSupplies/58275498",
		"name": "PlanningSupplies",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100085386158/child/PlanningSupplies/58275498",
		"name": "PlanningSupplies",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100085386158",
		"name": "simulationSets",
		"kind": "item"
	}
	]
}
Back to Top