API

Quality management APIs

POST quality/documents

Create a QMS document

HTTP method POST
URI https://api.rambase.net/quality/documents
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 6037, version 8

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

Required/mandatory field

Title of the document

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

Description of document

This field is optional.

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

This field is optional.

>
5
          <FolderId
FolderId

Folder identifier

Minimum value: 100000

Default value: 100000

This field is optional.

>{Integer}</FolderId>
6
     </Folder>
7
</QualityDocument>
1
{
2
     "qualityDocument": {
3
          "title
Title

Required/mandatory field

Title of the document

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

Description of document

This field is optional.

": "{String}",
5
          "folder
Folder

This field is optional.

": {
6
               "folderId
FolderId

Folder identifier

Minimum value: 100000

Default value: 100000

This field is optional.

": "{Integer}"
7
          }
8
     }
9
}

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
<QualityDocument>
2
     <QualityDocumentId
QualityDocumentId

Identifier of the quality document

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

Status of the document

Possible domain values can be found here

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

Title of the document

>{String}</Title>
5
     <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>
6
     <Description
Description

Description of document

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

Determines whether training is required

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

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

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

Date and time for when a document was updated

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

Date and time when quality document was archived.

>
11
          <QualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

Status of quality document version

Possible domain values can be found here

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

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

Possible domain values can be found here

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

Date until which the quality document version is valid

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

Number of the latest document version.

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

Determines if new training is required

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

Determines if new reading is required

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

Describing the changes in the document version

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

Date and time when document version was sent to verification

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

Date and time for when document version was approved

>{Datetime}</ApprovedAt>
21
          <Author>
22
               <EmployeeId
EmployeeId

Employee identifier

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

First name of employee

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

Last name of employee

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

Employee reference

>{String}</EmployeeLink>
26
          </Author>
27
          <AuthorSuccessor>
28
               <EmployeeId
EmployeeId

Employee identifier

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

First name of employee

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

Last name of employee

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

Employee reference

>{String}</EmployeeLink>
32
          </AuthorSuccessor>
33
          <Verifier>
34
               <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
38
          </Verifier>
39
          <VerifierSuccessor>
40
               <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
44
          </VerifierSuccessor>
45
          <Approver>
46
               <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
50
          </Approver>
51
          <ApproverSuccessor>
52
               <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

>{String}</EmployeeLink>
56
          </ApproverSuccessor>
57
          <QualityDocumentVersionLink
QualityDocumentVersionLink

API reference to the item

>{String}</QualityDocumentVersionLink>
58
          <QualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

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

Possible domain values can be found here

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

Date and time for when document version was approved

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

Date until which the quality document version is valid

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

Number of the latest document version.

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

Date and time when document version was sent to verification

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

API reference to the item

>{String}</QualityDocumentVersionLink>
65
          <QualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

API reference to the item

>{String}</QualityDocumentVersionLink>
67
          <FolderId
FolderId

Folder identifier

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

Verbose folder text in english.

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

Company folder id

>{String}</FolderLink>
70
          <EmployeeId
EmployeeId

Employee identifier

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

First name of employee

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

Last name of employee

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

Employee reference

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

Employee identifier

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

First name of employee

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

Last name of employee

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

Employee reference

>{String}</EmployeeLink>
78
     </ArchivedAt>
79
</QualityDocument>
1
{
2
     "qualityDocument": {
3
          "qualityDocumentId
QualityDocumentId

Identifier of the quality document

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

Status of the document

Possible domain values can be found here

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

Title of the document

": "{String}",
6
          "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}",
7
          "description
Description

Description of document

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

Determines whether training is required

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

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

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

Date and time for when a document was updated

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

Date and time when quality document was archived.

": {
12
               "qualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

Status of quality document version

Possible domain values can be found here

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

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

Possible domain values can be found here

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

Date until which the quality document version is valid

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

Number of the latest document version.

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

Determines if new training is required

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

Determines if new reading is required

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

Describing the changes in the document version

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

Date and time when document version was sent to verification

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

Date and time for when document version was approved

": "{Datetime}",
22
               "author": {
23
                    "employeeId
EmployeeId

Employee identifier

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

First name of employee

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

Last name of employee

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

Employee reference

": "{String}"
27
               },
28
               "authorSuccessor": {
29
                    "employeeId
EmployeeId

Employee identifier

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

First name of employee

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

Last name of employee

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

Employee reference

": "{String}"
33
               },
34
               "verifier": {
35
                    "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}"
39
               },
40
               "verifierSuccessor": {
41
                    "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}"
45
               },
46
               "approver": {
47
                    "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}"
51
               },
52
               "approverSuccessor": {
53
                    "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

": "{String}"
57
               },
58
               "qualityDocumentVersionLink
QualityDocumentVersionLink

API reference to the item

": "{String}",
59
               "qualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

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

Possible domain values can be found here

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

Date and time for when document version was approved

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

Date until which the quality document version is valid

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

Number of the latest document version.

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

Date and time when document version was sent to verification

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

API reference to the item

": "{String}",
66
               "qualityDocumentVersionId
QualityDocumentVersionId

Quality Document Version identifier

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

API reference to the item

": "{String}",
68
               "folderId
FolderId

Folder identifier

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

Verbose folder text in english.

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

Company folder id

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

Employee identifier

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

First name of employee

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

Last name of employee

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

Employee reference

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

Employee identifier

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

First name of employee

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

Last name of employee

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

Employee reference

": "{String}"
79
          }
80
     }
81
}

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: