API

System APIs

POST system/reports/{reportId}/column-definitions

Column definitions of a report.

HTTP method POST
URI https://api.rambase.net/system/reports/{reportId}/column-definitions
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {reportId} Report definition identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 3922, version 8

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
<ColumnDefinition>
2
     <IsAggregatedColumn
IsAggregatedColumn

True if column should be aggregated

Default value: False

This field is optional.

>{Boolean}</IsAggregatedColumn>
3
     <APIFieldName
APIFieldName

Required/mandatory field

Reference to field name in API resource

>{String}</APIFieldName>
4
     <Format
Format

This field is optional.

>
5
          <NumberOfDecimals
NumberOfDecimals

Number of decimals

Minimum value: 0

Maximum value: 9

This field is optional.

>{Integer}</NumberOfDecimals>
6
     </Format>
7
     <Width
Width

Column width in pixels or percent

Minimum value: 1

This field is optional.

>{Integer}</Width>
8
</ColumnDefinition>
1
{
2
     "columnDefinition": {
3
          "isAggregatedColumn
IsAggregatedColumn

True if column should be aggregated

Default value: False

This field is optional.

": "{Boolean}",
4
          "aPIFieldName
APIFieldName

Required/mandatory field

Reference to field name in API resource

": "{String}",
5
          "format
Format

This field is optional.

": {
6
               "numberOfDecimals
NumberOfDecimals

Number of decimals

Minimum value: 0

Maximum value: 9

This field is optional.

": "{Integer}"
7
          },
8
          "width
Width

Column width in pixels or percent

Minimum value: 1

This field is optional.

": "{Integer}"
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
<ColumnDefinition>
2
     <ColumnDefinitionId
ColumnDefinitionId

Report Definition column line identifier

>{Integer}</ColumnDefinitionId>
3
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
4
     <IsAggregatedColumn
IsAggregatedColumn

True if column should be aggregated

>{Boolean}</IsAggregatedColumn>
5
     <APIFieldName
APIFieldName

Reference to field name in API resource

>{String}</APIFieldName>
6
     <Format>
7
          <NumberOfDecimals
NumberOfDecimals

Number of decimals

>{Integer}</NumberOfDecimals>
8
     </Format>
9
     <Width
Width

Column width in pixels or percent

>{Integer}</Width>
10
</ColumnDefinition>
1
{
2
     "columnDefinition": {
3
          "columnDefinitionId
ColumnDefinitionId

Report Definition column line identifier

": "{Integer}",
4
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
5
          "isAggregatedColumn
IsAggregatedColumn

True if column should be aggregated

": "{Boolean}",
6
          "aPIFieldName
APIFieldName

Reference to field name in API resource

": "{String}",
7
          "format": {
8
               "numberOfDecimals
NumberOfDecimals

Number of decimals

": "{Integer}"
9
          },
10
          "width
Width

Column width in pixels or percent

": "{Integer}"
11
     }
12
}

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 104768 HTTP 400 Missing Report Definition Column identifer. NO and ITM2 are mandatory.
Error 104769 HTTP 404 Report definition column not found.