Package com.onshape.api.requests

Class DocumentsCreateDocumentRequest

java.lang.Object

com.onshape.api.requests.DocumentsCreateDocumentRequest

public final class DocumentsCreateDocumentRequest
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentsCreateDocumentRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentsCreateDocumentRequest.Builder	builder(Onshape onshape)
String[]	getBetaCapabilityIds()	Get Onshape internal use
DocumentsCreateDocumentRequestElements[]	getElements()	Get custom elements definition to be created with document.
Boolean	getIsGenerateUnknownMessages()	Get Onshape internal use
Boolean	getIsPublic()	Get Whether document is public
String	getName()	Get Document name
String	getOwnerId()	Get Owner's user ID (default: current user)
Number	getOwnerType()	Get Owner's user type, which can be 0: user, 1: company
String	getParentId()	Get Id of a folder to place the created document in
String[]	getTags()	Get Onshape internal use
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getName

public final String getName()

Get Document name

Returns:

Document name

getParentId

public final String getParentId()

Get Id of a folder to place the created document in

Returns:

Id of a folder to place the created document in

getOwnerId

public final String getOwnerId()

Get Owner's user ID (default: current user)

Returns:

Owner's user ID (default: current user)

getOwnerType

public final Number getOwnerType()

Get Owner's user type, which can be 0: user, 1: company

Returns:

Owner's user type, which can be 0: user, 1: company

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

getIsGenerateUnknownMessages

public final Boolean getIsGenerateUnknownMessages()

Get Onshape internal use

Returns:

Onshape internal use

getTags

public final String[] getTags()

Get Onshape internal use

Returns:

Onshape internal use

getElements

public final DocumentsCreateDocumentRequestElements[] getElements()

Get custom elements definition to be created with document.

Returns:

custom elements definition to be created with document.

toString

public String toString()

Overrides:

toString in class Object

builder

public static final DocumentsCreateDocumentRequest.Builder builder(Onshape onshape)