Package com.onshape.api.requests

Class RevisionsEnumerateRevisionsRequest.Builder

java.lang.Object

com.onshape.api.requests.RevisionsEnumerateRevisionsRequest.Builder

Enclosing class:

RevisionsEnumerateRevisionsRequest

public static final class RevisionsEnumerateRevisionsRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
String	after()	Get An ISO-8601 UTC time string to find revisions since this instant
RevisionsEnumerateRevisionsRequest.Builder	after(String value)	Set An ISO-8601 UTC time string to find revisions since this instant
RevisionsEnumerateRevisionsResponse	call(String cid, Number elementType)	Calls enumerateRevisions method, Enumerate all revisions released in a company.
Boolean	latestOnly()	Get Only find the latest revisions of each part number
RevisionsEnumerateRevisionsRequest.Builder	latestOnly(Boolean value)	Set Only find the latest revisions of each part number
Number	limit()	Get Number of results to return per page (max is 100)
RevisionsEnumerateRevisionsRequest.Builder	limit(Number value)	Set Number of results to return per page (max is 100)

Methods inherited from class java.lang.Object

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

Method Detail

limit

public final Number limit()

Get Number of results to return per page (max is 100)

Returns:

Number of results to return per page (max is 100)

limit

public final RevisionsEnumerateRevisionsRequest.Builder limit(Number value)

Set Number of results to return per page (max is 100)

Parameters:

value - Number of results to return per page (max is 100)

Returns:

the Builder object.

latestOnly

public final Boolean latestOnly()

Get Only find the latest revisions of each part number

Returns:

Only find the latest revisions of each part number

latestOnly

public final RevisionsEnumerateRevisionsRequest.Builder latestOnly(Boolean value)

Set Only find the latest revisions of each part number

Parameters:

value - Only find the latest revisions of each part number

Returns:

the Builder object.

after

public final String after()

Get An ISO-8601 UTC time string to find revisions since this instant

Returns:

An ISO-8601 UTC time string to find revisions since this instant

after

public final RevisionsEnumerateRevisionsRequest.Builder after(String value)

Set An ISO-8601 UTC time string to find revisions since this instant

Parameters:

value - An ISO-8601 UTC time string to find revisions since this instant

Returns:

the Builder object.

call

public final RevisionsEnumerateRevisionsResponse call(String cid,
                                                      Number elementType)
                                               throws OnshapeException

Calls enumerateRevisions method, Enumerate all revisions released in a company. Returns a slice of the all revisions per API call and to get the next set of results use the "next" URL from the response. Only company admins can enumerate all revisions in a company.

Parameters:

cid - Company Id

elementType - Type of element, which can be 0: Part Studio, 1: Assembly, 2: Drawing. 4: Blob (Default: null)

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error