System APIs
Automated flow parameter for given identifiers
| HTTP method | GET |
| URI | https://api.rambase.net/system/automated-flows/{automatedFlowId}/parameters/{automatedFlowParameterId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {automatedFlowId} |
Automated flow identifier
Integer, minimum 100000 |
| - URI parameter {automatedFlowParameterId} |
Automated flow action parameter identifier
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 4605, version 5 |
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.
| $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. |
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.
AutomatedFlowParameterId
Automated flow parameter identifier
>{Integer}</AutomatedFlowParameterId>Value
Value of the parameter
>{String}</Value>AutomatedFlowActionParameterId
Automated flow action parameter identifier
>{Integer}</AutomatedFlowActionParameterId>Key
Key of the parameter. The key used to reference the value when the action is executed.
>{String}</Key>Title
Descriptive name of the parameter
>{String}</Title>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>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>AutomatedFlowActionParameterLink
Automated flow action parameter link
>{String}</AutomatedFlowActionParameterLink>AutomatedFlowParameterId
Automated flow parameter identifier
": "{Integer}",Value
Value of the parameter
": "{String}",AutomatedFlowActionParameterId
Automated flow action parameter identifier
": "{Integer}",Key
Key of the parameter. The key used to reference the value when the action is executed.
": "{String}",Title
Descriptive name of the parameter
": "{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}",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}"AutomatedFlowActionParameterLink
Automated flow action parameter link
": "{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 105763 HTTP 404 | Automated flow action not found |
| Error 105789 HTTP 404 | Parameter not found |