System APIs
Update a flow template
| HTTP method | PUT |
| URI | https://api.rambase.net/system/automated-flow-templates/{automatedFlowTemplateId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {automatedFlowTemplateId} |
Automated flow template identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 4966, 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.
AutomatedFlowTemplate
This field is optional.
>Name
Name of the automated flow
Input must match the following regular expression pattern: ^(?!.*(href)).*
This field is optional.
>{String}</Name>Description
Description of the automated flow template
This field is optional.
>{String}</Description>EventType
This field is optional.
>RamBaseEventTypeId
RamBase event type identifier
Minimum value: 100000
This field is optional.
>{Integer}</RamBaseEventTypeId>Action
This field is optional.
>AutomatedFlowActionId
Automated flow action identifier
Minimum value: 100000
This field is optional.
>{Integer}</AutomatedFlowActionId>AutomatedFlowTemplate
This field is optional.
": {Name
Name of the automated flow
Input must match the following regular expression pattern: ^(?!.*(href)).*
This field is optional.
": "{String}",Description
Description of the automated flow template
This field is optional.
": "{String}",EventType
This field is optional.
": {RamBaseEventTypeId
RamBase event type identifier
Minimum value: 100000
This field is optional.
": "{Integer}"Action
This field is optional.
": {AutomatedFlowActionId
Automated flow action identifier
Minimum value: 100000
This field is optional.
": "{Integer}"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 106751 HTTP 400 | Automation flow template not found |
| Error 106789 HTTP 404 | Automation flow template filter not found |
| Error 107167 HTTP 400 | Action parameter can not be a tag including "QIS" for this specific action and event. |
| Error 105904 HTTP 400 | Action is not active |