B Appendix: REST APIs

This appendix provides information about the REST APIs that are used by Oracle Customer Experience for Utilities solutions.

REST APIs Documentation Links

Metering and Customer Information REST Endpoints

These REST endpoints belong to Oracle Utilities customer information systems, and include:

  • Admin

    • Extendable Lookup (F1-ExtendableLookup)

    • Rates (C1-Rates)

    • Service Agreement Type (C1-SAType)

  • Financial Transactions

    • *Account Data (C1-AccountData)

    • Adjustment (C1-Adjustment)

    • Bill (C1-Bill)

    • Bill Segment (C1-BillSegment)

    • Payment (C1-Payment)

    • Pay Plan (C1-PayPlan)

    • *Person Data (C1-PersonData)

    • Service Agreement Data (C1-SAData)

  • System Services

    • Expand Tree (F1-ExpandTree)

    • Insights (F1-Insights)

  • Service

    • Work Queue (C1-WorkQueue)

  • V-Model

    • Billing Context (C1-BillingContext)

    • Business Search (C1-BusinessSearch)

    • Business Person Queries (C1-PersonQueries)

    • Communication Preferences (C1-CommunicationsPreferences)

    • Customer Activity History (C1-CustomerActivityHistory)

    • Person Information Synchronization (C1-CXperson)

    • Person (C1-Person)

    • Person Search (C1-PersonSearch)

    • Premise (C1-Premise)

    • Premise Activity History (C1-PremiseActivityHistory)

    • Service Agreement (C1-ServiceAgreement)

    • Service Points Common (C1-ServicePointCommon)

    • Service Point Search (C1-ServicePointSearch)

  • Usage

    • Billed Usage for SA (C1-BilledUsageData)

These Inbound Web Service APIs all have a Web Service Class of REST and Web Service Category of Customer Experience.

See Oracle Utilities Customer Cloud Service APIs.

* The total and minimum collections amounts returned in the C1-AccountData and C1-PersonData services require new snapshots that require a minimum version of Oracle Utilities CIS. For prior versions, these services can only return the original amounts in collections. For additional version requirement information, see My Oracle Support Document 2876281.1My Oracle Support Document 2876281.

Sales and Service REST Endpoint

The following REST endpoints belong to the Oracle Fusion Sales and Service systems:

  • Contacts

  • Contacts / Contact Points

  • Contacts / Source System References

  • Accounts

  • Accounts / Contact Points

  • Accounts / Source System References

  • Service Requests

  • Service Request References

  • Hub Source System References

  • Industries Class

  • Industries Class Metadata

  • Industries Class Related Entities

  • Industries Class Relationships

  • Interview References

  • Wrap Ups

  • Wrap Ups References

  • Conversation Messages

  • Conversation Message References

  • Opportunities

  • Opportunity References

  • Sales Leads

  • Leads References

  • Standard Lookups List of Values

  • Search Resources

  • Resources

 See the REST API for CX Sales and Fusion Service Guide, available in the Fusion Service library in the Oracle Help Center.

Utility Configurations REST Service

The <CXIF-host>/admin/utilityConfigurations REST service is used to configure utility information in the CX for Industries Framework system.

 To access information for this REST API, log in to My Oracle Support and view Document KB166238.

Customer Experience for Utilities REST Service

The <CXIF-host>api/utilitiesAdmin/v1/<ReferenceTypeName> REST service to manage reference types such as units of measure, service types, standard usage identifiers, and other utility related information.

 To access information for this REST API, see Customer Experience for Utilities REST APIs. For additional information on using this REST API, see Customer Experience for Utilities Configuration Tasks.