1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Manufacturing
  4. Process Work Orders
  5. Work Order Resources

Get all resources

get

/fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/ProcessWorkOrderResource

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Process Work Orders resource and used to uniquely identify an instance of Process Work Orders. The client should not generate the hash key value. Instead, the client should query on the Process Work Orders collection resource in order to navigate to a specific instance of Process Work Orders to get the hash key.
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
      Finder Variables:
      • WorkOrderOperationResourceId
  • 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:
    • ActualResourceUsage; number; Net actual usage of the assigned resource.
    • BasisType; string; Value that indicates whether the resource quantity is fixed; for example, usage per lot produced, or variable; for example, usage per item produced. A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE.
    • ChargeType; string; Value that indicates whether resource transactions are automatically generated and at what stage. A list of accepted values is defined in the lookup type ORA_WIS_CHARGE_TYPE.
    • CreatedBy; string; User who created the process work order operation resource.
    • CreationDate; string; Date when the used created the work order operation resource.
    • EquipmentProfileCode; string; Abbreviation that identifies the equipment profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in.
    • EquipmentProfileId; integer; Value that uniquely identifies the equipment profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in.
    • LastUpdateDate; string; Date when the user most recently updated the work order operation resource.
    • LastUpdatedBy; string; User who updated the process work order resource.
    • OperationName; string; Name of the operation that processes the resource.
    • OperationSequenceNumber; number; Number that indicates the sequence to use when performing the work order operations.
    • OrganizationId; integer; Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization.
    • PlannedCompletionDate; string; Planned date and time till the resource is engaged for the operation. The scheduling application sets this date. The planned completion date must not occur before the operation start date or after the operation finish date. This attribute is required.
    • PlannedStartDate; string; Planned date and time to engage the resource for the operation. The scheduling application sets this date. The planned start date must not occur before the operation start date or after the operation finish date. This attribute is required.
    • PrincipalFlag; boolean; Contains one of the following values: true or false. If true, then this resource is the principal resource among the group of simultaneous resources for that operation sequence. If false, then this resource is not the principal resource. This attribute does not have a default value.
    • ProfileCode; string; Abbreviation that identifies the job profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in.
    • ProfileId; integer; Value that uniquely identifies the job profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in.
    • RequiredUsage; number; Resource usage that the plant requires to make the work order quantity. The application calculates this value depending on whether the basis type is fixed or variable. Fixed: the required usage equals the usage rate. Variable: the required usage equals the usage rate multiplied by the work order quantity.
    • ResourceCode; string; Abbreviation that identifies the resource.
    • ResourceId; integer; Value that uniquely identifies the resource. It's a primary key that the application generates when it creates the resource.
    • ResourceName; string; Name of the resource.
    • ResourceSequenceNumber; number; Number that the application uses to determine the step in the sequence it must use to make sure resources work together correctly to finish the operation. If multiple resource lines include the same resource sequence number, then the application schedules them to occur at the same time.
    • ResourceType; string; Type of the resource. Values include Labor or Equipment.
    • ScheduledIndicator; string; Contains one of the following values: true or false. If true, then scheduling schedules the resource and computes the start date and completion date. If false, then scheduling does not schedule the resource and sets the start date equal to the completion date. The default value is true.
    • StandardOperationCode; string; Abbreviation that identifies the standard operation.
    • StandardOperationId; integer; Value that uniquely identifies the standard operation of a work order. It's a primary key that the application generates when it creates the operation.
    • WorkAreaCode; string; Abbreviation that identifies the work area.
    • WorkAreaId; integer; Value that uniquely identifies the work area. It's a primary key that the application generates when it creates the work area.
    • WorkCenterCode; string; Abbreviation that identifies the work center.
    • WorkCenterId; integer; Value that uniquely identifies the work center. It's a primary key that the application generates when it creates the work center.
    • WorkOrderId; integer; Value that uniquely identifies the work order. It's a primary key that the application generates when it creates the work order.
    • WorkOrderOperationId; integer; Value that uniquely identifies the work order operation. It's a primary key that the application generates when it creates the work order operation.
    • WorkOrderOperationResourceId; integer; Value that uniquely identifies the resource for the work order operation. It's a primary key that the application generates when it creates the resource for the work order operation.
  • 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 : processWorkOrders-ProcessWorkOrderResource
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : processWorkOrders-ProcessWorkOrderResource-item-response
Type: object
Show Source
  • Title: Actual Resource Usage
    Read Only: true
    Net actual usage of the assigned resource.
  • Title: Assigned Units
    Default Value: 1
    Number of resource units required to perform the operation.
  • Title: Basis
    Maximum Length: 30
    Default Value: 1
    Value that indicates whether the resource quantity is fixed; for example, usage per lot produced, or variable; for example, usage per item produced. A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE.
  • Title: Charge Type
    Maximum Length: 30
    Value that indicates whether resource transactions are automatically generated and at what stage. A list of accepted values is defined in the lookup type ORA_WIS_CHARGE_TYPE.
  • Read Only: true
    Maximum Length: 64
    User who created the process work order operation resource.
  • Read Only: true
    Date when the used created the work order operation resource.
  • Maximum Length: 255
    Abbreviation that identifies the equipment profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in.
  • Title: Equipment Profile
    Value that uniquely identifies the equipment profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in.
  • Read Only: true
    Date when the user most recently updated the work order operation resource.
  • Read Only: true
    Maximum Length: 64
    User who updated the process work order resource.
  • Links
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the operation that processes the resource.
  • Title: Operation Sequence
    Read Only: true
    Number that indicates the sequence to use when performing the work order operations.
  • Read Only: true
    Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization.
  • Read Only: true
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the resource associated with this operation is pulled in as part of a phantom explosion that pulled in the resources from the work definition of a phantom material tied to the operation. If false, then the resource is not a part of phantom explosion. The default value is false.
  • Title: Completion Date
    Planned date and time till the resource is engaged for the operation. The scheduling application sets this date. The planned completion date must not occur before the operation start date or after the operation finish date. This attribute is required.
  • Title: Start Date
    Planned date and time to engage the resource for the operation. The scheduling application sets this date. The planned start date must not occur before the operation start date or after the operation finish date. This attribute is required.
  • Title: Principal
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then this resource is the principal resource among the group of simultaneous resources for that operation sequence. If false, then this resource is not the principal resource. This attribute does not have a default value.
  • Maximum Length: 255
    Abbreviation that identifies the job profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in.
  • Value that uniquely identifies the job profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in.
  • Title: Required Usage
    Resource usage that the plant requires to make the work order quantity. The application calculates this value depending on whether the basis type is fixed or variable. Fixed: the required usage equals the usage rate. Variable: the required usage equals the usage rate multiplied by the work order quantity.
  • Title: Activity
    Maximum Length: 30
    Abbreviation that identifies the resource activity.
  • Resource Attachments
    Title: Resource Attachments
    The Resource Attachments resource manages the attachments for a resource.
  • Title: Code
    Maximum Length: 30
    Abbreviation that identifies the resource.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the resource.
  • Flexfields for Resources
    Title: Flexfields for Resources
    The Flexfields for Resources resource manages descriptive flexfields that contain details about the resources that the work order operations use.
  • Exceptions for Operation Resources
    Title: Exceptions for Operation Resources
    The Exceptions for Operation Resources resource gets the count of exceptions that occurred for a resource during the operation.
  • Value that uniquely identifies the resource. It's a primary key that the application generates when it creates the resource.
  • Resource Instances
    Title: Resource Instances
    The Resource Instances resource manages the instances of a work order operation. Each instance supports an equipment resource or labor resource.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the resource.
  • Title: Sequence
    Number that the application uses to determine the step in the sequence it must use to make sure resources work together correctly to finish the operation. If multiple resource lines include the same resource sequence number, then the application schedules them to occur at the same time.
  • Title: Type
    Read Only: true
    Maximum Length: 30
    Type of the resource. Values include Labor or Equipment.
  • Title: Scheduled
    Maximum Length: 30
    Contains one of the following values: true or false. If true, then scheduling schedules the resource and computes the start date and completion date. If false, then scheduling does not schedule the resource and sets the start date equal to the completion date. The default value is true.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the standard operation.
  • Read Only: true
    Value that uniquely identifies the standard operation of a work order. It's a primary key that the application generates when it creates the operation.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Unit of measure that the resource uses.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure that the resource uses.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work area.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work area.
  • Read Only: true
    Value that uniquely identifies the work area. It's a primary key that the application generates when it creates the work area.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the work area.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the work center.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work center.
  • Value that uniquely identifies the work center. It's a primary key that the application generates when it creates the work center.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the work center.
  • Read Only: true
    Value that uniquely identifies the work order. It's a primary key that the application generates when it creates the work order.
  • Value that uniquely identifies the work order operation. It's a primary key that the application generates when it creates the work order operation.
  • Read Only: true
    Value that uniquely identifies the resource for the work order operation. It's a primary key that the application generates when it creates the resource for the work order operation.
