Specify Custom Response Headers in the OCI Object Storage Action

You can define custom response headers when uploading objects into an object storage bucket in the Oracle Cloud Console. You can then define those same headers with the Download object operation when configuring the OCI Object storage action in the integration canvas.

This capability allows Oracle Integration retrieval-augmented generation (RAG) functionality to retrieve the custom response headers and use that information to provide context.

This section provides a high-level overview of designing and running an integration that uses custom response headers.

  1. Sign in to the Oracle Cloud Console.
  2. In the navigation pane, select Storage, then Buckets.
  3. Click the bucket name.
  4. Click Objects, then click Upload object.
  5. Specify the object to upload (for this example, a file named image10.png is uploaded).
  6. Expand Optional response headers and metadata to define the custom response header names and values. For this example, the following headers are defined:
    Header Value
    opc-meta-customobjectstorageheader1 CustomObjectStorageHeader1_Value
    opc-meta-customobjectstorageheader2 CustomObjectStorageHeader2_Value

    The Object details page shows the Content type, date, ETag, Last modified, strict-transport-security, x-api-id, and x-content-type0options parameters. Below this is the Metadata section, which shows the two response headers and their values. The actual header names and values appear in the text immediately above this image.

  7. Save your updates.
  8. Configure an OCI Object storage action in the integration canvas. At a high level, you must:
    1. Drag the OCI Object storage action into the integration canvas.
    2. Select Manage buckets, then select Download object.
    3. Click Custom at the bottom of the page to add the custom response headers that you previously defined in your object storage bucket in the Oracle Cloud Console. The names you specify must match exactly with those created in the Oracle Cloud Console.

      For this example, a special custom response header to return the target endpoint URL to the user (x-oracle-ics-target-url) is also defined. This URL does not need to be defined in the object storage bucket.


      The View Response Headers page shows the Custom HTTP Headers section. The three custom headers are defined: opc-meta-customobjectstorageheader1, opc-meta-customobjectstorageheader2, and x-oracle-ics-target-url.

      See Invoke Oracle Cloud Infrastructure Object Storage from an Integration with an OCI Object Storage Action for specific steps on configuring this action.

  9. In the mapper, expand Custom HTTP Headers in the Sources and Target sections.
  10. Map the source header elements you created to the target header elements.

    The Sources, Mapping canvas, and Target sections are shown. The source Custom HTTP Headers section is expanded to show the three custom response headers you created. Each is mapped to the target Custom HTTP Headers.

  11. Complete integration design, then define a business identifier and activate the integration.
  12. From the Configure and run page, click Run.

    The two custom response header names and values and the target endpoint URL are displayed in the Response section.


    The Request section shows the URI parameters (which is selected), Headers, Body, cURL, and Integration properties tabs. Below this, ObjectName is selected and a value of image10.png is shown. Below this, the Response section is shown. The status message is 200 OK. The instance ID is shown. Both the custom response headers and their values are shown. The targeturl parameter shows the target URL.