View, Edit and Add Reference Types

To meet the needs of your utility, you can view and edit existing reference types, or you can add your own reference types.

To view the existing reference types:

  • Request URL: <CXIF-host>/api/utilitiesAdmin/v1/<ReferenceTypeName>

    For example, For example, https://xxxxxxxx.oci.customer-oci.com/api/utilitiesAdmin/v1/<ReferenceTypeName>

  • Operation: GET

  • Authorization: OAUTH2.0

For instructions on how to find the request URL, see generate-access-token-ref-types.html#GUID-43C1E003-799A-424B-9C89-552E0E104550__section_af5_3rr_42c.

To edit the reference types:

  1. Get the response using a GET call.

  2. Using the information below, update the configuration and perform a POST operation to the below endpoint with the specified payload.

    Request URL: <hostname>/api/CXIPlatformService/v1/CXIReferenceEntity/<ReferenceTypeName>

For Example, https://xxxxxxxx.oci.customer-oci.com/api/CXIPlatformService/v1/CXIReferenceEntity/<ReferenceTypeName>

    Operation: POST

    Authorization: OAUTH2.0

    Request payload

    {

    "items": [

    {

    "operation": "update",

    "data": <object for a single record returned from GET in step 1>

    }

    ]

    }

The following sections describe the available configurations by integration point in CX for Utilities applications.

In this section:

Parent topic: Customer Experience for Utilities Reference Type Configurations