Package com.onshape.api.requests

Class CommentsCreateRequest

java.lang.Object

com.onshape.api.requests.CommentsCreateRequest

public final class CommentsCreateRequest
extends Object

Request object for create API endpoint. © 2018-Present Onshape Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommentsCreateRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CommentsCreateRequest.Builder	builder(Onshape onshape)
String	getAssemblyFeature()	Get id of an assembly feature, with the owner occurrence path id prepended.
String	getAssignee()	Get the user this comment is assigned to.
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	getElementOccurrence()	Get id of an assembly occurrence.
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	getVersionId()	Get id of the version to comment on.
CommentsCreateRequestViewData	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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

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.

getElementOccurrence

public final String getElementOccurrence()

Get id of an assembly occurrence.

Returns:

id of an assembly occurrence.

getAssemblyFeature

public final String getAssemblyFeature()

Get id of an assembly feature, with the owner occurrence path id prepended.

Returns:

id of an assembly feature, with the owner occurrence path id prepended.

getViewData

public final CommentsCreateRequestViewData getViewData()

Get camera view data associated with this comment.

Returns:

camera view data associated with this comment.

getAssignee

public final String getAssignee()

Get the user this comment is assigned to.

Returns:

the user this comment is assigned to.

toString

public String toString()

Overrides:

toString in class Object

builder

public static final CommentsCreateRequest.Builder builder(Onshape onshape)