System APIs
This resource updates the basic data of an Event Type.
| HTTP method | PUT |
| URI | https://api.rambase.net/system/rambase-event-types/{rambaseEventTypeId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {rambaseEventTypeId} |
RamBase event type identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 257, version 16 |
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.
RamBaseEventType
This field is optional.
>Description
Description of the Event Type
This field is optional.
>{String}</Description>AllowWebhooks
If the Event Type can be used to create webhooks
This field is optional.
>{Boolean}</AllowWebhooks>AllowAutomatedFlows
Whether this event type can be used in an automated flow.
This field is optional.
>{Boolean}</AllowAutomatedFlows>Name
Name of the rambase event type. This should be more human readable than eventtype.
This field is optional.
>{String}</Name>Namespace
Namespace of the rambase event type
This field is optional.
>{String}</Namespace>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.
This field is optional.
>{String}</ObjectDetailsUri>RamBaseEventType
This field is optional.
": {Description
Description of the Event Type
This field is optional.
": "{String}",AllowWebhooks
If the Event Type can be used to create webhooks
This field is optional.
": "{Boolean}",AllowAutomatedFlows
Whether this event type can be used in an automated flow.
This field is optional.
": "{Boolean}",Name
Name of the rambase event type. This should be more human readable than eventtype.
This field is optional.
": "{String}",Namespace
Namespace of the rambase event type
This field is optional.
": "{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.
This field is optional.
": "{String}"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 102559 HTTP 400 | It not allowed to update in this status |
| Error 102560 HTTP 400 | Event type can not be "blank" |
| Error 102561 HTTP 400 | Event type already exist on another RamBase event type |