OpenAPI Specification
openapi: 3.0.1
info:
title: Onshape REST Account Comment 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: Comment
description: Create, read, update, and delete comments.
paths:
/comments:
get:
tags:
- Comment
summary: Get a list of comments in a document.
operationId: getComments
parameters:
- name: did
in: query
schema:
type: string
default: ''
- name: objectType
in: query
schema:
type: integer
format: int32
default: 6
- name: pid
in: query
schema:
type: string
default: ''
- name: eid
in: query
schema:
type: string
default: ''
- name: filter
in: query
schema:
type: integer
format: int32
default: 0
- name: resolved
in: query
schema:
type: boolean
default: true
- name: sortColumn
in: query
schema:
type: string
default: createdAt
- name: sortOrder
in: query
schema:
type: string
default: asc
- name: offset
in: query
schema:
minimum: 0
type: integer
format: int32
default: 0
- name: limit
in: query
schema:
maximum: 200
minimum: 1
type: integer
format: int32
default: 20
responses:
default:
description: default response
content:
application/json;charset=UTF-8; qs=0.09:
schema:
$ref: '#/components/schemas/BTListResponseBTCommentInfo'
deprecated: false
security:
- OAuth2:
- OAuth2Read
BasicAuth:
- OAuth2Read
x-BTVisibility: PRODUCTION
post:
tags:
- Comment
summary: Update a document with a new comment.
operationId: createComment
requestBody:
content:
application/json;charset=UTF-8; qs=0.09:
schema:
$ref: '#/components/schemas/BTCommentParams'
required: true
responses:
default:
description: default response
content:
application/json;charset=UTF-8; qs=0.09:
schema:
$ref: '#/components/schemas/BTCommentInfo'
deprecated: false
security:
- OAuth2:
- OAuth2Read
BasicAuth:
- OAuth2Read
x-BTVisibility: PRODUCTION
/comments/{cid}:
get:
tags:
- Comment
summary: Get details for a comment.
operationId: getComment
parameters:
- name: cid
in: path
required: true
schema:
type: string
responses:
default:
description: default response
content:
application/json;charset=UTF-8; qs=0.09:
schema:
$ref: '#/components/schemas/BTCommentInfo'
deprecated: false
security:
- OAuth2:
- OAuth2Read
BasicAuth:
- OAuth2Read
x-BTVisibility: PRODUCTION
post:
tags:
- Comment
summary: Update the content of an existing comment.
operationId: updateComment
parameters:
- name: cid
in: path
required: true
schema:
type: string
requestBody:
content:
application/json;charset=UTF-8; qs=0.09:
schema:
$ref: '#/components/schemas/BTCommentParams'
required: true
responses:
default:
description: default response
content:
application/json;charset=UTF-8; qs=0.09:
schema:
$ref: '#/components/schemas/BTCommentInfo'
deprecated: false
security:
- OAuth2:
- OAuth2Write
BasicAuth:
- OAuth2Write
x-BTVisibility: PRODUCTION
delete:
tags:
- Comment
summary: Delete a comment from a document.
operationId: deleteComment
parameters:
- name: cid
in: path
required: true
schema:
type: string
responses:
default:
description: default response
content:
application/json;charset=UTF-8; qs=0.09:
schema:
type: object
deprecated: false
security:
- OAuth2:
- OAuth2Delete
BasicAuth:
- OAuth2Delete
x-BTVisibility: PRODUCTION
/comments/{cid}/attachment:
post:
tags:
- Comment
summary: Add an attachment to a comment.
description: Attach a file to the comment. The file must be in JPEG, PNG, or GIF format
operationId: addAttachment
parameters:
- name: cid
in: path
required: true
schema:
type: string
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/BTBFileUpload'
responses:
default:
description: default response
content:
application/json;charset=UTF-8; qs=0.09:
schema:
$ref: '#/components/schemas/BTCommentInfo'
deprecated: false
security:
- OAuth2:
- OAuth2Write
BasicAuth:
- OAuth2Write
x-BTVisibility: PRODUCTION
delete:
tags:
- Comment
summary: Delete all attachments from a comment.
operationId: deleteAttachments
parameters:
- name: cid
in: path
required: true
schema:
type: string
responses:
default:
description: default response
content:
application/json;charset=UTF-8; qs=0.09:
schema:
type: object
deprecated: false
security:
- OAuth2:
- OAuth2Delete
BasicAuth:
- OAuth2Delete
x-BTVisibility: PRODUCTION
/comments/{cid}/attachment/{fdid}.{ext}:
get:
tags:
- Comment
summary: Get the attachment with the specified file extension that is associated with the specified comment.
description: Returns only a single attachment.
operationId: getAttachment
parameters:
- name: cid
in: path
required: true
schema:
type: string
- name: fdid
in: path
required: true
schema:
type: string
- name: ext
in: path
required: true
schema:
type: string
responses:
default:
description: default response
content:
application/octet-stream:
schema:
type: object
image/*:
schema:
type: object
deprecated: false
security:
- OAuth2:
- OAuth2Read
BasicAuth:
- OAuth2Read
x-BTVisibility: PRODUCTION
/comments/{cid}/reopen:
post:
tags:
- Comment
summary: Reopen a resolved comment.
operationId: reopen
parameters:
- name: cid
in: path
required: true
schema:
type: string
responses:
default:
description: default response
content:
application/json;charset=UTF-8; qs=0.09:
schema:
$ref: '#/components/schemas/BTCommentInfo'
deprecated: false
security:
- OAuth2:
- OAuth2Write
BasicAuth:
- OAuth2Write
x-BTVisibility: PRODUCTION
/comments/{cid}/resolve:
post:
tags:
- Comment
summary: Resolve a comment.
operationId: resolve
parameters:
- name: cid
in: path
required: true
schema:
type: string
responses:
default:
description: default response
content:
application/json;charset=UTF-8; qs=0.09:
schema:
$ref: '#/components/schemas/BTCommentInfo'
deprecated: false
security:
- OAuth2:
- OAuth2Write
BasicAuth:
- OAuth2Write
x-BTVisibility: PRODUCTION
components:
schemas:
BTUserBasicSummaryInfo:
required:
- jsonType
type: object
properties:
jsonType:
type: string
discriminator:
propertyName: jsonType
mapping:
user-summary: '#/components/schemas/BTUserBasicSummaryInfo'
user-detail-summary: '#/components/schemas/BTUserDetailSummaryInfo'
allOf:
- $ref: '#/components/schemas/BTBaseInfo'
- type: object
properties:
href:
type: string
description: URI to fetch complete information of the resource.
format: uri
id:
type: string
description: Id of the resource.
image:
type: string
isOnshapeSupport:
type: boolean
name:
type: string
description: Name of the resource.
state:
type: integer
format: int32
viewRef:
type: string
description: URI to visualize the resource in a webclient if applicable.
format: uri
BTCommentInfo:
type: object
properties:
annotationId:
type: string
annotationType:
type: integer
format: int32
appEntity:
type: string
assemblyFeatures:
type: array
items:
type: string
assignedAt:
type: string
format: date-time
assignee:
$ref: '#/components/schemas/BTUserSummaryInfo'
attachment:
$ref: '#/components/schemas/BTCommentAttachmentInfo'
calloutInstanceId:
type: string
canDelete:
type: boolean
canResolveOrReopen:
type: boolean
coordinates:
$ref: '#/components/schemas/CoordinatesInfo'
createdAt:
type: string
format: date-time
dimensionConstraintId:
type: string
dimensionFeatureId:
type: string
dimensionParameterId:
type: string
dimensionPartQuery:
type: string
documentId:
type: string
elementFeature:
type: string
elementId:
type: string
elementOccurrences:
type: array
items:
type: string
elementQuery:
type: string
href:
type: string
description: URI to fetch complete information of the resource.
format: uri
id:
type: string
description: Id of the resource.
message:
type: string
name:
type: string
description: Name of the resource.
objectId:
type: string
objectType:
type: integer
format: int32
parentId:
type: string
releasePackageId:
type: string
reopenedAt:
type: string
format: date-time
reopenedBy:
$ref: '#/components/schemas/BTUserSummaryInfo'
replyCount:
type: integer
format: int64
resolvedAt:
type: string
format: date-time
resolvedBy:
$ref: '#/components/schemas/BTUserSummaryInfo'
state:
type: integer
format: int32
thumbnail:
$ref: '#/components/schemas/BTCommentAttachmentInfo'
topLevel:
type: boolean
user:
$ref: '#/components/schemas/BTUserSummaryInfo'
userCompany:
type: string
versionId:
type: string
viewData:
$ref: '#/components/schemas/BTViewDataInfo'
viewRef:
type: string
description: URI to visualize the resource in a webclient if applicable.
format: uri
workspaceId:
type: string
BTCompanySummaryInfo:
type: object
properties:
admin:
type: boolean
description:
type: string
domainPrefix:
type: string
enterpriseBaseUrl:
type: string
enterpriseSubtype:
type: integer
format: int32
href:
type: string
description: URI to fetch complete information of the resource.
format: uri
id:
type: string
description: Id of the resource.
image:
type: string
name:
type: string
description: Name of the resource.
noPublicDocuments:
type: boolean
ownerId:
type: string
secondaryDomainPrefixes:
uniqueItems: true
type: array
items:
type: string
state:
type: integer
format: int32
type:
type: integer
format: int32
viewRef:
type: string
description: URI to visualize the resource in a webclient if applicable.
format: uri
BTListResponseBTCommentInfo:
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/BTCommentInfo'
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.
BTBaseInfo:
type: object
properties:
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.
viewRef:
type: string
description: URI to visualize the resource in a webclient if applicable.
format: uri
CoordinatesParams:
type: object
properties:
x:
type: number
format: float
y:
type: number
format: float
z:
type: number
format: float
CoordinatesInfo:
type: object
properties:
x:
type: number
format: float
y:
type: number
format: float
z:
type: number
format: float
BTCommentAttachmentInfo:
type: object
properties:
fileName:
type: string
href:
type: string
description: URI to fetch complete information of the resource.
format: uri
id:
type: string
description: Id of the resource.
mimeType:
type: string
name:
type: string
description: Name of the resource.
thumbnailFor:
type: string
viewRef:
type: string
description: URI to visualize the resource in a webclient if applicable.
format: uri
BTCommentParams:
type: object
properties:
annotationId:
type: string
annotationType:
type: integer
format: int32
appEntity:
type: string
assemblyFeature:
type: string
assignee:
type: string
description: Assign the comment during creation. Comments cannot be reassigned during an update at this time.
calloutInstanceId:
type: string
coordinates:
$ref: '#/components/schemas/CoordinatesParams'
dimensionConstraintId:
type: string
dimensionFeatureId:
type: string
dimensionParameterId:
type: string
dimensionPartQuery:
type: string
documentId:
type: string
elementFeature:
type: string
elementId:
type: string
elementOccurrence:
type: string
elementQuery:
type: string
id:
type: string
message:
type: string
objectId:
type: string
objectType:
type: integer
format: int32
parentId:
type: string
versionId:
type: string
viewData:
$ref: '#/components/schemas/BTViewDataParams'
workspaceId:
type: string
BTBFileUpload:
type: object
properties:
file:
type: string
description: The file to upload.
format: binary
BTViewDataInfo:
type: object
properties:
angle:
type: number
format: double
cameraViewport:
type: array
items:
type: number
format: double
isPerspective:
type: boolean
viewMatrix:
type: array
items:
type: number
format: double
BTUserDetailSummaryInfo:
type: object
discriminator:
propertyName: jsonType
mapping:
user-detail-summary: '#/components/schemas/BTUserDetailSummaryInfo'
user-summary: '#/components/schemas/BTUserSummaryInfo'
allOf:
- $ref: '#/components/schemas/BTUserBasicSummaryInfo'
- type: object
properties:
documentationName:
type: string
email:
type: string
firstName:
type: string
lastName:
type: string
GlobalPermissionInfo:
type: object
properties:
accessReports:
type: boolean
adminEnterprise:
type: boolean
allowAppStoreAccess:
type: boolean
allowPublicDocumentsAccess:
type: boolean
approveReleases:
type: boolean
branchLockPermissions:
type: boolean
createDocumentsInRoot:
type: boolean
createProject:
type: boolean
createReleases:
type: boolean
createTasks:
type: boolean
deletePermanently:
type: boolean
enableLabs:
type: boolean
exportFiles:
type: boolean
importFiles:
type: boolean
manageGuestUsers:
type: boolean
manageNonGeometricItems:
type: boolean
manageRbac:
type: boolean
manageStandardContentMetadata:
type: boolean
manageUsers:
type: boolean
manageWorkflows:
type: boolean
shareForAnonymousAccess:
type: boolean
transferDocumentsFromEnterprise:
type: boolean
useRevisionTools:
type: boolean
BTViewDataParams:
type: object
properties:
angle:
type: number
format: double
cameraViewport:
type: array
items:
type: number
format: double
isPerspective:
type: boolean
viewMatrix:
type: array
items:
type: number
format: double
BTUserSummaryInfo:
type: object
discriminator:
propertyName: jsonType
mapping:
user-summary: '#/components/schemas/BTUserSummaryInfo'
companyuser: '#/components/schemas/BTCompanyUserSummaryInfo'
BTUserAdminSummaryInfo: '#/components/schemas/BTUserAdminSummaryInfo'
userinfo: '#/components/schemas/BTUserInfo'
BTUserOAuth2SummaryInfo: '#/components/schemas/BTUserOAuth2SummaryInfo'
allOf:
- $ref: '#/components/schemas/BTUserDetailSummaryInfo'
- type: object
properties:
company:
$ref: '#/components/schemas/BTCompanySummaryInfo'
companyUserState:
type: integer
format: int32
confirmationRequested:
type: boolean
documentationNameOverride:
type: string
globalPermissions:
$ref: '#/components/schemas/GlobalPermissionInfo'
invitationState:
type: integer
format: int32
isExternal:
type: boolean
isGuest:
type: boolean
isLight:
type: boolean
lastLoginTime:
type: string
format: date-time
personalMessageAllowed:
type: boolean
source:
type: integer
format: int32
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