API

Quality management APIs

GET system/reports/117501/result-set

This report shows the number of documents in the folders and how many documents that are in each status.

Report name Documents per folder
Report identifier 117501
HTTP method GET
URI https://api.rambase.net/system/reports/117501/result-set
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6955, version 13

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.

$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.

Approver Integer Reference to approver of the document. Available macros: currentUser()
Author Integer Author of the document version. Available macros: currentUser()
ContentType String Document type. Can be quiz, message, file url or structured content.
CreatedAt Datetime {DCM.CREATEDATUTC}}. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
FolderId Integer Folder identifier.
Verifier Integer Reference to verifier of the document. Available macros: currentUser()

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

FolderId Integer Folder identifier

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

Folder

>
5
                    <FolderId
FolderId

Folder identifier

>{Integer}</FolderId>
6
                    <Name
Name

Verbose folder text in english.

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

Company folder id

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

>{String}</FolderLink>
8
               </Folder>
9
               <Approved
Approved

Total amount of documents that are approved

>
10
                    <Total
Total

Amount of documents that are approved

>{Integer}</Total>
11
                    <WithinReviewInterval
WithinReviewInterval

Amount of documents that are approved and within review interval

>{Integer}</WithinReviewInterval>
12
                    <ApproachingReviewDate
ApproachingReviewDate

Amount of documents that are approved and approaching review date

>{Integer}</ApproachingReviewDate>
13
                    <PastReviewDate
PastReviewDate

Amount of documents that are approved and past review date

>{Integer}</PastReviewDate>
14
               </Approved>
15
               <Archived
Archived

Amount of documents that are archived

>{Integer}</Archived>
16
               <Pending
Pending

Amount of documents that are pending verification or approval

>
17
                    <Approval
Approval

Amount of documents that are waiting for approval

>{Integer}</Approval>
18
                    <Verification
Verification

Amount of documents that are waiting for verification

>{Integer}</Verification>
19
               </Pending>
20
               <Drafts
Drafts

Total amount of documents that are in draft

>
21
                    <Total
Total

Amount of documents that are in draft

>{Integer}</Total>
22
                    <New
New

Amount of documents that are in draft and in version 1

>{Integer}</New>
23
               </Drafts>
24
          </Row>
25
     </Rows>
26
     <Aggregated
Aggregated

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

>
27
          <Approved
Approved

Total amount of documents that are approved

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

>
28
               <Total
Total

Amount of documents that are approved

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

>{Integer}</Total>
29
               <WithinReviewInterval
WithinReviewInterval

Amount of documents that are approved and within review interval

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

>{Integer}</WithinReviewInterval>
30
               <ApproachingReviewDate
ApproachingReviewDate

Amount of documents that are approved and approaching review date

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

>{Integer}</ApproachingReviewDate>
31
               <PastReviewDate
PastReviewDate

Amount of documents that are approved and past review date

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

>{Integer}</PastReviewDate>
32
          </Approved>
33
          <Archived
Archived

Amount of documents that are archived

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

>{Integer}</Archived>
34
          <Pending
Pending

Amount of documents that are pending verification or approval

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

>
35
               <Approval
Approval

Amount of documents that are waiting for approval

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

>{Integer}</Approval>
36
               <Verification
Verification

Amount of documents that are waiting for verification

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

>{Integer}</Verification>
37
          </Pending>
38
          <Drafts
Drafts

Total amount of documents that are in draft

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

>
39
               <Total
Total

Amount of documents that are in draft

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

>{Integer}</Total>
40
               <New
New

Amount of documents that are in draft and in version 1

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

>{Integer}</New>
41
          </Drafts>
42
     </Aggregated>
43
     <Paging
Paging

Detailed paging information for this list.

>
44
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
47
          <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>
48
          <FirstPage
FirstPage

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

>{String}</FirstPage>
49
          <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>
50
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
51
          <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>
52
          <NextPage
NextPage

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

>{String}</NextPage>
53
          <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>
54
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
56
     </Paging>
57
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "folder
Folder

Folder

": {
6
                         "folderId
FolderId

Folder identifier

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

Verbose folder text in english.

": "{String}",
8
                         "folderLink
FolderLink

Company folder id

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

": "{String}"
9
                    },
10
                    "approved
Approved

Total amount of documents that are approved

": {
11
                         "total
Total

Amount of documents that are approved

": "{Integer}",
12
                         "withinReviewInterval
WithinReviewInterval

Amount of documents that are approved and within review interval

": "{Integer}",
13
                         "approachingReviewDate
ApproachingReviewDate

Amount of documents that are approved and approaching review date

": "{Integer}",
14
                         "pastReviewDate
PastReviewDate

Amount of documents that are approved and past review date

": "{Integer}"
15
                    },
16
                    "archived
Archived

Amount of documents that are archived

": "{Integer}",
17
                    "pending
Pending

Amount of documents that are pending verification or approval

": {
18
                         "approval
Approval

Amount of documents that are waiting for approval

": "{Integer}",
19
                         "verification
Verification

Amount of documents that are waiting for verification

": "{Integer}"
20
                    },
21
                    "drafts
Drafts

Total amount of documents that are in draft

": {
22
                         "total
Total

Amount of documents that are in draft

": "{Integer}",
23
                         "new
New

Amount of documents that are in draft and in version 1

": "{Integer}"
24
                    }
25
               }
26
          ],
27
          "aggregated
Aggregated

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

": {
28
               "approved
Approved

Total amount of documents that are approved

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

": {
29
                    "total
Total

Amount of documents that are approved

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

": "{Integer}",
30
                    "withinReviewInterval
WithinReviewInterval

Amount of documents that are approved and within review interval

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

": "{Integer}",
31
                    "approachingReviewDate
ApproachingReviewDate

Amount of documents that are approved and approaching review date

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

": "{Integer}",
32
                    "pastReviewDate
PastReviewDate

Amount of documents that are approved and past review date

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

": "{Integer}"
33
               },
34
               "archived
Archived

Amount of documents that are archived

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

": "{Integer}",
35
               "pending
Pending

Amount of documents that are pending verification or approval

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

": {
36
                    "approval
Approval

Amount of documents that are waiting for approval

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

": "{Integer}",
37
                    "verification
Verification

Amount of documents that are waiting for verification

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

": "{Integer}"
38
               },
39
               "drafts
Drafts

Total amount of documents that are in draft

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

": {
40
                    "total
Total

Amount of documents that are in draft

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

": "{Integer}",
41
                    "new
New

Amount of documents that are in draft and in version 1

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

": "{Integer}"
42
               }
43
          }
44
     }
45
}

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 101606 HTTP 404 Module not found
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