API

Quality management APIs

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

Gets a comment on a quality document version

HTTP method GET
URI https://api.rambase.net/quality/documents/{qualityDocumentId}/versions/{qualityDocumentVersionId}/comments/{commentId}
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
- URI parameter {commentId} Commend identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 6252, 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
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.

$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
<Comment>
2
     <CommentId
CommentId

Commend identifier

>{Integer}</CommentId>
3
     <Content
Content

The content of the comment

>{String}</Content>
4
     <IsDeleted
IsDeleted

True if the comment is deleted

>{Boolean}</IsDeleted>
5
     <IsEdited
IsEdited

True if the comment has been edited since the original creation

>{Boolean}</IsEdited>
6
     <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

>
7
          <CommentId
CommentId

Commend identifier

>{Integer}</CommentId>
8
     </ParentComment>
9
     <CreatedAt
CreatedAt

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

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

Automatically generated timestamp when a comment was updated

>{Datetime}</UpdatedAt>
11
     <CreatedBy
CreatedBy

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

>
12
          <UserId
UserId

User identifier

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

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

First name of the user

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

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

Name of the user

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

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

User reference

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

>{String}</UserLink>
16
     </CreatedBy>
17
</Comment>
1
{
2
     "comment": {
3
          "commentId
CommentId

Commend identifier

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

The content of the comment

": "{String}",
5
          "isDeleted
IsDeleted

True if the comment is deleted

": "{Boolean}",
6
          "isEdited
IsEdited

True if the comment has been edited since the original creation

": "{Boolean}",
7
          "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

": {
8
               "commentId
CommentId

Commend identifier

": "{Integer}"
9
          },
10
          "createdAt
CreatedAt

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

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

Automatically generated timestamp when a comment was updated

": "{Datetime}",
12
          "createdBy
CreatedBy

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

": {
13
               "userId
UserId

User identifier

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

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

First name of the user

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

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

Name of the user

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

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

User reference

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

": "{String}"
17
          }
18
     }
19
}

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: