API

Quality management APIs

GET quality/documents/{qualityDocumentId}/versions/{qualityDocumentVersionId}

View quality document version

HTTP method GET
URI https://api.rambase.net/quality/documents/{qualityDocumentId}/versions/{qualityDocumentVersionId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {qualityDocumentId} Identifier of the quality document
Integer, minimum 1
- URI parameter {qualityDocumentVersionId} Identifier of the document version
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 6061, version 26

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.

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

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

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
<QualityDocumentVersion>
2
     <QualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

Status of quality document version

Possible domain values can be found here

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

Date and time when quality document version was created

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

Date and time when quality document version was updated

>{Datetime}</UpdatedAt>
6
     <ReviseAt
ReviseAt

Date and time for when document version was revised

>{Datetime}</ReviseAt>
7
     <VerifiedAt
VerifiedAt

Date and time for when document version was verified

>{Datetime}</VerifiedAt>
8
     <ApprovedAt
ApprovedAt

Date and time for when document version was approved

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

Date and time when document version was sent to verification

>{Datetime}</SentToVerificationAt>
10
     <ValidTo
ValidTo

Date until which the quality document version is valid

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

Number of the latest document version.

>{Integer}</Version>
12
     <ChangeDescription
ChangeDescription

Describing the changes in the document version

>{String}</ChangeDescription>
13
     <ContentType
ContentType

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

Possible domain values can be found here

>{String}</ContentType>
14
     <Title
Title

New title of the document, which will be updated when version is approved.

>{String}</Title>
15
     <RequiresNewTraining
RequiresNewTraining

Determines if new training is required

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

Determines if new reading is required

>{Boolean}</RequiresNewReading>
17
     <Author
Author

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

>
18
          <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
22
     </Author>
23
     <AuthorSuccessor
AuthorSuccessor

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

>
24
          <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
28
     </AuthorSuccessor>
29
     <Verifier
Verifier

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

>
30
          <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
34
     </Verifier>
35
     <VerifierSuccessor
VerifierSuccessor

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

>
36
          <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
40
     </VerifierSuccessor>
41
     <Approver
Approver

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

>
42
          <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
46
     </Approver>
47
     <ApproverSuccessor
ApproverSuccessor

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

>
48
          <EmployeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

>{String}</EmployeeLink>
52
     </ApproverSuccessor>
53
</QualityDocumentVersion>
1
{
2
     "qualityDocumentVersion": {
3
          "qualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

Status of quality document version

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time when quality document version was created

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

Date and time when quality document version was updated

": "{Datetime}",
7
          "reviseAt
ReviseAt

Date and time for when document version was revised

": "{Datetime}",
8
          "verifiedAt
VerifiedAt

Date and time for when document version was verified

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

Date and time for when document version was approved

": "{Datetime}",
10
          "sentToVerificationAt
SentToVerificationAt

Date and time when document version was sent to verification

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

Date until which the quality document version is valid

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

Number of the latest document version.

": "{Integer}",
13
          "changeDescription
ChangeDescription

Describing the changes in the document version

": "{String}",
14
          "contentType
ContentType

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

Possible domain values can be found here

": "{String}",
15
          "title
Title

New title of the document, which will be updated when version is approved.

": "{String}",
16
          "requiresNewTraining
RequiresNewTraining

Determines if new training is required

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

Determines if new reading is required

": "{Boolean}",
18
          "author
Author

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

": {
19
               "employeeId
EmployeeId

Employee identifier

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

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
23
          },
24
          "authorSuccessor
AuthorSuccessor

This field is greyed out because it is an expandable field. You have to add $expand=AuthorSuccessor 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=AuthorSuccessor in your request URI to get this field

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
29
          },
30
          "verifier
Verifier

This field is greyed out because it is an expandable field. You have to add $expand=Verifier 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=Verifier in your request URI to get this field

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
35
          },
36
          "verifierSuccessor
VerifierSuccessor

This field is greyed out because it is an expandable field. You have to add $expand=VerifierSuccessor 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=VerifierSuccessor in your request URI to get this field

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
41
          },
42
          "approver
Approver

This field is greyed out because it is an expandable field. You have to add $expand=Approver 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=Approver in your request URI to get this field

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
47
          },
48
          "approverSuccessor
ApproverSuccessor

This field is greyed out because it is an expandable field. You have to add $expand=ApproverSuccessor 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=ApproverSuccessor in your request URI to get this field

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

": "{String}"
53
          }
54
     }
55
}

Possible error codes the response might return: