Package com.onshape.api.requests

Class DocumentsCreateVersionRequest

java.lang.Object

com.onshape.api.requests.DocumentsCreateVersionRequest

public final class DocumentsCreateVersionRequest
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentsCreateVersionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentsCreateVersionRequest.Builder	builder(Onshape onshape)
String	getDescription()	Get Version description
String	getDocumentId()	Get Document ID (must match path parameter)
Boolean	getFromHistory()	Get Specifies whether to create a version at a specific microversion (specified by microversionId)
String	getMicroversionId()	Get Microversion ID at which to create the version if fromHistory is true
String	getName()	Get Version name
String	getWorkspaceId()	Get Workspace ID of a workspace where the version will be created if fromHistory is false.
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 Document ID (must match path parameter)

Returns:

Document ID (must match path parameter)

getWorkspaceId

public final String getWorkspaceId()

Get Workspace ID of a workspace where the version will be created if fromHistory is false. If fromHistory is false and workspaceId is not set, the default workspace is used.

Returns:

Workspace ID of a workspace where the version will be created if fromHistory is false. If fromHistory is false and workspaceId is not set, the default workspace is used.

getName

public final String getName()

Get Version name

Returns:

Version name

getDescription

public final String getDescription()

Get Version description

Returns:

Version description

getMicroversionId

public final String getMicroversionId()

Get Microversion ID at which to create the version if fromHistory is true

Returns:

Microversion ID at which to create the version if fromHistory is true

getFromHistory

public final Boolean getFromHistory()

Get Specifies whether to create a version at a specific microversion (specified by microversionId)

Returns:

Specifies whether to create a version at a specific microversion (specified by microversionId)

toString

public String toString()

Overrides:

toString in class Object

builder

public static final DocumentsCreateVersionRequest.Builder builder(Onshape onshape)