PUT v1/{subscriptionID}/comments/{commentID}/read?commentRead={commentRead}

Gets a startup project including its diagram for a user in a subscription.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subscriptionID

The Circle subscription ID.

globally unique identifier

Required

commentID

The comment ID to be updated.

globally unique identifier

Required

commentRead

Optional. represents whether the comment has been read by the user.

boolean

Required

Body Parameters

None.

Response Information

Resource Description

Returns a startup project for a user that is associated with the specified security token in the specified user subscription ID.

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'.