Configuration Service

This REST service is used to get, add, update, and delete configurations.

Get Configuration

Method: HTTP GET

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

Parameters: applicationid (Select the value from the drop-down list)

Add Configuration

Method: HTTP POST

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

Parameters: applicationid (Select the value from the drop-down list)

Example of addConfigRequest:

Copy
{
"appDescription": "catalog",
"categories": [
{
"ConfValues": [
{
"description": "string",
"propName": "string",
"propertyVisibility": "Basic",
"tenantProperty": true,
"value": "string",
"valueType": "Number"
}
],
"categoryName": "string",
"description": "string",
"visibility": "Basic"
}
]
}

Update Configuration

Method: HTTP PUT

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

Parameters: applicationid (Select the value from the drop-down list)

Example of updateRequest:

Copy
{
"propName": "string",
"value": "string",
"valueType": "Number"
}

Delete Configuration

Method: HTTP DELETE

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

Parameters: applicationid (Select value from the drop-down)

Example of deleteRequest:Closed 

Copy
[
"string"
]

 

Upload Configuration File

This API is used to upload config files into the configuration table in the admin database through the REST service.

Method: HTTP POST

Endpoint: http://<host_address>:<port_address>/v1/configuration/uploadConfigFile/{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.

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

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.