Package com.onshape.api.responses

Class DocumentsCreateDocumentResponse

java.lang.Object

com.onshape.api.types.AbstractResponseObject

com.onshape.api.responses.DocumentsCreateDocumentResponse

public final class DocumentsCreateDocumentResponse
extends AbstractResponseObject

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

Constructor Summary

Constructors

Constructor	Description
DocumentsCreateDocumentResponse()

Method Summary

Modifier and Type	Method	Description
Boolean	getActive()	Get Whether a shared document is active
String[]	getBetaCapabilityIds()	Get Onshape internal use
Date	getCreatedAt()	Get Creation date
DocumentsCreateDocumentResponseCreatedBy	getCreatedBy()	Get User information for the creator of the document
DocumentsCreateDocumentResponseDefaultWorkspace	getDefaultWorkspace()	Get Information about the default workspace
String	getHref()	Get Document URL
String	getId()	Get Document ID
Boolean	getIsPublic()	Get Whether document is public
Date	getModifiedAt()	Get Date of last modification
DocumentsCreateDocumentResponseModifiedBy	getModifiedBy()	Get User information for the last modifier of the document
String	getName()	Get Name of document
DocumentsCreateDocumentResponseOwner	getOwner()	Get Information about document owner
String	getPermission()	Get Onshape internal use (Deprecated)
String[]	getPermissionSet()	Get User's level of access to the document.
Number	getSizeBytes()	Get Size of document in bytes
Boolean	getStarred()	Get Whether document has been starred (Deprecated)
String[]	getTags()	Get Reserved for future use
DocumentsCreateDocumentResponseThumbnail	getThumbnail()	Get Thumbnail information
Boolean	getTrash()	Get Whether document has been trashed
Date	getTrashedAt()	Get When document has been trashed
DocumentsCreateDocumentResponse	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

DocumentsCreateDocumentResponse

public DocumentsCreateDocumentResponse()

Method Detail

refresh

public final DocumentsCreateDocumentResponse 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 DocumentsCreateDocumentResponseDefaultWorkspace 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 DocumentsCreateDocumentResponseOwner 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 Onshape internal use (Deprecated)

Returns:

Onshape internal use (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 Boolean getStarred()

Get Whether document has been starred (Deprecated)

Returns:

Whether document has been starred (Deprecated)

getActive

public final Boolean 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

getThumbnail

public final DocumentsCreateDocumentResponseThumbnail getThumbnail()

Get Thumbnail information

Returns:

Thumbnail information

getCreatedBy

public final DocumentsCreateDocumentResponseCreatedBy 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 DocumentsCreateDocumentResponseModifiedBy 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

toString

public String toString()

Overrides:

toString in class Object