Package com.onshape.api.responses

Class MetadataCategoryGetCategoryResponse

java.lang.Object

com.onshape.api.types.AbstractResponseObject

com.onshape.api.responses.MetadataCategoryGetCategoryResponse

public final class MetadataCategoryGetCategoryResponse
extends AbstractResponseObject

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

Constructor Summary

Constructors

Constructor	Description
MetadataCategoryGetCategoryResponse()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Get Category description
String	getId()	Get Category id
MetadataCategoryGetCategoryResponseMemberCategories[]	getMemberCategories()	Get Array of member category info objects
String[]	getMemberCategoryIds()	Get List of ids of the categories this category is member of
String	getName()	Get Category name
Number[]	getObjectTypes()	Get List of metadata object types this category is applicable for picking
String	getOwnerId()	Get CompanyId that owns the category
Number	getOwnerType()	Get Category owner type, which will be: 1:company, 2: onshape
Number	getPublishState()	Get Category publish state, which can be: 0: PENDING, 1: ACTIVE, 2: INACTIVE
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

MetadataCategoryGetCategoryResponse

public MetadataCategoryGetCategoryResponse()

Method Detail

getId

public final String getId()

Get Category id

Returns:

Category id

getName

public final String getName()

Get Category name

Returns:

Category name

getDescription

public final String getDescription()

Get Category description

Returns:

Category description

getOwnerId

public final String getOwnerId()

Get CompanyId that owns the category

Returns:

CompanyId that owns the category

getOwnerType

public final Number getOwnerType()

Get Category owner type, which will be: 1:company, 2: onshape

Returns:

Category owner type, which will be: 1:company, 2: onshape

getPublishState

public final Number getPublishState()

Get Category publish state, which can be: 0: PENDING, 1: ACTIVE, 2: INACTIVE

Returns:

Category publish state, which can be: 0: PENDING, 1: ACTIVE, 2: INACTIVE

getObjectTypes

public final Number[] getObjectTypes()

Get List of metadata object types this category is applicable for picking

Returns:

List of metadata object types this category is applicable for picking

getMemberCategoryIds

public final String[] getMemberCategoryIds()

Get List of ids of the categories this category is member of

Returns:

List of ids of the categories this category is member of

getMemberCategories

public final MetadataCategoryGetCategoryResponseMemberCategories[] getMemberCategories()

Get Array of member category info objects

Returns:

Array of member category info objects

toString

public String toString()

Overrides:

toString in class Object