1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Plan Inputs
  5. Component Items
  6. Substitute Items

Get all substitute component items

get

/fscmRestApi/resources/11.13.18.05/planInputs/{PlanInputId}/child/ComponentItems/{ComponentItemsUniqID}/child/SubstituteItems

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- BillSequenceId, ComponentSequenceId, NewPlanId, OrganizationId, PlanId, SimulationSetId, BillSequenceIdSecondary, NewPlanIdSecondary, OrganizationIdSecondary, PlanIdSecondary and SimulationSetIdSecondary ---for the Component Items resource and used to uniquely identify an instance of Component Items. The client should not generate the hash key value. Instead, the client should query on the Component Items collection resource with a filter on the primary key values in order to navigate to a specific instance of Component Items.

    For example: ComponentItems?q=BillSequenceId=<value1>;ComponentSequenceId=<value2>;NewPlanId=<value3>;OrganizationId=<value4>;PlanId=<value5>;SimulationSetId=<value6>;BillSequenceIdSecondary=<value7>;NewPlanIdSecondary=<value8>;OrganizationIdSecondary=<value9>;PlanIdSecondary=<value10>;SimulationSetIdSecondary=<value11>
  • 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 substitute item using the primary key.
      Finder Variables
      • BillSequenceId; integer; Value that uniquely identifies the sequence in which a component is used within an operation.
      • ComponentSequenceId; integer; Value that uniquely identifies the component on the source application instance.
      • NewPlanId; integer; Value that uniquely identifies the new plan that the duplication process creates.
      • OrganizationId; integer; Value that uniquely identifies the organization.
      • PlanId; integer; Value that uniquely identifies the plan.
      • SimulationSetId; integer; Value that uniquely identifies the simulation set.
      • SubstituteSequenceId; integer; Value that uniquely identifies the substitute component on the source application instance.
  • 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:
    • AssemblyItem; string; Name of the assembly item.
    • AssemblyItemId; string; Unique identifier of the assembly item.
    • BillSequenceId; integer; Value that uniquely identifies the sequence in which a component is used within an operation.
    • ChangeIndicatorFlag; boolean; Value that identifies whether the substitute component has been modified. Valid values are true or false. If true, then the row is new or modified. If false, then the row isn't new or modified.
    • ComponentItem; string; Name of the component item being consumed.
    • ComponentItemId; string; Unique identifier of the component item.
    • ComponentSequenceId; integer; Value that uniquely identifies the component on the source application instance.
    • EnforceIntegerRequirement; string; Specifies whether the result of a component's calculated quantity or inverse quantity is required to be an integer. Valid values for this option are None, Round up, and Round down.
    • FindNumber; string; Number used to locate a specific instance of an item in a structure. This number enables users to define multiple occurrences of the same component for an assembly in its item structure.
    • LastUpdateDate; string; Date when the component item was last updated.
    • LastUpdatedBy; string; Name of the user who last updated the component item.
    • NewPlanId; integer; Value that uniquely identifies the new plan that the duplication process creates.
    • OperationSequenceNumber; string; Order in which the operation occurs.
    • Organization; string; Name of the organization.
    • OrganizationCode; string; Organization code for the assembly item.
    • OrganizationId; integer; Unique identifier of the organization.
    • PlanId; integer; Value that uniquely identifies the supply plan associated with the component item
    • SimulationSetId; integer; Value that uniquely identifies the simulation set.
    • SubstituteComponent; string; Name of the substitute component.
    • SubstituteComponentDescription; string; Description of the substitute component.
    • SubstituteComponentId; integer; Unique identifier of the substitute component item.
    • SubstituteComponentPriority; integer; A numeric value indicating the priority of the object.
    • SubstituteComponentQuantity; number; Quantity needed when using a substitute item in place of the original component item.
    • SubstituteComponentUOM; string; Unit of measure of the substitute component item.
    • SubstituteComponentUOMCode; string; Unit of measure code of the substitute component item.
    • SubstituteSequenceId; integer; Value that uniquely identifies the substitute component on the source application instance.
  • 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 : planInputs-ComponentItems-SubstituteItems
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : planInputs-ComponentItems-SubstituteItems-item-response
Type: object
Show Source
Back to Top