API

System APIs

GET system/reports/103041/result-set?showActiveUserAssignmentsOnly={showActiveOnly}

Roles users are assigned to in current company.

Report name Role user assignments for company
Report identifier 103041
HTTP method GET
URI https://api.rambase.net/system/reports/103041/result-set?showActiveUserAssignmentsOnly={showActiveOnly}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 5446, 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
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.

showActiveUserAssignmentsOnly Boolean, optional Active user assignments

Default: true
$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.

ConsultantRoles() Named filter Roles for consultants - Required user level "JHC" or "Partner"
PortalUserRoles() Named filter Roles for portal users
StandardUserRoles() Named filter Roles for standard users
Comment String Description of why the user has been assigned to the role.
EmployeeDepartmentId Integer Department identifier.
EmployeeSuperiorId Integer Superior of the employee.
RequiredUserLevel 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.
Status Integer Status for the user assignments.
UserAssignmentId Integer User assignment identifier.
UserId Integer User identifier.
ValidFrom Date Valid from date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ValidTo Date Valid to date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()

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

Comment String Description of why the user has been assigned to the role
EmployeeDepartmentId Integer Department identifier
EmployeeSuperiorId Integer Superior of the employee
RequiredUserLevel 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
Status Integer Status for the user assignments
UserAssignmentId Integer User assignment identifier
UserId Integer User identifier
ValidFrom Date Valid from date
ValidTo Date Valid to date

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

Employee reference

>
5
                    <UserId
UserId

User identifier

>{Integer}</UserId>
6
                    <FirstName
FirstName

First name of the user

>{String}</FirstName>
7
                    <Name
Name

Name of the user

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

User reference

>{String}</UserLink>
9
               </User>
10
               <Role
Role

Role reference

>
11
                    <RoleId
RoleId

Role identifier

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

Name of the role

>{String}</Name>
13
                    <RoleLink
RoleLink

Role reference

>{String}</RoleLink>
14
               </Role>
15
               <ValidFrom
ValidFrom

Valid from date

>{Date}</ValidFrom>
16
               <ValidTo
ValidTo

Valid to date

>{Date}</ValidTo>
17
               <Comment
Comment

Description of why the user has been assigned to the role

>{String}</Comment>
18
               <Employee
Employee

Employee reference

>
19
                    <Gender
Gender

Gender of the employee

Possible domain values can be found here

>{String}</Gender>
20
                    <JobTitle
JobTitle

Job title of employee. Ex. Sales manager

>{String}</JobTitle>
21
                    <Email
Email

Email address of the employee

>{String}</Email>
22
                    <Company
Company

Company code/database the object belongs to

>
23
                         <CompanyId
CompanyId

Company identifier

>{Integer}</CompanyId>
24
                         <Name
Name

Name of company

>{String}</Name>
25
                         <Database
Database

Abbreviation/code to identify the company

>{String}</Database>
26
                         <CompanyLink
CompanyLink

Company reference

>{String}</CompanyLink>
27
                    </Company>
28
                    <Department
Department

Department reference. One of the system/fixed account dimensions.

>
29
                         <DepartmentId
DepartmentId

Department identifier

>{Integer}</DepartmentId>
30
                         <Name
Name

Name of department

>{String}</Name>
31
                         <DepartmentLink
DepartmentLink

Finance department reference

>{String}</DepartmentLink>
32
                    </Department>
33
                    <Superior
Superior

Superior of the employee

>
34
                         <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
35
                         <LastName
LastName

Last name of employee

>{String}</LastName>
36
                         <FirstName
FirstName

First name of employee

>{String}</FirstName>
37
                         <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
38
                    </Superior>
39
               </Employee>
40
               <Inspect>
41
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
42
                    <Filter
Filter

Filter used when inspecting a line in a report.

>{String}</Filter>
43
               </Inspect>
44
          </Row>
45
     </Rows>
46
     <ColumnParameters
ColumnParameters

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

>
47
          <ColumnParameter
ColumnParameter

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

>
48
               <Key
Key

Key that is used in description to lookup value from COS. The key is referenced by encapsulating it in curly braces.

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

>{String}</Key>
49
               <Value
Value

The value of the column parameter from COS that will be shown in the column headers referencing the column parameter key.

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

>{String}</Value>
50
          </ColumnParameter>
51
     </ColumnParameters>
52
     <Paging
Paging

Detailed paging information for this list.

>
53
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
56
          <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>
57
          <FirstPage
FirstPage

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

>{String}</FirstPage>
58
          <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>
59
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
60
          <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>
61
          <NextPage
NextPage

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

>{String}</NextPage>
62
          <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>
63
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
65
     </Paging>
66
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "user
User

Employee reference

": {
6
                         "userId
UserId

User identifier

": "{Integer}",
7
                         "firstName
FirstName

First name of the user

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

Name of the user

": "{String}",
9
                         "userLink
UserLink

User reference

": "{String}"
10
                    },
11
                    "role
Role

Role reference

": {
12
                         "roleId
RoleId

Role identifier

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

Name of the role

": "{String}",
14
                         "roleLink
RoleLink

Role reference

": "{String}"
15
                    },
16
                    "validFrom
ValidFrom

Valid from date

": "{Date}",
17
                    "validTo
ValidTo

Valid to date

": "{Date}",
18
                    "comment
Comment

Description of why the user has been assigned to the role

": "{String}",
19
                    "employee
Employee

Employee reference

": {
20
                         "gender
Gender

Gender of the employee

Possible domain values can be found here

": "{String}",
21
                         "jobTitle
JobTitle

Job title of employee. Ex. Sales manager

": "{String}",
22
                         "email
Email

Email address of the employee

": "{String}",
23
                         "company
Company

Company code/database the object belongs to

": {
24
                              "companyId
CompanyId

Company identifier

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

Name of company

": "{String}",
26
                              "database
Database

Abbreviation/code to identify the company

": "{String}",
27
                              "companyLink
CompanyLink

Company reference

": "{String}"
28
                         },
29
                         "department
Department

Department reference. One of the system/fixed account dimensions.

": {
30
                              "departmentId
DepartmentId

Department identifier

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

Name of department

": "{String}",
32
                              "departmentLink
DepartmentLink

Finance department reference

": "{String}"
33
                         },
34
                         "superior
Superior

Superior of the employee

": {
35
                              "employeeId
EmployeeId

Employee identifier

": "{Integer}",
36
                              "lastName
LastName

Last name of employee

": "{String}",
37
                              "firstName
FirstName

First name of employee

": "{String}",
38
                              "employeeLink
EmployeeLink

Employee reference

": "{String}"
39
                         }
40
                    },
41
                    "inspect": {
42
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}",
43
                         "filter
Filter

Filter used when inspecting a line in a report.

": "{String}"
44
                    }
45
               }
46
          ],
47
          "columnParameters
ColumnParameters

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

": [
48
               {
49
                    "key
Key

Key that is used in description to lookup value from COS. The key is referenced by encapsulating it in curly braces.

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

": "{String}",
50
                    "value
Value

The value of the column parameter from COS that will be shown in the column headers referencing the column parameter key.

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

": "{String}"
51
               }
52
          ]
53
     }
54
}

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