API

RamBase REST APIs

POST system/users/{userId}/dashboards/{dashboardName}/widgets

Add a new widget to a dashboard. The other widgets on the same dashbord will autmatically have its position recalculated.

HTTP method POST
URI https://api.rambase.net/system/users/{userId}/dashboards/{dashboardName}/widgets
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {userId} User identifier
Integer, minimum 100
- URI parameter {dashboardName} The module based dashboard name used as a witdget container
String
Successful HTTP status code 201
API resource identifier 1839, version 2

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
<Widget>
2
     <WidgetApplicationMatch
WidgetApplicationMatch

Required/mandatory field

The lookup name of the widget/application

>{String}</WidgetApplicationMatch>
3
     <Placement>
4
          <Row
Row

Required/mandatory field

The placement of a component (widget) in a dashboard.

Minimum value: 0

>{Integer}</Row>
5
          <Column
Column

Required/mandatory field

The placement of a component (widget) in a dashboard.

Minimum value: 0

>{Integer}</Column>
6
     </Placement>
7
     <SerializedSettingsObject
SerializedSettingsObject

A widget can have different settings. These settings are stored here as a json serialized string

This field is optional.

>{String}</SerializedSettingsObject>
8
</Widget>
1
{
2
     "widget": {
3
          "widgetApplicationMatch
WidgetApplicationMatch

Required/mandatory field

The lookup name of the widget/application

": "{String}",
4
          "placement": {
5
               "row
Row

Required/mandatory field

The placement of a component (widget) in a dashboard.

Minimum value: 0

": "{Integer}",
6
               "column
Column

Required/mandatory field

The placement of a component (widget) in a dashboard.

Minimum value: 0

": "{Integer}"
7
          },
8
          "serializedSettingsObject
SerializedSettingsObject

A widget can have different settings. These settings are stored here as a json serialized string

This field is optional.

": "{String}"
9
     }
10
}

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
<Widget>
2
     <WidgetId
WidgetId

A unique id that will indentify a specific widget on a dashboard

>{String}</WidgetId>
3
     <WidgetApplicationMatch
WidgetApplicationMatch

The lookup name of the widget/application

>{String}</WidgetApplicationMatch>
4
     <Placement>
5
          <Row
Row

The placement of a component (widget) in a dashboard.

>{Integer}</Row>
6
          <Column
Column

The placement of a component (widget) in a dashboard.

>{Integer}</Column>
7
     </Placement>
8
     <SerializedSettingsObject
SerializedSettingsObject

A widget can have different settings. These settings are stored here as a json serialized string

>{String}</SerializedSettingsObject>
9
</Widget>
1
{
2
     "widget": {
3
          "widgetId
WidgetId

A unique id that will indentify a specific widget on a dashboard

": "{String}",
4
          "widgetApplicationMatch
WidgetApplicationMatch

The lookup name of the widget/application

": "{String}",
5
          "placement": {
6
               "row
Row

The placement of a component (widget) in a dashboard.

": "{Integer}",
7
               "column
Column

The placement of a component (widget) in a dashboard.

": "{Integer}"
8
          },
9
          "serializedSettingsObject
SerializedSettingsObject

A widget can have different settings. These settings are stored here as a json serialized string

": "{String}"
10
     }
11
}

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 106131 HTTP 404 Could not find dashboard