System APIs
Create new report definition
| HTTP method | POST |
| URI | https://api.rambase.net/system/reports |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 5427, version 1 |
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.
Name
Required/mandatory field
Name of report definition
>{String}</Name>Description
Description of the report definition
This field is optional.
>{String}</Description>Name
Required/mandatory field
Name of report definition
": "{String}",Description
Description of the report definition
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. |
| $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] |
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.
ReportId
Report definition identifier
>{Integer}</ReportId>Name
Name of report definition
>{String}</Name>Description
Description of the report definition
>{String}</Description>TranslatedName
Name translated to selected language. If no translation exists for the given langauage, english name will show.
>{String}</TranslatedName>TranslatedDescription
Description translated to selected language. If no translation exists for the given langauage, english description will show.
>{String}</TranslatedDescription>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>ReportId
Report definition identifier
": "{Integer}",Status
Status of report definition
Possible domain values can be found here
": "{Integer}",Name
Name of report definition
": "{String}",Description
Description of the report definition
": "{String}",TranslatedName
Name translated to selected language. If no translation exists for the given langauage, english name will show.
": "{String}",TranslatedDescription
Description translated to selected language. If no translation exists for the given langauage, english description will show.
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}"
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 101015 HTTP 404 | Permission not found |
| Error 101420 HTTP 404 | Setting definition not found |