New REST endpoints added under Configuration Service

Application Properties APIs

Get Application Properties by Application ID

This API is used to get information for each service.

Method: HTTP GET

Endpoint: http://<host_address>:<port_address>/v1/configuration/{applicationId}

Select the applicationId such as catalog, common, offersearchindex, opes, or shopping cart from the drop-down list and click Execute.
All the properties related to the requested application that are present in app_properties table are shown in json format.

Update Application Properties for Application ID

This API is used to modify information for each service.

Method: HTTP PUT

Endpoint: http://<host_address>:<port_address>/v1/configuration/{applicationId}

Select the applicationId such as catalog, common, offersearchindex, opes, or shopping cart from the drop-down list, put the properties to be modified in the Request Body field and then click Execute.
In the responses, it shows the status such as success or failure for the executed request.

Save Application Properties for Application ID

This API is used to seed application properties to the database for each service when the database is empty at the starting of the service. The application properties are stored at $OPE_HOME/seed-data/app-properties location.

Method: HTTP POST

Endpoint: http://<host_address>:<port_address>/v1/configuration/{applicationId}

Select the applicationId such as catalog, common, offersearchindex, opes, or shopping cart from the drop-down list, put the application properties to be uploaded in the Request Body field and then click Execute.

 

Delete Application Properties for Application ID

This API is used to delete application properties from the database for each service. The application properties are stored at $OPE_HOME/seed-data/app-properties location.

Method: HTTP DELETE

Endpoint: http://<host_address>:<port_address>/v1/configuration/{applicationId}

Select the applicationId such as catalog, common, offersearchindex, opes, or shopping cart from the drop-down list, put the application properties to be deleted in the Request Body field and then click Execute. You can also use '*' or 'All' to delete multiple or all the properties of a particular service at once.

Replicate Tenant Properties

This API is used to replicate the tenant-specific properties through the REST service. Previously, properties could only be replicated through the Configurator UI.

Method: HTTP POST

Endpoint: http://<host_address>:<port_address>/v1/configuration/replicateTenantProperties/{sourceTenantId}

Click Execute to replicate the default tenant-specific properties to the current tenant.

Note: If the secure API is enabled, you need to create the required tenant by using the authorization token. The user which is used to generate the authorization token is the destination tenant.

Get supported files metadata

This API is used to get the list of files for the application properties supported by the configuration service.

Method: HTTP GET

Endpoint: http://<host_address>:<port_address>/v1/configuration/configFilesMetadata

Click Execute to get the list of required files to start each service.

Get list of applications available with Configuration Service

This API is used to get the list of available applications with the configuration service.

Method: HTTP GET

Endpoint: http://<host_address>:<port_address>/v1/configuration/availableApplications

Click Execute to get the list of available applications with the configuration service.

Configuration Files APIs

Download Configuration File for Application ID

This API is used to download configuration files from the configuration table in the admin database through REST service.

Method: HTTP GET

Endpoint: http://<host_address>:<port_address>/v1/configuration/ConfigFile/{applicationid}

Select the applicationid from the drop-down list, click Execute, and then click Download File link to download the configuration files.

Upload Configuration File for Application ID

This API is used to upload config files into the configuration table in the admin database through REST service. The configuration files are stored at $OPE_HOME/seed-data/congig-files location.

Method: HTTP POST

Endpoint: http://<host_address>:<port_address>/v1/configuration/ConfigFile/{applicationid}

Select the applicationid from the drop-down list, click Choose File to browse, select the file that you want to upload, and click Execute.

Note: The following files are supported for the upload configuration API:
  • logback.xml

  • logback_catalog.xml

  • logback_offersearchindex.xml

  • logback_ope.xml

  • logback_shoppingcart.xml

  • log4j2.xml

Note: When you upload a file that is already present in the database, the older file is replaced.

Configuration Notification API

Configurator Notification API

This API provides notification from the server side whenever there is a change (add, update, or delete) in application properties for any application.

Method: HTTP GET

Endpoint: http://<host_address>:<port_address>/configurator/events

Click Execute to get the notification for the changes in application properties for the application that you set.