API

Quality management APIs

POST quality/documents/{qualityDocumentId}/versions

Creates a quality document version

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

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

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

This field is optional.

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

Required/mandatory field

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

Applicable domain values can be found here

>{String}</ContentType>
4
</QualityDocumentVersion>
1
{
2
     "qualityDocumentVersion": {
3
          "title
Title

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

This field is optional.

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

Required/mandatory field

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

Applicable domain values can be found here

": "{String}"
5
     }
6
}

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.

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

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.

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

>
17
          <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

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

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
25
          <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
29
          <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

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

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

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

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
41
     </RequiresNewReading>
42
</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

": {
18
               "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}",
22
               "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}",
26
               "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}",
30
               "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}",
34
               "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}",
38
               "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}"
42
          }
43
     }
44
}

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: