Repository navigation
Expand file tree
/
Copy pathcorepatterns.clientsettings.html
More file actions
336 lines (320 loc) · 13.4 KB
/
Copy pathcorepatterns.clientsettings.html
File metadata and controls
336 lines (320 loc) · 13.4 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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
<!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 - Platform | Client 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 class="menu-item" href="masterdatabusinessentities.html">
Master Data Business Entities
</a>
<a class="menu-item" href="materialsmanagement.html">
Materials Management
</a>
<a id="current-menu-item" class="menu-item " href="platform.html">
Platform
</a>
<a class="menu-subitem " href="identity.accessgroups.html">
Access Group
</a>
<a class="menu-subitem " href="corepatterns.addresses.html">
Address
</a>
<a class="menu-subitem " href="corepatterns.assignments.html">
Assignment
</a>
<a class="menu-subitem menu-item-selected" href="corepatterns.clientsettings.html">
Client Setting
</a>
<a class="menu-subitem " href="corepatterns.companies.html">
Company
</a>
<a class="menu-subitem " href="corepatterns.contacts.html">
Contact
</a>
<a class="menu-subitem " href="corepatterns.contactgroups.html">
Contact Group
</a>
<a class="menu-subitem " href="corepatterns.contacttypes.html">
Contact Type
</a>
<a class="menu-subitem " href="corepatterns.countries.html">
Country
</a>
<a class="menu-subitem " href="corepatterns.cultures.html">
Culture
</a>
<a class="menu-subitem " href="corepatterns.currencies.html">
Currency
</a>
<a class="menu-subitem " href="corepatterns.customentityrecords.html">
Custom Entity Record
</a>
<a class="menu-subitem " href="reporting.offlinereports.html">
Data Report
</a>
<a class="menu-subitem " href="operations.dbversions.html">
Db Version
</a>
<a class="menu-subitem " href="corepatterns.drafts.html">
Draft
</a>
<a class="menu-subitem " href="operations.emailtemplates.html">
Email Template
</a>
<a class="menu-subitem " href="corepatterns.schemaattributes.html">
Entity Attribute
</a>
<a class="menu-subitem " href="corepatterns.entitylockreasons.html">
Entity Lock Reason
</a>
<a class="menu-subitem " href="corepatterns.fiscaltimezones.html">
Fiscal Time Zone
</a>
<a class="menu-subitem " href="corepatterns.importdatainfos.html">
Import Data Info
</a>
<a class="menu-subitem " href="operations.notifications.html">
Notification
</a>
<a class="menu-subitem " href="corepatterns.operations.html">
Operation
</a>
<a class="menu-subitem " href="corepatterns.organizationconfigurations.html">
Organization Configuration
</a>
<a class="menu-subitem " href="corepatterns.postalzones.html">
Postal Code
</a>
<a class="menu-subitem " href="corepatterns.powerbiinfos.html">
Power Bi Info
</a>
<a class="menu-subitem " href="corepatterns.regions.html">
Region
</a>
<a class="menu-subitem " href="corepatterns.schemaentities.html">
Schema Entity Management
</a>
<a class="menu-subitem " href="corepatterns.sequences.html">
Sequence
</a>
<a class="menu-subitem " href="corepatterns.subscriptionvalidations.html">
Subscription Validation
</a>
<a class="menu-subitem " href="corepatterns.units.html">
Unit
</a>
<a class="menu-subitem " href="corepatterns.unitdimensions.html">
Unit Dimension
</a>
<a class="menu-subitem " href="operations.upgradeversions.html">
Upgrade Version
</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>Platform | Client Setting</h1>
<p>
</p>
<h2>Overview</h2>
<br/>
<table>
<tbody>
<tr>
<td>URL</td>
<td class="breakword url-cell">api/{tenantKey}/{orgKey}/corePatterns/clientSettings <i title="Copy to clipboard" class="copy-clipboard fa fa-clipboard clipboard-url" aria-hidden="true" data-clipboard-target="#copy-corepatterns-clientsettings"></i></td>
<div class="hidden-copylink" id="copy-corepatterns-clientsettings">api/{tenantKey}/{orgKey}/corePatterns/clientSettings</div>
</tr>
<tr>
<td>Methods Supported</td>
<td><a href="#GET">GET</a></td>
</tr>
</tbody>
</table>
<h2>All Operations</h2>
<p>
This service includes the following operations:
</p>
<ul>
<li>
GET:
<ul>
<li><a href="#c5df0e6f-6c86-4ca9-b376-c40224622d4d">GET Get Shell General Settings</a></li>
</ul>
</li>
</ul>
<h2>All Resources</h2>
<p>
This service uses the following resources:
</p>
<ul>
<li><a href="#ShellGeneralSettings">ShellGeneralSettings</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="c5df0e6f-6c86-4ca9-b376-c40224622d4d"></a>
<h3>GET Get Shell General Settings <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-c5df0e6f-6c86-4ca9-b376-c40224622d4d"></i></h3>
<div class="hidden-copylink" id="copy-c5df0e6f-6c86-4ca9-b376-c40224622d4d"><a href="#c5df0e6f-6c86-4ca9-b376-c40224622d4d">GET Get Shell General Settings</a></div>
<p class="operation-description">Custom operation 'GetShellGeneralSettings'.</p>
<p>Response:</p>
<table>
<tbody>
<tr>
<td>When successful, the response body contains a resource of type 'ShellGeneralSettings'. See <a href="#ShellGeneralSettings">ShellGeneralSettings.</a></td>
</tr>
</tbody>
</table>
<p>Response status codes:</p>
<table>
<tbody>
<tr>
<td class="highlighted">200</td>
<td>OK. The operation was completed successfully.</td>
</tr>
<tr>
<td class="highlighted">400</td>
<td>BadRequest. The request parameters are invalid.</td>
</tr>
</tbody>
</table>
</div>
<div class="content-section-col2">
<p>Resource URL:</p>
<div class="hidden-copylink" id="copy2-c5df0e6f-6c86-4ca9-b376-c40224622d4d">api/{tenantKey}/{orgKey}/corePatterns/clientSettings/getShellGeneralSettings</div>
<div class="resource-url">
<div class="inner-resource-url"><div>GET /corePatterns/clientSettings/getShellGeneralSettings</div></div>
<div class="copy-clipboard clipboard-example" data-clipboard-target="#copy2-c5df0e6f-6c86-4ca9-b376-c40224622d4d"><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="ShellGeneralSettings"></a>
<h4>ShellGeneralSettings <i title="Copy to clipboard" class="copy-clipboard fa fa-link" aria-hidden="true" data-clipboard-target="#copy-ShellGeneralSettings"></i></h4>
<div class="hidden-copylink" id="copy-ShellGeneralSettings"><a href="#ShellGeneralSettings">ShellGeneralSettings</a></div>
<p>The following elements are optional:</p>
<table>
<tbody>
<tr>
<td class="highlighted">logo</td>
<td class="wrap"><i>(string)</i> Logo.
</td>
</tr>
<tr>
<td class="highlighted">routesUri</td>
<td class="wrap"><i>(string)</i> Routes Uri.
</td>
</tr>
<tr>
<td class="highlighted">showSupportRequestOption</td>
<td class="wrap"><i>(bool)</i> Show Support Request Option.
</td>
</tr>
<tr>
<td class="highlighted">showFeedbackOption</td>
<td class="wrap"><i>(bool)</i> Show Feedback Option.
</td>
</tr>
<tr>
<td class="highlighted">showApplicationsOption</td>
<td class="wrap"><i>(bool)</i> Show Applications Option.
</td>
</tr>
<tr>
<td class="highlighted">applicationsExternalUri</td>
<td class="wrap"><i>(string)</i> Applications External Uri.
</td>
</tr>
<tr>
<td class="highlighted">pnsExternalUri</td>
<td class="wrap"><i>(string)</i> Pns External Uri.
</td>
</tr>
<tr>
<td class="highlighted">hideRoleIfSingleRole</td>
<td class="wrap"><i>(bool)</i> Hide Role If Single Role.
</td>
</tr>
<tr>
<td class="highlighted">createCompanyOperation</td>
<td class="wrap"><i>(string)</i> Create Company Operation.
</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>