Package com.onshape.api.requests

Class DocumentsGetVersionRequest.Builder

java.lang.Object

com.onshape.api.requests.DocumentsGetVersionRequest.Builder

Enclosing class:

DocumentsGetVersionRequest

public static final class DocumentsGetVersionRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
DocumentsGetVersionResponse	call(OnshapeDocument document, String vid)	Calls getVersion method, Get information about a version
DocumentsGetVersionResponse	call(String did, String vid)	Calls getVersion method, Get information about a version
String	linkDocumentId()	Get Id of document that links to the document being accessed.
DocumentsGetVersionRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.

Methods inherited from class java.lang.Object

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

Method Detail

linkDocumentId

public final String linkDocumentId()

Get Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

linkDocumentId

public final DocumentsGetVersionRequest.Builder linkDocumentId(String value)

Set Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Parameters:

value - Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

the Builder object.

call

public final DocumentsGetVersionResponse call(String did,
                                              String vid)
                                       throws OnshapeException

Calls getVersion method, Get information about a version

Parameters:

did - Document ID

vid - Version ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final DocumentsGetVersionResponse call(OnshapeDocument document,
                                              String vid)
                                       throws OnshapeException

Calls getVersion method, Get information about a version

Parameters:

document - Document object from Onshape URL.

vid - Version ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error