Package com.onshape.api.requests

Class MetadataGetMetadataSchemaRequest.Builder

java.lang.Object

com.onshape.api.requests.MetadataGetMetadataSchemaRequest.Builder

Enclosing class:

MetadataGetMetadataSchemaRequest

public static final class MetadataGetMetadataSchemaRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
MetadataGetMetadataSchemaResponse	call(String ownerId, Number objectType)	Calls getMetadataSchema method, Get metadata schema, or Onshape schema if user/company has no schema for the given object type
String	documentId()	Get ID of the document the schema is associated with.
MetadataGetMetadataSchemaRequest.Builder	documentId(String value)	Set ID of the document the schema is associated with.
Number	ownerType()	Get Schema owner type, which can be: 1:company 2:onshape (default: 1)
MetadataGetMetadataSchemaRequest.Builder	ownerType(Number value)	Set Schema owner type, which can be: 1:company 2:onshape (default: 1)

Methods inherited from class java.lang.Object

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

Method Detail

ownerType

public final Number ownerType()

Get Schema owner type, which can be: 1:company 2:onshape (default: 1)

Returns:

Schema owner type, which can be: 1:company 2:onshape (default: 1)

ownerType

public final MetadataGetMetadataSchemaRequest.Builder ownerType(Number value)

Set Schema owner type, which can be: 1:company 2:onshape (default: 1)

Parameters:

value - Schema owner type, which can be: 1:company 2:onshape (default: 1)

Returns:

the Builder object.

documentId

public final String documentId()

Get ID of the document the schema is associated with.

Returns:

ID of the document the schema is associated with.

documentId

public final MetadataGetMetadataSchemaRequest.Builder documentId(String value)

Set ID of the document the schema is associated with.

Parameters:

value - ID of the document the schema is associated with.

Returns:

the Builder object.

call

public final MetadataGetMetadataSchemaResponse call(String ownerId,
                                                    Number objectType)
                                             throws OnshapeException

Calls getMetadataSchema method, Get metadata schema, or Onshape schema if user/company has no schema for the given object type

Parameters:

ownerId - Schema owner ID (Default: null)

objectType - Metadata object type, which can be: 0:GLOBAL, 1:DOCUMENT, 2:PART, 3:ASSEMBLY, 4:DRAWING, 5:PART_STUDIO, 6: BLOB_ELEMENT, 7:APP_ELEMENT, 8:VERSION, 9:WORKSPACE (Default: null)

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error