Package com.onshape.api.requests

Class MetadataCategoryCreateCategoryRequest

java.lang.Object

com.onshape.api.requests.MetadataCategoryCreateCategoryRequest

public final class MetadataCategoryCreateCategoryRequest
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetadataCategoryCreateCategoryRequest.Builder

Method Summary

Modifier and Type	Method	Description
static MetadataCategoryCreateCategoryRequest.Builder	builder(Onshape onshape)
String	getDescription()	Get Category description
String[]	getMemberCategoryIds()	Get List of ids of the categories this category will be member of
String	getName()	Get Category name
Number	getObjectType()	Get 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
Number[]	getObjectTypes()	Get List of metadata object types this category will be applicable for picking
String	getOwnerId()	Get CompanyId that will own the category
Number	getOwnerType()	Get Owner type, which can be: 1:company
Number	getPublishState()	Get Category publish state, which can be: 0: PENDING, 1: ACTIVE, 2: INACTIVE
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 Category name

Returns:

Category name

getDescription

public final String getDescription()

Get Category description

Returns:

Category description

getOwnerId

public final String getOwnerId()

Get CompanyId that will own the category

Returns:

CompanyId that will own the category

getOwnerType

public final Number getOwnerType()

Get Owner type, which can be: 1:company

Returns:

Owner type, which can be: 1:company

getObjectType

public final Number getObjectType()

Get 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

Returns:

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

getObjectTypes

public final Number[] getObjectTypes()

Get List of metadata object types this category will be applicable for picking

Returns:

List of metadata object types this category will be applicable for picking

getMemberCategoryIds

public final String[] getMemberCategoryIds()

Get List of ids of the categories this category will be member of

Returns:

List of ids of the categories this category will be member of

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

toString

public String toString()

Overrides:

toString in class Object

builder

public static final MetadataCategoryCreateCategoryRequest.Builder builder(Onshape onshape)