Get details of one resource requirement
get
/fscmRestApi/resources/11.13.18.05/planInputs/{PlanInputId}/child/ResourceRequirements/{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: string
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: string
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : planInputs-ResourceRequirements-item-response
Type:
Show Source
object
-
ActualStartDate: string
(date)
Read Only:
true
Actual operation start date. This is the first day that the resource is required for production. -
AlternateNumber: integer
Read Only:
true
Alternate number of the corresponding operation resource. -
AssemblyItemId: integer
(int64)
Read Only:
true
Assembly that uses the resource for the production generating resource requirement. -
AssignedUnits: number
Read Only:
true
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
Read Only:
true
Maximum Length:255
Name of the plan. -
ConstrDateAdditionalCap: number
Read Only:
true
Additional capacity required by the resource computed by the planning engine on the resource constraint date. -
ConstrDateResourceCapacity: number
Read Only:
true
Total capacity required by the resource computed by the planning engine on the resource constraint date. -
ConsumptionStartDate: string
(date)
Read Only:
true
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
Read Only:
true
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
Read Only:
true
Maximum Length:4000
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
Read Only:
true
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
Read Only:
true
Maximum Length:4000
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
Read Only:
true
Maximum Length:64
Indicates the user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Indicates the date and time of the creation of the row. -
CummulativeQuantity: number
Read Only:
true
Indicates the total resource requirement of the resource. -
DepartmentCode: string
Read Only:
true
Maximum Length:120
Value that uniquely identifies the department that the resource belongs to. -
DepartmentId: integer
(int64)
Read Only:
true
Department identifier or the work center of the resource. -
Description: string
Read Only:
true
Maximum Length:4000
Description of the resource. -
EarliestStartDate: string
(date)
Read Only:
true
Earliest start date for improved exceptions. -
EndDate: string
(date)
Read Only:
true
End date of the resource requirement. The resource isn't required after this date. -
ExecutionSequence: number
Read Only:
true
Indicates the execution sequence number of the operation if the work order has resequence operations. -
FirmEndDate: string
(date)
Read Only:
true
End date marked as firm so that it doesn't change during replan. -
FirmPlannedType: integer
Read Only:
true
Indicates whether the resource requirement is marked as firm. -
FirmStartDate: string
(date)
Read Only:
true
Start date is marked to be firm. -
FirmStatus: string
Read Only:
true
Maximum Length:4000
Description of how a resource requirement is firmed. -
FixedLeadTime: number
Read Only:
true
Value of the Fixed Lead Time. This is used irrespective of the quantity being manufactured. -
HoursExpended: number
Read Only:
true
Hours expended on a resource of a job. -
ItemName: string
Read Only:
true
Maximum Length:4000
Value that uniquely identifies the assembly item associated with the resource requirement. -
LastUpdateDate: string
(date-time)
Read Only:
true
Indicates the date and time of the last update of the row. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Indicates the session sign-in associated with the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaterialAvailDate: string
(date)
Read Only:
true
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
Read Only:
true
Number of maximum resource units assigned to perform the operation. -
NeedByDate: string
(date)
Read Only:
true
Date on which a resource requirement should be complete to meet the demand on time. -
NewScheduleDate: string
(date)
Read Only:
true
Value that indicates the new schedule date of the resource requirement demand. -
OperationCost: number
Read Only:
true
Value that indicates the outside processing operation cost. -
OperationSequenceId: integer
Read Only:
true
Operation sequence identifier of the operation where the resource requirement is generated. -
OperationSequenceNumber: integer
Read Only:
true
Sequence number of the operation for the resource requirement. -
OrderNumber: string
Read Only:
true
Maximum Length:240
Value that uniquely identifies the order number of the supply that generates the resource requirement. -
OrganizationCode: string
Read Only:
true
Maximum Length:4000
Indicates the organization identifier. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization that the department resource belongs to. -
OSPOperationType: integer
Read Only:
true
Value that indicates the type of outside processing operation. -
OSPOperationTypeStr: string
Read Only:
true
Maximum Length:4000
Descriptive value of the type of resource requirements, whether In-House or Supplier. -
ParentId: integer
(int64)
Read Only:
true
Reference to the parent transaction identifier of the resource requirement. -
PlanId: integer
Read Only:
true
Value that uniquely identifies the plan associated with the resource requirements of a resource. -
QuantityInQueue: number
Read Only:
true
Number of units in the queue of the operation. -
ResourceCode: string
Read Only:
true
Maximum Length:40
Identifier of the resource associated with the resource requirement. -
ResourceConstraintDate: string
(date)
Read Only:
true
Date populated by the planning engine process for a bottleneck or resource marked critical because it's constrained. -
ResourceHours: number
Read Only:
true
Value that indicates the resource hours required. -
ResourceId: integer
Read Only:
true
Value that uniquely identifies the resource. -
ResourceSequenceNumber: integer
Read Only:
true
Identifier of the planned resource sequence for the operation requirement. -
ResourceUOMCode: string
Read Only:
true
Maximum Length:4000
Identifier of the unit of measure of the resource. -
RoutingSequenceId: integer
Read Only:
true
Routing sequence identifier for the routing or the work definition. -
SchedulePriority: number
Read Only:
true
Order priority of the resource requirement. -
ScheduleType: integer
Read Only:
true
Schedule identifier on the resource. If this is set then the resource is used in planning. -
ScheduleTypeCode: string
Read Only:
true
Maximum Length:4000
Descriptive value of how the resource requirement is scheduled. -
StartDate: string
(date)
Read Only:
true
Start date of the resource requirement. -
Supplier: string
Read Only:
true
Maximum Length:4000
Value that identifies the supplier of an outside processing operation. -
SupplierId: integer
(int64)
Read Only:
true
Value that indicates the unique supplier identifier of an outside processing operation. -
SupplierSite: string
Read Only:
true
Maximum Length:4000
Value that uniquely identifies the supplier site of an outside processing operation. -
SupplierSiteId: integer
(int64)
Read Only:
true
Value that indicates the unique supplier site identifier for an outside processing operation in the planning system. -
SupplyId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supply generating the Resource Requirements resource. -
SupplyType: integer
Read Only:
true
Value that indicates the type of supply generating the resource requirement. -
SupplyTypeCode: string
Read Only:
true
Maximum Length:4000
Descriptive value of the supply type generating the Resource Requirements resource. -
TimezoneName: string
Read Only:
true
Maximum Length:4000
Value that uniquely identifies the time zone. -
TotalResourceHours: number
Read Only:
true
Total inflated resource hours required for an activity of a job. -
TransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies a resource requirement entry. -
UnadjustedResourceHours: number
Read Only:
true
Resource hours unadjusted for utilization and efficiency. -
UOMCode: string
Read Only:
true
Maximum Length:4000
Value that uniquely identifies the unit of measure. -
UsageRate: number
Read Only:
true
Rate per assembly or amount per job or schedule. -
VariableLeadTime: number
Read Only:
true
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
Read Only:
true
Maximum Length:120
Value that uniquely identifies the work area that the department resource belongs to. -
WorkAreaId: integer
(int64)
Read Only:
true
Value indicates the work area identifier of the department resource. -
Yield: number
Read Only:
true
Indicates the operation yield that uses the resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.