API

System APIs

POST system/automated-flows

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.

Format:
1
<AutomatedFlow>
2
     <Name
Name

Required/mandatory field

Name of the automated flow

Input must match the following regular expression pattern: ^(?!.*(href)).*

>{String}</Name>
3
     <Description
Description

Description of the automated flow

This field is optional.

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

This field is optional.

>
5
          <RamBaseEventTypeId
RamBaseEventTypeId

RamBase event type identifier

Minimum value: 100000

This field is optional.

>{Integer}</RamBaseEventTypeId>
6
     </EventType>
7
     <Action
Action

This field is optional.

>
8
          <AutomatedFlowActionId
AutomatedFlowActionId

Automated flow action identifier

Minimum value: 100000

This field is optional.

>{Integer}</AutomatedFlowActionId>
9
     </Action>
10
</AutomatedFlow>
1
{
2
     "automatedFlow": {
3
          "name
Name

Required/mandatory field

Name of the automated flow

Input must match the following regular expression pattern: ^(?!.*(href)).*

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

Description of the automated flow

This field is optional.

": "{String}",
5
          "eventType
EventType

This field is optional.

": {
6
               "ramBaseEventTypeId
RamBaseEventTypeId

RamBase event type identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
7
          },
8
          "action
Action

This field is optional.

": {
9
               "automatedFlowActionId
AutomatedFlowActionId

Automated flow action identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
10
          }
11
     }
12
}

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.
$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.

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