API

System APIs

PUT system/automated-flow-actions/{automatedFlowActionId}/parameters/{automatedFlowActionParameterId}

Update an automated flow action parameter

HTTP method PUT
URI https://api.rambase.net/system/automated-flow-actions/{automatedFlowActionId}/parameters/{automatedFlowActionParameterId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {automatedFlowActionId} Automated flow action identifier
Integer, minimum 100000
- URI parameter {automatedFlowActionParameterId} Automated flow action parameter identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 4480, version 6

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
<AutomatedFlowActionParameter
AutomatedFlowActionParameter

This field is optional.

>
2
     <Title
Title

Descriptive name of the parameter

This field is optional.

>{String}</Title>
3
     <Key
Key

Key of the parameter. The key used to reference the value when the action is executed.

This field is optional.

>{String}</Key>
4
     <Description
Description

Description of the parameter

This field is optional.

>{String}</Description>
5
     <Datatype
Datatype

Datatype of the parameter.

Applicable domain values can be found here

This field is optional.

>{String}</Datatype>
6
     <DefaultValue
DefaultValue

Default value of the parameter

This field is optional.

>{String}</DefaultValue>
7
     <IsOptional
IsOptional

True if the parameter is optional, meaning it is not required for the action to run

This field is optional.

>{Boolean}</IsOptional>
8
     <SortIndex
SortIndex

Sort order of the parameter

Minimum value: 0

This field is optional.

>{Integer}</SortIndex>
9
     <ValueRestrictions
ValueRestrictions

This field is optional.

>
10
          <MinimumValue
MinimumValue

Minimum allowed value of parameter. This field can only be set on datatype with a numeric type.

This field is optional.

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

Maximum allowed value of parameter. This field can only be set on datatype with a numeric type.

This field is optional.

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

This field is optional.

>
13
               <Object
Object

Object/archive/context of the values

This field is optional.

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

Fieldname of the DOV

This field is optional.

>{String}</Field>
15
          </DomainValueList>
16
     </ValueRestrictions>
17
</AutomatedFlowActionParameter>
1
{
2
     "automatedFlowActionParameter
AutomatedFlowActionParameter

This field is optional.

": {
3
          "title
Title

Descriptive name of the parameter

This field is optional.

": "{String}",
4
          "key
Key

Key of the parameter. The key used to reference the value when the action is executed.

This field is optional.

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

Description of the parameter

This field is optional.

": "{String}",
6
          "datatype
Datatype

Datatype of the parameter.

Applicable domain values can be found here

This field is optional.

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

Default value of the parameter

This field is optional.

": "{String}",
8
          "isOptional
IsOptional

True if the parameter is optional, meaning it is not required for the action to run

This field is optional.

": "{Boolean}",
9
          "sortIndex
SortIndex

Sort order of the parameter

Minimum value: 0

This field is optional.

": "{Integer}",
10
          "valueRestrictions
ValueRestrictions

This field is optional.

": {
11
               "minimumValue
MinimumValue

Minimum allowed value of parameter. This field can only be set on datatype with a numeric type.

This field is optional.

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

Maximum allowed value of parameter. This field can only be set on datatype with a numeric type.

This field is optional.

": "{Decimal}",
13
               "domainValueList
DomainValueList

This field is optional.

": {
14
                    "object
Object

Object/archive/context of the values

This field is optional.

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

Fieldname of the DOV

This field is optional.

": "{String}"
16
               }
17
          }
18
     }
19
}

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.

Format:
1
1

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 105792 HTTP 400 Parameter datatype 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