Onshape AppAssociativeData API

openapi: 3.0.1
info:
  title: Onshape REST Account AppAssociativeData 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: AppAssociativeData
  description: Manage the application-specific metadata that associates application data with Onshape data.
paths:
  /appelements/d/{did}/w/{wid}/e/{eid}/copyassociativedata:
    post:
      tags:
      - AppAssociativeData
      summary: Copy associative data from one view to another.
      description: You can manage associativity with [translateIds](https://cad.onshape.com/glassworks/explorer/#/PartStudio/translateIds).
      operationId: copyAssociativeData
      parameters:
      - name: did
        in: path
        required: true
        schema:
          type: string
      - name: wid
        in: path
        required: true
        schema:
          type: string
      - name: eid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json;charset=UTF-8; qs=0.09:
            schema:
              $ref: '#/components/schemas/BTAppElementParamsArrayBTCopyViewAssociativeDataParams'
      responses:
        default:
          description: default response
          content:
            application/json;charset=UTF-8; qs=0.09:
              schema:
                $ref: '#/components/schemas/BTAppAssociativeDataArrayInfo'
      deprecated: false
      security:
      - OAuth2:
        - OAuth2Write
        BasicAuth:
        - OAuth2Write
      x-BTVisibility: PRODUCTION
  /appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/associativedata:
    get:
      tags:
      - AppAssociativeData
      summary: Get the associative data for the specified app element.
      description: You can manage associativity with [translateIds](https://cad.onshape.com/glassworks/explorer/#/PartStudio/translateIds).
      operationId: getAssociativeData
      parameters:
      - name: did
        in: path
        description: The id of the document in which to perform the operation.
        required: true
        schema:
          type: string
      - name: linkDocumentId
        in: query
        description: The id of the document through which the above document should be accessed; only applicable when accessing a version of the document. This allows a user who has access to document a to see data from document b, as long as document b has been linked to document a by a user who has permission to both.
        schema:
          type: string
          default: ''
      - name: wvm
        in: path
        description: Indicates which of workspace (w), version (v), or document microversion (m) id is specified below.
        required: true
        schema:
          type: string
          enum:
          - w
          - v
          - m
      - name: wvmid
        in: path
        description: The id of the workspace, version or document microversion in which the operation should be performed.
        required: true
        schema:
          type: string
      - name: eid
        in: path
        description: The id of the element in which to perform the operation.
        required: true
        schema:
          type: string
      - name: transactionId
        in: query
        schema:
          type: string
          default: ''
      - name: changeId
        in: query
        schema:
          type: string
          default: ''
      - name: associativeDataId
        in: query
        schema:
          type: array
          items:
            type: string
      - name: externalDocumentId
        in: query
        schema:
          type: string
          default: ''
      - name: elementId
        in: query
        schema:
          type: string
          default: ''
      - name: viewId
        in: query
        schema:
          type: string
          default: ''
      - name: microversionId
        in: query
        schema:
          type: string
          default: ''
      - name: documentMicroversion
        in: query
        schema:
          type: string
          default: ''
      - name: deterministicId
        in: query
        schema:
          type: string
          default: ''
      - name: featureId
        in: query
        schema:
          type: string
          default: ''
      - name: entityId
        in: query
        schema:
          type: string
          default: ''
      - name: occurrenceId
        in: query
        schema:
          type: string
          default: ''
      - name: returnIdTags
        in: query
        schema:
          type: boolean
          default: false
      - name: referenceId
        in: query
        schema:
          type: string
          default: ''
      responses:
        default:
          description: default response
          content:
            application/json;charset=UTF-8; qs=0.09:
              schema:
                $ref: '#/components/schemas/BTAppAssociativeDataArrayInfo'
      deprecated: false
      security:
      - OAuth2:
        - OAuth2Read
        BasicAuth:
        - OAuth2Read
      x-BTVisibility: PRODUCTION
    post:
      tags:
      - AppAssociativeData
      summary: Set the associative data for the specified app element.
      description: You can manage associativity with [translateIds](https://cad.onshape.com/glassworks/explorer/#/PartStudio/translateIds).
      operationId: postAssociativeData
      parameters:
      - name: did
        in: path
        required: true
        schema:
          type: string
      - name: eid
        in: path
        required: true
        schema:
          type: string
      - name: wvm
        in: path
        required: true
        schema:
          type: string
      - name: wvmid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json;charset=UTF-8; qs=0.09:
            schema:
              type: string
        required: true
      responses:
        default:
          description: default response
          content:
            application/json;charset=UTF-8; qs=0.09:
              schema:
                $ref: '#/components/schemas/BTAppAssociativeDataArrayInfo'
      deprecated: false
      security:
      - OAuth2:
        - OAuth2Read
        - OAuth2Write
        BasicAuth:
        - OAuth2Read
        - OAuth2Write
      x-BTVisibility: PRODUCTION
    delete:
      tags:
      - AppAssociativeData
      summary: Delete the associative data from the specified app element.
      description: You can manage associativity with [translateIds](https://cad.onshape.com/glassworks/explorer/#/PartStudio/translateIds).
      operationId: deleteAssociativeData
      parameters:
      - name: did
        in: path
        required: true
        schema:
          type: string
      - name: eid
        in: path
        required: true
        schema:
          type: string
      - name: wvm
        in: path
        required: true
        schema:
          type: string
      - name: wvmid
        in: path
        required: true
        schema:
          type: string
      - name: transactionId
        in: query
        schema:
          type: string
          default: ''
      - name: parentChangeId
        in: query
        schema:
          type: string
          default: ''
      - name: associativeDataId
        in: query
        schema:
          type: array
          items:
            type: string
      - name: externalDocumentId
        in: query
        schema:
          type: string
          default: ''
      - name: elementId
        in: query
        schema:
          type: string
          default: ''
      - name: viewId
        in: query
        schema:
          type: string
          default: ''
      - name: microversionId
        in: query
        schema:
          type: string
          default: ''
      - name: documentMicroversion
        in: query
        schema:
          type: string
          default: ''
      - name: deterministicId
        in: query
        schema:
          type: string
          default: ''
      - name: featureId
        in: query
        schema:
          type: string
          default: ''
      - name: entityId
        in: query
        schema:
          type: string
          default: ''
      - name: occurrenceId
        in: query
        schema:
          type: string
          default: ''
      - name: referenceId
        in: query
        schema:
          type: string
          default: ''
      responses:
        default:
          description: default response
          content:
            application/json;charset=UTF-8; qs=0.09:
              schema:
                $ref: '#/components/schemas/BTAppElementBasicInfo'
      deprecated: false
      security:
      - OAuth2:
        - OAuth2Write
        BasicAuth:
        - OAuth2Write
      x-BTVisibility: PRODUCTION
components:
  schemas:
    BTNameValuePair:
      type: object
      properties:
        name:
          type: string
        value:
          type: string
    BTCopyViewAssociativeDataParams:
      type: object
      properties:
        associativeDataIds:
          type: array
          items:
            type: string
        destinationViewId:
          type: string
        sourceDocumentId:
          type: string
        sourceElementId:
          type: string
        sourceViewId:
          type: string
        sourceWvm:
          type: string
        sourceWvmId:
          type: string
    BTAppElementBasicInfo:
      type: object
      properties:
        changeId:
          type: string
        errorCode:
          type: integer
          description: '`0: OK (healthy) | 1: INFO | 2: WARNING | 3: ERROR (dangling or view generation call failed) | 4: UNKNOWN`'
          format: int32
        errorDescription:
          type: string
          description: A human-readable value for the error that occurred, if one occurred.
        errorValue:
          $ref: '#/components/schemas/BTAppElementErrorCode'
        parentChangeId:
          type: string
    BTAppElementErrorCode:
      type: string
      enum:
      - OK
      - TRANSACTION_CONFLICT
      - NOT_FOUND
      - INCONSISTENT_CHANGES
    BTAssociativeDataInfo:
      type: object
      properties:
        associativeDataId:
          type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/BTNameValuePair'
        documentId:
          type: string
        documentMicroversion:
          type: string
        elementId:
          type: string
        error:
          type: string
        idTag:
          type: string
        microversionId:
          type: string
        occurrenceId:
          type: string
        type:
          $ref: '#/components/schemas/GBTAppElementAssociativeDataType'
        versionId:
          type: string
    BTAppAssociativeDataArrayInfo:
      type: object
      properties:
        changeId:
          type: string
        errorCode:
          type: integer
          description: '`0: OK (healthy) | 1: INFO | 2: WARNING | 3: ERROR (dangling or view generation call failed) | 4: UNKNOWN`'
          format: int32
        errorDescription:
          type: string
          description: A human-readable value for the error that occurred, if one occurred.
        errorValue:
          $ref: '#/components/schemas/BTAppElementErrorCode'
        items:
          type: array
          items:
            $ref: '#/components/schemas/BTAssociativeDataInfo'
        parentChangeId:
          type: string
    GBTAppElementAssociativeDataType:
      type: string
      enum:
      - ONSHAPE_DRAWING_VIEW
      - MODEL_TOPOLOGY
      - MODEL_DEFINITION_FEATURE
      - MODEL_DEFINITION_ENTITY
      - UNKNOWN
    BTAppElementParamsArrayBTCopyViewAssociativeDataParams:
      type: object
      properties:
        description:
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/BTCopyViewAssociativeDataParams'
        parentChangeId:
          type: string
        transactionId:
          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