Package com.onshape.api.responses

Class MetadataGetMetadataSchemaPropertiesResponseItems

java.lang.Object

com.onshape.api.types.AbstractResponseObject

com.onshape.api.responses.MetadataGetMetadataSchemaPropertiesResponseItems

public final class MetadataGetMetadataSchemaPropertiesResponseItems
extends AbstractResponseObject

Object used in calls to getMetadataSchemaProperties API endpoint. © 2018-Present Onshape Inc.

Field Summary

Fields

Modifier and Type	Field	Description
String	description	Property description
Boolean	editableInMicroversion	True if this property can be edited in a workspace.
Boolean	editableInVersion	True if this property can be edited in a version.
String	id	Property ID
String	name	Property name
String	namespace	Property namespace (use to disambiguate properties with same name)
String	ownerId	Property owner ID
Number	ownerType	Property owner type, which can be: 1: company, 2: onshape
MetadataGetMetadataSchemaPropertiesResponseItemsPropertyConfigSummaryInfoList[]	propertyConfigSummaryInfoList	Additional information about property.
Number	valueType	Value type of property, which can be: 0:STRING, 1:BOOL, 2:INT, 3:DOUBLE, 4:DATE, 5:ENUM, 6:OBJECT, 7:BLOB, 8:USER

Constructor Summary

Constructors

Constructor	Description
MetadataGetMetadataSchemaPropertiesResponseItems()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Get Property description
Boolean	getEditableInMicroversion()	Get True if this property can be edited in a workspace.
Boolean	getEditableInVersion()	Get True if this property can be edited in a version.
String	getId()	Get Property ID
String	getName()	Get Property name
String	getNamespace()	Get Property namespace (use to disambiguate properties with same name)
String	getOwnerId()	Get Property owner ID
Number	getOwnerType()	Get Property owner type, which can be: 1: company, 2: onshape
MetadataGetMetadataSchemaPropertiesResponseItemsPropertyConfigSummaryInfoList[]	getPropertyConfigSummaryInfoList()	Get Additional information about property.
Number	getValueType()	Get Value type of property, which can be: 0:STRING, 1:BOOL, 2:INT, 3:DOUBLE, 4:DATE, 5:ENUM, 6:OBJECT, 7:BLOB, 8:USER
String	toString()

Methods inherited from class com.onshape.api.types.AbstractResponseObject

getOtherProperties

Methods inherited from class java.lang.Object

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

Field Detail

id

public String id

Property ID

name

public String name

Property name

description

public String description

Property description

ownerId

public String ownerId

Property owner ID

ownerType

public Number ownerType

Property owner type, which can be: 1: company, 2: onshape

namespace

public String namespace

Property namespace (use to disambiguate properties with same name)

valueType

public Number valueType

Value type of property, which can be: 0:STRING, 1:BOOL, 2:INT, 3:DOUBLE, 4:DATE, 5:ENUM, 6:OBJECT, 7:BLOB, 8:USER

editableInVersion

public Boolean editableInVersion

True if this property can be edited in a version.

editableInMicroversion

public Boolean editableInMicroversion

True if this property can be edited in a workspace.

propertyConfigSummaryInfoList

public MetadataGetMetadataSchemaPropertiesResponseItemsPropertyConfigSummaryInfoList[] propertyConfigSummaryInfoList

Additional information about property.

Constructor Detail

MetadataGetMetadataSchemaPropertiesResponseItems

public MetadataGetMetadataSchemaPropertiesResponseItems()

Method Detail

getId

public final String getId()

Get Property ID

Returns:

Property ID

getName

public final String getName()

Get Property name

Returns:

Property name

getDescription

public final String getDescription()

Get Property description

Returns:

Property description

getOwnerId

public final String getOwnerId()

Get Property owner ID

Returns:

Property owner ID

getOwnerType

public final Number getOwnerType()

Get Property owner type, which can be: 1: company, 2: onshape

Returns:

Property owner type, which can be: 1: company, 2: onshape

getNamespace

public final String getNamespace()

Get Property namespace (use to disambiguate properties with same name)

Returns:

Property namespace (use to disambiguate properties with same name)

getValueType

public final Number getValueType()

Get Value type of property, which can be: 0:STRING, 1:BOOL, 2:INT, 3:DOUBLE, 4:DATE, 5:ENUM, 6:OBJECT, 7:BLOB, 8:USER

Returns:

Value type of property, which can be: 0:STRING, 1:BOOL, 2:INT, 3:DOUBLE, 4:DATE, 5:ENUM, 6:OBJECT, 7:BLOB, 8:USER

getEditableInVersion

public final Boolean getEditableInVersion()

Get True if this property can be edited in a version.

Returns:

True if this property can be edited in a version.

getEditableInMicroversion

public final Boolean getEditableInMicroversion()

Get True if this property can be edited in a workspace.

Returns:

True if this property can be edited in a workspace.

getPropertyConfigSummaryInfoList

public final MetadataGetMetadataSchemaPropertiesResponseItemsPropertyConfigSummaryInfoList[] getPropertyConfigSummaryInfoList()

Get Additional information about property.

Returns:

Additional information about property.

toString

public String toString()

Overrides:

toString in class Object