Onshape MetadataCategory API
Access properties associated with metadata categories.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/onshape-metadatacategory-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
title: Onshape REST Account Metadata Category API
description: '## Welcome to the Onshape REST API Explorer
**See the [API Explorer Guide](https://onshape-public.github.io/docs/api-intro/explorer/) for help navigating this page.**
### Using this page
1. Sign in to your [Onshape](https://cad.onshape.com) account in another tab.
2. Click the `Try it out` button below. It toggles to a `Cancel` button when selected.
### Authenticating
To authenticate your calls, click the `Authorize` button. See [API Explorer Guide: Authentication](https://onshape-public.github.io/docs/api-intro/explorer/#authentication) for details. Calls made when authenticated via API Keys or OAuth count against your annual [API limits](https://onshape-public.github.io/docs/auth/limits/#annual-api-call-limits).
* **Tip:** To ensure the current session isn''t used when trying other authentication techniques, make sure to [remove the Onshape cookie](https://support.google.com/chrome/answer/95647#zippy=%2Cdelete-cookies-from-a-site) as per the instructions for your browser, or use a private or incognito window.
### Additional resources
* [Onshape API Guide](https://onshape-public.github.io/docs/): Our full suite of developer guides, to be used as an accompaniment to this API Explorer.
* [Onshape Developer Portal](https://cad.onshape.com/appstore/dev-portal): The Onshape portal for managing your API keys, OAuth2 credentials, your Onshape applications, and your Onshape App Store entries.
* [Authentication Guide](https://onshape-public.github.io/docs/auth/): Our guide to using API keys, request signatures, and OAuth2 in your Onshape applications.'
termsOfService: https://www.onshape.com/legal/terms-of-use
contact:
email: api-support@onshape.zendesk.com
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 1.218.84032-34acba44be17
x-logo:
url: images/logo-onshape-gray-green-nav-bar.svg
backgroundColor: '#ffffff'
altText: Onshape
href: images/logo-onshape-gray-green-nav-bar.svg
x-indeterministic-schemas:
- BTDiffInfo
- BTParameterSpecArray-2600
- BTSplineDescription-2118
- NodeModel
- BTPFunctionDeclaration-246
- BTPFunctionOrPredicateDeclaration-247
- BTPExpression-9
- SkinModel
- BTMAnnotation-4664
x-filter-info: ?restUserRole=PUBLIC
servers:
- url: https://cad.onshape.com/api/v16
description: Current
security:
- BasicAuth: []
tags:
- name: MetadataCategory
description: Access properties associated with metadata categories.
paths:
/metadatacategory/categoryproperties:
get:
tags:
- MetadataCategory
summary: Get properties associated with the specified metadata categories.
description: 'An object''s category specifies its type: Part, Assembly, Drawing, etc. Available properties depend on the object''s category.'
operationId: getCategoryProperties
parameters:
- name: ownerId
in: query
schema:
type: string
- name: ownerType
in: query
schema:
type: integer
format: int32
default: 1
- name: documentId
in: query
schema:
type: string
- name: categoryIds
in: query
schema:
type: array
items:
type: string
- name: objectType
in: query
schema:
type: integer
format: int32
- name: strict
in: query
schema:
type: boolean
default: true
- name: includeObjectTypeDefaults
in: query
schema:
type: boolean
default: false
- name: includeComputedProperties
in: query
schema:
type: boolean
default: true
- name: includePartPropertiesTableOnlyProperties
in: query
schema:
type: boolean
default: true
- name: onlyActive
in: query
schema:
type: boolean
default: false
- name: onlyObjectTypeDefaults
in: query
schema:
type: boolean
default: false
responses:
default:
description: default response
content:
application/json;charset=UTF-8; qs=0.09:
schema:
$ref: '#/components/schemas/BTListResponseBTCategoryPropertyInfo'
deprecated: false
security:
- OAuth2:
- OAuth2Read
BasicAuth:
- OAuth2Read
x-BTVisibility: PRODUCTION
components:
schemas:
BTCategoryPropertyConfigInfo:
type: object
properties:
computedAssemblyPropertyAggregatedPropertyId:
type: string
computedAssemblyPropertyAggregationOperator:
type: integer
format: int32
computedAssemblyPropertyConfig:
$ref: '#/components/schemas/BTComputedAssemblyPropertyConfig'
computedAssemblyPropertyErrorValuePolicy:
type: integer
format: int32
computedAssemblyPropertyFilterInverted:
type: boolean
computedAssemblyPropertyFilterPropertyId:
type: string
computedAssemblyPropertyMissingValuePolicy:
type: integer
format: int32
computedAssemblyPropertySecondaryPropertyId:
type: string
computedPartPropertyConfig:
$ref: '#/components/schemas/BTComputedPartPropertyConfig'
computedPropertyFunctionName:
type: string
computedPropertyFunctionNamespace:
type: string
computedPropertyFunctionURL:
type: string
defaultValue:
type: string
displayName:
type: string
enumValues:
type: array
items:
$ref: '#/components/schemas/BTMetadataEnumValue'
maxCount:
type: integer
format: int32
maxDate:
type: string
format: date-time
maxLength:
type: integer
format: int32
maxValue:
type: number
format: double
minCount:
type: integer
format: int32
minDate:
type: string
format: date-time
minLength:
type: integer
format: int32
minValue:
type: number
format: double
multiline:
type: boolean
multivalued:
type: boolean
pattern:
type: string
publishState:
type: integer
format: int32
quantityType:
type: integer
format: int32
required:
type: boolean
BTComputedAssemblyPropertyAggregationOperator:
type: string
enum:
- SUM
- MINIMUM
- MAXIMUM
- AVERAGE
- WEIGHTED_SUM
- WEIGHTED_AVERAGE
- ANY
- ALL
- NOT_ANY
- NOT_ALL
BTComputedPartPropertyConfig:
type: object
properties:
computedPartPropertySpecFunction:
type: string
computedPartPropertySpecNamespace:
type: string
computedPropertyFunctionReturnType:
type: integer
format: int32
propertyFunctionDocumentId:
type: string
BTComputedAssemblyPropertyConfig:
type: object
properties:
aggregatedPropertyId:
type: string
aggregationOperator:
$ref: '#/components/schemas/BTComputedAssemblyPropertyAggregationOperator'
errorValuePolicy:
$ref: '#/components/schemas/BTComputedAssemblyPropertyErrorPolicy'
filterPropertyId:
type: string
isFilterPropertyInverted:
type: boolean
missingValuePolicy:
$ref: '#/components/schemas/BTComputedAssemblyPropertyErrorPolicy'
secondaryPropertyId:
type: string
BTListResponseBTCategoryPropertyInfo:
type: object
properties:
href:
type: string
description: URI for current page of resources.
format: uri
items:
type: array
description: Array of items in the current page.
items:
$ref: '#/components/schemas/BTCategoryPropertyInfo'
next:
type: string
description: URI for next page of the resources if more are available.
format: uri
previous:
type: string
description: URI for previous page of the resources.
format: uri
description: A list of resources that typically supports paging.
BTCategoryPropertyInfo:
type: object
properties:
array:
type: boolean
assignable:
type: boolean
blobMimeType:
type: string
categoryPropertyConfigInfo:
$ref: '#/components/schemas/BTCategoryPropertyConfigInfo'
categorySummaryInfoList:
type: array
items:
$ref: '#/components/schemas/BTMetadataCategorySummaryInfo'
description:
type: string
editableInMicroversion:
type: boolean
editableInVersion:
type: boolean
href:
type: string
description: URI to fetch complete information of the resource.
format: uri
id:
type: string
description: Id of the resource.
name:
type: string
description: Name of the resource.
objectDefName:
type: string
ownerId:
type: string
ownerType:
type: integer
format: int32
uiReadonlyInMicroversion:
type: boolean
uiReadonlyInVersion:
type: boolean
valueType:
type: integer
format: int32
viewRef:
type: string
description: URI to visualize the resource in a webclient if applicable.
format: uri
BTMetadataCategorySummaryInfo:
type: object
properties:
defaultObjectType:
type: integer
format: int32
description:
type: string
href:
type: string
description: URI to fetch complete information of the resource.
format: uri
id:
type: string
description: Id of the resource.
name:
type: string
description: Name of the resource.
objectTypes:
type: array
items:
type: integer
format: int32
ownerId:
type: string
ownerType:
type: integer
format: int32
publishState:
type: integer
format: int32
viewRef:
type: string
description: URI to visualize the resource in a webclient if applicable.
format: uri
BTComputedAssemblyPropertyErrorPolicy:
type: string
enum:
- ExcludeFromComputation
- TreatAsZero
- TreatAsTrue
- TreatAsFalse
- PropagateError
BTMetadataEnumValue:
type: object
properties:
label:
type: string
state:
type: integer
format: int32
value:
type: string
securitySchemes:
OAuth2:
type: oauth2
description: Use OAuth 2.0 to authenticate requests.
flows:
authorizationCode:
authorizationUrl: /oauth/authorize
tokenUrl: /oauth/token
refreshUrl: /oauth/token
scopes:
OAuth2Internal: Application is Onshape Internal
OAuth2ReadPII: Application can read your profile information
OAuth2Read: Application can read your documents
OAuth2Write: Application can write to your documents
OAuth2Delete: Application can delete your documents and workspaces
OAuth2Purchase: Application can request purchases on your behalf
OAuth2Share: Application can share and unshare documents on your behalf
document.create: Atlas Application can create a document
document.edit: Atlas Application can edit a document
document.delete: Atlas Application can delete a document
document.read: Atlas Application can read a document
enterprise.create: Atlas Application can create an enterprise
enterprise.read: Atlas Application can read from an enterprise
enterprise.edit: Atlas Application can edit an enterprise
enterprise.delete: Atlas Application can delete an enterprise
enterprise.member.create: Atlas Application can create an enterprise member
enterprise.member.read: Atlas Application can read the details of an enterprise member
enterprise.member.edit: Atlas Application can edit the details of an enterprise member
enterprise.member.delete: Atlas Application can delete a member from an enterprise
webhook.create: Atlas Application can create a webhook on behalf of the logged-in user
webhook.edit: Atlas Application can edit a webhook on behalf of the logged-in user
webhook.read: Atlas Application can read a webhook on behalf of the logged-in user
webhook.delete: Atlas Application can delete a webhook on behalf of the logged-in user
PLMIntegration: PLM automation can invoke limited operations
BasicAuth:
type: http
description: Use Basic Authentication with API Keys (key as username and secret as password) to authenticate requests.
scheme: basic