2 Common Characteristics

Security

Services are secured using OAuth 2.0, which is the industry standard protocol for authorization. To invoke these services, you need to obtain an access token and use it as a bearer token on all requests. You may use the same OAuth client and configuration as you would use with File Transfer Services (FTS) specifically for AI Foundation (not Planning, which may use a different client) except for the scope, which will be different. The scope used for all data streaming APIs will use the format rgbu:rsp:RSP-<ENV> where the environment code is based on the URL used to access the applications. For example, the stage environment may use:

rgbu:rsp:RSP-STG1

Refer to the File Transfer Services section of the RAP Implementation Guide for additional details on configuring an OAuth client application.

URL Paths

Based on your implementation, you will need to prefix the endpoint with just the deployment hostname. The format that should be used for the hostname is rap.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/, where <Region Name> will be the region for your data center and <Customer Subnamespace> will be specific to your company’s name and AI Foundation environment (production, stage, and so on).

Example Service URL:

https://rap.retail.us-ashburn-1.ocs.oraclecloud.com/rgbu-rap-xcust-prd1-rsp/RiRestService/services/foundation/allocation/manage

The following links provide access to the services:

  • The ReSTful Web services swagger URL is available at:

    https://<hostname/namespace>/RiRestService/swagger-ui/

  • The ReSTful Web services openapi.yaml is available at:

    https://<hostname/namespace>/RiRestService/services/openapi.yaml

  • The ReSTful Web services’s WADL file is available at:

    https://<hostname/namespace>/RiRestService/services/application.wadl

Date Format

Dates on all payloads will use a specific format for the date only or the datetime. The date without a timestamp requires yyyy-mm-dd format and datetimes require yyyy-mm-ddTHH24:Mi:SS.SSSZ format.

Example date in a JSON payload:

"releaseDate": "2026-05-15"

Example datetime in a JSON payload:

"createDateTime": "2026-01-12T00:00:00.000Z"

Limited Availability During Nightly Batch Cycle

Data streaming ReST services can interfere with batch jobs running during the AIF nightly batch window. To avoid data processing conflicts, data streaming ReST services are either not available during the entire duration of the nightly batch window or unavailable for a portion of the nightly batch, depending on the API. These services will fail with a 400 error if they are invoked during the window of unavailability.