Package com.onshape.api.responses

Class DocumentsGetDocumentResponse

java.lang.Object

com.onshape.api.types.AbstractResponseObject

com.onshape.api.responses.DocumentsGetDocumentResponse

public final class DocumentsGetDocumentResponse
extends AbstractResponseObject

Response object for getDocument API endpoint. © 2018-Present Onshape Inc.

Constructor Summary

Constructors

Constructor	Description
DocumentsGetDocumentResponse()

Method Summary

Modifier and Type	Method	Description
String	getActive()	Get Whether a shared document is active
String[]	getBetaCapabilityIds()	Get Onshape internal use
Date	getCreatedAt()	Get Creation date
DocumentsGetDocumentResponseCreatedBy	getCreatedBy()	Get User information for the creator of the document
DocumentsGetDocumentResponseDefaultWorkspace	getDefaultWorkspace()	Get Information about the default workspace
String	getDocumentThumbnailElementId()	Get The element which the Document Thumbnail should mirror
String	getHref()	Get Document URL
String	getId()	Get Document ID
Boolean	getIsPublic()	Get Whether document is public
Date	getModifiedAt()	Get Date of last modification
DocumentsGetDocumentResponseModifiedBy	getModifiedBy()	Get User information for the last modifier of the document
String	getName()	Get Name of document
DocumentsGetDocumentResponseOwner	getOwner()	Get Information about document owner
String	getPermission()	Get User's level of access to the document; can be ANONYMOUS_ACCESS, READ, READ_COPY_EXPORT, COMMENT, WRITE, RESHARE, FULL, or OWNER (Deprecated)
String[]	getPermissionSet()	Get User's level of access to the document.
Number	getSizeBytes()	Get Size of document in bytes
String	getStarred()	Get Whether document has been starred (Deprecated)
String[]	getTags()	Get Reserved for future use
DocumentsGetDocumentResponseThumbnail	getThumbnail()	Get Thumbnail information
Number	getTotalWorkspacesScheduledForUpdate()	Get Number of workspaces that are scheduled for updating
Number	getTotalWorkspacesUpdating()	Get Number of workspaces that are updating
Boolean	getTrash()	Get Whether document has been trashed
Date	getTrashedAt()	Get When document has been trashed
DocumentsGetDocumentResponse	refresh(Onshape onshape)	Refresh this page of results
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

Constructor Detail

DocumentsGetDocumentResponse

public DocumentsGetDocumentResponse()

Method Detail

refresh

public final DocumentsGetDocumentResponse refresh(Onshape onshape)
                                           throws OnshapeException

Refresh this page of results

Parameters:

onshape - The Onshape client object.

Returns:

Updated response.

Throws:

OnshapeException - On HTTP or serialization error.

getDefaultWorkspace

public final DocumentsGetDocumentResponseDefaultWorkspace getDefaultWorkspace()

Get Information about the default workspace

Returns:

Information about the default workspace

getBetaCapabilityIds

public final String[] getBetaCapabilityIds()

Get Onshape internal use

Returns:

Onshape internal use

getIsPublic

public final Boolean getIsPublic()

Get Whether document is public

Returns:

Whether document is public

getOwner

public final DocumentsGetDocumentResponseOwner getOwner()

Get Information about document owner

Returns:

Information about document owner

getPermissionSet

public final String[] getPermissionSet()

Get User's level of access to the document. Possible values: OWNER, DELETE, RESHARE, WRITE, READ, COPY, EXPORT, COMMENT

Returns:

User's level of access to the document. Possible values: OWNER, DELETE, RESHARE, WRITE, READ, COPY, EXPORT, COMMENT

getPermission

public final String getPermission()

Get User's level of access to the document; can be ANONYMOUS_ACCESS, READ, READ_COPY_EXPORT, COMMENT, WRITE, RESHARE, FULL, or OWNER (Deprecated)

Returns:

User's level of access to the document; can be ANONYMOUS_ACCESS, READ, READ_COPY_EXPORT, COMMENT, WRITE, RESHARE, FULL, or OWNER (Deprecated)

getTrashedAt

public final Date getTrashedAt()

Get When document has been trashed

Returns:

When document has been trashed

getTrash

public final Boolean getTrash()

Get Whether document has been trashed

Returns:

Whether document has been trashed

getStarred

public final String getStarred()

Get Whether document has been starred (Deprecated)

Returns:

Whether document has been starred (Deprecated)

getActive

public final String getActive()

Get Whether a shared document is active

Returns:

Whether a shared document is active

getCreatedAt

public final Date getCreatedAt()

Get Creation date

Returns:

Creation date

getDocumentThumbnailElementId

public final String getDocumentThumbnailElementId()

Get The element which the Document Thumbnail should mirror

Returns:

The element which the Document Thumbnail should mirror

getThumbnail

public final DocumentsGetDocumentResponseThumbnail getThumbnail()

Get Thumbnail information

Returns:

Thumbnail information

getCreatedBy

public final DocumentsGetDocumentResponseCreatedBy getCreatedBy()

Get User information for the creator of the document

Returns:

User information for the creator of the document

getModifiedAt

public final Date getModifiedAt()

Get Date of last modification

Returns:

Date of last modification

getModifiedBy

public final DocumentsGetDocumentResponseModifiedBy getModifiedBy()

Get User information for the last modifier of the document

Returns:

User information for the last modifier of the document

getTags

public final String[] getTags()

Get Reserved for future use

Returns:

Reserved for future use

getSizeBytes

public final Number getSizeBytes()

Get Size of document in bytes

Returns:

Size of document in bytes

getName

public final String getName()

Get Name of document

Returns:

Name of document

getId

public final String getId()

Get Document ID

Returns:

Document ID

getHref

public final String getHref()

Get Document URL

Returns:

Document URL

getTotalWorkspacesUpdating

public final Number getTotalWorkspacesUpdating()

Get Number of workspaces that are updating

Returns:

Number of workspaces that are updating

getTotalWorkspacesScheduledForUpdate

public final Number getTotalWorkspacesScheduledForUpdate()

Get Number of workspaces that are scheduled for updating

Returns:

Number of workspaces that are scheduled for updating

toString

public String toString()

Overrides:

toString in class Object