API

Quality management APIs

GET quality/documents?searchPhrase={SearchPhrase}&includeArchived={IncludeArchived}&folderId={FolderId}&includeSubFolders={includeSubFolders}

Gets a list of documents. A document is

HTTP method GET
URI https://api.rambase.net/quality/documents?searchPhrase={SearchPhrase}&includeArchived={IncludeArchived}&folderId={FolderId}&includeSubFolders={includeSubFolders}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6034, version 71

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.

searchPhrase String, optional Search phrase
includeArchived Boolean, optional Include archived documents

Default: false
folderId Integer, optional Folder identifier

Minimum: 100000,
Default: 100000
includeSubFolders Boolean, optional Search in subfolders

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

Active() Named filter All active, non archived documents
CreatedByMe() Named filter Show all documents created by me
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
ApprovedVersion Integer Number of the latest document version.
ApprovedVersionApprovedAt Datetime Date and time for when document version was approved. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
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()
ApprovedVersionContentType String Document type. Can be quiz, message, file url or structured content.
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 Date and time when document was created. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CreatedBy Integer Employee identifier. Available macros: currentUser()
Description String Description of document.
FolderId Integer Folder identifier.
LastVersion Integer Number of the latest document version.
LastVersionApprovedAt Datetime Date and time for when document version was approved. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
LastVersionContentType String Document type. Can be quiz, message, file url or structured content.
LastVersionStatus Integer Status of quality document version.
QualityDocumentId Integer Identifier of the quality document.
Status Integer Status of the document.
Title String Title 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

ApprovedVersionApprovedAt Datetime Date and time for when document version was approved
ApprovedVersionApprover Integer Employee identifier
ApprovedVersionApproverSuccessor Integer Employee identifier
ApprovedVersionAuthor Integer Employee identifier
ApprovedVersionAuthorSuccessor Integer Employee identifier
ApprovedVersionContentType String Document type. Can be quiz, message, file url or structured content
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 Date and time when document was created
CreatedBy Integer Employee identifier
Description String Description of document
FolderId Integer Folder identifier
LastVersionApprovedAt Datetime Date and time for when document version was approved
LastVersionContentType String Document type. Can be quiz, message, file url or structured content
LastVersionStatus Integer Status of quality document version
QualityDocumentId Integer Identifier of the quality document
Status Integer Status of the document
Title String Title 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
<QualityDocuments>
2
     <QualityDocument>
3
          <QualityDocumentId
QualityDocumentId

Identifier of the quality document

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

Status of the document

Possible domain values can be found here

>{Integer}</Status>
5
          <Title
Title

Title of the document

>{String}</Title>
6
          <DisplayTitle
DisplayTitle

Title generated according to the system setting.

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

>{String}</DisplayTitle>
7
          <RevisionDuration
RevisionDuration

Specify the number of years or a specific date for document review. A null or blank value means no limit, while a specific date triggers an immediate revision.

Possible domain values can be found here

>{Integer}</RevisionDuration>
8
          <Description
Description

Description of document

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

Determines whether training is required

>{Boolean}</RequiresTraining>
10
          <CreatedAt
CreatedAt

Automatically generated timestamp field maintained by the execution engine (when a document is created)

>{Datetime}</CreatedAt>
11
          <UpdatedAt
UpdatedAt

Date and time for when a document was updated

>{Datetime}</UpdatedAt>
12
          <ArchivedAt
ArchivedAt

Date and time when quality document was archived.

>{Datetime}</ArchivedAt>
13
          <LastVersion
LastVersion

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

>
14
               <QualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

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

Status of quality document version

Possible domain values can be found here

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

>{Integer}</Status>
16
               <ContentType
ContentType

Document type. Can be quiz, message, file url or structured content

Possible domain values can be found here

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

>{String}</ContentType>
17
               <ValidTo
ValidTo

Date until which the quality document version is valid

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

>{Datetime}</ValidTo>
18
               <Version
Version

Number of the latest document version.

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

>{Integer}</Version>
19
               <RequiresNewTraining
RequiresNewTraining

Determines if new training is required

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

>{Boolean}</RequiresNewTraining>
20
               <RequiresNewReading
RequiresNewReading

Determines if new reading is required

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

>{Boolean}</RequiresNewReading>
21
               <ChangeDescription
ChangeDescription

Describing the changes in the document version

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

>{String}</ChangeDescription>
22
               <SentToVerificationAt
SentToVerificationAt

Date and time when document version was sent to verification

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

>{Datetime}</SentToVerificationAt>
23
               <ApprovedAt
ApprovedAt

Date and time for when document version was approved

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

>{Datetime}</ApprovedAt>
24
               <Author
