System APIs
Adds an applicable domain value to the provided custom fields value list.
| HTTP method | POST |
| URI | https://api.rambase.net/system/dictionary/custom-fields/{customFieldId}/value-list |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {customFieldId} |
Custom field identifier
Integer, minimum 1 |
| Successful HTTP status code | 201 |
| API resource identifier | 2979, version 4 |
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.
Value
Value of the DOV
Maximum value: 1024
This field is optional.
>{String}</Value>Priority
Priority of the domainvalue
Minimum value: 0
Maximum value: 200
Default value: 25
This field is optional.
>{Integer}</Priority>Description
Required/mandatory field
Description of the name/value/code/key
>{String}</Description>Value
Value of the DOV
Maximum value: 1024
This field is optional.
": "{String}",Priority
Priority of the domainvalue
Minimum value: 0
Maximum value: 200
Default value: 25
This field is optional.
": "{Integer}",Description
Required/mandatory field
Description of the name/value/code/key
": "{String}"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.
| $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 |
| $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. |
| $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] |
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.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
DomainValueId
Identifier of the domain value
>{Integer}</DomainValueId>Value
Value of the DOV
>{String}</Value>Priority
Priority of the domainvalue
>{Integer}</Priority>Description
Description of the name/value/code/key
>{String}</Description>TranslatedDescription
Description of the name/value/code/key
>{String}</TranslatedDescription>DomainValueId
Identifier of the domain value
": "{Integer}",Status
Status of the DOV
Possible domain values can be found here
": "{Integer}",Value
Value of the DOV
": "{String}",Priority
Priority of the domainvalue
": "{Integer}",Description
Description of the name/value/code/key
": "{String}",TranslatedDescription
Description of the name/value/code/key
": "{String}"
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: