Get one resource

get

/fscmRestApi/resources/11.13.18.05/maintenanceWorkOrders/{WorkOrderId}/child/WorkOrderOperation/{WoOperationId}/child/WorkOrderOperationResource/{WoOperationResourceId}

Request

Path Parameters
  • Value that uniquely identifies the work order operation. This attribute is read-only. The value of this attribute is generated when the application creates the work order operation.
  • Value that uniquely identifies the work order operation resource. It is a primary key that the application generates when it creates the work order operation resource.
  • Value that uniquely identifies the work order. This attribute is read-only. The value of this attribute is derived from the work order number when the application creates the work order.
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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationResource-item-response
Type: object
Show Source
  • Title: Assigned Units
    Default Value: 1
    Number of resource units required to perform the operation.
  • Title: Basis
    Maximum Length: 30
    Default Value: 1
    Contains one of the following values: 1 or 2. If 1, then the resource consumption is fixed. It does not change according to work order quantity. If 2, then the resource consumption is not fixed. It might change according to work order quantity. The default value is 2. A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE. For maintenance work orders the work order quantity is always one.
  • Title: Charge Type
    Maximum Length: 30
    Abbreviation that identifies how the resource is charged. A list of accepted values is defined in the lookup type ORA_WIS_CHARGE_TYPE. The charge type is required. Valid values include MANUAL or AUTOMATIC. For a count point operation, the value must be AUTOMATIC for automatic transact operations and MANUAL for optional operations.
  • Maximum Length: 255
    Abbreviation that uniquely identifies the qualification profile. Values are predefined and created for equipment qualifications. This attribute is applicable only for equipment type resources. When it's specified, only those equipment resource instances that meet the qualifications can be reported for resource transactions. It's a non-mandatory attribute for a work order operation resource.
  • Title: Equipment Profile
    Value that uniquely identifies the qualification profile. Values are predefined and created for equipment qualifications. This attribute is applicable only for equipment type resources. When it's specified, only those equipment resource instances that meet the qualifications can be reported for resource transactions. It's a non-mandatory attribute for a work order operation resource.
  • Links
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the operation to which the operation resource belongs. This attribute is read-only. The value of this attribute is derived from the work order operation.
  • Title: Operation Sequence
    Read Only: true
    Number that identifies the sequence to use when performing the work order operations to which the operation resource belongs. This attribute is read-only. The value of this attribute is derived from the work order operation.
  • Value that uniquely identifies the organization where the operation is performed. This attribute is read-only. The value of this attribute is derived from the work order organization.
  • Title: Completion Date
    Date when the resource is planned to finish. 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. The default value is the operation end date.
  • Title: Start Date
    Date when the resource is planned to start. 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. The default value is the operation start date.
  • 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. If false, then this resource is not the principal resource. Note that one of the simultaneous resources must be a principal resource. The default value is false.
  • Maximum Length: 255
    Indicates the skills and qualifications that make up the resource's job profile. The lookup value is taken from the employee's human resource talent profile and must be a valid and active PROFILE_CODE.
  • Value that uniquely identifies the work order operation resource's job profile. The application generates this key value.
  • Maximum Length: 255
    Abbreviation that identifies the reason for repair of the maintenance work order operation resource. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Reason for repair.
  • Title: Name
    Read Only: true
    Maximum Length: 240
    Name of the reason for the repair code.
  • Maximum Length: 255
    Abbreviation that identifies the repair transaction for the maintenance work order operation resource. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Repair Transaction.
  • Title: Name
    Read Only: true
    Maximum Length: 240
    Name of the repair transaction code.
  • Title: Required Usage
    Resource usage that the plant requires to make the required 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 is the product of the usage rate and the work order quantity. For maintenance work orders the work order quantity is always one.
  • Maximum Length: 255
    Abbreviation that identifies the resource assigned to the work order operation. You must provide either the resource identifier or the resource code to create an operation resource.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the operation of the resource assigned to the work order operation such as labor or equipment. This attribute is read-only. The value of this attribute is derived from the resource.
  • Value that uniquely identifies the resource assigned to the work order operation. You must provide either the resource identifier or the resource code to create a work order operation resource.
  • Title: Sequence
    Number that indicates the unique sequence of the resource assigned to the work order operation. The sequence is required to create an operation resource. The resource sequence number can be same for more than one resource and they are called simultaneous resources. For simultaneous resources one of the resources must be a principal resource. When principal resource has scheduled = YES, then other resources have schedule = YES or NO, but when principal resource has scheduled = NO, other resources should have scheduled = NO.
  • Title: Type
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the type of the resource assigned to the work order operation such as labor or equipment. This attribute is read-only. The value of this attribute is derived from the resource.
  • Title: Scheduled
    Read Only: true
    Maximum Length: 30
    This attribute is not currently used for Oracle Maintenance Cloud. You must use the ScheduledIndicator attribute instead.
  • Contains one of the following values: YES or NO. If YES, then scheduling schedules the resource and computes the start date and completion dates. If NO, then scheduling does not schedule the resource and it sets the start date equal to the completion date. A list of accepted values is defined in the lookup type ORA_WIS_RESOURCE_SCHEDULE. The default value is YES.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the standard operation the operation is referring to. This attribute is read-only. The value of this attribute is derived from the operation.
  • Read Only: true
    Value that uniquely identifies the standard operation the operation is referring to. This attribute is read-only. The value of this attribute is derived from the operation.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Unit of measure of the resource consumption. This attribute is read-only. The value of this attribute is derived from the resource.
  • Title: Usage Rate
    Resource usage rate that the plant requires to make the required work order quantity. The resource usage rate is used to calculate the required usage based on the basis type and the work order quantity. For maintenance work orders the work order quantity is always one.
  • Value that uniquely identifies the work order operation. This is a prepopulated row. This attribute is read-only. The value of this attribute is derived from the work order operation.
  • Read Only: true
    Value that uniquely identifies the work order operation resource. It is a primary key that the application generates when it creates the work order operation resource.
  • Maximum Length: 255
    Abbreviation that identifies the work accomplished against the maintenance work order operation resource. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Reason for repair.
  • Title: Name
    Read Only: true
    Maximum Length: 240
    Name of the work accomplished code.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that uniquely identifies the work area in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation work center.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work area in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation work center.
  • Read Only: true
    Value that uniquely identifies the work area in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation work center.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the work area in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation work center.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work center in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the work center identifier.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the work center in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation.
  • Read Only: true
    Value that uniquely identifies the work order to which the operation resource belongs. This attribute is read-only. The value of this attribute is derived from the work order.
  • 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.
  • Resource Instances
    Title: Resource Instances
    The Resource Instances for Maintenance Work Orders resource manages the resource instances that the work order requires to perform a maintenance operation.
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 : Resource Instances
Type: array
Title: Resource Instances
The Resource Instances for Maintenance Work Orders resource manages the resource instances that the work order requires to perform a maintenance operation.
Show Source
Nested Schema : maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationResource-WorkOrderOperationResourceDFF-item-response
Type: object
Show Source
Nested Schema : maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationResource-WorkOrderOperationResourceInstance-item-response
Type: object
Show Source
  • Maximum Length: 255
    Abbreviation that identifies the equipment resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the equipment instance identifier.
  • Value that uniquely identifies the equipment resource instance assigned to the operation resource. You must provide either the equipment resource identifier or a labor resource identifier to create an operation resource instance.
  • Title: Identifier
    Read Only: true
    Maximum Length: 80
    Value that uniquely identifies the equipment resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the equipment instance identifier.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the equipment resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the equipment instance identifier.
  • Maximum Length: 255
    Abbreviation that identifies the labor resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the labor instance identifier.
  • Value that uniquely identifies the labor resource instance assigned to the operation resource. You must provide either the equipment resource identifier or a labor resource identifier to create an operation resource instance.
  • Title: Identifier
    Read Only: true
    Maximum Length: 30
    Value that uniquely identifies the labor resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the labor instance identifier.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    Name of the labor resource instance assigned to the operation resource. This attribute is read-only. The value of this attribute is derived from the equipment instance identifier.
  • Links
  • Value that uniquely identifies the organization in which the work order is performed. This attribute is read-only. The value of this attribute is derived from the work order.
  • Read Only: true
    Value that uniquely identifies the work order operation. This attribute is read-only. The value of this attribute is derived from the operation.
  • Value that uniquely identifies work order resource to which the resource instance is added. The operation resource identifier is required to create an operation resource instance.
  • Value that uniquely identifies the resource instance for the work order operation resource. The value is generated when the resource instance is created. This attribute is read-only.
  • Read Only: true
    Value that uniquely identifies the work order. This attribute is read-only. The value of this attribute is derived from the work order.
  • Flexfields for Resource Instances
    Title: Flexfields for Resource Instances
    The Flexfields for Resource Instances resource manages descriptive flexfields that contain details about the resource instance.
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 : maintenanceWorkOrders-WorkOrderOperation-WorkOrderOperationResource-WorkOrderOperationResourceInstance-WorkOrderOperationResourceInstanceDFF-item-response
Type: object
Show Source
Back to Top