Author

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

>
25
                    <EmployeeId
EmployeeId

Employee identifier

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

>{Integer}</EmployeeId>
26
                    <FirstName
FirstName

First name of employee

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

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

Last name of employee

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

>{String}</LastName>
28
                    <EmployeeLink
EmployeeLink

Employee reference

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

>{String}</EmployeeLink>
29
               </Author>
30
               <AuthorSuccessor
AuthorSuccessor

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

>
31
                    <EmployeeId
EmployeeId

Employee identifier

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

>{Integer}</EmployeeId>
32
                    <FirstName
FirstName

First name of employee

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

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

Last name of employee

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

>{String}</LastName>
34
                    <EmployeeLink
EmployeeLink

Employee reference

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

>{String}</EmployeeLink>
35
               </AuthorSuccessor>
36
               <Verifier
Verifier

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

>
37
                    <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
41
               </Verifier>
42
               <VerifierSuccessor
VerifierSuccessor

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

>
43
                    <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
47
               </VerifierSuccessor>
48
               <Approver
Approver

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

>
49
                    <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
53
               </Approver>
54
               <ApproverSuccessor
ApproverSuccessor

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

>
55
                    <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
59
               </ApproverSuccessor>
60
               <QualityDocumentVersionLink
QualityDocumentVersionLink

API reference to the item

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

>{String}</QualityDocumentVersionLink>
61
          </LastVersion>
62
          <LastApprovedVersion
LastApprovedVersion

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

>
63
               <QualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

>{Integer}</QualityDocumentVersionId>
64
               <ContentType
ContentType

Document type. Can be quiz, message, file url or structured content

Possible domain values can be found here

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

>{String}</ContentType>
65
               <ApprovedAt
ApprovedAt

Date and time for when document version was approved

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

>{Datetime}</ApprovedAt>
66
               <ValidTo
ValidTo

Date until which the quality document version is valid

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

>{Datetime}</ValidTo>
67
               <Version
Version

Number of the latest document version.

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

>{Integer}</Version>
68
               <SentToVerificationAt
SentToVerificationAt

Date and time when document version was sent to verification

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

>{Datetime}</SentToVerificationAt>
69
               <QualityDocumentVersionLink
QualityDocumentVersionLink

API reference to the item

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

>{String}</QualityDocumentVersionLink>
70
          </LastApprovedVersion>
71
          <LastSignificantVersion
LastSignificantVersion

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

>
72
               <QualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

>{Integer}</QualityDocumentVersionId>
73
               <QualityDocumentVersionLink
QualityDocumentVersionLink

API reference to the item

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

>{String}</QualityDocumentVersionLink>
74
          </LastSignificantVersion>
75
          <Folder
Folder

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

>
76
               <FolderId
FolderId

Folder identifier

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

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

Verbose folder text in english.

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

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

Company folder id

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

>{String}</FolderLink>
79
          </Folder>
80
          <CreatedBy
CreatedBy

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

>
81
               <EmployeeId
EmployeeId

Employee identifier

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

>{Integer}</EmployeeId>
82
               <FirstName
FirstName

First name of employee

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

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

Last name of employee

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

>{String}</LastName>
84
               <EmployeeLink
EmployeeLink

Employee reference

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

>{String}</EmployeeLink>
85
          </CreatedBy>
86
          <ArchivedBy
ArchivedBy

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

>
87
               <EmployeeId
EmployeeId

Employee identifier

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

>{Integer}</EmployeeId>
88
               <FirstName
FirstName

First name of employee

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

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

Last name of employee

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

>{String}</LastName>
90
               <EmployeeLink
EmployeeLink

Employee reference

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

>{String}</EmployeeLink>
91
          </ArchivedBy>
92
          <QualityDocumentLink
QualityDocumentLink

API reference to the item

>{String}</QualityDocumentLink>
93
     </QualityDocument>
94
     <Paging
Paging

Detailed paging information for this list.

>
95
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
98
          <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>
99
          <FirstPage
FirstPage

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

>{String}</FirstPage>
100
          <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>
101
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
102
          <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>
103
          <NextPage
NextPage

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

>{String}</NextPage>
104
          <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>
105
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
107
     </Paging>
