Jump to

• Request
• Response

Get one supply

get

/fscmRestApi/resources/11.13.18.05/planInputs/{PlanInputId}/child/PlanningSupplies/{TransactionId}

Request

Path Parameters

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

Query Parameters

• dependency: string
  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>
• expand: string
  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).
• fields: string
  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
• links: string
  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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : planInputs-PlanningSupplies-item-response

Type: object

Show Source

• ActualStartDate: string (date)
  Read Only: true

  Date when the work was started, which applies to work orders in process.
• AlternateBOMDesignator: string
  Read Only: true

  Maximum Length: 80

  Name of the alternate bill of material.
• AlternateRoutingDesignator: string
  Read Only: true

  Maximum Length: 30

  Name of a routing used for the make order.
• AssetNumber: string
  Read Only: true

  Maximum Length: 80

  Number that identifies the asset associated with a maintenance work order.
• BatchQuantity: number
  Read Only: true

  Quantity that moves through operations in a process work order.
• BatchUOM: string
  Read Only: true

  Maximum Length: 3

  Unit of measure for the batch quantity in a process work order.
• Buyer: string
  Read Only: true

  Maximum Length: 240

  Name of the buyer associated to the item.
• BuyerManagedTransportation: string
  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.
• Canceled: integer
  Read Only: true

  Value that indicates whether the supply has been canceled.
• CompletedQuantity: number
  Read Only: true

  Quantity of the work order that's already completed.
• 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
  Read Only: true

  Maximum Length: 400

  Name of the customer associated with the drop ship purchase order.
• CustomerSite: string
  Read Only: true

  Maximum Length: 400

  Code associated with a specific customer ship-to location.
• DeliveryPrice: number
  Read Only: true

  Supply unit price for purchased supply.
• DestinationTimeZone: string
  Read Only: true

  Maximum Length: 400

  Time zone associated with the entity that's receiving the order. The destination entity can be a customer or an organization.
• DestinationType: string
  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.
• DropShipCustomer: string
  Read Only: true

  Maximum Length: 400

  Number that uniquely identifies the customer whose demand is being met through the drop ship supply.
• DropShipCustomerSite: string
  Read Only: true

  Maximum Length: 400

  Customer site to which the drop ship supply must be shipped to meet the demand.
• ExpectedScrapQuantity: number
  Read Only: true

  Quantity of the work order or planned order that's expected to be scrapped in addition to the quantity already scrapped.
• ExpenseDestinationTransfer: string
  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.
• ExpirationDate: string (date)
  Read Only: true

  Date when the existing lot associated with the supply expires.
• FirmDate: string (date)
  Read Only: true

  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.
• FirmPlannedType: integer
  Read Only: true

  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.
• FirmQuantity: number
  Read Only: true

  Fixed quantity of supply. This attribute value can't be changed by planning and is only populated when the firm status is firm.
• FirmStartQuantity: number
  Read Only: true

  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.
• FirmStatus: string
  Read Only: true

  Maximum Length: 400

  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.
• HoldDate: string (date)
  Read Only: true

  Date on which the on-hand inventory lot is no longer on hold.
• Item: string
  Read Only: true

  Maximum Length: 300

  Name of the item associated with the supply.
• ItemDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the item that's associated with the supply.
• ItemStructureName: string
  Read Only: true

  Maximum Length: 400

  Name of the item structure planned to be used for the make order.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the supply.
• LineNumber: string
  Read Only: true

  Maximum Length: 400

  Number that identifies the order line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Lot: string
  Read Only: true

  Maximum Length: 80

  Number that identifies the lot of the on-hand supply.
• MakeOrBuy: string
  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.
• MaturityDate: string (date)
  Read Only: true

  Date when an inventory lot fully matures. It can then be used to fulfill demand.
• NeedByDate: string (date)
  Read Only: true

  Date when the supply quantity is needed.
• OldDockDate: string (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.
• OldDueDate: string (date)
  Read Only: true

  Date when the order was originally due. This attribute value is extracted from the source application.
• OrderNumber: string
  Read Only: true

  Maximum Length: 400

  Number that identifies the order associated with the supply.
• OrderQuantity: number
  Read Only: true

  Quantity associated with the supply.
• OrderType: integer
  Read Only: true

  Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
• OrderTypeText: string
  Read Only: true

  Maximum Length: 400

  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.
• Organization: string
  Read Only: true

  Maximum Length: 49

  Name of the organization associated with the order.
• OrganizationTimeZone: string
  Read Only: true

  Maximum Length: 400

  Time zone associated with an organization.
• OriginalNeedByDate: string (date)
  Read Only: true

  Date when the order was originally needed. This value is extracted from the source application.
• OriginalOrderQuantity: number
  Read Only: true

  Original quantity associated with the order. This value is extracted from the source application.
• Planner: string
  Read Only: true

  Maximum Length: 10

  Abbreviation that identifies the planner responsible for the item.
• PlannerDescription: string
  Read Only: true

  Maximum Length: 400

  Description of the planner responsible for the item.
• PlanningAttributes: array Planning Attributes
  Title: Planning Attributes

  The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.
• PlanningMakeBuyCode: integer
  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.
• ProcessName: string
  Read Only: true

  Maximum Length: 120

  Name of the manufacturing process used for this work order or planned order.
• ProjectGroupValue: string
  Read Only: true

  Maximum Length: 400

  Value that identifies the project group.
• ProjectValue: string
  Read Only: true

  Maximum Length: 400

  Value that identifies the project.
• PromisedArrivalDate: string (date)
  Read Only: true

  Date when a customer has been promised the delivery of the order.
• PromisedShipDate: string (date)
  Read Only: true

  Date when a customer has been promised the shipping of the order.
• ReceiptNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the receipt of the transfer order.
• RemainingQuantity: number
  Read Only: true

  Work order quantity that remains to be completed.
• RequestedArrivalDate: string (date)
  Read Only: true

  Date when the material must arrive at the customer site.
• RequestedShipDate: string (date)
  Read Only: true

  Date when the material must be shipped out to the customer.
• Revision: string
  Read Only: true

  Maximum Length: 10

  Abbreviation that identifies the revision of the inventory item.
• ScheduleLineNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the purchase order line location information for collection at the schedule level.
• ScheduleName: string
  Read Only: true

  Maximum Length: 10

  Name of the schedule associated to the supply.
• SchedulePriority: number
  Read Only: true

  Value that identifies the priority of the work order.
• ScrappedQuantity: number
  Read Only: true

  Work order quantity that has been scrapped.
• ShipmentHeaderNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the shipment header of the transfer order.
• ShipmentLineNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the shipment line of the transfer order.
• ShipMethod: string
  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.
• ShippingMethod: string
  Read Only: true

  Maximum Length: 400

  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
  Read Only: true

  Maximum Length: 400

  Name of the organization that will source the order.
• SourceSubinventoryCode: string
  Read Only: true

  Maximum Length: 10

  Abbreviation that identifies the subinventory associated with the source of the supply.
• SourceTimeZone: string
  Read Only: true

  Maximum Length: 400

  Time zone associated with the entity that's sourcing the order. The sourcing entity can be a supplier or an organization.
• StartQuantity: number
  Read Only: true

  Quantity at the beginning of a manufacturing process.
• Subinventory: string
  Read Only: true

  Maximum Length: 10

  Subinventory code associated with the supply.
• SuggestedCompletionDate: string (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.
• SuggestedDockDate: string (date)
  Read Only: true

  Date when the order is recommended to arrive at the receiving dock.
• SuggestedDueDate: string (date)
  Read Only: true

  Date when a supply is expected to be completed.
• SuggestedOrderDate: string (date)
  Read Only: true

  Date when an order is recommended to be placed.
• SuggestedShipDate: string (date)
  Read Only: true

  Date when the order is recommended to be shipped.
• SuggestedStartDate: string (date)
  Read Only: true

  Date when work on the order is recommended to begin.
• Supplier: string
  Read Only: true

  Maximum Length: 400

  Name of the source supplier.
• SupplierSite: string
  Read Only: true

  Maximum Length: 400

  Abbreviation that indicates the specific supplier location from where the item is being sourced.
• TaskValue: string
  Read Only: true

  Maximum Length: 400

  Value that identifies task.
• TransactionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supply transaction. This value is internally generated by the application.
• Undercompleted: integer
  Read Only: true

  Contains one of the following values 1 or 2. If 1, then the work order is undercompleted based on undercompletion tolerance values. If 2, then the work order isn't undercompleted.
• UnitNumber: string
  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: 400

  Name of the unit of measure associated with the order quantity.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure associated with the order quantity.
• WIPStatusCode: integer
  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.
• WIPSupplyType: integer
  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.
• WorkDefinition: string
  Read Only: true

  Maximum Length: 400

  Name that uniquely identifies a work definition used for a make order.
• WorkOrderStatus: string
  Read Only: true

  Maximum Length: 400

  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.
• WorkOrderSubtype: integer
  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 .

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the order.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipMethod":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShippingMethod":{
            "maxLength":400,
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedArrivalDate":{
            "type":"string",
            "description":"Date when the material must arrive at the customer site.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the manufacturing process used for this work order or planned order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Customer":{
            "maxLength":400,
            "type":"string",
            "description":"Name of the customer associated with the drop ship purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmDate":{
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderStatus":{
            "maxLength":400,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuggestedDockDate":{
            "type":"string",
            "description":"Date when the order is recommended to arrive at the receiving dock.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "maxLength":400,
            "type":"string",
            "description":"Number that identifies the order associated with the supply.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderTypeText":{
            "maxLength":400,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActualStartDate":{
            "type":"string",
            "description":"Date when the work was started, which applies to work orders in process.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateRoutingDesignator":{
            "maxLength":30,
            "type":"string",
            "description":"Name of a routing used for the make order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the asset associated with a maintenance work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSite":{
            "maxLength":400,
            "type":"string",
            "description":"Code associated with a specific customer ship-to location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the item associated with the supply.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateBOMDesignator":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the alternate bill of material.",
            "nullable":true,
            "readOnly":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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DropShipCustomer":{
            "maxLength":400,
            "type":"string",
            "description":"Number that uniquely identifies the customer whose demand is being met through the drop ship supply.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationTimeZone":{
            "maxLength":400,
            "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":{
            "type":"string",
            "description":"Date when an order is recommended to be placed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ShipmentHeaderNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the shipment header of the transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttributes":{
            "title":"Planning Attributes",
            "type":"array",
            "description":"The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.",
            "items":{
                "$ref":"#/components/schemas/planInputs-PlanningSupplies-PlanningAttributes-item-response"
            },
            "x-cardinality":"1"
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure associated with the order quantity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the receipt of the transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the supply.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RemainingQuantity":{
            "type":"number",
            "description":"Work order quantity that remains to be completed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpenseDestinationTransfer":{
            "maxLength":400,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScrappedQuantity":{
            "type":"number",
            "description":"Work order quantity that has been scrapped.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuggestedDueDate":{
            "type":"string",
            "description":"Date when a supply is expected to be completed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supply transaction. This value is internally generated by the application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Lot":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the lot of the on-hand supply.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WIPSupplyType":{
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuyerManagedTransportation":{
            "maxLength":400,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Revision":{
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the revision of the inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Undercompleted":{
            "type":"integer",
            "description":"Contains one of the following values 1 or 2. If 1, then the work order is undercompleted based on undercompletion tolerance values. If 2, then the work order isn't undercompleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "maxLength":400,
            "type":"string",
            "description":"Abbreviation that indicates the specific supplier location from where the item is being sourced.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldDate":{
            "type":"string",
            "description":"Date on which the on-hand inventory lot is no longer on hold.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuggestedShipDate":{
            "type":"string",
            "description":"Date when the order is recommended to be shipped.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Canceled":{
            "type":"integer",
            "description":"Value that indicates whether the supply has been canceled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "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":{
            "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":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MakeOrBuy":{
            "maxLength":400,
            "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
        },
        "ProjectValue":{
            "maxLength":400,
            "type":"string",
            "description":"Value that identifies the project.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpectedScrapQuantity":{
            "type":"number",
            "description":"Quantity of the work order or planned order that's expected to be scrapped in addition to the quantity already scrapped.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PromisedArrivalDate":{
            "type":"string",
            "description":"Date when a customer has been promised the delivery of the order.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuggestedStartDate":{
            "type":"string",
            "description":"Date when work on the order is recommended to begin.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleLineNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the purchase order line location information for collection at the schedule level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SchedulePriority":{
            "type":"number",
            "description":"Value that identifies the priority of the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "maxLength":49,
            "type":"string",
            "description":"Name of the organization associated with the order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTimeZone":{
            "maxLength":400,
            "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
        },
        "BatchUOM":{
            "maxLength":3,
            "type":"string",
            "description":"Unit of measure for the batch quantity in a process work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OldDueDate":{
            "type":"string",
            "description":"Date when the order was originally due. This attribute value is extracted from the source application.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OriginalNeedByDate":{
            "type":"string",
            "description":"Date when the order was originally needed. This value is extracted from the source application.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompletedQuantity":{
            "type":"number",
            "description":"Quantity of the work order that's already completed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectGroupValue":{
            "maxLength":400,
            "type":"string",
            "description":"Value that identifies the project group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OldDockDate":{
            "type":"string",
            "description":"Date when the order was originally to arrive at the receiving dock. This attribute value is extracted from the source application.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmStartQuantity":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Buyer":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the buyer associated to the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationType":{
            "maxLength":400,
            "type":"string",
            "description":"Value that indicates where the supply is destined. A list of accepted values is defined in the lookup type ORA_MSC_DESTINATION_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DropShipCustomerSite":{
            "maxLength":400,
            "type":"string",
            "description":"Customer site to which the drop ship supply must be shipped to meet the demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item that's associated with the supply.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineNumber":{
            "maxLength":400,
            "type":"string",
            "description":"Number that identifies the order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderQuantity":{
            "type":"number",
            "description":"Quantity associated with the supply.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganization":{
            "maxLength":400,
            "type":"string",
            "description":"Name of the organization that will source the order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmStatus":{
            "maxLength":400,
            "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
        },
        "WorkDefinition":{
            "maxLength":400,
            "type":"string",
            "description":"Name that uniquely identifies a work definition used for a make order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderSubtype":{
            "type":"integer",
            "description":"Work order subtype associated with the make order. A list of accepted values is defined in the lookup type ORA_MSC_WO_SUB_TYPE .",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Supplier":{
            "maxLength":400,
            "type":"string",
            "description":"Name of the source supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipmentLineNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the shipment line of the transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuggestedCompletionDate":{
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WIPStatusCode":{
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmPlannedType":{
            "type":"integer",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchQuantity":{
            "type":"number",
            "description":"Quantity that moves through operations in a process work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeliveryPrice":{
            "type":"number",
            "description":"Supply unit price for purchased supply.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaturityDate":{
            "type":"string",
            "description":"Date when an inventory lot fully matures. It can then be used to fulfill demand.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannerDescription":{
            "maxLength":400,
            "type":"string",
            "description":"Description of the planner responsible for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleName":{
            "maxLength":10,
            "type":"string",
            "description":"Name of the schedule associated to the supply.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOM":{
            "maxLength":400,
            "type":"string",
            "description":"Name of the unit of measure associated with the order quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmQuantity":{
            "type":"number",
            "description":"Fixed quantity of supply. This attribute value can't be changed by planning and is only populated when the firm status is firm.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Date when the existing lot associated with the supply expires.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NeedByDate":{
            "type":"string",
            "description":"Date when the supply quantity is needed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemStructureName":{
            "maxLength":400,
            "type":"string",
            "description":"Name of the item structure planned to be used for the make order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OriginalOrderQuantity":{
            "type":"number",
            "description":"Original quantity associated with the order. This value is extracted from the source application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartQuantity":{
            "type":"number",
            "description":"Quantity at the beginning of a manufacturing process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationTimeZone":{
            "maxLength":400,
            "type":"string",
            "description":"Time zone associated with an organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Subinventory":{
            "maxLength":10,
            "type":"string",
            "description":"Subinventory code associated with the supply.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Planner":{
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the planner responsible for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedShipDate":{
            "type":"string",
            "description":"Date when the material must be shipped out to the customer.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PromisedShipDate":{
            "type":"string",
            "description":"Date when a customer has been promised the shipping of the order.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceSubinventoryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the subinventory associated with the source of the supply.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the order was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskValue":{
            "maxLength":400,
            "type":"string",
            "description":"Value that identifies task.",
            "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 : 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

• Array of: object planInputs-PlanningSupplies-PlanningAttributes-item-response

{
    "title":"Planning Attributes",
    "type":"array",
    "description":"The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.",
    "items":{
        "$ref":"#/components/schemas/planInputs-PlanningSupplies-PlanningAttributes-item-response"
    },
    "x-cardinality":"1"
}

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."
        }
    }
}

Nested Schema : planInputs-PlanningSupplies-PlanningAttributes-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrderNumber: string
  Title: Order Number

  Maximum Length: 4000

  Number that identifies the order associated with the demand or supply.
• PlanningAttributeNumber10: string
  Maximum Length: 4000

  Value for the planning attribute number 10 in attribute-based planning.
• PlanningAttributeNumber11: string
  Maximum Length: 4000

  Value for the planning attribute number 11 in attribute-based planning.
• PlanningAttributeNumber12: string
  Maximum Length: 4000

  Value for the planning attribute number 12 in attribute-based planning.
• PlanningAttributeNumber13: string
  Maximum Length: 4000

  Value for the planning attribute number 13 in attribute-based planning.
• PlanningAttributeNumber14: string
  Maximum Length: 4000

  Value for the planning attribute number 14 in attribute-based planning.
• PlanningAttributeNumber15: string
  Maximum Length: 4000

  Value for the planning attribute number 15 in attribute-based planning.
• PlanningAttributeNumber3: string
  Maximum Length: 4000

  Value for the planning attribute number 3 in attribute-based planning.
• PlanningAttributeNumber4: string
  Maximum Length: 4000

  Value for the planning attribute number 4 in attribute-based planning.
• PlanningAttributeNumber5: string
  Maximum Length: 4000

  Value for the planning attribute number 5 in attribute-based planning.
• PlanningAttributeNumber6: string
  Maximum Length: 4000

  Value for the planning attribute number 6 in attribute-based planning.
• PlanningAttributeNumber7: string
  Maximum Length: 4000

  Value for the planning attribute number 7 in attribute-based planning.
• PlanningAttributeNumber8: string
  Maximum Length: 4000

  Value for the planning attribute number 8 in attribute-based planning.
• PlanningAttributeNumber9: string
  Maximum Length: 4000

  Value for the planning attribute number 9 in attribute-based planning.
• TransactionId: integer (int64)
  Value that uniquely identifies the demand or supply. This value is internally generated by the application.

{
    "type":"object",
    "properties":{
        "PlanningAttributeNumber10":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 10 in attribute-based planning.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber14":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 14 in attribute-based planning.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber13":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 13 in attribute-based planning.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "title":"Order Number",
            "maxLength":4000,
            "type":"string",
            "description":"Number that identifies the order associated with the demand or supply.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber12":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 12 in attribute-based planning.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber11":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 11 in attribute-based planning.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber8":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 8 in attribute-based planning.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand or supply. This value is internally generated by the application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningAttributeNumber9":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 9 in attribute-based planning.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber15":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 15 in attribute-based planning.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber6":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 6 in attribute-based planning.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber7":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 7 in attribute-based planning.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber4":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 4 in attribute-based planning.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber5":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 5 in attribute-based planning.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber3":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 3 in attribute-based planning.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

PlanningAttributes

Operation: /fscmRestApi/resources/11.13.18.05/planInputs/{PlanInputId}/child/PlanningSupplies/{TransactionId}/child/PlanningAttributes

Parameters:

• PlanInputId: $request.path.PlanInputId
• TransactionId3: $request.path.TransactionId3

The Planning Attributes resource manages the attribute-based planning attributes associated with a demand or supply.

Back to Top