REST APIs (Inbound)

Use Oracle REST APIs to create, review, update, and sometimes delete data in Oracle Fusion Cloud Maintenance and Oracle Fusion Cloud Manufacturing

Included in the data are setup, definition, and transactional entities.

Key Feature: Create and Manage Setup Data

Best Practices

• Certain entities can only be created and managed using a REST resource and not file-based data import (FBDI). An example is the Asset Condition Event Codes resource.
• Other entities might be created and managed using either a REST resource or FBDI. An example is the Installed Base Assets resource.

Constraints

• Several objects are supported using the REST API and FBDI integration methods.
• You should review the capabilities of each and decide on the best method for the implementation and ongoing management of the object data.

Key Feature: Perform Data Updates in Near Real Time

Best Practices

Use this option only if you need to perform near real-time mode operations. This can include creating or updating data.

Constraints

Because some objects have creation date/time validations that are unique per minute (for example, a meter reading), you should model your real-time updates to follow the validations of each object.

Key Feature: Retrieve Data for Custom Pages or External Systems

Best Practices

• You can perform GET operations to retrieve setup, lookup, and general object data.
• The queries can be by object id, query, or finder. To ensure good performance:
  • Limit the attributes using the fields query parameter.
  • Avoid OR conditions with LIKE clauses, where possible.
  • Avoid querying master records using only child query criteria, where possible

Constraints

• Retrieving child records across multiple main records.
• Retrieving fetch child entity levels along with the main record.

Entities in Oracle Maintenance and Oracle Manufacturing with REST API Support

This table lists the Oracle Maintenance and Oracle Manufacturing entities with REST API support.

Asset Area	Entity	Resource Owner	Description
Asset Management	Asset Condition Event Codes	Oracle Maintenance	Manages the condition event code definitions. The codes are used in supplier warranty, failure capture, maintenance programs, and work order creation.
	Asset Diagnostic Symptoms	Oracle Maintenance	Manages the asset diagnostic symptoms. Symptoms are observations or diagnostic information related to anomalous asset behavior that might precede or occur along with a failure event.
	Asset Failure Events	Oracle Maintenance	Manages failure events for work orders. For an event, one or more failure instances might be created and associated with an event.
	Asset Failure Sets	Oracle Maintenance	Manages the failure sets. Failure sets define the rules around how failure data is captured, and in which conditions a technician is required to capture failure data on a work order. Failure sets use Condition event codes in their definitions.
	Asset Group Rules	Oracle Maintenance	Manages creating and updating of asset group rules. Group rules are used as the basis for creating an Asset Group.
	Asset Groups	Oracle Maintenance	Manages how to create and update asset groups, based on a group rule.
	Asset Logical Hierarchy Names	Oracle Maintenance	Manages the parent node in a logical hierarchy. Once defined, child nodes can be defined using Relationships.
	Asset Logical Hierarchy Relationships	Oracle Maintenance	Manages the logical relationships between a parent node and its child nodes.
	Asset Warranty Claims	Oracle Maintenance	Manages the warranty claims and their associated warranty entitlements. Claims are created and updated in the context of a maintenance work order.
	Asset Warranty Contracts	Oracle Maintenance	Manages the asset warranty contracts, including the meter durations.
	Asset Warranty Coverages	Oracle Maintenance	Manages the warranty coverage definitions, including associated items, meters, and repair transaction codes. Coverages are used as the basis for creating an asset Warranty Contract.
	Asset Warranty Entitlements	Oracle Maintenance	Manages the entitlements within a warranty claim for the reimbursement of work order or miscellaneous expenses using a Warranty Claim.
	Asset Warranty Provider Rates	Oracle Maintenance	Manages the warranty claim labor rates for a warranty provider. The rates will be used for a corresponding Standard Repair Time to create an Entitlement in a Warranty Claim.
	Asset Warranty Standard Repair Times	Oracle Maintenance	Manages the warranty claim standard rates for a warranty provider and standard operation. The times will be used for a corresponding Provider Rate to create an Entitlement in a Warranty Claim.
	Customer Asset Transactions	Oracle Maintenance	Manages sales order information about a customer asset by transaction type.
	Failure Instances	Oracle Maintenance	Manages failure instances across all failure events. One or more instances might be defined for an Event, referencing Condition Event Codes.
	Genealogy Objects	Oracle Maintenance	Manages the genealogy objects. A genealogy object is a lot or serial number that's flagged to be tracked by the Product Genealogy process.
	Genealogy Relationships	Oracle Maintenance	Manages the relationships between a parent genealogy object and its child components.
	Installed Base Assets	Oracle Maintenance	Manages the customer and enter prize asset and child entities, including: Qualifications Charges Fixed asset associations Meters Notes Parts list Relationships Descriptive flexfields (DFFs)
	Qualification Profiles	Oracle Maintenance	Manages qualification profiles used to assign or transact a qualified equipment resource instance for a work order operation.
	Qualification Requirements	Oracle Maintenance	Manages the qualification requirements. Qualification requirements are recorded for specific assets and are used during the work order transactions.
Work Setup	Work Area	Oracle Manufacturing	Manages the names of the work areas where maintenance is planned and executed.
	Work Center	Oracle Manufacturing	Manages the names of the work centers where maintenance is planned and executed.
	Resources	Oracle Manufacturing	Manages production resources used in maintenance. A resource can include labor, equipment, and tools that you allocate to a work center.
	Resource Instances	Oracle Manufacturing	A child resource of the Production Resource. A resource instance can include a person, equipment, or tools that are explicitly identified in a work order operation.
	Standard Operations	Oracle Manufacturing	Manages standard operations, including resource details.
	Work Definition Requests	Oracle Manufacturing	Manages only the creation of a work definition using a request payload. This includes the header, operations, materials, and resources. This resource supports only the POST creation, but not the PATCH update operation. Also, this resource doesn't support the GET operation. Instead, you must use the Work Definitions resource after creation.
	Work Definitions	Oracle Manufacturing	Manages the viewing of work definition details that are created by the Requests. You can view the header, operations, materials, resources, and attachments. This resource doesn't support the POST operation. Instead you must use Work Definitions Requests.
	Maintenance Programs	Oracle Maintenance	Used to define and update a maintenance program. Maintenance programs are used to define and generate a daily preventative maintenance forecast for one or more assets, based on a calendar pattern or meter utilization. The forecast is then used to create preventative maintenance work orders, using one or more work definitions.
Work Execution	Work Requests (Help Desk)	Help Desk	Manages create and update of work requests using an Internal Service Request. A request can then be used as the basis for reporting an issue with an asset and creating a maintenance work order for resolution.
	Maintenance Recommendations	Oracle Maintenance	Manages recommendations for maintenance programs.
	Maintenance Work Orders	Oracle Maintenance	Manages the create and update of maintenance work orders, including the operation, material and resource entities.
	Maintenance Operation Transactions	Oracle Maintenance	Manages the status change of the maintenance operation.
	Maintenance Material Transactions	Oracle Maintenance	Manages the movement of an item or product between the shop floor and the subinventory or locator, including charges for the work order.
	Maintenance Resource Transactions	Oracle Maintenance	Stores resource charges for the work order.
	Meter Templates	Oracle Maintenance	Manages meter definitions, including item applicability. Meter templates are used to instantiate an Asset or Subscription meter for utilization tracking.
	Meter Readings	Oracle Maintenance	Manages the meter reading history of an asset- or subscription-based meter.
	Maintenance Forecasts	Oracle Maintenance	Manages the forecast due dates for a work requirement and asset in a maintenance program.