API

System APIs

GET system/automated-flow-templates/{automatedFlowTemplateId}

Automated flow template details for provided identifier

HTTP method GET
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 4955, 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
1

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.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable 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.

Format:
1
<AutomatedFlowTemplate>
2
     <AutomatedFlowTemplateId
AutomatedFlowTemplateId

Automated flow template identifier

>{Integer}</AutomatedFlowTemplateId>
3
     <Status
Status

Status of the automated flow template

Possible domain values can be found here

>{Integer}</Status>
4
     <Name
Name

Name of the automated flow

>{String}</Name>
5
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
     <Description
Description

Description of the automated flow template

>{String}</Description>
7
     <EventType>
8
          <RamBaseEventTypeId
RamBaseEventTypeId

RamBase event type identifier

>{Integer}</RamBaseEventTypeId>
9
          <Name
Name

Key of the Event Type. This key will be used to identify which event to fire.

>{String}</Name>
10
          <Namespace
Namespace

Namespace of the rambase event type

>{String}</Namespace>
11
          <Description
Description

Description of the Event Type

>{String}</Description>
12
          <ObjectDetailsUri
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>
13
          <RamBaseEventTypeLink
RamBaseEventTypeLink

RamBase event type reference

>{String}</RamBaseEventTypeLink>
14
     </EventType>
15
     <Action>
16
          <AutomatedFlowActionId
AutomatedFlowActionId

Automated flow action identifier

>{Integer}</AutomatedFlowActionId>
17
          <Name
Name

Name of the action

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

Description of the action

>{String}</Description>
19
          <AutomatedFlowActionLink
AutomatedFlowActionLink

Automated flow action link

>{String}</AutomatedFlowActionLink>
20
     </Action>
21
     <Repository
Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>
22
          <Scope
Scope

Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{String}</Scope>
23
          <IsChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{Boolean}</IsChanged>
24
          <ChangedBy
ChangedBy

EmployeeId of the employee making the change

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>
25
               <UserId
UserId

User identifier

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{Integer}</UserId>
26
               <UserLink
UserLink

User reference

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{String}</UserLink>
27
          </ChangedBy>
28
          <IsPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{Boolean}</IsPendingDeployment>
29
     </Repository>
30
</AutomatedFlowTemplate>
1
{
2
     "automatedFlowTemplate": {
3
          "automatedFlowTemplateId
AutomatedFlowTemplateId

Automated flow template identifier

": "{Integer}",
4
          "status
Status

Status of the automated flow template

Possible domain values can be found here

": "{Integer}",
5
          "name
Name

Name of the automated flow

": "{String}",
6
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
          "description
Description

Description of the automated flow template

": "{String}",
8
          "eventType": {
9
               "ramBaseEventTypeId
RamBaseEventTypeId

RamBase event type identifier

": "{Integer}",
10
               "name
Name

Key of the Event Type. This key will be used to identify which event to fire.

": "{String}",
11
               "namespace
Namespace

Namespace of the rambase event type

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

Description of the Event Type

": "{String}",
13
               "objectDetailsUri
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}",
14
               "ramBaseEventTypeLink
RamBaseEventTypeLink

RamBase event type reference

": "{String}"
15
          },
16
          "action": {
17
               "automatedFlowActionId
AutomatedFlowActionId

Automated flow action identifier

": "{Integer}",
18
               "name
Name

Name of the action

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

Description of the action

": "{String}",
20
               "automatedFlowActionLink
AutomatedFlowActionLink

Automated flow action link

": "{String}"
21
          },
22
          "repository
Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": {
23
               "scope
Scope

Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{String}",
24
               "isChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{Boolean}",
25
               "changedBy
ChangedBy

EmployeeId of the employee making the change

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": {
26
                    "userId
UserId

User identifier

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{Integer}",
27
                    "userLink
UserLink

User reference

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{String}"
28
               },
29
               "isPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{Boolean}"
30
          }
31
     }
32
}

Possible error codes the response might return:

Error 101814 HTTP 404 Employee not found