Nested Schema : Resource Attachments
Type: array
Title: Resource Attachments
The Resource Attachments resource manages the attachments for a resource.
Show Source
Nested Schema : Flexfields for Resources
Type: array
Title: Flexfields for Resources
The Flexfields for Resources resource manages descriptive flexfields that contain details about the resources that the work order operations use.
Show Source
Nested Schema : Exceptions for Operation Resources
Type: array
Title: Exceptions for Operation Resources
The Exceptions for Operation Resources resource gets the count of exceptions that occurred for a resource during the operation.
Show Source
Nested Schema : Resource Instances
Type: array
Title: Resource Instances
The Resource Instances resource manages the instances of a work order operation. Each instance supports an equipment resource or labor resource.
Show Source
Nested Schema : processWorkOrders-ProcessWorkOrderResource-ResourceAttachment-item-response
Type: object
Show Source
Nested Schema : processWorkOrders-ProcessWorkOrderResource-ResourceDFF-item-response
Type: object
Show Source
Nested Schema : processWorkOrders-ProcessWorkOrderResource-ResourceExceptionCount-item-response
Type: object
Show Source
Nested Schema : processWorkOrders-ProcessWorkOrderResource-ResourceInstance-item-response
Type: object
Show Source
Nested Schema : Flexfields for Resource Instances
Type: array
Title: Flexfields for Resource Instances
The Flexfields for Resource Instances resource manages descriptive flexfields that contain details about the resource instance.
Show Source
Nested Schema : processWorkOrders-ProcessWorkOrderResource-ResourceInstance-ResourceInstanceDFF-item-response
Type: object
Show Source
  • Title: Context Segment
    Maximum Length: 80
    Descriptive flexfield context name for work order operation resource instance.
  • Title: Context Segment
    Descriptive flexfield context display value for work order operation resource instance.
  • Links
  • Value that uniquely identifies an output of a work order operation resource instance. It's a primary key that the application generates when it creates the work order operation resource instance.
Back to Top