Excel Add-In for Highrise

Build 24.0.9060

Comments

Create, update, delete, and query Comments associated with a Note or Email and visible to the authenticated user.

Table Specific Information

Select

To retrieve Comments, provide a SubjectType that the Note belongs to, such as Notes or Emails, and the Subject Id.

SELECT * FROM Comments WHERE SubjectType = 'notes' AND SubjectId = '351922361'

Insert

The following query inserts a Comment. At least the Comment Body and ParentId must be provided.

INSERT INTO Comments (Body, ParentId) VALUES ('me comment', '351199012') 

Columns

Name Type ReadOnly References Description
Id [KEY] Integer True

The unique identifier of the comment.

Body String False

The body of the comment.

ParentId Integer False

The Id of the parent of the comment.

SubjectId Integer True

The Id of the subject of the comment.

SubjectType String True

The subject type of the comment.

SubjectName String True

The subject name of the comment.

CollectionId Integer True

The Id of the collection.

CollectionType String True

The type of the collection.

VisibleTo String True

Who the comment is visible to: Everyone, Owner, or NamedGroup.

GroupId Integer True

The Id of the group.

OwnerId Integer True

The Id of the owner.

AuthorId Integer True

The Id of the author of the comment.

CreatedAt Datetime True

The date and time when the comment was created.

UpdatedAt Datetime True

The date and time when the comment was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ParentType String

Whether the comment is associated with a note or email.

The allowed values are note, email.

The default value is note.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060