Quality management APIs

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

HTTP method	POST
URI	https://api.rambase.net/quality/documents/{qualityDocumentId}/versions/{qualityDocumentVersionId}/comments
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	6251, version 5

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:

                                        <Comment>
                                    

<Content

Content

Required/mandatory field

The content of the comment

>{String}</Content>

<ParentComment

ParentComment

Identifier of the parent of this comment. If this comment is a reply to another comment, then the reference to the other comment is stored in this field

This field is optional.

<CommentId

CommentId

Commend identifier

Minimum value: 100000

This field is optional.

>{Integer}</CommentId>

                                             </ParentComment>
                                    

                                        </Comment>
                                    

{

                                             "comment": {
                                    

"content

Content

Required/mandatory field

The content of the comment

": "{String}",

"parentComment

ParentComment

Identifier of the parent of this comment. If this comment is a reply to another comment, then the reference to the other comment is stored in this field

This field is optional.

": {

"commentId

CommentId

Commend identifier

Minimum value: 100000

This field is optional.

": "{Integer}"

}

}

}

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

                                        <Comment>
                                    

<CommentId

CommentId

Commend identifier

>{Integer}</CommentId>

<Content

Content

The content of the comment

>{String}</Content>

<IsDeleted

IsDeleted

True if the comment is deleted

>{Boolean}</IsDeleted>

<IsEdited

IsEdited

True if the comment has been edited since the original creation

>{Boolean}</IsEdited>

<ParentComment

ParentComment

Identifier of the parent of this comment. If this comment is a reply to another comment, then the reference to the other comment is stored in this field

<CommentId

CommentId

Commend identifier

>{Integer}</CommentId>

                                             </ParentComment>
                                    

<CreatedAt

CreatedAt

Automatically generated timestamp when a comment on a document version was created

>{Datetime}</CreatedAt>

<UpdatedAt

UpdatedAt

Automatically generated timestamp when a comment was updated

<UserId

UserId

User identifier

>{Integer}</UserId>

<FirstName

FirstName

First name of the user

>{String}</FirstName>

<Name

Name

Name of the user

>{String}</Name>

<UserLink

UserLink

User reference

>{String}</UserLink>

                                             </UpdatedAt>
                                    

                                        </Comment>
                                    

{

                                             "comment": {
                                    

"commentId

CommentId

Commend identifier

": "{Integer}",

"content

Content

The content of the comment

": "{String}",

"isDeleted

IsDeleted

True if the comment is deleted

": "{Boolean}",

"isEdited

IsEdited

True if the comment has been edited since the original creation

": "{Boolean}",

"parentComment

ParentComment

Identifier of the parent of this comment. If this comment is a reply to another comment, then the reference to the other comment is stored in this field

": {

"commentId

CommentId

Commend identifier

": "{Integer}"

},

"createdAt

CreatedAt

Automatically generated timestamp when a comment on a document version was created

": "{Datetime}",

"updatedAt

UpdatedAt

Automatically generated timestamp when a comment was updated

": {

"userId

UserId

User identifier

": "{Integer}",

"firstName

FirstName

First name of the user

": "{String}",

"name

Name

Name of the user

": "{String}",

"userLink

UserLink

User reference

": "{String}"

}

}

}

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: