System APIs
Create parameter for an automated flow action
HTTP method | POST |
URI | https://api.rambase.net/system/automated-flow-actions/{automatedFlowActionId}/parameters |
Supported formats | Xml, Html, Json (ex. $format=json) |
- URI parameter {automatedFlowActionId} |
Automated flow action identifier
Integer, minimum 100000 |
Successful HTTP status code | 201 |
API resource identifier | 4477, 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.
Title
Descriptive name of the parameter
This field is optional.
>{String}</Title>Key
Key of the parameter. The key used to reference the value when the action is executed.
This field is optional.
>{String}</Key>Description
Description of the parameter
This field is optional.
>{String}</Description>Datatype
Required/mandatory field
Datatype of the parameter.
Applicable domain values can be found here
>{String}</Datatype>DefaultValue
Default value of the parameter
This field is optional.
>{String}</DefaultValue>IsOptional
True if the parameter is optional, meaning it is not required for the action to run
Default value: False
This field is optional.
>{Boolean}</IsOptional>SortIndex
Sort order of the parameter
Minimum value: 0
This field is optional.
>{Integer}</SortIndex>ValueRestrictions
This field is optional.
>MinimumValue
Minimum allowed value of parameter. This field can only be set on datatype with a numeric type.
This field is optional.
>{Decimal}</MinimumValue>MaximumValue
Maximum allowed value of parameter. This field can only be set on datatype with a numeric type.
This field is optional.
>{Decimal}</MaximumValue>DomainValueList
This field is optional.
>Object
Object/archive/context of the values
This field is optional.
>{String}</Object>Field
Fieldname of the DOV
This field is optional.
>{String}</Field>Title
Descriptive name of the parameter
This field is optional.
": "{String}",Key
Key of the parameter. The key used to reference the value when the action is executed.
This field is optional.
": "{String}",Description
Description of the parameter
This field is optional.
": "{String}",Datatype
Required/mandatory field
Datatype of the parameter.
Applicable domain values can be found here
": "{String}",DefaultValue
Default value of the parameter
This field is optional.
": "{String}",IsOptional
True if the parameter is optional, meaning it is not required for the action to run
Default value: False
This field is optional.
": "{Boolean}",SortIndex
Sort order of the parameter
Minimum value: 0
This field is optional.
": "{Integer}",ValueRestrictions
This field is optional.
": {MinimumValue
Minimum allowed value of parameter. This field can only be set on datatype with a numeric type.
This field is optional.
": "{Decimal}",MaximumValue
Maximum allowed value of parameter. This field can only be set on datatype with a numeric type.
This field is optional.
": "{Decimal}",DomainValueList
This field is optional.
": {Object
Object/archive/context of the values
This field is optional.
": "{String}",Field
Fieldname of the DOV
This field is optional.
": "{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.
AutomatedFlowActionParameterId
Automated flow action parameter identifier
>{Integer}</AutomatedFlowActionParameterId>Title
Descriptive name of the parameter
>{String}</Title>Key
Key of the parameter. The key used to reference the value when the action is executed.
>{String}</Key>Description
Description of the parameter
>{String}</Description>Datatype
Datatype of the parameter.
Possible domain values can be found here
>{String}</Datatype>DefaultValue
Default value of the parameter
>{String}</DefaultValue>IsOptional
True if the parameter is optional, meaning it is not required for the action to run
>{Boolean}</IsOptional>SortIndex
Sort order of the parameter
>{Integer}</SortIndex>MinimumValue
Minimum allowed value of parameter. This field can only be set on datatype with a numeric type.
>{Decimal}</MinimumValue>MaximumValue
Maximum allowed value of parameter. This field can only be set on datatype with a numeric type.
>{Decimal}</MaximumValue>RegularExpression
A regular expression used to restrict possible values for this parameter.
>{String}</RegularExpression>Object
Object/archive/context of the values
>{String}</Object>Field
Fieldname of the DOV
>{String}</Field>AutomatedFlowActionParameterId
Automated flow action parameter identifier
": "{Integer}",Title
Descriptive name of the parameter
": "{String}",Key
Key of the parameter. The key used to reference the value when the action is executed.
": "{String}",Description
Description of the parameter
": "{String}",Datatype
Datatype of the parameter.
Possible domain values can be found here
": "{String}",DefaultValue
Default value of the parameter
": "{String}",IsOptional
True if the parameter is optional, meaning it is not required for the action to run
": "{Boolean}",SortIndex
Sort order of the parameter
": "{Integer}",MinimumValue
Minimum allowed value of parameter. This field can only be set on datatype with a numeric type.
": "{Decimal}",MaximumValue
Maximum allowed value of parameter. This field can only be set on datatype with a numeric type.
": "{Decimal}",RegularExpression
A regular expression used to restrict possible values for this parameter.
": "{String}",Object
Object/archive/context of the values
": "{String}",Field
Fieldname of the DOV
": "{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:
Error 105791 HTTP 400 | Parameter key is required |
Error 106809 HTTP 400 | Parameter title is required |
Error 106808 HTTP 400 | Sort index has to be a positive integer |
Error 105794 HTTP 400 | A parameter with that name already exists |
Error 106591 HTTP 400 | A boolean can only have a default value of 'true' or 'false' |
Error 106592 HTTP 400 | A boolean can not have a minimum, maximum, domain value or regex restrictions |
Error 106593 HTTP 400 | A string value can not have a minimum, maximum or domain value restriction |
Error 106594 HTTP 400 | A number value can only have a number as default value |
Error 106595 HTTP 400 | A number value can not have a domain value or regex restriction |
Error 106828 HTTP 400 | Minimum value can not be larger than maximum value |
Error 106829 HTTP 400 | Default value can not me lower than minimum value |
Error 106830 HTTP 400 | Default value can not be larger than the maximum value |
Error 106599 HTTP 400 | Domain value object and field is required for parameters with datatype DOV |
Error 106597 HTTP 400 | A domain value can not have a minimum, maximum or regex restriction |
Error 106600 HTTP 400 | Default value does not exists in DOV |