1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Plan Inputs
  5. Resource Requirements

Get details of all resource requirements

get

/fscmRestApi/resources/11.13.18.05/planInputs/{PlanInputId}/child/ResourceRequirements

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 resource requirements according to the value that identifies the resource requirements.
      Finder Variables
      • PlanId; integer; Value that uniquely identifies the demand and supply plan associated with the resource requirements of a resource.
      • TransactionId; integer; Value that uniquely identifies resource requirements associated with a resource.
    • TransactionIdFinder Finds resource requirement attributes specific to the resource.
      Finder Variables
      • TransactionId; integer; Value that uniquely identifies resource requirements.
  • 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:
    • ActualStartDate; string; Actual operation start date. This is the first day that the resource is required for production.
    • AlternateNumber; integer; Alternate number of the corresponding operation resource.
    • AssemblyItemId; integer; Assembly that uses the resource for the production generating resource requirement.
    • AssignedUnits; number; Number of resource units assigned to perform the operation. For example assigned units of 2 means that two of that resource are used.
    • CompileDesignator; string; Name of the plan.
    • ConstrDateAdditionalCap; number; Additional capacity required by the resource computed by the planning engine on the resource constraint date.
    • ConstrDateResourceCapacity; number; Total capacity required by the resource computed by the planning engine on the resource constraint date.
    • ConsumptionStartDate; string; Start date of the next resource requirement in the sequence. If this is the last resource requirement in the supply, then this date is the same as the consumption start date of the supply.
    • ContributesDmdLateness; number; This attribute value is Yes, if the Need by Date - Earliest Start Date is less than the lead time of the resource requirement.
    • ContributesDmdLatenessCode; string; Indicates whether the lead time of the resource requirement is greater than the difference between the need-by date and the earliest start date of the resource in a supply plan. If Yes, then it's greater. If no, then it isn't. The default value is Yes.
    • ContributesOverload; number; The resource requirement has this attribute set to Yes if it belongs to a time bucket in which the resource capacity is overloaded.
    • ContributesOverloadCode; string; Indicates whether the resource requirement belongs to a time bucket in which the resource capacity is overloaded in a supply plan. If Yes, then it does. If no, then it doesn't. The default value is Yes.
    • CreatedBy; string; Indicates the user who created the row.
    • CreationDate; string; Indicates the date and time of the creation of the row.
    • CummulativeQuantity; number; Indicates the total resource requirement of the resource.
    • DepartmentCode; string; Value that uniquely identifies the department that the resource belongs to.
    • DepartmentId; integer; Department identifier or the work center of the resource.
    • Description; string; Description of the resource.
    • EarliestStartDate; string; Earliest start date for improved exceptions.
    • EndDate; string; End date of the resource requirement. The resource isn't required after this date.
    • ExecutionSequence; number; Indicates the execution sequence number of the operation if the work order has resequence operations.
    • FirmEndDate; string; End date marked as firm so that it doesn't change during replan.
    • FirmPlannedType; integer; Indicates whether the resource requirement is marked as firm.
    • FirmStartDate; string; Start date is marked to be firm.
    • FirmStatus; string; Description of how a resource requirement is firmed.
    • FixedLeadTime; number; Value of the Fixed Lead Time. This is used irrespective of the quantity being manufactured.
    • HoursExpended; number; Hours expended on a resource of a job.
    • ItemName; string; Value that uniquely identifies the assembly item associated with the resource requirement.
    • LastUpdateDate; string; Indicates the date and time of the last update of the row.
    • LastUpdateLogin; string; Indicates the session sign-in associated with the user who last updated the row.
    • LastUpdatedBy; string; Indicates the user who last updated the row.
    • MaterialAvailDate; string; Completion date of the previous resource requirement in the sequence. If this is the first resource requirement in the supply, then this date is the same as the material available date of the supply.
    • MaximumAssignedUnits; number; Number of maximum resource units assigned to perform the operation.
    • NeedByDate; string; Date on which a resource requirement should be complete to meet the demand on time.
    • NewScheduleDate; string; Value that indicates the new schedule date of the resource requirement demand.
    • OSPOperationType; integer; Value that indicates the type of outside processing operation.
    • OSPOperationTypeStr; string; Descriptive value of the type of resource requirements, whether In-House or Supplier.
    • OperationCost; number; Value that indicates the outside processing operation cost.
    • OperationSequenceId; integer; Operation sequence identifier of the operation where the resource requirement is generated.
    • OperationSequenceNumber; integer; Sequence number of the operation for the resource requirement.
    • OrderNumber; string; Value that uniquely identifies the order number of the supply that generates the resource requirement.
    • OrganizationCode; string; Indicates the organization identifier.
    • OrganizationId; integer; Value that uniquely identifies the organization that the department resource belongs to.
    • ParentId; integer; Reference to the parent transaction identifier of the resource requirement.
    • PlanId; integer; Value that uniquely identifies the plan associated with the resource requirements of a resource.
    • QuantityInQueue; number; Number of units in the queue of the operation.
    • ResourceCode; string; Identifier of the resource associated with the resource requirement.
    • ResourceConstraintDate; string; Date populated by the planning engine process for a bottleneck or resource marked critical because it's constrained.
    • ResourceHours; number; Value that indicates the resource hours required.
    • ResourceId; integer; Value that uniquely identifies the resource.
    • ResourceSequenceNumber; integer; Identifier of the planned resource sequence for the operation requirement.
    • ResourceUOMCode; string; Identifier of the unit of measure of the resource.
    • RoutingSequenceId; integer; Routing sequence identifier for the routing or the work definition.
    • SchedulePriority; number; Order priority of the resource requirement.
    • ScheduleType; integer; Schedule identifier on the resource. If this is set then the resource is used in planning.
    • ScheduleTypeCode; string; Descriptive value of how the resource requirement is scheduled.
    • StartDate; string; Start date of the resource requirement.
    • Supplier; string; Value that identifies the supplier of an outside processing operation.
    • SupplierId; integer; Value that indicates the unique supplier identifier of an outside processing operation.
    • SupplierSite; string; Value that uniquely identifies the supplier site of an outside processing operation.
    • SupplierSiteId; integer; Value that indicates the unique supplier site identifier for an outside processing operation in the planning system.
    • SupplyId; integer; Value that uniquely identifies the supply generating the Resource Requirements resource.
    • SupplyType; integer; Value that indicates the type of supply generating the resource requirement.
    • SupplyTypeCode; string; Descriptive value of the supply type generating the Resource Requirements resource.
    • TimezoneName; string; Value that uniquely identifies the time zone.
    • TotalResourceHours; number; Total inflated resource hours required for an activity of a job.
    • TransactionId; integer; Value that uniquely identifies a resource requirement entry.
    • UOMCode; string; Value that uniquely identifies the unit of measure.
    • UnadjustedResourceHours; number; Resource hours unadjusted for utilization and efficiency.
    • UsageRate; number; Rate per assembly or amount per job or schedule.
    • VariableLeadTime; number; Variable lead time used in conjunction with the quantity of the assembly being manufactured. This is used to compute the duration of the outside processing operation.
    • WorkAreaCode; string; Value that uniquely identifies the work area that the department resource belongs to.
    • WorkAreaId; integer; Value indicates the work area identifier of the department resource.
    • Yield; number; Indicates the operation yield that uses the resource.
  • 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-ResourceRequirements
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : planInputs-ResourceRequirements-item-response
Type: object
Show Source
Back to Top