System APIs
Lists setting definitions and what values current system has for each setting.
| HTTP method | GET |
| URI | https://api.rambase.net/system/settings?search={search} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 150 |
| Successful HTTP status code | 200 |
| API resource identifier | 3037, version 1 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| search String, optional | Search for setting based on key or name (english and specified language). |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
| IsRequired Boolean | Flag if setting is required/must be set before using system. If this is a sub-setting, this settings must be set when the parent setting is turned on. The user must activate this setting (a system setting value must exist for this setting). If a default value is also specified, that will actually be a suggested value, the setting must still be activated. |
| Key String | Setting name used to reference the setting. |
| ModuleId Integer | Module identifier. |
| ParentSystemSettingDefinitionId Integer | System setting definition identifier. |
| SystemSettingId Integer | System setting identifier. |
Read more about filters and sorting on how to use sortable parameters
| IsRequired Boolean | Flag if setting is required/must be set before using system. If this is a sub-setting, this settings must be set when the parent setting is turned on. The user must activate this setting (a system setting value must exist for this setting). If a default value is also specified, that will actually be a suggested value, the setting must still be activated. |
| Key String | Setting name used to reference the setting |
| ModuleId Integer | Module identifier |
| ParentSystemSettingDefinitionId Integer | System setting definition identifier |
| SystemSettingId Integer | System setting identifier |
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
SystemSettingId
System setting identifier
>{Integer}</SystemSettingId>Status
Status of the system setting value
>{Integer}</Status>Value
System setting value
>{String}</Value>SystemSettingDefinitionId
System setting definition identifier
>{Integer}</SystemSettingDefinitionId>Key
Setting name used to reference the setting
>{String}</Key>Name
Short name/description of the setting definition
>{String}</Name>Description
Descrtiption of the setting definition
>{String}</Description>DefaultValue
Default value if setting not set for system
>{String}</DefaultValue>DataType
Allowed values for setting. Used for validation of input from user.
>{String}</DataType>MinimumValue
For data type integer or decimal a minimum value can be specified, e.g. if a value range is allowed.
>{Decimal}</MinimumValue>MaximumValue
For data type integer or decimal a maximum value can be specified, e.g. if a value range is allowed.
>{Decimal}</MaximumValue>IsRequired
Flag if setting is required/must be set before using system. If this is a sub-setting, this settings must be set when the parent setting is turned on. The user must activate this setting (a system setting value must exist for this setting). If a default value is also specified, that will actually be a suggested value, the setting must still be activated.
>{Boolean}</IsRequired>ModuleId
Module identifier
>{Integer}</ModuleId>ModuleLink
Module reference
>{String}</ModuleLink>SystemSettingDefinitionId
System setting definition identifier
>{Integer}</SystemSettingDefinitionId>SystemSettingDefinitionLink
System setting definition link
>{String}</SystemSettingDefinitionLink>Object
Object/archive/context of the DOV
>{String}</Object>Field
Fieldname of the DOV
>{String}</Field>SystemSettingDefinitionLink
System setting definition link
>{String}</SystemSettingDefinitionLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>SystemSettingId
System setting identifier
": "{Integer}",Status
Status of the system setting value
": "{Integer}",Value
System setting value
": "{String}",SystemSettingDefinitionId
System setting definition identifier
": "{Integer}",Key
Setting name used to reference the setting
": "{String}",Name
Short name/description of the setting definition
": "{String}",Description
Descrtiption of the setting definition
": "{String}",DefaultValue
Default value if setting not set for system
": "{String}",DataType
Allowed values for setting. Used for validation of input from user.
": "{String}",MinimumValue
For data type integer or decimal a minimum value can be specified, e.g. if a value range is allowed.
": "{Decimal}",MaximumValue
For data type integer or decimal a maximum value can be specified, e.g. if a value range is allowed.
": "{Decimal}",IsRequired
Flag if setting is required/must be set before using system. If this is a sub-setting, this settings must be set when the parent setting is turned on. The user must activate this setting (a system setting value must exist for this setting). If a default value is also specified, that will actually be a suggested value, the setting must still be activated.
": "{Boolean}",ModuleId
Module identifier
": "{Integer}",ModuleLink
Module reference
": "{String}"SystemSettingDefinitionId
System setting definition identifier
": "{Integer}",SystemSettingDefinitionLink
System setting definition link
": "{String}"Object
Object/archive/context of the DOV
": "{String}",Field
Fieldname of the DOV
": "{String}"SystemSettingDefinitionLink
System setting definition link
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 101015 HTTP 404 | Permission not found |