Get one work order resource
get
/fscmRestApi/resources/11.13.18.05/maintenanceWorkOrderResources/{WoOperationResourceId}
Request
Path Parameters
-
WoOperationResourceId(required): integer(int64)
Value that uniquely identifies the resource for work order operation. This attribute is read-only. The value of this attribute is generated when the application creates the operation resource.
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:
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.
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 : maintenanceWorkOrderResources-item-response
Type:
Show Source
object
-
AssignedUnits: number
Read Only:
true
Number of resource units required to perform the operation. -
AutoTransactFlag: boolean
Title:
Automatically transact
Read Only:true
Maximum Length:1
Contains one of the following values: true or false. If true, then automatically report the operation when the operation occurs on the shop floor. If false, then don't report this operation automatically. If the operation isn't significant, it's recommended that you set AutoTransactFlag to true. The Count Point attribute and the Automatically Transact attribute are mutually exclusive. You must make sure that each of these attributes do not both contain true. If the Count Point and Automatically Transact attributes each contain false, then the operation is optional. Note that the user can manually report component usage and resource usage for an optional operation. The default value is false. -
BasisType: string
Title:
Meaning
Read Only:true
Maximum Length:80
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. -
BasisTypeCode: string
Title:
Basis
Read Only:true
Maximum Length:30
Abbreviation for the basis type of material defined for the work order operation. Valid values are contained in the lookup EGP_BOM_BASIS_TYPE. -
ChargeType: string
Title:
Meaning
Read Only:true
Maximum Length:80
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. -
ChargeTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation for the charge type of material defined for the work order operation. Valid values are contained in the lookup ORA_WIS_CHARGE_TYPE. -
CountPointOperationFlag: boolean
Title:
Count Point
Read Only:true
Maximum Length:1
Contains one of the following values: true or false. If true, then make this operation a count point operation. If an operation occurs on the shop floor, the user must manually report it in the application when the operation occurs. If false, then don't make this operation a count point operation. The user doesn't need to report the operation. It's recommended that you configure each work order so that it includes at least one count point operation, and to make sure that the last operation that the work order performs is a count point operation. The default value is true. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Session login associated with the user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date when the record was created. -
EqpQualProfileCode: string
Read Only:
true
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. -
EqpQualProfileId: integer
(int64)
Read Only:
true
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. -
InverseRequiredUsage: number
Read Only:
true
Inverse of the usage rate. The application uses this inverse when the resource usage rate is a fraction, but the inverse of this rate is an integer. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Session login associated with the user who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MntResourceAssignedFlag: boolean
Read Only:
true
Maximum Length:255
Contains one of the following values: YES or NO. If YES, then the logged in user is assigned to the resource. If NO, the user is not assigned to the resource. -
MntResourceQualifiedFlag: boolean
Read Only:
true
Maximum Length:255
Contains one of the following values: YES or NO. If YES, then the logged in user is qualified to report resource usage for the resource. If NO, the user is not qualified for the resource. -
OpenUsage: number
Read Only:
true
Value that is the difference between the required usage and the reported usage. -
OperationSequenceNumber: number
Title:
Operation Sequence
Read Only:true
Number that identifies the sequence to use when performing the work order operations. The operation sequence is required to create an operation. It must be a positive integer. Its value must be unique within the work order operations. If it isn't provided, then the last operation sequence incremented by 10 is used as sequence to create an operation. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation for the maintenance organization of the work order. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the maintenance organization of the work order. -
PlannedCompletionDate: string
(date-time)
Read Only:
true
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. -
PlannedStartDate: string
(date-time)
Read Only:
true
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. -
PrincipalFlag: boolean
Read Only:
true
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. -
ProfileCode: string
Read Only:
true
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. -
ProfileId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order operation resource's job profile. The application generates this key value. -
ReasonForRepairCode: string
Title:
Code
Read Only:true
Maximum Length:30
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. -
ReasonForRepairCodeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the reason for repair of the maintenance work order operation material. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Reason for repair. -
ReasonForRepairName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the reason for the repair code. -
RepairTransactionCode: string
Title:
Code
Read Only:true
Maximum Length:30
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. -
RepairTransactionCodeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the repair transaction of the maintenance work order operation material. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Transaction code. -
RepairTransactionName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the repair transaction code. -
ReportedUsage: number
Read Only:
true
Number of resource units reported for the operation. -
ReportedUsagePerAsset: number
Read Only:
true
Number of resource units reported for the operation per asset. -
RequestMaintenanceFlag: boolean
Read Only:
true
Maximum Length:1
Value that identifies whether the Request Maintenance action is enabled. -
RequiredUsage: number
Title:
Required Usage
Read Only:true
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. -
ResourceCode: string
Title:
Code
Read Only:true
Maximum Length:30
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. -
ResourceDescription: string
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. -
ResourceExceptionFlag: boolean
Read Only:
true
Maximum Length:1
Value that indicates the presence of open resource type exceptions for a resource requirement in a work order operation. -
ResourceId: integer
(int64)
Read Only:
true
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. -
ResourceInstanceNames: string
Read Only:
true
Maximum Length:255
List of comma separated resource instance names. Restricted to the first 50 characters. -
ResourceName: string
Title:
Name
Read Only:true
Maximum Length:80
Name 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. -
ResourceSequenceNumber: number
Read Only:
true
Number that identifies the sequence of the resource in the work order operation. The sequence is required to create an operation resource. The last operation resource sequence incremented by 10 is used as sequence to create an operation resource. -
ResourceType: string
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. -
ScheduledFlag: boolean
Read Only:
true
Maximum Length:30
This attribute is not currently used for Oracle Maintenance Cloud. You must use the ScheduledIndicator attribute instead. -
ScheduledIndicator: string
Read Only:
true
Maximum Length:255
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. -
StandardOperationCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the standard operation for work order operation. This attribute is read-only. -
StandardOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the standard operation for work order operation. This attribute is read-only. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure of the material component quantity to be issued. It is the primary unit of measure of the item. This attribute is read-only. The value of this attribute is derived from the material component item. -
UOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure of the operation material quantity. -
UsageRate: number
Read Only:
true
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. -
WoOperationDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the operation to be performed during the work order execution. The operation description is optional to create the work order operation. -
WoOperationId: integer
(int64)
Read Only:
true
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. -
WoOperationName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the work order operation. The operation name is required to create an operation. -
WoOperationResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the resource for work order operation. This attribute is read-only. The value of this attribute is generated when the application creates the operation resource. -
WorkAccomplishedCode: string
Title:
Code
Read Only:true
Maximum Length:30
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. -
WorkAccomplishedCodeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work accomplished of the maintenance work order operation material. This attribute is read-only. The list of values comes from the user-defined condition event codes with the transaction type Work accomplished. -
WorkAccomplishedName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the work accomplished code. -
WorkCenterDescription: string
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. -
WorkCenterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work center in which the operation is performed. This attribute is read-only. The value of this attribute is derived from the operation. -
WorkCenterName: string
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. -
WorkMethodCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the method that the work order uses such as DISCRETE_MANUFACTURING or MAINTENANCE. -
WorkOrderId: integer
(int64)
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 number when the application creates the work order. -
WorkOrderNumber: string
Title:
Work Order
Read Only:true
Maximum Length:120
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number.
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.