System APIs
Create new automated flow
| HTTP method | POST |
| URI | https://api.rambase.net/system/automated-flows |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 4584, 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.
Name
Required/mandatory field
Name of the automated flow
Input must match the following regular expression pattern: ^(?!.*(href)).*
>{String}</Name>Description
Description of the automated flow
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>Name
Required/mandatory field
Name of the automated flow
Input must match the following regular expression pattern: ^(?!.*(href)).*
": "{String}",Description
Description of the automated flow
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. |
| $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.
AutomatedFlowId
Automated flow identifier
>{Integer}</AutomatedFlowId>Status
Status of the automated flow
Possible domain values can be found here
>{Integer}</Status>Name
Name of the automated flow
>{String}</Name>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Description
Description of the automated flow
>{String}</Description>UserId
User identifier
>{Integer}</UserId>FirstName
First name of the user
>{String}</FirstName>Name
Name of the user
>{String}</Name>UserLink
User reference
>{String}</UserLink>RamBaseEventTypeId
RamBase event type identifier
>{Integer}</RamBaseEventTypeId>Name
Key of the Event Type. This key will be used to identify which event to fire.
>{String}</Name>Description
Description of the Event Type
>{String}</Description>ObjectDetailsUri
API location for where to find more information about the object this event occurred for. May contains placeholders from with reference to parameter names. The parameter names are case sensitive.
>{String}</ObjectDetailsUri>RamBaseEventTypeLink
RamBase event type reference
>{String}</RamBaseEventTypeLink>AutomatedFlowActionId
Automated flow action identifier
>{Integer}</AutomatedFlowActionId>Name
Name of the action
>{String}</Name>Description
Description of the action
>{String}</Description>AutomatedFlowActionLink
Automated flow action link
>{String}</AutomatedFlowActionLink>AutomatedFlowId
Automated flow identifier
": "{Integer}",Status
Status of the automated flow
Possible domain values can be found here
": "{Integer}",Name
Name of the automated flow
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",Description
Description of the automated flow
": "{String}",UserId
User identifier
": "{Integer}",FirstName
First name of the user
": "{String}",Name
Name of the user
": "{String}",UserLink
User reference
": "{String}"RamBaseEventTypeId
RamBase event type identifier
": "{Integer}",Name
Key of the Event Type. This key will be used to identify which event to fire.
": "{String}",Description
Description of the Event Type
": "{String}",ObjectDetailsUri
API location for where to find more information about the object this event occurred for. May contains placeholders from with reference to parameter names. The parameter names are case sensitive.
": "{String}",RamBaseEventTypeLink
RamBase event type reference
": "{String}"AutomatedFlowActionId
Automated flow action identifier
": "{Integer}",Name
Name of the action
": "{String}",Description
Description of the action
": "{String}",AutomatedFlowActionLink
Automated flow action 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 101013 HTTP 404 | Sub-module not found |
| Error 106417 HTTP 404 | Automated flow 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 |