Package com.onshape.api.requests

Class MetadataCategoryCreatePropertyRequest

java.lang.Object

com.onshape.api.requests.MetadataCategoryCreatePropertyRequest

public final class MetadataCategoryCreatePropertyRequest
extends Object

Request object for createProperty API endpoint. © 2018-Present Onshape Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetadataCategoryCreatePropertyRequest.Builder

Method Summary

Modifier and Type	Method	Description
static MetadataCategoryCreatePropertyRequest.Builder	builder(Onshape onshape)
String[]	getAddToCategoryIds()	Get List of IDs of the categories to associate this property with
String	getBlobMimeType()	Get Blob mime type if valueType == BLOB (7)
MetadataCategoryCreatePropertyRequestCategoryPropertyConfigParams	getCategoryPropertyConfigParams()	Get Additional information about property
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
Boolean	getIsArray()	Get True if property is an array type
String	getName()	Get Property 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
String[]	getRemoveFromCategoryIds()	Get List of IDs of the categories to dis-associate this property from
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 java.lang.Object

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

Method Detail

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

Returns:

Property owner type, which can be: 1:company

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

getIsArray

public final Boolean getIsArray()

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

getCategoryPropertyConfigParams

public final MetadataCategoryCreatePropertyRequestCategoryPropertyConfigParams getCategoryPropertyConfigParams()

Get Additional information about property

Returns:

Additional information about property

getAddToCategoryIds

public final String[] getAddToCategoryIds()

Get List of IDs of the categories to associate this property with

Returns:

List of IDs of the categories to associate this property with

getRemoveFromCategoryIds

public final String[] getRemoveFromCategoryIds()

Get List of IDs of the categories to dis-associate this property from

Returns:

List of IDs of the categories to dis-associate this property from

toString

public String toString()

Overrides:

toString in class Object

builder

public static final MetadataCategoryCreatePropertyRequest.Builder builder(Onshape onshape)