lock
GET
api/Settings/v1/{interfaceCode}?showAll={showAll}
Return all Settings for a given interface
EXPANDexpand_more
Request Information
Roles
- InterfaceSettings
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
interfaceCode |
Interface Code for the settings you wish to retrieve |
string |
Required |
showAll | boolean |
Default value is False |
Body Parameters
None.
EXPANDexpand_more
Response Information
Resource Description
Returns all the Settings for the relevant interface code
Collection of SettingsModelName | Description | Type | Additional information |
---|---|---|---|
ID | string |
None. |
|
SaveObj | Object |
None. |
|
Title | string |
None. |
|
Parent | string |
None. |
|
ParentDefinitionSeq | string |
None. |
|
NodeTitle | string |
None. |
|
Description | string |
None. |
|
ReadOnly | string |
None. |
|
Locked | XSYSCentrallyManagedLock |
None. |
|
Type | string |
None. |
|
ViewType | string |
None. |
|
Value | Object |
None. |
|
Error | SettingsLoadError |
None. |
|
RowVersion | string |
None. |
|
SelectOptions | Collection of SettingsLookupMenuItem |
None. |
|
SubSettings | Collection of SettingsModel |
None. |
Response Formats
Sample not available.
Sample not available.
Sample not available.
Sample not available.