Add Attachments to Maintenance Work Orders Using a REST Service

Work order attachments may contain important information and relevant instructions that can be used to effectively assess the work required and assign the right resources. Prior to this update, you were able to add attachments to work orders through the user interface only.  In this update, you can leverage the Work Order Attachments REST API to manage attachments on a work order. You are able to perform multiple actions including retrieving all attachments or a single attachment, adding or updating attachments to a work order, and deleting attachments.

Some tasks or business processes require that you store and maintain documents, images, or other files in the form of attachments for future reference. Attachments may exist in the form of large objects, text, an image, or a media file. There are three types of attachments supported, including text, URL, and files. A text attachment comprises unstructured written text, a URL attachment comprises a web link to an external web page when clicked, and a file attachment that comprises images or documents and media. In general, Oracle REST APIs support working with all types of attachments. In this update, you can now store attachments in a column within the same database table. The file contents should be provided in base64 format. Please use the link: https://www.base64encode.org to ensure the file is in the correct format.

You can now associate attachments with work orders using a REST resource in addition to associating attachments via user interface pages. You can also search for existing attachments or update your attachments using other operations in the same REST resource.

Steps to Enable

Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.

Key Resources

Access Requirements

Users who are assigned a configured job role that contains these privileges can access this feature:

  • Manage Customer Assets (CSI_MANAGE_CUSTOMER_ASSETS_PRIV)
  • Manage Maintainable Assets (MNT_MANAGE_MAINTAINABLE_ASSETS_PRIV)

These privileges were available prior to this update.