PUT v1/bunits/{bunitId}/consumers/{consumerId}/comments/{commentId}

Update a comment.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bunitId The ID of the business unit of the consumption unit integer

Required

consumerId The ID of the consumption unit of the comment integer

Required

commentId The ID of the comment to update integer

Required

Body Parameters

The comment object to update

Comment
NameDescriptionTypeAdditional information
Consumer The consumption unit the comment relates to
Consumer

None.

Notifications A list of business units and the users who have received notification
Collection of CommentNotification

None.

Schedules The comment may be concerning specific schedules
Collection of Schedule

None.

Type The type of comment
CommentType

None.

Summary Summary that contains information about nodes and file spaces
string

None.

Text Text contains the actual content of the comment
string

None.

User The user who created the comment
User

None.

Receivers Receivers is a list of emails and are used in case the comment is also sent as an email
Collection of string

None.

ExcludeFromStatusReports Comments will not be included when status reports are delivered
boolean

None.

Attachments A list of files uploaded to the comment
Collection of CommentAttachment

None.

Id A unique ID for the object.
integer

Read-only.

CreatedDate Time and date the object was created.
date

Read-only.

ArchivedDate Time and date the object was or is going to be archived.

Unarchived objects have no value in ArchivedDate
date

Read-only.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

Response Information

Resource Description

The updated comment object

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.