Jasmin Developers - Web API Reference

Master Data Business Entities | Setting

Service to manage generic business settings.

Overview


URL api/{tenantKey}/{orgKey}/businessCore/settings
Methods Supported GET, POST

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Get By Key

Returns the setting that matches the specified key.

The following elements are required:

settingKey (string) Defines the key of the setting to be returned.

Response:

When successful, the response body contains a string.

Resource URL:

GET /businessCore/settings/getByKey/{settingKey}

POST Operations

POST Set By Key

Instructs the 'Settings' service to set the value for the specified key.

The following elements are required:

settingKey (string) Defines the key of the setting to be saved.
value (Setting) Defines the setting's value.

Response:

When successful, the response body is empty.

Resource URL:

POST /businessCore/settings/setByKey/{settingKey}

Resources


Setting

The following elements are optional:

value (string) Value.