-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbusinesscore.settings.html
More file actions
269 lines (262 loc) · 11.8 KB
/
businesscore.settings.html
File metadata and controls
269 lines (262 loc) · 11.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8">
<script src="javascript/thirdparty/jquery-3.2.0.min.js"></script>
<script src="javascript/thirdparty/handlebars-latest.js"></script>
<script src="javascript/thirdparty/typeahead.bundle.js"></script>
<script src="javascript/thirdparty/clipboard.min.js"></script>
<script src="javascript/searchindex.js"></script>
<script src="javascript/script.js"></script>
<link rel="stylesheet" href="resources/fonts/font-awesome-4.7.0/css/font-awesome.min.css">
<link rel="stylesheet" type="text/css" href="styles/normalizer.css">
<link rel="stylesheet" type="text/css" href="styles/style.css">
<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"></script>
<title>Jasmin Developers - Master Data Business Entities | Setting</title>
</header>
<body>
<div class="header">
<i id="menu-button" class="menu-icon fa fa-bars" aria-hidden="true"></i>
<div class="title">Jasmin Developers - Web API Reference</div>
<div id="search" class="search">
<i class="search-icon fa fa-search" aria-hidden="true"></i>
<input class="typeahead" type="text" placeholder="Search">
</div>
</div>
<div class="sidebar" id="sidebar">
<a class="menu-item " href="index.html">
Overview
</a>
<a class="menu-item" href="accountspayable.html">
Accounts Payable
</a>
<a class="menu-item" href="accountsreceivable.html">
Accounts Receivable
</a>
<a class="menu-item" href="financials.html">
Financials
</a>
<a class="menu-item" href="goodsreceipt.html">
Goods Receipt
</a>
<a class="menu-item" href="logistics.html">
Logistics
</a>
<a id="current-menu-item" class="menu-item " href="masterdatabusinessentities.html">
Master Data Business Entities
</a>
<a class="menu-subitem " href="businesscore.assortments.html">
Assortment
</a>
<a class="menu-subitem " href="businesscore.brands.html">
Brand
</a>
<a class="menu-subitem " href="businesscore.parties.html">
Entity
</a>
<a class="menu-subitem " href="businesscore.exchangeratesdocuments.html">
Exchange Rates Document
</a>
<a class="menu-subitem " href="businesscore.items.html">
Item
</a>
<a class="menu-subitem " href="businesscore.brandmodels.html">
Model
</a>
<a class="menu-subitem " href="businesscore.organizationvalidations.html">
Organization Validation
</a>
<a class="menu-subitem " href="businesscore.productinfos.html">
Product Info
</a>
<a class="menu-subitem " href="businesscore.series.html">
Serie
</a>
<a class="menu-subitem menu-item-selected" href="businesscore.settings.html">
Setting
</a>
<a class="menu-item" href="materialsmanagement.html">
Materials Management
</a>
<a class="menu-item" href="platform.html">
Platform
</a>
<a class="menu-item" href="purchases.html">
Purchases
</a>
<a class="menu-item" href="sales.html">
Sales
</a>
<a class="menu-item" href="shipping.html">
Shipping
</a>
<a class="menu-item" href="taxes.html">
Taxes
</a>
</div>
<div class="content">
<div class="content-section">
<div class="content-section-col1">
<h1>Master Data Business Entities | Setting</h1>
<p>
Service to manage generic business settings.
</p>
<h2>Overview</h2>
<br/>
<table>
<tbody>
<tr>
<td>URL</td>
<td class="breakword url-cell">api/{tenantKey}/{orgKey}/businessCore/settings <i title="Copy to clipboard" class="copy-clipboard fa fa-clipboard clipboard-url" aria-hidden="true" data-clipboard-target="#copy-businesscore-settings"></i></td>
<div class="hidden-copylink" id="copy-businesscore-settings">api/{tenantKey}/{orgKey}/businessCore/settings</div>
</tr>
<tr>
<td>Methods Supported</td>
<td><a href="#GET">GET</a>, <a href="#POST">POST</a></td>
</tr>
</tbody>
</table>
<h2>All Operations</h2>
<p>
This service includes the following operations:
</p>
<ul>
<li>
GET:
<ul>
<li><a href="#4a96def2-dc64-4438-8793-dfe7e38d9376">GET Get By Key</a></li>
</ul>
</li>
<li>
POST:
<ul>
<li><a href="#6f429fd6-9966-45ea-8048-eb9b3fc5cdc1">POST Set By Key</a></li>
</ul>
</li>
</ul>
<h2>All Resources</h2>
<p>
This service uses the following resources:
</p>
<ul>
<li><a href="#Setting">Setting</a></li>
</ul>
</div>
</div>
<div class="content-section">
<div class="content-section-col1">
<a class="anchor" name="GET"></a>
<h2>GET Operations</h2>
</div>
</div>
<div class="content-section">
<div class="content-section-col1">
<a class="anchor" name="4a96def2-dc64-4438-8793-dfe7e38d9376"></a>
<h3>GET Get By Key <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-4a96def2-dc64-4438-8793-dfe7e38d9376"></i></h3>
<div class="hidden-copylink" id="copy-4a96def2-dc64-4438-8793-dfe7e38d9376"><a href="#4a96def2-dc64-4438-8793-dfe7e38d9376">GET Get By Key</a></div>
<p class="operation-description">Returns the setting that matches the specified key.</p>
<p>The following elements are required:</p>
<table>
<tbody>
<tr>
<td class="highlighted">settingKey</td>
<td><i>(string)</i> Defines the key of the setting to be returned.</td>
</tr>
</tbody>
</table>
<br />
<p>Response:</p>
<table>
<tbody>
<tr>
<td>When successful, the response body contains a string.</td>
</tr>
</tbody>
</table>
</div>
<div class="content-section-col2">
<p>Resource URL:</p>
<div class="hidden-copylink" id="copy2-4a96def2-dc64-4438-8793-dfe7e38d9376">api/{tenantKey}/{orgKey}/businessCore/settings/getByKey/{settingKey}</div>
<div class="resource-url">
<div class="inner-resource-url"><div>GET /businessCore/settings/getByKey/{settingKey}</div></div>
<div class="copy-clipboard clipboard-example" data-clipboard-target="#copy2-4a96def2-dc64-4438-8793-dfe7e38d9376"><div><i title="Copy to clipboard" class="fa fa-clipboard" aria-hidden="true"></i></div></div>
</div>
</div>
</div>
<div class="content-section">
<div class="content-section-col1">
<a class="anchor" name="POST"></a>
<h2>POST Operations</h2>
</div>
</div>
<div class="content-section">
<div class="content-section-col1">
<a class="anchor" name="6f429fd6-9966-45ea-8048-eb9b3fc5cdc1"></a>
<h3>POST Set By Key <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-6f429fd6-9966-45ea-8048-eb9b3fc5cdc1"></i></h3>
<div class="hidden-copylink" id="copy-6f429fd6-9966-45ea-8048-eb9b3fc5cdc1"><a href="#6f429fd6-9966-45ea-8048-eb9b3fc5cdc1">POST Set By Key</a></div>
<p class="operation-description">Instructs the 'Settings' service to set the value for the specified key.</p>
<p>The following elements are required:</p>
<table>
<tbody>
<tr>
<td class="highlighted">settingKey</td>
<td><i>(string)</i> Defines the key of the setting to be saved.</td>
</tr>
<tr>
<td class="highlighted">value</td>
<td><i>(Setting)</i> Defines the setting's value.</td>
</tr>
</tbody>
</table>
<br />
<p>Response:</p>
<table>
<tbody>
<tr>
<td>When successful, the response body is empty.</td>
</tr>
</tbody>
</table>
</div>
<div class="content-section-col2">
<p>Resource URL:</p>
<div class="hidden-copylink" id="copy2-6f429fd6-9966-45ea-8048-eb9b3fc5cdc1">api/{tenantKey}/{orgKey}/businessCore/settings/setByKey/{settingKey}</div>
<div class="resource-url">
<div class="inner-resource-url"><div>POST /businessCore/settings/setByKey/{settingKey}</div></div>
<div class="copy-clipboard clipboard-example" data-clipboard-target="#copy2-6f429fd6-9966-45ea-8048-eb9b3fc5cdc1"><div><i title="Copy to clipboard" class="fa fa-clipboard" aria-hidden="true"></i></div></div>
</div>
</div>
</div>
<div class="content-section">
<div class="content-section-col1">
<h2>Resources</h2>
<br />
<a class="anchor" name="Setting"></a>
<h4>Setting <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-Setting"></i></h4>
<div class="hidden-copylink" id="copy-Setting"><a href="#Setting">Setting</a></div>
<p>The following elements are optional:</p>
<table>
<tbody>
<tr>
<td class="highlighted">value</td>
<td class="wrap"><i>(string)</i> Value.
</td>
</tr>
</tbody>
</table>
<br />
<br />
</div>
</div>
</div>
</body>
<script>
var clipboard = new Clipboard('.copy-clipboard');
clipboard.on('success', function(e) {
showTooltip(e.trigger, 'Copied!', 'left');
});
clipboard.on('error', function(e) {
showTooltip(e.trigger, 'Error!', 'left');
});
</script>
</html>