Package com.onshape.api.responses

Class MetadataGetPropertyInfoResponse

java.lang.Object

com.onshape.api.types.AbstractResponseObject

com.onshape.api.responses.MetadataGetPropertyInfoResponse

public final class MetadataGetPropertyInfoResponse
extends AbstractResponseObject

Response object for getPropertyInfo API endpoint. © 2018-Present Onshape Inc.

Constructor Summary

Constructors

Constructor	Description
MetadataGetPropertyInfoResponse()

Method Summary

Modifier and Type	Method	Description
Boolean	getArray()	Get True if property is an array type
String	getBlobMimeType()	Get Blob mime type if valueType == BLOB (7)
String	getDescription()	Get Property description
Boolean	getEditableInMicroversion()	Get True if this property can be edited in a Microversion
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	getObjectDefName()	Get Object type name if valueType == OBJECT (6)
String	getOwnerId()	Get Property owner ID
Number	getOwnerType()	Get Property owner type, which can be: 1: company 2:onshape
MetadataGetPropertyInfoResponsePropertyConfigInfoList[]	getPropertyConfigInfoList()	Get Additional information about property only returned if schemaId is included in request
String	getSafeName()	Get Safe name
Number	getSearchBoost()	Get Relative ordering of search importance.
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

Constructor Detail

MetadataGetPropertyInfoResponse

public MetadataGetPropertyInfoResponse()

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

getArray

public final Boolean getArray()

Get True if property is an array type

Returns:

True if property is an array type

getObjectDefName

public final String getObjectDefName()

Get Object type name if valueType == OBJECT (6)

Returns:

Object type name if valueType == OBJECT (6)

getBlobMimeType

public final String getBlobMimeType()

Get Blob mime type if valueType == BLOB (7)

Returns:

Blob mime type if valueType == BLOB (7)

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 Microversion

Returns:

True if this property can be edited in a Microversion

getSafeName

public final String getSafeName()

Get Safe name

Returns:

Safe name

getSearchBoost

public final Number getSearchBoost()

Get Relative ordering of search importance. Baseline is 1.0

Returns:

Relative ordering of search importance. Baseline is 1.0

getPropertyConfigInfoList

public final MetadataGetPropertyInfoResponsePropertyConfigInfoList[] getPropertyConfigInfoList()

Get Additional information about property only returned if schemaId is included in request

Returns:

Additional information about property only returned if schemaId is included in request

toString

public String toString()

Overrides:

toString in class Object