API

Quality management APIs

GET quality/documents/key-figures?groupBy={groupBy}

Key figures for quality documents

HTTP method GET
URI https://api.rambase.net/quality/documents/key-figures?groupBy={groupBy}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6334, version 9

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.

groupBy String, optional Key determines by what documents are grouped by. It can be i.e. status, author, dates and more

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

ToApproveByMe() Named filter Show all documents which should be approved by me
ToReviseByMe() Named filter Show all documents that should be revised by me
ToVerifyByMe() Named filter Show all documents which should be verified by me
ApprovedVersionApprover Integer Employee identifier. Available macros: currentUser()
ApprovedVersionApproverSuccessor Integer Employee identifier. Available macros: currentUser()
ApprovedVersionAuthor Integer Employee identifier. Available macros: currentUser()
ApprovedVersionAuthorSuccessor Integer Employee identifier. Available macros: currentUser()
ApprovedVersionVerifier Integer Employee identifier. Available macros: currentUser()
ApprovedVersionVerifierSuccessor Integer Employee identifier. Available macros: currentUser()
Approver Integer Employee identifier. Available macros: currentUser()
ApproverSuccessor Integer Employee identifier. Available macros: currentUser()
Author Integer Employee identifier. Available macros: currentUser()
AuthorSuccessor Integer Employee identifier. Available macros: currentUser()
CreatedAt Datetime Automatically generated timestamp field maintained by the execution engine (when a document is created). Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
FolderId Integer Folder identifier.
LastVersionStatus Integer Status of quality document version.
Status Integer Status of the document.
ValidTo Datetime Date until which the quality document version is valid. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Verifier Integer Employee identifier. Available macros: currentUser()
VerifierSuccessor Integer Employee identifier. Available macros: currentUser()

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

ApprovedVersionApprover Integer Employee identifier
ApprovedVersionApproverSuccessor Integer Employee identifier
ApprovedVersionAuthor Integer Employee identifier
ApprovedVersionAuthorSuccessor Integer Employee identifier
ApprovedVersionVerifier Integer Employee identifier
ApprovedVersionVerifierSuccessor Integer Employee identifier
Approver Integer Employee identifier
ApproverSuccessor Integer Employee identifier
Author Integer Employee identifier
AuthorSuccessor Integer Employee identifier
CreatedAt Datetime Automatically generated timestamp field maintained by the execution engine (when a document is created)
FolderId Integer Folder identifier
LastVersionStatus Integer Status of quality document version
Status Integer Status of the document
ValidTo Datetime Date until which the quality document version is valid
Verifier Integer Employee identifier
VerifierSuccessor Integer Employee 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
<KeyFigures>
2
     <KeyFigure>
3
          <Key
Key

GroupBy can be "RUT" (RentalUnit), "RUTYEARMONTH" ( RentalUnit, Year, Month) or "YEARMONTH" (Year or month)

>{String}</Key>
4
          <Description
Description

Description of the key.

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

Number of occurrences with the specified key.

>{Integer}</Occurrences>
6
     </KeyFigure>
7
     <Paging
Paging

Detailed paging information for this list.

>
8
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
11
          <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>
12
          <FirstPage
FirstPage

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

>{String}</FirstPage>
13
          <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>
14
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
15
          <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>
16
          <NextPage
NextPage

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

>{String}</NextPage>
17
          <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>
18
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
20
     </Paging>
21
</KeyFigures>
1
{
2
     "keyFigures": [
3
          {
4
               "key
Key

GroupBy can be "RUT" (RentalUnit), "RUTYEARMONTH" ( RentalUnit, Year, Month) or "YEARMONTH" (Year or month)

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

Description of the key.

": "{String}",
6
               "occurrences
Occurrences

Number of occurrences with the specified key.

": "{Integer}"
7
          }
8
     ],
9
     "paging
Paging

Detailed paging information for this list.

": {
10
          "pageSize
PageSize

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

": "{Integer}",
11
          "position
Position

Position of the first element in the list

": "{Integer}",
12
          "page
Page

Page index

": "{Integer}",
13
          "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}",
14
          "firstPage
FirstPage

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

": "{String}",
15
          "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}",
16
          "previousPage
PreviousPage

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

": "{String}",
17
          "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}",
18
          "nextPage
NextPage

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

": "{String}",
19
          "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}",
20
          "lastPage
LastPage

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

": "{String}",
21
          "size
Size

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

": "{Integer}"
22
     }
23
}

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: