Package com.onshape.api.requests

Class WorkflowGetActiveWorkflowsRequest.Builder

java.lang.Object

com.onshape.api.requests.WorkflowGetActiveWorkflowsRequest.Builder

Enclosing class:

WorkflowGetActiveWorkflowsRequest

public static final class WorkflowGetActiveWorkflowsRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
WorkflowGetActiveWorkflowsResponse	call()	Calls getActiveWorkflows method, Get active workflows for the logged-in user's company, optionally specific to a document
String	documentId()	Get Document ID that is owned by company for which workflow info is requested.
WorkflowGetActiveWorkflowsRequest.Builder	documentId(String value)	Set Document ID that is owned by company for which workflow info is requested.
Boolean	full()	Get Whether to include the full workflow json
WorkflowGetActiveWorkflowsRequest.Builder	full(Boolean value)	Set Whether to include the full workflow json

Methods inherited from class java.lang.Object

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

Method Detail

documentId

public final String documentId()

Get Document ID that is owned by company for which workflow info is requested.

Returns:

Document ID that is owned by company for which workflow info is requested.

documentId

public final WorkflowGetActiveWorkflowsRequest.Builder documentId(String value)

Set Document ID that is owned by company for which workflow info is requested.

Parameters:

value - Document ID that is owned by company for which workflow info is requested.

Returns:

the Builder object.

full

public final Boolean full()

Get Whether to include the full workflow json

Returns:

Whether to include the full workflow json

full

public final WorkflowGetActiveWorkflowsRequest.Builder full(Boolean value)

Set Whether to include the full workflow json

Parameters:

value - Whether to include the full workflow json

Returns:

the Builder object.

call

public final WorkflowGetActiveWorkflowsResponse call()
                                              throws OnshapeException

Calls getActiveWorkflows method, Get active workflows for the logged-in user's company, optionally specific to a document

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error