CommentsGetResponseItems (api-client 1.137.27923.860f36b32a5a API)

java.lang.Object
- com.onshape.api.types.AbstractResponseObject
- - com.onshape.api.responses.CommentsGetResponseItems

All Implemented Interfaces:

ResponseWithDocument
```
public final class CommentsGetResponseItems
extends AbstractResponseObject
implements ResponseWithDocument
```
Object used in calls to get API endpoint. © 2018-Present Onshape Inc.

Field Summary

Fields
Modifier and Type	Field	Description
`String[]`	`assemblyFeatures`	The list of assembly features on which this comment has lived.
`String`	`assignedAt`	Date assigned.
`Map`	`assignee`	the user this comment is assigned to.
`Map`	`attachment`	attachment details.
`Boolean`	`canDelete`	Can delete.
`Boolean`	`canResolveOrReopen`	Can resolve or reopen
`String`	`createdAt`	Date created.
`String`	`documentId`	id of the document to comment on.
`String`	`elementFeature`	id of an element feature.
`String`	`elementId`	id of the element.
`String[]`	`elementOccurrences`	The list of occurrences on which this comment has lived.
`String`	`elementQuery`	query to get element parts like face.
`String`	`message`	Raw text for the comment.
`String`	`parentId`	id of the parent comment in case this is a reply.
`String`	`releasePackageId`	Release package id.
`String`	`reopenedAt`	Date reopened.
`Map`	`reopenedBy`	user who reopened this comment.
`Number`	`replyCount`	number of replies.
`String`	`resolvedAt`	Date resolved.
`Map`	`resolvedBy`	user who resolved this comment.
`Number`	`state`	0=open, 1=resolved, 2=reopened.
`Map`	`thumbnail`	thumbnail url.
`Boolean`	`topLevel`	is this document at the top level.
`Map`	`user`	user who created this comment.
`String`	`versionId`	id of the version to comment on.
`CommentsGetResponseItemsViewData`	`viewData`	camera view data associated with this comment.
`String`	`workspaceId`	id of the document workspace to comment on.

Constructor Summary

Constructors
Constructor Description

CommentsGetResponseItems()

Constructors
Constructor	Description
`CommentsGetResponseItems()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String[]`	`getAssemblyFeatures()`	Get The list of assembly features on which this comment has lived.
`String`	`getAssignedAt()`	Get Date assigned.
`Map`	`getAssignee()`	Get the user this comment is assigned to.
`Map`	`getAttachment()`	Get attachment details.
`Boolean`	`getCanDelete()`	Get Can delete.
`Boolean`	`getCanResolveOrReopen()`	Get Can resolve or reopen
`String`	`getCreatedAt()`	Get Date created.
`OnshapeDocument`	`getDocument()`	Returns an OnshapeDocument object that can be used in subsequent calls to the related document
`String`	`getDocumentId()`	Get id of the document to comment on.
`String`	`getElementFeature()`	Get id of an element feature.
`String`	`getElementId()`	Get id of the element.
`String[]`	`getElementOccurrences()`	Get The list of occurrences on which this comment has lived.
`String`	`getElementQuery()`	Get query to get element parts like face.
`String`	`getMessage()`	Get Raw text for the comment.
`String`	`getParentId()`	Get id of the parent comment in case this is a reply.
`String`	`getReleasePackageId()`	Get Release package id.
`String`	`getReopenedAt()`	Get Date reopened.
`Map`	`getReopenedBy()`	Get user who reopened this comment.
`Number`	`getReplyCount()`	Get number of replies.
`String`	`getResolvedAt()`	Get Date resolved.
`Map`	`getResolvedBy()`	Get user who resolved this comment.
`Number`	`getState()`	Get 0=open, 1=resolved, 2=reopened.
`Map`	`getThumbnail()`	Get thumbnail url.
`Boolean`	`getTopLevel()`	Get is this document at the top level.
`Map`	`getUser()`	Get user who created this comment.
`String`	`getVersionId()`	Get id of the version to comment on.
`CommentsGetResponseItemsViewData`	`getViewData()`	Get camera view data associated with this comment.
`String`	`getWorkspaceId()`	Get id of the document workspace to comment on.
`String`	`toString()`

Methods inherited from class com.onshape.api.types.AbstractResponseObject
getOtherProperties

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - createdAt
```
public String createdAt
```
    Date created.
  - releasePackageId
```
public String releasePackageId
```
    Release package id.
  - topLevel
```
public Boolean topLevel
```
    is this document at the top level.
  - user
```
public Map user
```
    user who created this comment.
  - resolvedBy
```
public Map resolvedBy
```
    user who resolved this comment.
  - reopenedBy
```
public Map reopenedBy
```
    user who reopened this comment.
  - resolvedAt
```
public String resolvedAt
```
    Date resolved.
  - reopenedAt
```
public String reopenedAt
```
    Date reopened.
  - assignedAt
```
public String assignedAt
```
    Date assigned.
  - canResolveOrReopen
```
public Boolean canResolveOrReopen
```
    Can resolve or reopen
  - canDelete
```
public Boolean canDelete
```
    Can delete.
  - attachment
```
public Map attachment
```
    attachment details.
  - thumbnail
```
public Map thumbnail
```
    thumbnail url.
  - replyCount
```
public Number replyCount
```
    number of replies.
  - state
```
public Number state
```
    0=open, 1=resolved, 2=reopened.
  - documentId
```
public String documentId
```
    id of the document to comment on.
  - workspaceId
```
public String workspaceId
```
    id of the document workspace to comment on. Optional field.
  - versionId
```
public String versionId
```
    id of the version to comment on. Optional field.
  - parentId
```
public String parentId
```
    id of the parent comment in case this is a reply.
  - message
```
public String message
```
    Raw text for the comment.
  - elementId
```
public String elementId
```
    id of the element.
  - elementQuery
```
public String elementQuery
```
    query to get element parts like face.
  - elementFeature
```
public String elementFeature
```
    id of an element feature.
  - elementOccurrences
```
public String[] elementOccurrences
```
    The list of occurrences on which this comment has lived. The list of occurrences is updated after restructure.
  - assemblyFeatures
```
public String[] assemblyFeatures
```
    The list of assembly features on which this comment has lived. The list of features is updated after restructure.
  - viewData
```
public CommentsGetResponseItemsViewData viewData
```
    camera view data associated with this comment.
  - assignee
```
public Map assignee
```
    the user this comment is assigned to.
- Constructor Detail
  - CommentsGetResponseItems
```
public CommentsGetResponseItems()
```
- Method Detail
  - getCreatedAt
```
public final String getCreatedAt()
```
    Get Date created.
    
    Returns:
    
    Date created.
  - getReleasePackageId
```
public final String getReleasePackageId()
```
    Get Release package id.
    
    Returns:
    
    Release package id.
  - getTopLevel
```
public final Boolean getTopLevel()
```
    Get is this document at the top level.
    
    Returns:
    
    is this document at the top level.
  - getUser
```
public final Map getUser()
```
    Get user who created this comment.
    
    Returns:
    
    user who created this comment.
  - getResolvedBy
```
public final Map getResolvedBy()
```
    Get user who resolved this comment.
    
    Returns:
    
    user who resolved this comment.
  - getReopenedBy
```
public final Map getReopenedBy()
```
    Get user who reopened this comment.
    
    Returns:
    
    user who reopened this comment.
  - getResolvedAt
```
public final String getResolvedAt()
```
    Get Date resolved.
    
    Returns:
    
    Date resolved.
  - getReopenedAt
```
public final String getReopenedAt()
```
    Get Date reopened.
    
    Returns:
    
    Date reopened.
  - getAssignedAt
```
public final String getAssignedAt()
```
    Get Date assigned.
    
    Returns:
    
    Date assigned.
  - getCanResolveOrReopen
```
public final Boolean getCanResolveOrReopen()
```
    Get Can resolve or reopen
    
    Returns:
    
    Can resolve or reopen
  - getCanDelete
```
public final Boolean getCanDelete()
```
    Get Can delete.
    
    Returns:
    
    Can delete.
  - getAttachment
```
public final Map getAttachment()
```
    Get attachment details.
    
    Returns:
    
    attachment details.
  - getThumbnail
```
public final Map getThumbnail()
```
    Get thumbnail url.
    
    Returns:
    
    thumbnail url.
  - getReplyCount
```
public final Number getReplyCount()
```
    Get number of replies.
    
    Returns:
    
    number of replies.
  - getState
```
public final Number getState()
```
    Get 0=open, 1=resolved, 2=reopened.
    
    Returns:
    
    0=open, 1=resolved, 2=reopened.
  - getDocumentId
```
public final String getDocumentId()
```
    Get id of the document to comment on.
    
    Returns:
    
    id of the document to comment on.
  - getWorkspaceId
```
public final String getWorkspaceId()
```
    Get id of the document workspace to comment on. Optional field.
    
    Returns:
    
    id of the document workspace to comment on. Optional field.
  - getVersionId
```
public final String getVersionId()
```
    Get id of the version to comment on. Optional field.
    
    Returns:
    
    id of the version to comment on. Optional field.
  - getParentId
```
public final String getParentId()
```
    Get id of the parent comment in case this is a reply.
    
    Returns:
    
    id of the parent comment in case this is a reply.
  - getMessage
```
public final String getMessage()
```
    Get Raw text for the comment.
    
    Returns:
    
    Raw text for the comment.
  - getElementId
```
public final String getElementId()
```
    Get id of the element.
    
    Returns:
    
    id of the element.
  - getElementQuery
```
public final String getElementQuery()
```
    Get query to get element parts like face.
    
    Returns:
    
    query to get element parts like face.
  - getElementFeature
```
public final String getElementFeature()
```
    Get id of an element feature.
    
    Returns:
    
    id of an element feature.
  - getElementOccurrences
```
public final String[] getElementOccurrences()
```
    Get The list of occurrences on which this comment has lived. The list of occurrences is updated after restructure.
    
    Returns:
    
    The list of occurrences on which this comment has lived. The list of occurrences is updated after restructure.
  - getAssemblyFeatures
```
public final String[] getAssemblyFeatures()
```
    Get The list of assembly features on which this comment has lived. The list of features is updated after restructure.
    
    Returns:
    
    The list of assembly features on which this comment has lived. The list of features is updated after restructure.
  - getViewData
```
public final CommentsGetResponseItemsViewData getViewData()
```
    Get camera view data associated with this comment.
    
    Returns:
    
    camera view data associated with this comment.
  - getAssignee
```
public final Map getAssignee()
```
    Get the user this comment is assigned to.
    
    Returns:
    
    the user this comment is assigned to.
  - getDocument
```
public final OnshapeDocument getDocument()
```
    Returns an OnshapeDocument object that can be used in subsequent calls to the related document
    
    Specified by:
    
    getDocument in interface ResponseWithDocument
    
    Returns:
    
    The OnshapeDocument object.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CommentsGetResponseItems

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.onshape.api.types.AbstractResponseObject

Methods inherited from class java.lang.Object

Field Detail

createdAt

releasePackageId

topLevel

user

resolvedBy

reopenedBy

resolvedAt

reopenedAt

assignedAt

canResolveOrReopen

canDelete

attachment

thumbnail

replyCount

state

documentId

workspaceId

versionId

parentId

message

elementId

elementQuery

elementFeature

elementOccurrences

assemblyFeatures

viewData

assignee

Constructor Detail

CommentsGetResponseItems

Method Detail

getCreatedAt

getReleasePackageId

getTopLevel

getUser

getResolvedBy

getReopenedBy

getResolvedAt

getReopenedAt

getAssignedAt

getCanResolveOrReopen

getCanDelete

getAttachment

getThumbnail

getReplyCount

getState

getDocumentId

getWorkspaceId

getVersionId

getParentId

getMessage

getElementId

getElementQuery

getElementFeature

getElementOccurrences

getAssemblyFeatures

getViewData

getAssignee

getDocument

toString