API

System APIs

POST system/reports

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.

Format:
1
<Report>
2
     <Name
Name

Required/mandatory field

Name of report definition

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

Description of the report definition

This field is optional.

>{String}</Description>
4
</Report>
1
{
2
     "report": {
3
          "name
Name

Required/mandatory field

Name of report definition

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

Description of the report definition

This field is optional.

": "{String}"
5
     }
6
}

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.

Format:
1
<Report>
2
     <ReportId
ReportId

Report definition identifier

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

Status of report definition

Possible domain values can be found here

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

Name of report definition

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

Description of the report definition

>{String}</Description>
6
     <TranslatedName
TranslatedName

Name translated to selected language. If no translation exists for the given langauage, english name will show.

>{String}</TranslatedName>
7
     <TranslatedDescription
TranslatedDescription

Description translated to selected language. If no translation exists for the given langauage, english description will show.

>{String}</TranslatedDescription>
8
     <CreatedAt
CreatedAt

Date and time of creation

>
9
          <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

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

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

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

EmployeeId of the employee making the change

>
12
               <UserId
UserId

User identifier

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

User reference

>{String}</UserLink>
14
          </ChangedBy>
15
     </CreatedAt>
16
</Report>
1
{
2
     "report": {
3
          "reportId
ReportId

Report definition identifier

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

Status of report definition

Possible domain values can be found here

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

Name of report definition

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

Description of the report definition

": "{String}",
7
          "translatedName
TranslatedName

Name translated to selected language. If no translation exists for the given langauage, english name will show.

": "{String}",
8
          "translatedDescription
TranslatedDescription

Description translated to selected language. If no translation exists for the given langauage, english description will show.

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

Date and time of creation

": {
10
               "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

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

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

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

EmployeeId of the employee making the change

": {
13
                    "userId
UserId

User identifier

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

User reference

": "{String}"
15
               }
16
          }
17
     }
18
}

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