108
</QualityDocuments>
1
{
2
     "qualityDocuments": [
3
          {
4
               "qualityDocumentId
QualityDocumentId

Identifier of the quality document

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

Status of the document

Possible domain values can be found here

": "{Integer}",
6
               "title
Title

Title of the document

": "{String}",
7
               "displayTitle
DisplayTitle

Title generated according to the system setting.

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

": "{String}",
8
               "revisionDuration
RevisionDuration

Specify the number of years or a specific date for document review. A null or blank value means no limit, while a specific date triggers an immediate revision.

Possible domain values can be found here

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

Description of document

": "{String}",
10
               "requiresTraining
RequiresTraining

Determines whether training is required

": "{Boolean}",
11
               "createdAt
CreatedAt

Automatically generated timestamp field maintained by the execution engine (when a document is created)

": "{Datetime}",
12
               "updatedAt
UpdatedAt

Date and time for when a document was updated

": "{Datetime}",
13
               "archivedAt
ArchivedAt

Date and time when quality document was archived.

": "{Datetime}",
14
               "lastVersion
LastVersion

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

": {
15
                    "qualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

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

Status of quality document version

Possible domain values can be found here

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

": "{Integer}",
17
                    "contentType
ContentType

Document type. Can be quiz, message, file url or structured content

Possible domain values can be found here

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

": "{String}",
18
                    "validTo
ValidTo

Date until which the quality document version is valid

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

": "{Datetime}",
19
                    "version
Version

Number of the latest document version.

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

": "{Integer}",
20
                    "requiresNewTraining
RequiresNewTraining

Determines if new training is required

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

": "{Boolean}",
21
                    "requiresNewReading
RequiresNewReading

Determines if new reading is required

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

": "{Boolean}",
22
                    "changeDescription
ChangeDescription

Describing the changes in the document version

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

": "{String}",
23
                    "sentToVerificationAt
SentToVerificationAt

Date and time when document version was sent to verification

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

": "{Datetime}",
24
                    "approvedAt
ApprovedAt

Date and time for when document version was approved

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

": "{Datetime}",
25
                    "author
Author

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

": {
26
                         "employeeId
EmployeeId

Employee identifier

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

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

First name of employee

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

": "{String}",
28
                         "lastName
LastName

Last name of employee

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

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

Employee reference

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

": "{String}"
30
                    },
31
                    "authorSuccessor
AuthorSuccessor

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

": {
32
                         "employeeId
EmployeeId

Employee identifier

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

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

First name of employee

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

": "{String}",
34
                         "lastName
LastName

Last name of employee

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

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

Employee reference

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

": "{String}"
36
                    },
37
                    "verifier
Verifier

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

": {
38
                         "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
42
                    },
43
                    "verifierSuccessor
VerifierSuccessor

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

": {
44
                         "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
48
                    },
49
                    "approver
Approver

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

": {
50
                         "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
54
                    },
55
                    "approverSuccessor
ApproverSuccessor

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

": {
56
                         "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
60
                    },
61
                    "qualityDocumentVersionLink
QualityDocumentVersionLink

API reference to the item

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

": "{String}"
62
               },
63
               "lastApprovedVersion
LastApprovedVersion

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

": {
64
                    "qualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

": "{Integer}",
65
                    "contentType
ContentType

Document type. Can be quiz, message, file url or structured content

Possible domain values can be found here

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

": "{String}",
66
                    "approvedAt
ApprovedAt

Date and time for when document version was approved

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

": "{Datetime}",
67
                    "validTo
ValidTo

Date until which the quality document version is valid

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

": "{Datetime}",
68
                    "version
Version

Number of the latest document version.

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

": "{Integer}",
69
                    "sentToVerificationAt
SentToVerificationAt

Date and time when document version was sent to verification

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

": "{Datetime}",
70
                    "qualityDocumentVersionLink
QualityDocumentVersionLink

API reference to the item

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

": "{String}"
71
               },
72
               "lastSignificantVersion
LastSignificantVersion

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

": {
73
                    "qualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

": "{Integer}",
74
                    "qualityDocumentVersionLink
QualityDocumentVersionLink

API reference to the item

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

": "{String}"
75
               },
76
               "folder
Folder

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

": {
77
                    "folderId
FolderId

Folder identifier

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

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

Verbose folder text in english.

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

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

Company folder id

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

": "{String}"
80
               },
81
               "createdBy
CreatedBy

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

": {
82
                    "employeeId
EmployeeId

Employee identifier

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

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

First name of employee

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

": "{String}",
84
                    "lastName
LastName

Last name of employee

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

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

Employee reference

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

": "{String}"
86
               },
87
               "archivedBy
ArchivedBy

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

": {
88
                    "employeeId
EmployeeId

Employee identifier

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

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

First name of employee

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

": "{String}",
90
                    "lastName
LastName

Last name of employee

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

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

Employee reference

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

": "{String}"
92
               },
93
               "qualityDocumentLink
QualityDocumentLink

API reference to the item

": "{String}"
94
          }
95
     ],
96
     "paging
Paging

Detailed paging information for this list.

": {
97
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
109
     }
110
}

Possible error codes the response might return: