Onshape Task API
Create, access, and modify Tasks and Action Items.
Create, access, and modify Tasks and Action Items.
openapi: 3.0.1
info:
title: Onshape REST Account Task 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: Task
description: Create, access, and modify Tasks and Action Items.
paths:
/tasks:
get:
tags:
- Task
summary: Lists tasks assigned to the specified user
description: Returns a list of tasks assigneed to the userId specified in the request. Only company admins can view tasks that were not created by them and are not assigned to them.
operationId: getActionItems
parameters:
- name: userId
in: query
schema:
type: string
- name: status
in: query
schema:
type: integer
format: int32
default: 2
- name: role
in: query
schema:
type: integer
format: int32
default: 1
- name: order
in: query
schema:
type: integer
format: int32
default: 1
- name: type
in: query
schema:
type: array
items:
type: string
- name: documentId
in: query
schema:
type: string
- name: offset
in: query
schema:
minimum: 0
type: integer
format: int32
default: 0
- name: limit
in: query
schema:
maximum: 100
minimum: 1
type: integer
format: int32
default: 50
responses:
default:
description: default response
content:
application/json;charset=UTF-8; qs=0.09:
schema:
$ref: '#/components/schemas/BTTaskListResponse'
deprecated: false
security:
- OAuth2:
- OAuth2Read
BasicAuth:
- OAuth2Read
x-BTVisibility: PRODUCTION
post:
tags:
- Task
summary: Create a new task in a draft state.
operationId: createTask
requestBody:
content:
application/json;charset=UTF-8; qs=0.09:
schema:
$ref: '#/components/schemas/BTCreateTaskParams'
required: true
responses:
default:
description: default response
content:
application/json;charset=UTF-8; qs=0.09:
schema:
$ref: '#/components/schemas/BTTaskInfo'
deprecated: false
security:
- OAuth2:
- OAuth2Write
BasicAuth:
- OAuth2Write
x-BTVisibility: PRODUCTION
/tasks/{tid}:
get:
tags:
- Task
summary: Get a task by id.
operationId: getTask
parameters:
- name: tid
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/BTTaskInfo'
deprecated: false
security:
- OAuth2:
- OAuth2Read
BasicAuth:
- OAuth2Read
x-BTVisibility: PRODUCTION
post:
tags:
- Task
summary: Update the task and its properties.
operationId: updateTask
parameters:
- name: tid
in: path
required: true
schema:
type: string
requestBody:
content:
application/json;charset=UTF-8; qs=0.09:
schema:
$ref: '#/components/schemas/BTUpdateTaskParams'
required: true
responses:
default:
description: default response
content:
application/json;charset=UTF-8; qs=0.09:
schema:
$ref: '#/components/schemas/BTTaskInfo'
deprecated: false
security:
- OAuth2:
- OAuth2Write
BasicAuth:
- OAuth2Write
x-BTVisibility: PRODUCTION
/tasks/{tid}/{transition}:
post:
tags:
- Task
summary: Execute a workflow transition.
operationId: transitionTask
parameters:
- name: tid
in: path
required: true
schema:
type: string
- name: transition
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/BTTaskInfo'
deprecated: false
security:
- OAuth2:
- OAuth2Write
BasicAuth:
- OAuth2Write
x-BTVisibility: PRODUCTION
components:
schemas:
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
BTThumbnailSizeInfo:
type: object
properties:
href:
type: string
format: uri
mediaType:
type: string
renderMode:
type: string
sheetName:
type: string
size:
type: string
uniqueId:
type: string
viewOrientation:
type: string
BTTaskItemInfo:
type: object
properties:
assemblyFeatures:
type: array
items:
type: string
bodyType:
type: string
configuration:
type: string
dataType:
type: string
documentId:
type: string
elementFeature:
type: string
elementId:
type: string
elementOccurrences:
type: array
items:
type: string
elementQuery:
type: string
elementType:
type: integer
format: int32
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.
partId:
type: string
releaseState:
type: integer
format: int32
revisionId:
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
BTTaskTypeInfo:
type: object
properties:
displayName:
type: string
id:
type: string
name:
type: string
CoordinatesInfo:
type: object
properties:
x:
type: number
format: float
y:
type: number
format: float
z:
type: number
format: float
BTWorkflowableObjectInfo:
type: object
properties:
companyId:
type: string
createdAt:
type: string
format: date-time
createdBy:
$ref: '#/components/schemas/BTUserBasicSummaryInfo'
description:
type: string
documentId:
type: string
href:
type: string
description: URI to fetch complete information of the resource.
format: uri
id:
type: string
description: Id of the resource.
modifiedAt:
type: string
format: date-time
modifiedBy:
$ref: '#/components/schemas/BTUserBasicSummaryInfo'
name:
type: string
description: Name of the resource.
properties:
type: array
items:
$ref: '#/components/schemas/BTWorkflowPropertyInfo'
viewRef:
type: string
description: URI to visualize the resource in a webclient if applicable.
format: uri
workflow:
$ref: '#/components/schemas/BTWorkflowSnapshotInfo'
workflowError:
type: string
writeOnly: true
workflowId:
$ref: '#/components/schemas/BTPublishedWorkflowId'
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
BTTaskItemParams:
type: object
properties:
bodyType:
type: string
description: Body type to reference from a task.
configuration:
type: string
description: Configuration of reference. Used to restrict a reference to a specific configuration of an element.
description:
type: string
description: Description of the reference.
documentId:
type: string
description: Id of a document. Required to reference a document or anything contained within it.
elementId:
type: string
description: Id of an element reference. Used when referencing an element.
elementType:
type: integer
description: Type of element reference. Options are 0 (Part Studio), 1 (Assembly), 2 (Drawing), 3 (Feature Studio), 4 (Blob), 5 (Application), 6 (Table), 7 (Bill of Materials), 8 (Variable Studio), or 9 (Publication Item).
format: int32
mimeType:
type: string
description: Mimetype of reference. Used when referencing blob elements.
name:
type: string
description: Name of the reference.
partId:
type: string
description: Deterministic Id of a part. Used when referencing parts.
revisionId:
type: string
description: Id of a revision to reference from a task.
versionId:
type: string
description: Id of a document version. Used when referencing the version itself or an element or part in it.
workspaceId:
type: string
description: Id of a document workspace. Used when referencing the workspace itself or an element or part in it.
description: References to add to the task.
x-BTVisibility-properties:
viewData: INTERNAL
dataType: INTERNAL
elementFeature: INTERNAL
id: INTERNAL
assemblyFeature: INTERNAL
elementQuery: INTERNAL
elementOccurrence: INTERNAL
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
BTUpdateTaskParams:
type: object
properties:
companyId:
type: string
description: Use to transfer task ownership to the company.
deleteItemIds:
uniqueItems: true
type: array
description: References to remove from the task.
items:
type: string
description: References to remove from the task.
descriptionParamValue:
type: string
itemParams:
type: array
description: References to add to the task.
items:
$ref: '#/components/schemas/BTTaskItemParams'
nameParamValue:
type: string
propertyValues:
type: array
description: Task metadata properties.
items:
$ref: '#/components/schemas/BTPropertyValueParam'
workflowId:
type: string
BTMetadataPropertyUiHintsInfo:
type: object
properties:
multiline:
type: boolean
BTTaskListResponse:
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/BTTaskInfo'
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
taskTypes:
type: array
items:
$ref: '#/components/schemas/BTTaskTypeInfo'
BTMetadataPropertyValidatorInfo:
type: object
properties:
max:
type: number
maxCount:
type: integer
format: int32
maxDate:
type: string
format: date-time
maxLength:
type: integer
format: int32
min:
type: number
minCount:
type: integer
format: int32
minDate:
type: string
format: date-time
minLength:
type: integer
format: int32
pattern:
type: string
quantityType:
type: integer
format: int32
BTPublishedWorkflowId:
type: object
properties:
companyId:
type: string
versionId:
type: string
workflowId:
type: string
BTMetadataPropertyInfo:
type: object
properties:
aggregationSkippedFilteredOutValues:
type: boolean
computedAssemblyProperty:
type: boolean
computedProperty:
type: boolean
computedPropertyError:
type: string
computedPropertyEvalInfo:
type: string
dateFormat:
type: string
defaultValue:
type: object
dirty:
type: boolean
editable:
type: boolean
editableInUi:
type: boolean
enumValues:
type: array
items:
$ref: '#/components/schemas/BTMetadataEnumValueInfo'
initialValue:
type: object
multivalued:
type: boolean
name:
type: string
propertyId:
type: string
propertyOverrideStatus:
type: integer
description: '0: Unknown | 1: Not computed | 2: Computed without override | 3: Computed with override | 4: Computed with subassembly overrides | 5: Overridden'
format: int32
propertySource:
type: integer
format: int32
publicPartOverridable:
type: boolean
required:
type: boolean
schemaId:
type: string
uiHints:
$ref: '#/components/schemas/BTMetadataPropertyUiHintsInfo'
validator:
$ref: '#/components/schemas/BTMetadataPropertyValidatorInfo'
value:
type: object
valueType:
type: string
BTWorkflowStateInfo:
type: object
properties:
approverSourceProperty:
type: string
displayName:
type: string
editPermissions:
uniqueItems: true
type: array
items:
type: string
editableProperties:
uniqueItems: true
type: array
items:
type: string
name:
type: string
nonEditableProperties:
uniqueItems: true
type: array
items:
type: string
notifierSourceProperty:
type: string
requiredItemProperties:
uniqueItems: true
type: array
items:
type: string
requiredProperties:
uniqueItems: true
type: array
items:
type: string
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
BTThumbnailInfo:
type: object
properties:
href:
type: string
format: uri
id:
type: string
secondarySizes:
type: array
items:
type: array
items:
$ref: '#/components/schemas/BTThumbnailSizeInfo'
sizes:
type: array
items:
$ref: '#/components/schemas/BTThumbnailSizeInfo'
BTTaskUserSummaryInfo:
type: object
properties:
acted:
type: boolean
company:
$ref: '#/components/schemas/BTCompanySummaryInfo'
companyUserState:
type: integer
format: int32
confirmationRequested:
type: boolean
documentationName:
type: string
documentationNameOverride:
type: string
email:
type: string
firstName:
type: string
globalPermissions:
$ref: '#/components/schemas/GlobalPermissionInfo'
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
invitationState:
type: integer
format: int32
isExternal:
type: boolean
isGuest:
type: boolean
isLight:
type: boolean
isOnshapeSupport:
type: boolean
lastLoginTime:
type: string
format: date-time
lastName:
type: string
name:
type: string
description: Name of the resource.
personalMessageAllowed:
type: boolean
source:
type: integer
format: int32
state:
type: integer
format: int32
viewRef:
type: string
description: URI to visualize the resource in a webclient if applicable.
format: uri
BTWorkflowableObjectObserver:
type: object
properties:
adminOverride:
type: boolean
approvalDate:
type: string
format: date-time
approvalState:
$ref: '#/components/schemas/BTWorkflowObserverState'
approverId:
type: string
approverName:
type: string
associatedStates:
type: string
companyId:
type: string
createdAt:
type: string
format: date-time
createdBy:
type: string
creatorOverride:
type: boolean
description:
type: string
entryId:
type: string
entryType:
$ref: '#/components/schemas/BTWorkflowObserverEntryType'
id:
type: string
isExternal:
type: boolean
modifiedAt:
type: string
format: date-time
modifiedBy:
type: string
name:
type: string
new:
type: boolean
objectId:
type: string
observationType:
type: integer
format: int32
propertyId:
type: string
rejectionDate:
type: string
format: date-time
removable:
type: boolean
BTPublishedWorkflowInfo:
type: object
properties:
activeState:
type: integer
format: int32
companyId:
type: string
description:
type: string
documentId:
type: string
elementId:
type: string
id:
type: string
imageSrc:
type: string
isPickable:
type: boolean
json:
type: string
name:
type: string
objectType:
type: integer
format: int32
ownerType:
type: integer
format: int32
publishedDate:
type: string
description: The date of publication of workflow
format: date-time
usesExternalPlm:
type: boolean
description: Whether the workflow connects to an external PLM service like Arena
versionId:
type: string
description: Captures information about a published workflow
BTWorkflowObserverState:
type: string
enum:
- NONE
- APPROVED
- REJECTED
- OVERRIDDEN
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
BTPropertyValueParam:
type: object
properties:
propertyId:
type: string
description: Id of the property to set.
value:
type: object
description: 'Value to set for the property. User property values must be a list of `{ "id": "idValue" }` maps.'
BTWorkflowSnapshotInfo:
type: object
properties:
actions:
type: array
items:
$ref: '#/components/schemas/BTWorkflowActionInfo'
approverIds:
type: array
items:
type: string
canBeDiscarded:
type: boolean
currentStateDisplayName:
type: string
debugMicroversionId:
type: string
errorMessage:
type: string
isCreator:
type: boolean
isDiscarded:
type: boolean
isFrozen:
type: boolean
isSetup:
type: boolean
metadataState:
type: string
notifierIds:
type: array
items:
type: string
state:
$ref: '#/components/schemas/BTWorkflowStateInfo'
usesExternalPlm:
type: boolean
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
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
BTOwnerInfo:
type: object
properties:
href:
type: string
description: URI to fetch complete information of the resource.
format: uri
id:
type: string
description: Id
# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/onshape/refs/heads/main/openapi/onshape-task-api-openapi.yml