REST API for Oracle Fusion Cloud SCM

Get all work order resources

get

/fscmRestApi/resources/11.13.18.05/maintenanceWorkOrderResources

Request

Query Parameters

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
finder: string
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 resources according to the primary key.
  Finder Variables:
  - WoOperationResourceId; integer; Value that uniquely identifies the resource.
- WorkOrderResourcesByAsset: Finds work order resources according to provided asset and workorder identifiers.
  Finder Variables:
  - BindAssetId; integer; Value that uniquely identifies the asset.
  - BindWorkOrderId; integer; Value that uniquely identifies the work order.
limit: integer

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.
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
offset: integer

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.
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).
orderBy: string

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
q: string
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:
- AssignedUnits; number; Number of resource units required to perform the operation.
- AutoTransactFlag; boolean; 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; 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; 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; 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; 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; 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; Session login associated with the user who created the record.
- CreationDate; string; Date when the record was created.
- EqpQualProfileId; integer; 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.
- LastUpdateDate; string; Date when the record was most recently updated.
- LastUpdatedBy; string; Session login associated with the user who most recently updated the record.
- MntResourceAssignedFlag; boolean; 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; 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; Value that is the difference between the required usage and the reported usage.
- OperationSequenceNumber; number; 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; Abbreviation for the maintenance organization of the work order.
- OrganizationId; integer; Value that uniquely identifies the maintenance organization of the work order.
- PlannedCompletionDate; string; 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 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; 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.
- ProfileId; integer; Value that uniquely identifies the work order operation resource's job profile. The application generates this key value.
- ReasonForRepairCode; string; 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; 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; Name of the reason for the repair code.
- RepairTransactionCode; string; 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; 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; Name of the repair transaction code.
- RequiredUsage; number; 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; 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; 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.
- ResourceId; integer; 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.
- ResourceName; string; 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; 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; 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; This attribute is not currently used for Oracle Maintenance Cloud. You must use the ScheduledIndicator attribute instead.
- ScheduledIndicator; string; 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; Abbreviation that identifies the standard operation for work order operation. This attribute is read-only.
- StandardOperationId; integer; Value that uniquely identifies the standard operation for work order operation. This attribute is read-only.
- UOMCode; string; Abbreviation that identifies the unit of measure of the operation material quantity.
- UnitOfMeasure; string; 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.
- UsageRate; number; 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; 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; 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; Name of the work order operation. The operation name is required to create an operation.
- WoOperationResourceId; integer; 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; 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; 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; Name of the work accomplished code.
- WorkCenterDescription; string; 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; 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; 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.
- WorkOrderId; integer; 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; 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.
totalResults: boolean

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

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.

Response

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

Type: object

Show Source

count(required): integer

The number of resource instances returned in the current range.
hasMore(required): boolean

Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
items: array Items

Title: Items

The items in the collection.
limit(required): integer

The actual paging size used by the server.
links(required): array Links

Title: Links

The link relations associated with the resource instance.
offset(required): integer

The offset value used in the current page.
totalResults: integer

The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/maintenanceWorkOrderResources-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Maintenance",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object maintenanceWorkOrderResources-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/maintenanceWorkOrderResources-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : maintenanceWorkOrderResources-item-response

Type: object

Show Source

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.
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.
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.
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.
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.
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.

{
    "type":"object",
    "properties":{
        "ProfileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation resource's job profile. The application generates this key value.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageRate":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrincipalFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CountPointOperationFlag":{
            "title":"Count Point",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure of the operation material quantity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Session login associated with the user who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardOperationCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the standard operation for work order operation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkAccomplishedName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the work accomplished code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Session login associated with the user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "ResourceSequenceNumber":{
            "type":"number",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WoOperationResourceId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WoOperationName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the work order operation. The operation name is required to create an operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoTransactFlag":{
            "title":"Automatically transact",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledIndicator":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedUnits":{
            "type":"number",
            "description":"Number of resource units required to perform the operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "title":"Work Order",
            "maxLength":"120",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BasisTypeCode":{
            "title":"Basis",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation for the basis type of material defined for the work order operation. Valid values are contained in the lookup EGP_BOM_BASIS_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkAccomplishedCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "title":"Operation Sequence",
            "type":"number",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RepairTransactionCodeId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReportedUsage":{
            "type":"number",
            "description":"Number of resource units reported for the operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RepairTransactionName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the repair transaction code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkAccomplishedCodeId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReasonForRepairCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReasonForRepairCodeId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StandardOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the standard operation for work order operation. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlannedCompletionDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation for the charge type of material defined for the work order operation. Valid values are contained in the lookup ORA_WIS_CHARGE_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the maintenance organization of the work order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ScheduledFlag":{
            "maxLength":"30",
            "type":"boolean",
            "description":"This attribute is not currently used for Oracle Maintenance Cloud. You must use the ScheduledIndicator attribute instead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WoOperationDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the operation to be performed during the work order execution. The operation description is optional to create the work order operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannedStartDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EqpQualProfileId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MntResourceAssignedFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MntResourceQualifiedFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OpenUsage":{
            "type":"number",
            "description":"Value that is the difference between the required usage and the reported usage.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "AssetId",
                    "BasisTypeCode"
                ]
            },
            "x-queryable":true
        },
        "ReasonForRepairName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the reason for the repair code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation for the maintenance organization of the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EqpQualProfileCode":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RepairTransactionCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredUsage":{
            "title":"Required Usage",
            "type":"number",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProfileCode":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BasisType":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeType":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WoOperationId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReportedUsagePerAsset":{
            "type":"number",
            "description":"Number of resource units reported for the operation per asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the record was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}