API

Base APIs

GET base/companies/setting-definitions/{settingDefinitionId}

Company setting definition details for the provided identifier

HTTP method GET
URI https://api.rambase.net/base/companies/setting-definitions/{settingDefinitionId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {settingDefinitionId} Company setting definition identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 2039, version 14

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.

Format:
1
1

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.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

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.

Format:
1
<CompanySettingDefinition>
2
     <CompanySettingDefinitionId
CompanySettingDefinitionId

Company setting definition identifier

>{Integer}</CompanySettingDefinitionId>
3
     <Status
Status

Status of company setting definition

Possible domain values can be found here

>{Integer}</Status>
4
     <Key
Key

Setting name used to reference the setting

>{String}</Key>
5
     <Name
Name

Short name/description of the setting definition

>{String}</Name>
6
     <TranslatedName
TranslatedName

Name translated to selected language. If no translation exists for the given langauage, english name will show.

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedName in your request URI to get this field

>{String}</TranslatedName>
7
     <Description
Description

Descrtiption of the setting definition

>{String}</Description>
8
     <TranslatedDescription
TranslatedDescription

Description translated to selected language. If no translation exists for the given langauage, english description will show.

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedDescription in your request URI to get this field

>{String}</TranslatedDescription>
9
     <DefaultValue
DefaultValue

Default value if setting not set for company

>{String}</DefaultValue>
10
     <DataType
DataType

Allowed values for setting. Used for validation of input from user.

>{String}</DataType>
11
     <MinimumValue
MinimumValue

For data type integer or decimal a minimum value can be specified, e.g. if a value range is allowed.

>{Decimal}</MinimumValue>
12
     <MaximumValue
MaximumValue

For data type integer or decimal a maximum value can be specified, e.g. if a value range is allowed.

>{Decimal}</MaximumValue>
13
     <IsRequired
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 company 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>
14
     <NumberOfChildSettings
NumberOfChildSettings

Number of company setting definitions this setting is parent for.

This field is greyed out because it is an expandable field. You have to add $expand=NumberOfChildSettings in your request URI to get this field

>{Integer}</NumberOfChildSettings>
15
     <SubModule>
16
          <SubModuleId
SubModuleId

Submodule identifier

>{Integer}</SubModuleId>
17
          <Name
Name

Name of the submodule

>{String}</Name>
18
          <SubModuleLink
SubModuleLink

Submodule reference

>{String}</SubModuleLink>
19
          <Module
Module

This field is greyed out because it is an expandable field. You have to add $expand=SubModule.Module in your request URI to get this field

>
20
               <ModuleId
ModuleId

Module identifier

This field is greyed out because it is an expandable field. You have to add $expand=SubModule.Module in your request URI to get this field

>{Integer}</ModuleId>
21
               <Name
Name

Name of the module

This field is greyed out because it is an expandable field. You have to add $expand=SubModule.Module in your request URI to get this field

>{String}</Name>
22
               <ModuleLink
ModuleLink

Module reference

This field is greyed out because it is an expandable field. You have to add $expand=SubModule.Module in your request URI to get this field

>{String}</ModuleLink>
23
          </Module>
24
     </SubModule>
25
     <ParentCompanySettingDefinition>
26
          <CompanySettingDefinitionId
CompanySettingDefinitionId

Company setting definition identifier

>{Integer}</CompanySettingDefinitionId>
27
          <Name
Name

Short name/description of the setting definition

This field is greyed out because it is an expandable field. You have to add $expand=ParentCompanySettingDefinition.Name in your request URI to get this field

>{String}</Name>
28
          <CompanySettingDefinitionLink
CompanySettingDefinitionLink

Company setting definition reference

>{String}</CompanySettingDefinitionLink>
29
     </ParentCompanySettingDefinition>
30
     <DomainValueList>
31
          <Object
Object

Object/archive/context of the values

>{String}</Object>
32
          <Field
Field

Fieldname of the DOV

>{String}</Field>
33
     </DomainValueList>
34
     <ViewPermission>
35
          <PermissionId
PermissionId

Permission identifier. Optional. Set this if the setting is secret, e.g. not visible for customers. NOTE: If the setting is read in an application the user must have this permission if assigned.

>{Integer}</PermissionId>
36
          <Name
Name

Name of the permission

>{String}</Name>
37
          <PermissionLink
PermissionLink

Permission reference

>{String}</PermissionLink>
38
     </ViewPermission>
39
     <UpdatePermission>
40
          <PermissionId
PermissionId

Permission identifier. Required for active settings. User must have this permission to be allowed to update the value of this setting.

>{Integer}</PermissionId>
41
          <Name
Name

Name of the permission

