CommentModel

Defines content for a comment. As a consumer of the InfoCare WebAPI you are only allowed to add comments, you will not be allowed to modify or remove exsting comments. You do not have to set creation date or created by as this will be automatically set by the server.

Examples

Adding a comment by wrapping a field update in a comment model


var update = {
    AttributeAction: 0, //Add
    AttributeType: 1, //Comment
    AttributeData: {
        Fields: [{
            AttributeAction: 0, //Add
            AttributeType: 0, //Field
            AttributeData: {
                FieldName: "Comment",
                FieldValue: "This is an example comment"
            }
        }]
    }
}

Properties

Name	Description	Type	Additional information
CommentId	Gets or sets the server comment id. Property will be ignored for incoming messages.	integer	None.
ClientId	Gets or sets client id. This attribute will follow the specific comment on the specific update, useful for tracking each comment when adding multiple on the same update	string	None.
Fields	Gets a list fields defined for a comment. You can expect the following fields being available CreatedAt, the date when comment was added, will be ignored for new comments and set to current time CreatedBy, the person or entity that added the comment, will be ignored for new comments and set to logged on user Comment, the comment text IsAlert, set value to true if you want to mark the comment as alert. Ignore field or set to false if you do not want mark comment as an alert IsVisible, This field is optional and specifies whether the comment will be visible or not. If not specified visibility will be set according to existing rules: That is, for subcontractor and enterprise users IsVisible is set according to the activity workflow VisibilityOnComments field. For ServiceUsers and ExternalUsers IsVisible will be always set to true. If the IsVisible value is specified it will only be considered for InfoCare users.For any other user visibility will be set according to the rules explained previously.	Collection of AttributeUpdateModel	None.

Name

Description

Type

Additional information

CommentId

Gets or sets the server comment id. Property will be ignored for incoming messages.

integer

None.

ClientId

Gets or sets client id. This attribute will follow the specific comment on the specific update, useful for tracking each comment when adding multiple on the same update

string

None.

Fields

Gets a list fields defined for a comment. You can expect the following fields being available

CreatedAt, the date when comment was added, will be ignored for new comments and set to current time
CreatedBy, the person or entity that added the comment, will be ignored for new comments and set to logged on user
Comment, the comment text
IsAlert, set value to true if you want to mark the comment as alert. Ignore field or set to false if you do not want mark comment as an alert
IsVisible, This field is optional and specifies whether the comment will be visible or not. If not specified visibility will be set according to existing rules: That is, for subcontractor and enterprise users IsVisible is set according to the activity workflow VisibilityOnComments field. For ServiceUsers and ExternalUsers IsVisible will be always set to true. If the IsVisible value is specified it will only be considered for InfoCare users.For any other user visibility will be set according to the rules explained previously.

Collection of AttributeUpdateModel

None.