POST v1/{subscriptionID}/projects/{projectID}/diagram/nodes/{diagramNodeID}/comments?replyToCommentID={replyToCommentID}

Creates a new comment to a diagram node or as a reply to a comment.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subscriptionID

The Circle subscription ID.

globally unique identifier

Required

projectID

The project ID.

globally unique identifier

Required

diagramNodeID

The diagram node ID to be updated with the new comment.

globally unique identifier

Required

replyToCommentID

The comment ID that the new comment replies to.

globally unique identifier

Optional

Body Parameters

The comment to be created.

CommentModel
NameDescriptionTypeAdditional information
ID

Gets the comment ID.

globally unique identifier

None.

SubscriptionID

Gets the subscription ID of the comment.

globally unique identifier

None.

CreationTime

Gets the creation time of the comment.

date

None.

Creator

Gets the user who created the comment.

DetailedUserViewModel

None.

Read

Gets the value indicating whether the comment was read.

boolean

None.

Content

Gets the content of the comment.

string

None.

Replies

Gets and sets all the replies to the comment.

Collection of CommentModel

None.

Request Formats

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'XMPie.Framework.WebAPI.Models.CommentModel'. Path 'Replies'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'XMPie.Framework.WebAPI.Models.CommentModel'. Path 'Replies'.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CommentModel'.

Response Information

Resource Description

Returns the created comment.

CommentModel
NameDescriptionTypeAdditional information
ID

Gets the comment ID.

globally unique identifier

None.

SubscriptionID

Gets the subscription ID of the comment.

globally unique identifier

None.

CreationTime

Gets the creation time of the comment.

date

None.

Creator

Gets the user who created the comment.

DetailedUserViewModel

None.

Read

Gets the value indicating whether the comment was read.

boolean

None.

Content

Gets the content of the comment.

string

None.

Replies

Gets and sets all the replies to the comment.

Collection of CommentModel

None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'XMPie.Framework.WebAPI.Models.CommentModel'. Path 'Replies'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'XMPie.Framework.WebAPI.Models.CommentModel'. Path 'Replies'.