Base APIs
Update the given formula definition parameter
| HTTP method | PUT |
| URI | https://api.rambase.net/base/formula-definitions/{formulaDefinitionId}/parameters/{parameterId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {formulaDefinitionId} |
Formula identifier
Integer, minimum 100000 |
| - URI parameter {parameterId} |
Parameter identifier
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 2543, version 3 |
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.
Parameter
This field is optional.
>Key
Key that is used in formula and replaced with the value of the parameter
Minimum value: 2
Maximum value: 40
Input must match the following regular expression pattern: [a-zA-Z]
This field is optional.
>{String}</Key>Title
Title of the parameter
This field is optional.
>{String}</Title>Description
Description of the parameter
This field is optional.
>{String}</Description>Datatype
Datatype of the parameter
Applicable domain values can be found here
This field is optional.
>{String}</Datatype>MinimumValue
Minimum value of the parameter
This field is optional.
>{Decimal}</MinimumValue>MaximumValue
Maximum value of the parameter
This field is optional.
>{Decimal}</MaximumValue>Parameter
This field is optional.
": {Key
Key that is used in formula and replaced with the value of the parameter
Minimum value: 2
Maximum value: 40
Input must match the following regular expression pattern: [a-zA-Z]
This field is optional.
": "{String}",Title
Title of the parameter
This field is optional.
": "{String}",Description
Description of the parameter
This field is optional.
": "{String}",Datatype
Datatype of the parameter
Applicable domain values can be found here
This field is optional.
": "{String}",MinimumValue
Minimum value of the parameter
This field is optional.
": "{Decimal}",MaximumValue
Maximum value of the parameter
This field is optional.
": "{Decimal}"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. |
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.
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 102696 HTTP 404 | Formula definition not found |
| Error 102748 HTTP 400 | Parameter key must be longer than one character |
| Error 102706 HTTP 400 | A parameter with that key already exists for this formula definition |
| Error 102756 HTTP 400 | The chosen datatype is only allowed if the formula definition is of type Price |
| Error 102727 HTTP 400 | Minimumvalue and maximumvalue is not valid for the selected datatype |
| Error 102726 HTTP 400 | Minimum value can not be larger than maximum value |