Get all changed supplies

get

/fscmRestApi/resources/11.13.18.05/supplyPlans/{PlanId}/child/ChangedSupplies

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=
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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds the changed supply in the current plan using the primary key.
      Finder Variables
      • ComparedPlanId; number; Value that uniquely identifies the comparison plan.
    • RowFinder Finds the changed supply in the comparison plan using the primary key.
      Finder Variables
      • bComparedPlanId; integer;
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ActionChanged; string; Indicates whether an order's recommended action is different between plans. For example, an order where one plan suggests a reschedule in supply, while the same order in another plan has no recommended action. Valid value is 1: Action has changed, otherwise, the value is null.
    • ActionCodeComparisonPlan; string; Code that indicates the type of recommended change made by the planning engine to the supply or demand in the comparison plan. 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.
    • ActionCodeCurrentPlan; string; Code that indicates the type of recommended change made by the planning engine to the supply or demand in the current plan. 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.
    • ActionComparisonPlan; string; Value that indicates the type of recommended change made by the planning engine to the supply or demand in the comparison plan. Valid values include None, Cancel, Reschedule in, Reschedule out, Release, Release reservation, and Reschedule and release reservation. A list of accepted values is defined in the lookup type ORA_MSC_ACTIONS.
    • ActionCurrentPlan; string; Value that indicates the type of recommended change made by the planning engine to the supply or demand in the current plan. Valid values include None, Cancel, Reschedule in, Reschedule out, Release, Release reservation, and Reschedule and release reservation. A list of accepted values is defined in the lookup type ORA_MSC_ACTIONS.
    • CategoryId; string; Value that uniquely identifies the category.
    • CategoryName; string; Name of the category to which the item is assigned.
    • ComparedPlanId; number; Value that uniquely identifies the plan being compared.
    • FirmDateComparisonPlan; string; Date when supply is due in the comparison plan. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm.
    • FirmDateCurrentPlan; string; Date when supply is due in the current plan. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm.
    • FirmQuantityComparisonPlan; number; Fixed quantity of supply in the comparison plan. This attribute value can't be changed by planning and is only populated when the firm status is firm.
    • FirmQuantityCurrentPlan; number; Fixed quantity of supply in the current plan. This attribute value can't be changed by planning and is only populated when the firm status is firm.
    • FirmStatusComparisonPlan; string; Status that indicates whether the order is firm in the comparison plan. Valid values are Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
    • FirmStatusCurrentPlan; string; Status that indicates whether the order is firm in the current plan. Valid values are Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
    • InventoryItemId; integer; Value that uniquely identifies the item.
    • Item; string; Name of the item associated with the supply.
    • ItemDescription; string; Description of the item that's associated with the supply.
    • ItemStructureNameComparisonPlan; string; Name of the item structure planned to be used for the make order in the comparison plan.
    • ItemStructureNameCurrentPlan; string; Name of the item structure planned to be used for the make order in the current plan.
    • LineNumber; string; Number that identifies the order line.
    • NeedByDateComparisonPlan; string; Date when the supply quantity is needed in the comparison plan.
    • NeedByDateCurrentPlan; string; Date when the supply quantity is needed in the current plan.
    • NotesCount; integer; Number of notes associated with a supply order.
    • OrderNumber; string; Number that identifies the order associated with the supply.
    • OrderQuantityComparisonPlan; number; Quantity associated with the supply in the comparison plan.
    • OrderQuantityCurrentPlan; number; Quantity associated with the supply in the current plan.
    • OrderType; string; Abbreviation that identifies the type of order. A list of accepted values is defined in the lookup type MSC_ORDER_TYPE.
    • OrderTypeCode; number; 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; Name of the organization associated with the order.
    • OrganizationId; number; Value that uniquely identifies the organization.
    • PlanId; number; Value that uniquely identifies the plan.
    • PlanningAttributeNumber10ComparisonPlan; number; Value for the planning attribute number 10 in attribute-based planning in the comparison plan.
    • PlanningAttributeNumber10CurrentPlan; number; Value for the planning attribute number 10 in attribute-based planning in the current plan.
    • PlanningAttributeNumber11ComparisonPlan; integer; Value for the planning attribute number 11 in attribute-based planning in the comparison plan.
    • PlanningAttributeNumber11CurrentPlan; integer; Value for the planning attribute number 11 in attribute-based planning in the current plan.
    • PlanningAttributeNumber12ComparisonPlan; integer; Value for the planning attribute number 12 in attribute-based planning in the comparison plan.
    • PlanningAttributeNumber12CurrentPlan; integer; Value for the planning attribute number 12 in attribute-based planning in the current plan.
    • PlanningAttributeNumber13ComparisonPlan; integer; Value for the planning attribute number 13 in attribute-based planning in the comparison plan.
    • PlanningAttributeNumber13CurrentPlan; integer; Value for the planning attribute number 13 in attribute-based planning in the current plan.
    • PlanningAttributeNumber14ComparisonPlan; integer; Value for the planning attribute number 14 in attribute-based planning in the comparison plan.
    • PlanningAttributeNumber14CurrentPlan; integer; Value for the planning attribute number 14 in attribute-based planning in the current plan.
    • PlanningAttributeNumber15ComparisonPlan; integer; Value for the planning attribute number 15 in attribute-based planning in the comparison plan.
    • PlanningAttributeNumber15CurrentPlan; integer; Value for the planning attribute number 15 in attribute-based planning in the current plan.
    • PlanningAttributeNumber3ComparisonPlan; number; Value for the planning attribute number 3 in attribute-based planning in the comparison plan.
    • PlanningAttributeNumber3CurrentPlan; number; Value for the planning attribute number 3 in attribute-based planning in the current plan.
    • PlanningAttributeNumber4ComparisonPlan; number; Value for the planning attribute number 4 in attribute-based planning in the comparison plan.
    • PlanningAttributeNumber4CurrentPlan; number; Value for the planning attribute number 4 in attribute-based planning in the current plan.
    • PlanningAttributeNumber5ComparisonPlan; number; Value for the planning attribute number 5 in attribute-based planning in the comparison plan.
    • PlanningAttributeNumber5CurrentPlan; number; Value for the planning attribute number 5 in attribute-based planning in the current plan.
    • PlanningAttributeNumber6ComparisonPlan; number; Value for the planning attribute number 6 in attribute-based planning in the comparison plan.
    • PlanningAttributeNumber6CurrentPlan; number; Value for the planning attribute number 6 in attribute-based planning in the current plan.
    • PlanningAttributeNumber7ComparisonPlan; number; Value for the planning attribute number 7 in attribute-based planning in the comparison plan.
    • PlanningAttributeNumber7CurrentPlan; number; Value for the planning attribute number 7 in attribute-based planning in the current plan.
    • PlanningAttributeNumber8ComparisonPlan; number; Value for the planning attribute number 8 in attribute-based planning in the comparison plan.
    • PlanningAttributeNumber8CurrentPlan; number; Value for the planning attribute number 8 in attribute-based planning in the current plan.
    • PlanningAttributeNumber9ComparisonPlan; number; Value for the planning attribute number 9 in attribute-based planning in the comparison plan.
    • PlanningAttributeNumber9CurrentPlan; number; Value for the planning attribute number 9 in attribute-based planning in the current plan.
    • ProjectComparisonPlan; string; Value that identifies the project in the comparison plan.
    • ProjectCurrentPlan; string; Value that identifies the project in the current plan.
    • ProjectGroupValueComparisonPlan; string; Value that identifies the project group in the comparison plan.
    • ProjectGroupValueCurrentPlan; string; Value that identifies the project group in the current plan.
    • ReleaseStatusComparisonPlan; string; Code that indicates the release status of the order in the comparison plan. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.
    • ReleaseStatusCurrentPlan; string; Code that indicates the release status of the order in the current plan. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.
    • ReleaseStatusTextComparisonPlan; string; Value that indicates the release status of the order in the comparison plan. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.
    • ReleaseStatusTextCurrentPlan; string; Value that indicates the release status of the order in the current plan. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS.
    • RescheduleDaysComparisonPlan; number; Number of days to reschedule for a supply order in the comparison plan. 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.
    • RescheduleDaysCurrentPlan; number; Number of days to reschedule for a supply order in the current plan. 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.
    • RescheduledDaysChange; number; A supply order's difference in the number of reschedule days between the current plan and the comparison plan. A positive number means the supply order is rescheduled for later in the current plan. A negative number means the supply order is scheduled to be earlier in the current plan.
    • SourceOrgId; integer; Value that uniquely identifies the source organization.
    • SourceOrganization; string; Organization that will source the order.
    • SuggestedDueDateChange; number; The number of days that the suggested due date on an order differs between plans. For example, an order whose suggested due date differs by more than 5 days between plans.
    • SuggestedDueDateComparisonPlan; string; Date when the supply is recommended to be completed in the comparison plan.
    • SuggestedDueDateCurrentPlan; string; Date when the supply is recommended to be completed in the current plan.
    • Supplier; string; Name of the source supplier.
    • SupplierId; integer; Value that uniquely identifies the supplier.
    • SupplierSite; string; Abbreviation that indicates the specific supplier location from where the item is being sourced.
    • SupplierSiteId; integer; Value that uniquely identifies the supplier site.
    • TaskValueComparisonPlan; string; Value that identifies the task in the comparison plan.
    • TaskValueCurrentPlan; string; Value that identifies the task in the current plan.
    • TransactionId; integer; Value that uniquely identifies the supply transaction. This value is internally generated by the application.
    • UOM; string; Name of the unit of measure associated with the order quantity.
    • UOMCode; string; Abbreviation that identifies the unit of measure associated with the order quantity.
    • WorkDefinitionComparisonPlan; string; Name that uniquely identifies a work definition used for a make order in the comparison plan.
    • WorkDefinitionCurrentPlan; string; Name that uniquely identifies a work definition used for a make order in the current plan.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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-ChangedSupplies
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : supplyPlans-ChangedSupplies-item-response
Type: object
Show Source
Back to Top