API

System APIs

GET system/reports/114024/result-set

Roles with related Duties

Report name Roles with related Duties
Report identifier 114024
HTTP method GET
URI https://api.rambase.net/system/reports/114024/result-set
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6113, version 6

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
1

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.

$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]
$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
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

CompanyDefinedDuties() Named filter Duties created locally in current company
CompanyDefinedRoles() Named filter Roles created locally in current company
NewAndActiveDuties() Named filter New and active duties. Status less than 9.
NewAndActiveRoles() Named filter New and active roles (status less than 9)
PartnerUserRoles() Named filter Roles for partner consultants
PartnerUsers() Named filter Duties for partner consultants
PortalUserRoles() Named filter Roles for portal users
PortalUsers() Named filter Duties for portal users
StandardUserRoles() Named filter Roles for standard users
StandardUsers() Named filter Duties for standard users
SystemDefinedDuties() Named filter System defined duties
SystemDefinedRoles() Named filter System defined roles
DutyDescription String Description of the duty.
DutyId Integer Duty identifier.
DutyName String Name of the duty.
DutyRequiredUserLevel Integer The user level required to have a duty. Only users having the same level or higher can have the duty. Therefore a duty can only be added to roles that have the same user level or higher. User level (highest level first): Administrator, Partner, User, Portal user.
DutyStatus Integer Status of the duty.
DutySubModuleId Integer Submodule identifier.
RoleDescription String Description of the role.
RoleId Integer Role identifier.
RoleName String Name of the role.
RoleRequiredUserLevel Integer The user level required to have this role. Only user having the same level or higher can be assigned. This field also controls which duties can be added to the role. Only duties with the same level or lower can be added. User levels (highest level first): Administrator, Partner, User, Portal user.
RoleStatus Integer Status of the role.

Read more about filters and sorting on how to use sortable parameters

DutyDescription String Description of the duty
DutyId Integer Duty identifier
DutyName String Name of the duty
DutyRequiredUserLevel Integer The user level required to have a duty. Only users having the same level or higher can have the duty. Therefore a duty can only be added to roles that have the same user level or higher. User level (highest level first): Administrator, Partner, User, Portal user
DutyStatus Integer Status of the duty
DutySubModuleId Integer Submodule identifier
RoleDescription String Description of the role
RoleId Integer Role identifier
RoleName String Name of the role
RoleRequiredUserLevel Integer The user level required to have this role. Only user having the same level or higher can be assigned. This field also controls which duties can be added to the role. Only duties with the same level or lower can be added. User levels (highest level first): Administrator, Partner, User, Portal user
RoleStatus Integer Status of the role

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.

Format:
1
<Report>
2
     <Rows>
3
          <Row>
4
               <Role
Role

Role reference

>
5
                    <Status
Status

Status of the role

Possible domain values can be found here

>{Integer}</Status>
6
                    <RoleId
RoleId

Role identifier

>{Integer}</RoleId>
7
                    <Name
Name

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

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

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

>{String}</Description>
9
                    <RequiredUserLevel
RequiredUserLevel

The user level required to have this role. Only user having the same level or higher can be assigned.
This field also controls which duties can be added to the role. Only duties with the same level or lower can be added.

User levels (highest level first): Administrator, Partner, User, Portal user

>{Integer}</RequiredUserLevel>
10
                    <CompanyStatus
CompanyStatus

Status of the role for current company

>{Integer}</CompanyStatus>
11
                    <RoleLink
RoleLink

Role reference

>{String}</RoleLink>
12
               </Role>
13
               <Duty
Duty

Duty reference

>
14
                    <Status
Status

Status of the duty

Possible domain values can be found here

>{Integer}</Status>
15
                    <DutyId
DutyId

Duty identifier

>{Integer}</DutyId>
16
                    <Name
Name

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

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

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

>{String}</Description>
18
                    <SubModule
SubModule

Submodule reference

>
19
                         <SubModuleId
SubModuleId

Submodule identifier

>{Integer}</SubModuleId>
20
                         <Name
Name

Translated name of the module. The language used is specified either in $lang or by user settings. If translated name doesn't exist in desired language, english will be used.

>{String}</Name>
21
                         <Module
Module

Module reference

>
22
                              <ModuleId
ModuleId

Module identifier

>{Integer}</ModuleId>
23
                              <Name
Name

Translated name of the module. The language used is specified either in $lang or by user settings. If translated name doesn't exist in desired language, english will be used.

>{String}</Name>
24
                              <ModuleLink
ModuleLink

Module reference

>{String}</ModuleLink>
25
                         </Module>
26
                         <SubModuleLink
SubModuleLink

Submodule reference

>{String}</SubModuleLink>
27
                    </SubModule>
28
                    <RequiredUserLevel
RequiredUserLevel

The user level required to have a duty. Only users having the same level or higher can have the duty. Therefore a duty can only be added to roles that have the same user level or higher.

User level (highest level first): Administrator, Partner, User, Portal user

>{Integer}</RequiredUserLevel>
29
                    <CompanyStatus
CompanyStatus

Status of the duty for current company

>{Integer}</CompanyStatus>
30
                    <DutyLink
DutyLink

Duty reference

>{String}</DutyLink>
31
               </Duty>
32
               <Inspect>
33
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
34
               </Inspect>
35
          </Row>
36
     </Rows>
37
     <Paging
Paging

Detailed paging information for this list.

>
38
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
39
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
40
          <Page
Page

Page index

>{Integer}</Page>
41
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
42
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
43
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
44
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
45
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
46
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
47
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
48
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
49
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
50
     </Paging>
51
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "role
Role

Role reference

": {
6
                         "status
Status

Status of the role

Possible domain values can be found here

": "{Integer}",
7
                         "roleId
RoleId

Role identifier

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

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

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

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

": "{String}",
10
                         "requiredUserLevel
RequiredUserLevel

The user level required to have this role. Only user having the same level or higher can be assigned.
This field also controls which duties can be added to the role. Only duties with the same level or lower can be added.

User levels (highest level first): Administrator, Partner, User, Portal user

": "{Integer}",
11
                         "companyStatus
CompanyStatus

Status of the role for current company

": "{Integer}",
12
                         "roleLink
RoleLink

Role reference

": "{String}"
13
                    },
14
                    "duty
Duty

Duty reference

": {
15
                         "status
Status

Status of the duty

Possible domain values can be found here

": "{Integer}",
16
                         "dutyId
DutyId

Duty identifier

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

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

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

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

": "{String}",
19
                         "subModule
SubModule

Submodule reference

": {
20
                              "subModuleId
SubModuleId

Submodule identifier

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

Translated name of the module. The language used is specified either in $lang or by user settings. If translated name doesn't exist in desired language, english will be used.

": "{String}",
22
                              "module
Module

Module reference

": {
23
                                   "moduleId
ModuleId

Module identifier

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

Translated name of the module. The language used is specified either in $lang or by user settings. If translated name doesn't exist in desired language, english will be used.

": "{String}",
25
                                   "moduleLink
ModuleLink

Module reference

": "{String}"
26
                              },
27
                              "subModuleLink
SubModuleLink

Submodule reference

": "{String}"
28
                         },
29
                         "requiredUserLevel
RequiredUserLevel

The user level required to have a duty. Only users having the same level or higher can have the duty. Therefore a duty can only be added to roles that have the same user level or higher.

User level (highest level first): Administrator, Partner, User, Portal user

": "{Integer}",
30
                         "companyStatus
CompanyStatus

Status of the duty for current company

": "{Integer}",
31
                         "dutyLink
DutyLink

Duty reference

": "{String}"
32
                    },
33
                    "inspect": {
34
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
35
                    }
36
               }
37
          ]
38
     }
39
}

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 104920 HTTP 400 Log text is required
Error 104921 HTTP 400 Invalid log category
Error 101281 HTTP 400 Too many {0} parameters. Maximum is {1}.
Error 100175 HTTP 400 To date must be equal to, or later than from date.
Error 105710 HTTP 400 Invalid output type