>{String}</Name>
42
          <PermissionLink
PermissionLink

Permission reference

>{String}</PermissionLink>
43
     </UpdatePermission>
44
     <Repository
Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>
45
          <IsChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{Boolean}</IsChanged>
46
          <ChangedBy
ChangedBy

EmployeeId of the employee making the change

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{Integer}</ChangedBy>
47
          <IsPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{Boolean}</IsPendingDeployment>
48
     </Repository>
49
</CompanySettingDefinition>
1
{
2
     "companySettingDefinition": {
3
          "companySettingDefinitionId
CompanySettingDefinitionId

Company setting definition identifier

": "{Integer}",
4
          "status
Status

Status of company setting definition

Possible domain values can be found here

": "{Integer}",
5
          "key
Key

Setting name used to reference the setting

": "{String}",
6
          "name
Name

Short name/description of the setting definition

": "{String}",
7
          "translatedName
TranslatedName

Name translated to selected language. If no translation exists for the given langauage, english name will show.

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedName in your request URI to get this field

": "{String}",
8
          "description
Description

Descrtiption of the setting definition

": "{String}",
9
          "translatedDescription
TranslatedDescription

Description translated to selected language. If no translation exists for the given langauage, english description will show.

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedDescription in your request URI to get this field

": "{String}",
10
          "defaultValue
DefaultValue

Default value if setting not set for company

": "{String}",
11
          "dataType
DataType

Allowed values for setting. Used for validation of input from user.

": "{String}",
12
          "minimumValue
MinimumValue

For data type integer or decimal a minimum value can be specified, e.g. if a value range is allowed.

": "{Decimal}",
13
          "maximumValue
MaximumValue

For data type integer or decimal a maximum value can be specified, e.g. if a value range is allowed.

": "{Decimal}",
14
          "isRequired
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 company 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}",
15
          "numberOfChildSettings
NumberOfChildSettings

Number of company setting definitions this setting is parent for.

This field is greyed out because it is an expandable field. You have to add $expand=NumberOfChildSettings in your request URI to get this field

": "{Integer}",
16
          "subModule": {
17
               "subModuleId
SubModuleId

Submodule identifier

": "{Integer}",
18
               "name
Name

Name of the submodule

": "{String}",
19
               "subModuleLink
SubModuleLink

Submodule reference

": "{String}",
20
               "module
Module

This field is greyed out because it is an expandable field. You have to add $expand=SubModule.Module in your request URI to get this field

": {
21
                    "moduleId
ModuleId

Module identifier

This field is greyed out because it is an expandable field. You have to add $expand=SubModule.Module in your request URI to get this field

": "{Integer}",
22
                    "name
Name

Name of the module

This field is greyed out because it is an expandable field. You have to add $expand=SubModule.Module in your request URI to get this field

": "{String}",
23
                    "moduleLink
ModuleLink

Module reference

This field is greyed out because it is an expandable field. You have to add $expand=SubModule.Module in your request URI to get this field

": "{String}"
24
               }
25
          },
26
          "parentCompanySettingDefinition": {
27
               "companySettingDefinitionId
CompanySettingDefinitionId

Company setting definition identifier

": "{Integer}",
28
               "name
Name

Short name/description of the setting definition

This field is greyed out because it is an expandable field. You have to add $expand=ParentCompanySettingDefinition.Name in your request URI to get this field

": "{String}",
29
               "companySettingDefinitionLink
CompanySettingDefinitionLink

Company setting definition reference

": "{String}"
30
          },
31
          "domainValueList": {
32
               "object
Object

Object/archive/context of the values

": "{String}",
33
               "field
Field

Fieldname of the DOV

": "{String}"
34
          },
35
          "viewPermission": {
36
               "permissionId
PermissionId

Permission identifier. Optional. Set this if the setting is secret, e.g. not visible for customers. NOTE: If the setting is read in an application the user must have this permission if assigned.

": "{Integer}",
37
               "name
Name

Name of the permission

": "{String}",
38
               "permissionLink
PermissionLink

Permission reference

": "{String}"
39
          },
40
          "updatePermission": {
41
               "permissionId
PermissionId

Permission identifier. Required for active settings. User must have this permission to be allowed to update the value of this setting.

": "{Integer}",
42
               "name
Name

Name of the permission

": "{String}",
43
               "permissionLink
PermissionLink

Permission reference

": "{String}"
44
          },
45
          "repository
Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": {
46
               "isChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{Boolean}",
47
               "changedBy
ChangedBy

EmployeeId of the employee making the change

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{Integer}",
48
               "isPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{Boolean}"
49
          }
50
     }
51
}

Possible error codes the response might return:

Error 101013 HTTP 404 Sub-module not found