API

Quality management APIs

POST quality/documents/{qualityDocumentId}/versions/{qualityDocumentVersionId}/messages

Creates a document message

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

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
<Message>
2
     <Content
Content

Content of the message

This field is optional.

>{String}</Content>
3
     <SentTo>
4
          <UserId
UserId

Required/mandatory field

User identifier

Minimum value: 100

>{Integer}</UserId>
5
     </SentTo>
6
</Message>
1
{
2
     "message": {
3
          "content
Content

Content of the message

This field is optional.

": "{String}",
4
          "sentTo": {
5
               "userId
UserId

Required/mandatory field

User identifier

Minimum value: 100

": "{Integer}"
6
          }
7
     }
8
}

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
<Message>
2
     <MessageId
MessageId

Quality document verifier and consultant identifier

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

Status field. 1: Pending review, 7: Rejected, 9: Completed

Possible domain values can be found here

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

Content of the message

>{String}</Content>
5
     <SentAt
SentAt

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

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

Automatically generated timestamp field maintained by the execution engine (when document data is updated)

>
7
          <UserId
UserId

User identifier

>{Integer}</UserId>
8
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
9
          <Name
Name

Name of the user

>{String}</Name>
10
          <UserLink
UserLink

User reference

>{String}</UserLink>
11
          <UserId
UserId

User identifier

>{Integer}</UserId>
12
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
13
          <Name
Name

Name of the user

>{String}</Name>
14
          <UserLink
UserLink

User reference

>{String}</UserLink>
15
     </UpdatedAt>
16
</Message>
1
{
2
     "message": {
3
          "messageId
MessageId

Quality document verifier and consultant identifier

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

Status field. 1: Pending review, 7: Rejected, 9: Completed

Possible domain values can be found here

": "{Integer}",
5
          "content
Content

Content of the message

": "{String}",
6
          "sentAt
SentAt

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

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

Automatically generated timestamp field maintained by the execution engine (when document data is updated)

": {
8
               "userId
UserId

User identifier

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

First name of the user

": "{String}",
10
               "name
Name

Name of the user

": "{String}",
11
               "userLink
UserLink

User reference

": "{String}",
12
               "userId
UserId

User identifier

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

First name of the user

": "{String}",
14
               "name
Name

Name of the user

": "{String}",
15
               "userLink
UserLink

User reference

": "{String}"
16
          }
17
     }
18
}

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: