h1. Onshape REST API The Onshape REST API consumed by all clients. *Version:* 1.93 ---- {toc:printable=true|style=square|minLevel=2|maxLevel=3|type=list|outline=false|include=.*} h2. Endpoints h3. cancelPurchaseNew {status:colour=Yellow|title=delete|subtle=false} {code} delete /api/accounts/{aid}/purchases/{pid} {code} *Summary:* Cancel Recurring Subscription *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |aid | |(/) |null | | |pid | |(/) |null | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |cancelImmediately | |(x) |false | | h4. Responses *Status Code:* 0 *Message:* default response {code:title=Response Type} {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "default response", "content" : { "application/vnd.onshape.v1+json;charset=UTF-8; qs=0.1" : { }, "application/json;charset=UTF-8; qs=0.9" : { } } } {code} ---- h3. consumePurchase {status:colour=Yellow|title=post|subtle=false} {code} post /api/accounts/purchases/{pid}/consume {code} *Summary:* Mark Purchase Consumed For User *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |pid | |(/) |null | | h5. Body Parameter ||Name||Description||Required||Default||Pattern|| |bTPurchaseUserParams | |(x) | | | h4. Responses *Status Code:* 0 *Message:* default response {code:title=Response Type} BTPurchaseInfo {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "default response", "content" : { "application/vnd.onshape.v1+json;charset=UTF-8; qs=0.1" : { "schema" : { "$ref" : "#/components/schemas/BTPurchaseInfo" } }, "application/json;charset=UTF-8; qs=0.9" : { "schema" : { "$ref" : "#/components/schemas/BTPurchaseInfo" } } } } {code} ---- h3. getPlanPurchases {status:colour=Yellow|title=get|subtle=false} {code} get /api/accounts/plans/{planId}/purchases {code} *Summary:* Get Plan Purchases *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |planId | |(/) |null | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |offset | |(x) |0 | | |limit | |(x) |20 | | h4. Responses *Status Code:* 0 *Message:* default response {code:title=Response Type} BTListResponseBTPurchaseInfo {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "default response", "content" : { "application/vnd.onshape.v1+json;charset=UTF-8; qs=0.1" : { "schema" : { "$ref" : "#/components/schemas/BTListResponseBTPurchaseInfo" } }, "application/json;charset=UTF-8; qs=0.9" : { "schema" : { "$ref" : "#/components/schemas/BTListResponseBTPurchaseInfo" } } } } {code} ---- h3. getPurchases {status:colour=Yellow|title=get|subtle=false} {code} get /api/accounts/purchases {code} *Summary:* Get User's Appstore Purchases. *Description:* h4. Parameters h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |all | |(x) |false | | |ownPurchaseOnly | |(x) |false | | h4. Responses *Status Code:* 0 *Message:* default response {code:title=Response Type} array[BTPurchaseInfo] {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "default response", "content" : { "application/vnd.onshape.v1+json;charset=UTF-8; qs=0.1" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BTPurchaseInfo" } } }, "application/json;charset=UTF-8; qs=0.9" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BTPurchaseInfo" } } } } } {code} ---- h3. commitTransaction {status:colour=Yellow|title=post|subtle=false} {code} post /api/appelements/d/{did}/w/{wid}/e/{eid}/transactions/{tid} {code} *Summary:* Commit Transaction *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did | |(/) |null | | |eid | |(/) |null | | |wid | |(/) |null | | |tid | |(/) |null | | h5. Body Parameter ||Name||Description||Required||Default||Pattern|| |bTAppElementCommitTransactionParams | |(/) | | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTAppElementModifyInfo {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BTAppElementModifyInfo" } } } } {code} ---- h3. create7 {status:colour=Yellow|title=post|subtle=false} {code} post /api/appelements/d/{did}/w/{wid} {code} *Summary:* Create Element. *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did | |(/) |null | | |wid | |(/) |null | | h5. Body Parameter ||Name||Description||Required||Default||Pattern|| |bTAppElementParams | |(/) | | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTAppElementModifyInfo {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BTAppElementModifyInfo" } } } } {code} ---- h3. createReference1 {status:colour=Yellow|title=post|subtle=false} {code} post /api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/references {code} *Summary:* Create Reference *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did | |(/) |null | | |eid | |(/) |null | | |wvm | |(/) |null | | |wvmid | |(/) |null | | h5. Body Parameter ||Name||Description||Required||Default||Pattern|| |bTAppElementReferenceParams | |(/) | | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTAppElementReferenceInfo {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BTAppElementReferenceInfo" } } } } {code} ---- h3. deleteContent1 {status:colour=Yellow|title=delete|subtle=false} {code} delete /api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/subelements/{sid} {code} *Summary:* Delete a Sub-element *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did | |(/) |null | | |eid | |(/) |null | | |wvm | |(/) |null | | |wvmid | |(/) |null | | |sid | |(/) |null | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |transactionId | |(x) |null | | |parentChangeId | |(x) |null | | |description | |(x) |null | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTAppElementModifyInfo {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BTAppElementModifyInfo" } } } } {code} ---- h3. deleteReference1 {status:colour=Yellow|title=delete|subtle=false} {code} delete /api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/references/{rid} {code} *Summary:* Delete Reference *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did | |(/) |null | | |eid | |(/) |null | | |wvm | |(/) |null | | |wvmid | |(/) |null | | |rid | |(/) |null | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |transactionId | |(x) |null | | |parentChangeId | |(x) |null | | |description | |(x) |null | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTAppElementReferenceInfo {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BTAppElementReferenceInfo" } } } } {code} ---- h3. getHistory {status:colour=Yellow|title=get|subtle=false} {code} get /api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/history {code} *Summary:* Get History *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did | |(/) |null | | |eid | |(/) |null | | |wvm | |(/) |null | | |wvmid | |(/) |null | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTAppElementHistoryInfo {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BTAppElementHistoryInfo" } } } } {code} ---- h3. getSubElementContent {status:colour=Yellow|title=get|subtle=false} {code} get /api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content {code} *Summary:* Get Content *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did | |(/) |null | | |eid | |(/) |null | | |wvm | |(/) |null | | |wvmid | |(/) |null | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |transactionId | |(x) |null | | |changeId | |(x) |null | | |baseChangeId | |(x) |null | | |subelementId | |(x) |null | | |linkDocumentId | |(x) |null | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTAppElementContentInfo {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BTAppElementContentInfo" } } } } {code} ---- h3. getSubelementIds {status:colour=Yellow|title=get|subtle=false} {code} get /api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content/ids {code} *Summary:* Get Sub-element IDs *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did | |(/) |null | | |eid | |(/) |null | | |wvm | |(/) |null | | |wvmid | |(/) |null | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |transactionId | |(x) |null | | |changeId | |(x) |null | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTAppElementModifyInfo {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BTAppElementModifyInfo" } } } } {code} ---- h3. resolveReference1 {status:colour=Yellow|title=get|subtle=false} {code} get /api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/references/{rid} {code} *Summary:* Resolve Reference *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did | |(/) |null | | |eid | |(/) |null | | |wvm | |(/) |null | | |wvmid | |(/) |null | | |rid | |(/) |null | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |transactionId | |(x) |null | | |parentChangeId | |(x) |null | | |includeInternal | |(x) |false | | |linkDocumentId | |(x) |null | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTAppElementReferenceResolveInfo {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BTAppElementReferenceResolveInfo" } } } } {code} ---- h3. startTransaction {status:colour=Yellow|title=post|subtle=false} {code} post /api/appelements/d/{did}/w/{wid}/e/{eid}/transactions {code} *Summary:* Start Transaction *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did | |(/) |null | | |eid | |(/) |null | | |wid | |(/) |null | | h5. Body Parameter ||Name||Description||Required||Default||Pattern|| |bTAppElementStartTransactionParams | |(/) | | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTAppElementModifyInfo {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BTAppElementModifyInfo" } } } } {code} ---- h3. update5 {status:colour=Yellow|title=post|subtle=false} {code} post /api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/content {code} *Summary:* Update Element *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did | |(/) |null | | |eid | |(/) |null | | |wvm | |(/) |null | | |wvmid | |(/) |null | | h5. Body Parameter ||Name||Description||Required||Default||Pattern|| |bTAppElementUpdateParams | |(/) | | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTAppElementModifyInfo {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BTAppElementModifyInfo" } } } } {code} ---- h3. updateReference1 {status:colour=Yellow|title=post|subtle=false} {code} post /api/appelements/d/{did}/{wvm}/{wvmid}/e/{eid}/references/{rid} {code} *Summary:* Update Reference *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did | |(/) |null | | |eid | |(/) |null | | |wvm | |(/) |null | | |wvmid | |(/) |null | | |rid | |(/) |null | | h5. Body Parameter ||Name||Description||Required||Default||Pattern|| |bTAppElementReferenceParams | |(/) | | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTAppElementReferenceInfo {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BTAppElementReferenceInfo" } } } } {code} ---- h3. addFeature1 {status:colour=Yellow|title=post|subtle=false} {code} post /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/features {code} *Summary:* Add Feature *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did |Document ID. |(/) |null | | |wvm |One of w or v or m corresponding to whether a workspace or version or microversion was entered. |(/) |null | | |wvmid |Workspace (w), Version (v) or Microversion (m) ID. |(/) |null | | |eid |Element ID. |(/) |null | | h5. Body Parameter ||Name||Description||Required||Default||Pattern|| |body |feature The serialized feature definition |(x) | | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTFeatureDefinitionResponse {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/vnd.onshape.v2+json;charset=UTF-8; qs=0.2" : { "schema" : { "$ref" : "#/components/schemas/BTFeatureDefinitionResponse" } } } } {code} ---- h3. createPartStudio {status:colour=Yellow|title=post|subtle=false} {code} post /api/partstudios/d/{did}/w/{wid} {code} *Summary:* Create Part Studio *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did |Document ID. |(/) |null | | |wid |Workspace ID. |(/) |null | | h5. Body Parameter ||Name||Description||Required||Default||Pattern|| |bTModelElementParams | |(/) | | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTDocumentElementInfo {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/vnd.onshape.v1+json;charset=UTF-8; qs=0.1" : { "schema" : { "$ref" : "#/components/schemas/BTDocumentElementInfo" } }, "application/json;charset=UTF-8; qs=0.9" : { "schema" : { "$ref" : "#/components/schemas/BTDocumentElementInfo" } } } } {code} ---- h3. exportPS1 {status:colour=Yellow|title=get|subtle=false} {code} get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/parasolid {code} *Summary:* Export Part Studio to Parasolid *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did |Document ID. |(/) |null | | |wvm |One of w or v or m corresponding to whether a workspace or version or microversion was entered. |(/) |null | | |wvmid |Workspace (w), Version (v) or Microversion (m) ID. |(/) |null | | |eid |Element ID. |(/) |null | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |partIds |IDs of the parts to retrieve. Repeat query param to add more than one, i.e. partId=JHK&partId=JHD). May not be combined with other ID filters |(x) |null | | |version |Parasolid version |(x) |0 | | |includeExportIds |Whether topolgy ids should be exported as parasolid attributes |(x) |false | | |configuration |Configuration string. |(x) |null | | |linkDocumentId |Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter. |(x) |null | | h4. Responses *Status Code:* 307 *Message:* A Redirect! {code:title=Response Type} {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "A Redirect!" } {code} ---- h3. exportStl1 {status:colour=Yellow|title=get|subtle=false} {code} get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/stl {code} *Summary:* Export Part Studio to STL *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did |Document ID. |(/) |null | | |wvm |One of w or v or m corresponding to whether a workspace or version or microversion was entered. |(/) |null | | |wvmid |Workspace (w), Version (v) or Microversion (m) ID. |(/) |null | | |eid |Element ID. |(/) |null | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |partIds |IDs of the parts to retrieve. Repeat query param to add more than one, i.e. partId=JHK&partId=JHD). May not be combined with other ID filters |(x) |null | | |mode |Type of file: text, binary |(x) |text | | |grouping |Whether parts should be exported as a group or individually in a .zip file |(x) |true | | |scale |Scale for measurements. |(x) |1.0 | | |units |Name of base unit (meter, centimeter, millimeter, inch, foot, or yard) |(x) |inch | | |angleTolerance |Angle tolerance (in radians). This specifies the limit on the sum of the angular deviations of a tessellation chord from the tangent vectors at two chord endpoints. The specified value must be less than PI/2. This parameter currently has a default value chosen based on the complexity of the parts being tessellated. |(x) |null | | |chordTolerance |Chord tolerance (in meters). This specifies the limit on the maximum deviation of a tessellation chord from the true surface/edge. This parameter currently has a default value chosen based on the size and complexity of the parts being tessellated. |(x) |null | | |maxFacetWidth |Max facet width. This specifies the limit on the size of any side of a tessellation facet. |(x) |null | | |minFacetWidth |Max facet width. This specifies the limit on the size of any side of a tessellation facet. |(x) |null | | |configuration |Configuration string. |(x) |null | | |linkDocumentId |Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter. |(x) |null | | h4. Responses *Status Code:* 307 *Message:* A Redirect! {code:title=Response Type} {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "A Redirect!" } {code} ---- h3. getBodyDetails2 {status:colour=Yellow|title=get|subtle=false} {code} get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/bodydetails {code} *Summary:* Array of body information *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did |Document ID. |(/) |null | | |wvm |One of w or v or m corresponding to whether a workspace or version or microversion was entered. |(/) |null | | |wvmid |Workspace (w), Version (v) or Microversion (m) ID. |(/) |null | | |eid |Element ID. |(/) |null | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |configuration |Configuration string. |(x) |null | | |linkDocumentId |Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter. |(x) |null | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} array[BTExportModelBodiesResponse] {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/vnd.onshape.v1+json;charset=UTF-8; qs=0.1" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BTExportModelBodiesResponse" } } }, "application/json;charset=UTF-8; qs=0.9" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BTExportModelBodiesResponse" } } } } } {code} ---- h3. getBoundingBoxes2 {status:colour=Yellow|title=get|subtle=false} {code} get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/boundingboxes {code} *Summary:* Mass properties of parts or a PartStudio. *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did |Document ID. |(/) |null | | |wvm |One of w or v or m corresponding to whether a workspace or version or microversion was entered. |(/) |null | | |wvmid |Workspace (w), Version (v) or Microversion (m) ID. |(/) |null | | |eid |Element ID. |(/) |null | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |includeHidden |Whether or not to include bounding boxes for hidden parts. |(x) |false | | |includeWireBodies |Whether to include wire bodies in the bounding box. |(x) |true | | |configuration |Configuration string. |(x) |null | | |linkDocumentId |Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter. |(x) |null | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTBoundingBox {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/vnd.onshape.v1+json;charset=UTF-8; qs=0.1" : { "schema" : { "$ref" : "#/components/schemas/BTBoundingBox" } }, "application/json;charset=UTF-8; qs=0.9" : { "schema" : { "$ref" : "#/components/schemas/BTBoundingBox" } } } } {code} ---- h3. getEdges2 {status:colour=Yellow|title=get|subtle=false} {code} get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/tessellatededges {code} *Summary:* Tesselated edges from a PartStudio. *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did | |(/) |null | | |wvm | |(/) |null | | |wvmid | |(/) |null | | |eid | |(/) |null | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |angleTolerance | |(x) |null | | |chordTolerance | |(x) |null | | |partId | |(x) |null | | |edgeId | |(x) |null | | |configuration | |(x) |null | | |linkDocumentId | |(x) |null | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTExportTessellatedEdgesResponse {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BTExportTessellatedEdgesResponse" } } } } {code} ---- h3. getFaces2 {status:colour=Yellow|title=get|subtle=false} {code} get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/tessellatedfaces {code} *Summary:* Tesselated faces of the parts in the Part Studio. *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did |Document ID. |(/) |null | | |wvm |One of w or v or m corresponding to whether a workspace or version or microversion was entered. |(/) |null | | |wvmid |Workspace (w), Version (v) or Microversion (m) ID. |(/) |null | | |eid |Element ID. |(/) |null | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |angleTolerance |Angle tolerance (in radians). This specifies the limit on the sum of the angular deviations of a tessellation chord from the tangent vectors at two chord endpoints. The specified value must be less than PI/2. This parameter currently has a default value chosen based on the complexity of the parts being tessellated. |(x) |null | | |chordTolerance |Chord tolerance (in meters). This specifies the limit on the maximum deviation of a tessellation chord from the true surface/edge. This parameter currently has a default value chosen based on the size and complexity of the parts being tessellated. |(x) |null | | |maxFacetWidth |Max facet width. This specifies the limit on the size of any side of a tessellation facet. |(x) |null | | |outputVertexNormals |If true, output vertex normals corresponding to surface normals at facet vertex points. |(x) |false | | |outputFacetNormals |Output facet normals. |(x) |true | | |outputTextureCoordinates |Output texture coordinates. |(x) |false | | |outputIndexTable |Output index table. |(x) |false | | |partId |IDs of the parts to retrieve. Repeat query param to add more than one, i.e. partId=JHK&partId=JHD). May not be combined with other ID filters |(x) |null | | |faceId |IDs of the faces to tessellate (repeat query param to add more than one, i.e. faceId=JHK&faceId=JHD) |(x) |null | | |outputErrorFaces |Whether or not to output faces that cause an error |(x) |false | | |configuration |Configuration string. |(x) |null | | |linkDocumentId |Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter. |(x) |null | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTExportTessellatedFacesResponse {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BTExportTessellatedFacesResponse" } } } } {code} ---- h3. getFeatures {status:colour=Yellow|title=get|subtle=false} {code} get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/features {code} *Summary:* Get Feature List *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did |Document ID. |(/) |null | | |wvm |One of w or v or m corresponding to whether a workspace or version or microversion was entered. |(/) |null | | |wvmid |Workspace (w), Version (v) or Microversion (m) ID. |(/) |null | | |eid |Element ID. |(/) |null | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |featureId |ID of a feature; repeat query param to add more than one |(x) |null | | |linkDocumentId |Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter. |(x) |null | | |noSketchGeometry |Whether or not to output simple sketch info without geometry |(x) |false | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTFeatureListResponse {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/vnd.onshape.v2+json;charset=UTF-8; qs=0.2" : { "schema" : { "$ref" : "#/components/schemas/BTFeatureListResponse" } } } } {code} ---- h3. getMassProperties {status:colour=Yellow|title=get|subtle=false} {code} get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/massproperties {code} *Summary:* Mass properties of parts or a PartStudio. *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did |Document ID. |(/) |null | | |wvm |One of w or v or m corresponding to whether a workspace or version or microversion was entered. |(/) |null | | |wvmid |Workspace (w), Version (v) or Microversion (m) ID. |(/) |null | | |eid |Element ID. |(/) |null | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |partId |IDs of the parts to retrieve. Repeat query param to add more than one, i.e. partId=JHK&partId=JHD). May not be combined with other ID filters |(x) |null | | |massAsGroup |If true, specified parts will be evaluated as a single object instead of individually |(x) |true | | |configuration |Configuration string. |(x) |null | | |linkDocumentId |Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter. |(x) |null | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTMassPropResponse {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/vnd.onshape.v1+json;charset=UTF-8; qs=0.1" : { "schema" : { "$ref" : "#/components/schemas/BTMassPropResponse" } }, "application/json;charset=UTF-8; qs=0.9" : { "schema" : { "$ref" : "#/components/schemas/BTMassPropResponse" } } } } {code} ---- h3. getNamedViews2 {status:colour=Yellow|title=get|subtle=false} {code} get /api/partstudios/d/{did}/e/{eid}/namedViews {code} *Summary:* Get Named Views *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did |Document ID. |(/) |null | | |eid |Element ID. |(/) |null | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |skipPerspective |Whether views with a perspective projection should be omitted. |(x) |true | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTNamedViewsInfo {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/vnd.onshape.v1+json;charset=UTF-8; qs=0.1" : { "schema" : { "$ref" : "#/components/schemas/BTNamedViewsInfo" } }, "application/json;charset=UTF-8; qs=0.9" : { "schema" : { "$ref" : "#/components/schemas/BTNamedViewsInfo" } } } } {code} ---- h3. getOpenApi {status:colour=Yellow|title=get|subtle=false} {code} get /api/openapi {code} *Summary:* OpenAPI spec documentation for the Onshape REST API. *Description:* h4. Parameters h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |fileType |The type of file to return. Defaults to JSON. |(x) |json | | |excludedTags |If an operation contains an excluded tag, it is not returned from this endpoint. |(x) |null | | |includedTags |Return at most all the operations with tags included in includedTags. If not given, this will default to all tags. |(x) |null | | |documentationStatus |Only return endpoints that have the specified document status. Default is to return all the keys the user should have access to. |(x) |null | | h4. Responses *Status Code:* 200 *Message:* voila! {code:title=Response Type} OpenAPI {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "voila!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OpenAPI" } } } } {code} ---- h3. getShadedViews1 {status:colour=Yellow|title=get|subtle=false} {code} get /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/shadedviews {code} *Summary:* Get Shaded Views *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did |Document ID. |(/) |null | | |wvm |One of w or v or m corresponding to whether a workspace or version or microversion was entered. |(/) |null | | |wvmid |Workspace (w), Version (v) or Microversion (m) ID. |(/) |null | | |eid |Element ID. |(/) |null | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |viewMatrix |12-number view matrix (comma-separated), or one of the following named views: top, bottom, front, back, left, right The 12 entries in the view matrix form three rows and four columns, which is a linear transformation applied to the model itself. The matrix's first three columns maps the coordinate axes of the model to the coordinate axes of the view, and the fourth column translates the origin (in meters). The view coordinates have x pointing right, y pointing up, and z pointing towards the viewer, while a front view of the model has x pointing right, y pointing away from the viewer, and z pointing up. For example, the identity matrix viewMatrix=1,0,0,0,0,1,0,0,0,0,1,0 corresponds to the top view, and viewMatrix=0.612,0.612,0,0,-0.354,0.354,0.707,0,0.707,-0.707,0.707,0 corresponds (approximately) to the isometric view. The first three columns of the view matrix should be orthonormal and have a positive determinant. If this is not the case, view behavior may be undefined. |(x) |front | | |outputHeight |Output image height (in pixels) |(x) |500 | | |outputWidth |Output image width (in pixels) |(x) |500 | | |pixelSize |Height and width represented by each pixel (in meters). If the value is 0, the display will be sized to fit the output image dimensions. |(x) |0.003 | | |edges |The treatment to be applied to edges in the display. Options are show: show visible edges, hide: hide visible edges. |(x) |show | | |showAllParts |Whether or not all parts should be shown in the element, regardless of user setting. If false, the visibility setting made by the user will be reflected in the image. If true, all parts will be shown. |(x) |false | | |includeSurfaces |Whether or not surfaces should be shown in the element. It is applicable only when showAllParts is true. If false, surfaces will be excluded. If true, all surfaces will be shown. |(x) |false | | |useAntiAliasing |If true, an anti-aliasing factor will be used to smooth model boundaries in the final image result. If false, the image will be rasterized at the given resolution. Setting to true can have negative performance implications with respect to rendering time and memory usage. If a high-resolution image is requested and anti-aliasing is turned on, the server may not be able to fulfill the request. |(x) |false | | |configuration |Configuration string. |(x) |null | | |linkDocumentId |Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter. |(x) |null | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTShadedRenderDocumentResponse {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/vnd.onshape.v1+json;charset=UTF-8; qs=0.1" : { "schema" : { "$ref" : "#/components/schemas/BTShadedRenderDocumentResponse" } }, "application/json;charset=UTF-8; qs=0.9" : { "schema" : { "$ref" : "#/components/schemas/BTShadedRenderDocumentResponse" } } } } {code} ---- h3. getTranslatorFormats4 {status:colour=Yellow|title=get|subtle=false} {code} get /api/partstudios/d/{did}/w/{wid}/e/{eid}/translationformats {code} *Summary:* Get Translation Formats *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did |Document ID. |(/) |null | | |wid |Workspace ID. |(/) |null | | |eid |Element ID. |(/) |null | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |checkContent | Whether the current content or lack thereof should be considered when determining the available formats. Empty part studios cannot be translated into any format. |(x) |true | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} array[BTModelFormatInfo] {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/vnd.onshape.v1+json;charset=UTF-8; qs=0.1" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BTModelFormatInfo" } } }, "application/json;charset=UTF-8; qs=0.9" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BTModelFormatInfo" } } } } } {code} ---- h3. translateFormat5 {status:colour=Yellow|title=post|subtle=false} {code} post /api/partstudios/d/{did}/{wv}/{wvid}/e/{eid}/translations {code} *Summary:* Create Part Studio translation *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did |Document ID. |(/) |null | | |wv |One of w or v corresponding to whether a workspace or version was entered. |(/) |null | | |wvid |Workspace (w) or Version (v). |(/) |null | | |eid |Element ID. |(/) |null | | h5. Body Parameter ||Name||Description||Required||Default||Pattern|| |bTTranslateFormatParams | |(/) | | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTTranslationRequestInfo {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/vnd.onshape.v1+json;charset=UTF-8; qs=0.1" : { "schema" : { "$ref" : "#/components/schemas/BTTranslationRequestInfo" } }, "application/json;charset=UTF-8; qs=0.9" : { "schema" : { "$ref" : "#/components/schemas/BTTranslationRequestInfo" } } } } {code} ---- h3. translateIds1 {status:colour=Yellow|title=post|subtle=false} {code} post /api/partstudios/d/{did}/{wvm}/{wvmid}/e/{eid}/idtranslations {code} *Summary:* Id Translations *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did |Document ID. |(/) |null | | |wvm |One of w or v or m corresponding to whether a workspace or version or microversion was entered. |(/) |null | | |wvmid |Workspace (w), Version (v) or Microversion (m) ID. |(/) |null | | |eid |Element ID. |(/) |null | | h5. Body Parameter ||Name||Description||Required||Default||Pattern|| |bTIdTranslationParams | |(/) | | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTIdTranslationInfo {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/vnd.onshape.v1+json;charset=UTF-8; qs=0.1" : { "schema" : { "$ref" : "#/components/schemas/BTIdTranslationInfo" } }, "application/json;charset=UTF-8; qs=0.9" : { "schema" : { "$ref" : "#/components/schemas/BTIdTranslationInfo" } } } } {code} ---- h3. getDocuments {status:colour=Yellow|title=get|subtle=false} {code} get /api/documents {code} *Summary:* Get Documents *Description:* h4. Parameters h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |q | |(x) |null | | |filter | |(x) |null | | |owner | |(x) |null | | |ownerType | |(x) |1 | | |sortColumn | |(x) |createdAt | | |sortOrder | |(x) |desc | | |offset | |(x) |0 | | |limit | |(x) |20 | | |label | |(x) |null | | |project | |(x) |null | | |parentId | |(x) |null | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} BTGlobalTreeNodeListResponse {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BTGlobalTreeNodeListResponse" } } } } {code} ---- h3. getEndpoints {status:colour=Yellow|title=get|subtle=false} {code} get /api/endpoints {code} *Summary:* *Description:* h4. Parameters h4. Responses *Status Code:* 0 *Message:* default response {code:title=Response Type} {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "default response", "content" : { "application/vnd.onshape.v1+json;charset=UTF-8; qs=0.1" : { }, "application/json;charset=UTF-8; qs=0.9" : { } } } {code} ---- h3. getPartsWMV {status:colour=Yellow|title=get|subtle=false} {code} get /api/parts/d/{did}/{wvm}/{wvmid} {code} *Summary:* Get list of parts *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did |Document ID. |(/) |null | | |wvm |One of w or v or m corresponding to whether a workspace or version or microversion was entered. |(/) |null | | |wvmid |Workspace (w), Version (v) or Microversion (m) ID. |(/) |null | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |elementId |Element ID |(x) |null | | |withThumbnails |Whether or not to include thumbnails (not supported for microversion) |(x) |false | | |includePropertyDefaults |If true, include metadata schema property defaults in response |(x) |false | | |linkDocumentId |Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter. |(x) |null | | |configuration |Configuration string. |(x) |null | | h4. Responses *Status Code:* 200 *Message:* Success! {code:title=Response Type} array[BTPartMetadataInfo] {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "Success!", "content" : { "application/vnd.onshape.v1+json;charset=UTF-8; qs=0.1" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BTPartMetadataInfo" } } }, "application/json;charset=UTF-8; qs=0.9" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BTPartMetadataInfo" } } } } } {code} ---- h3. updatePartsWMV {status:colour=Yellow|title=post|subtle=false} {code} post /api/parts/d/{did}/{wvm}/{wvmid} {code} *Summary:* Part metadata batch update. *Description:* h4. Parameters h5. Path Parameters ||Name||Description||Required||Default||Pattern|| |did |Document ID. |(/) |null | | |wvm |One of w or v or m corresponding to whether a workspace or version or microversion was entered. |(/) |null | | |wvmid |Workspace (w), Version (v) or Microversion (m) ID. |(/) |null | | h5. Body Parameter ||Name||Description||Required||Default||Pattern|| |body | |(x) | | | h5. Query Parameters ||Name||Description||Required||Default||Pattern|| |editDescription |Description of the update (as appear in document history) |(x) |null | | h4. Responses *Status Code:* 0 *Message:* default response {code:title=Response Type} {code} See [#models] {code:title=Response Schema |collapse=true} { "description" : "default response", "content" : { "application/vnd.onshape.v1+json;charset=UTF-8; qs=0.1" : { }, "application/json;charset=UTF-8; qs=0.9" : { } } } {code} ---- h2. Models h3. Address ||Field Name||Required||Type||Description|| |city | |String | | |country | |String | | |line1 | |String | | |line2 | |String | | |postalCode | |String | | |state | |String | | h3. ApiResponse ||Field Name||Required||Type||Description|| |description | |String | | |headers | |map[String, Header] | | |content | |BodyPart_headers | | |links | |map[String, Link] | | |extensions | |map[String, Object] | | |getDollarref | |String | | h3. ApiResponses ||Field Name||Required||Type||Description|| |extensions | |map[String, Object] | | |default | |ApiResponse | | |empty | |Boolean | | h3. BTAPIApplicationDeprecateParams ||Field Name||Required||Type||Description|| |ownerEmailSubjectText | |String | | |ownerEmailMessageText | |String | | |userEmailSubjectText | |String | | |userEmailMessageText | |String | | h3. BTAPIApplicationParams ||Field Name||Required||Type||Description|| |hiddenFromPlusMenuUnderscore | |Boolean | | |name | |String | | |state | |Integer | | |description | |String | | |baseHref | |String | | |supportsCollaboration | |Boolean | | |developerId | |String | | |redirectURLs | |array[String] | | |primaryFormat | |String | | |uiSpec | |String | | |supportsMerge | |Boolean | | |adminTeamId | |String | | |hiddenFromPlusMenu | |Boolean | | |developerEmail | |String | | |internalGrantOnDemand | |Boolean | | |clientId | |String | | |scopeNames | |array[String] | | |storeEntryIsPublic | |Boolean | | h3. BTAPIApplicationSummaryInfo ||Field Name||Required||Type||Description|| |id | |String | | |state | |Integer | | |description | |String | | |clientId | |String | | |name | |String | | |href | |String | | |viewRef | |String | | h3. BTAPIDeveloperParams ||Field Name||Required||Type||Description|| |name | |String | | |website | |String | | |description | |String | | |userId | |String | | |companyId | |String | | h3. BTAPIKeyParams ||Field Name||Required||Type||Description|| |companyId | |String | | |scopeNames | |array[String] | | h3. BTAPIPartnerParams ||Field Name||Required||Type||Description|| |name | |String | | |website | |String | | |description | |String | | |userId | |String | | h3. BTAclParams ||Field Name||Required||Type||Description|| |public | |Boolean | | |documentId | |String | | |anonymousAccessAllowed | |Boolean | | |anonymousAllowsExport | |Boolean | | h3. BTActionInfo ||Field Name||Required||Type||Description|| |method | |String | | |tooltip | |String | | |isApproverAction | |Boolean | | |showIfApprovers | |Boolean | | |showIfNoApprovers | |Boolean | | |alwaysAllow | |Boolean | | |label | |String | | |action | |String | | |uiHint | |String | | |isAdminOverride | |Boolean | | h3. BTAddFriendParams ||Field Name||Required||Type||Description|| |email | |String | | h3. BTAddressInfo ||Field Name||Required||Type||Description|| |id | |String | | |state | |String | | |address | |String | | |zip | |String | | |country | |String | | |city | |String | | |stateCode | |String | | |countryCode | |String | | h3. BTAdminGroupParams ||Field Name||Required||Type||Description|| |userId | |String | | |groups | |array[String] | | h3. BTAdminRoleParams ||Field Name||Required||Type||Description|| |name | |String | | |permissions | |array[BTAdminRolePermissionParams] | | |id | |String | | |description | |String | | h3. BTAdminRolePermissionParams ||Field Name||Required||Type||Description|| |method | |String | | |resourcePath | |String | | |resourceLabel | |String | | |allowed | |Boolean | | h3. BTAdminTaskParams ||Field Name||Required||Type||Description|| |message | |String | | |taskName | |String | | |force | |Boolean | | |taskNames | |array[String] | | h3. BTAdminUserRoleParams ||Field Name||Required||Type||Description|| |userId | |String | | |roleIds | |array[String] | | h3. BTAgreementParams ||Field Name||Required||Type||Description|| |name | |String | | |content | |String | | |options | |array[String] | | |version | |Long | | |reapply | |Boolean | | h3. BTApiKeyUpdateParams ||Field Name||Required||Type||Description|| |state | |Integer | | |accessKey | |String | | h3. BTAppAssociativeDataParamsArray ||Field Name||Required||Type||Description|| |description | |String | | |items | |array[BTAssociativeDataParams] | | |transactionId | |String | | |parentChangeId | |String | | h3. BTAppElementChangeParams ||Field Name||Required||Type||Description|| |subelementId | |String | | |baseContent | |String | | |delta | |String | | h3. BTAppElementCommitTransactionParams ||Field Name||Required||Type||Description|| |description | |String | | |transactionId | |String | | |returnError | |Boolean | | h3. BTAppElementContentDeltaInfo ||Field Name||Required||Type||Description|| |delta | |String | | h3. BTAppElementContentEntryInfo ||Field Name||Required||Type||Description|| |subelementId | |String | | |baseContent | |String | | |deltas | |array[BTAppElementContentDeltaInfo] | | h3. BTAppElementContentInfo ||Field Name||Required||Type||Description|| |data | |array[BTAppElementContentEntryInfo] | | |changeId | |String | | |errorCode | |Integer | | |errorValue | |String | | |errorDescription | |String | | h3. BTAppElementHistoryEntryInfo ||Field Name||Required||Type||Description|| |description | |String | | |changeId | |String | | |createdAt | |Date | | h3. BTAppElementHistoryInfo ||Field Name||Required||Type||Description|| |changes | |array[BTAppElementHistoryEntryInfo] | | |errorCode | |Integer | | |errorValue | |String | | |errorDescription | |String | | h3. BTAppElementModifyInfo ||Field Name||Required||Type||Description|| |elementId | |String | | |changeId | |String | | |parentChangeId | |String | | |transactionId | |String | | |errorCode | |Integer | | |errorValue | |String | | |errorDescription | |String | | h3. BTAppElementParams ||Field Name||Required||Type||Description|| |name | |String | | |location | |BTElementLocationParams | | |description | |String | | |subelements | |array[BTAppElementChangeParams] | | |formatId | |String | | h3. BTAppElementReferenceInfo ||Field Name||Required||Type||Description|| |referenceId | |String | | |changeId | |String | | |parentChangeId | |String | | |transactionId | |String | | |errorCode | |Integer | | |errorValue | |String | | |errorDescription | |String | | h3. BTAppElementReferenceParams ||Field Name||Required||Type||Description|| |revision | |String | | |targetDocumentId | |String | | |targetElementId | |String | | |targetConfiguration | |String | | |isSketchOnly | |Boolean | | |transactionId | |String | | |parentChangeId | |String | | |sketchId | |String | | |sketchIds | |array[String] | | |idTag | |String | | |targetVersionId | |String | | |pureSketch | |Boolean | | |targetMicroversionId | |String | | |idTagMicroversionId | |String | | |hasDocumentMicroversions | |Boolean | | |partNumber | |String | | |returnError | |Boolean | | |trackNewVersions | |Boolean | | |updateSketchInfo | |Boolean | | h3. BTAppElementReferenceResolveInfo ||Field Name||Required||Type||Description|| |targetElementMicroversionId | |String | | |resolvedElementMicroversionId | |String | | |revision | |String | | |changeId | |String | | |targetDocumentId | |String | | |targetElementId | |String | | |targetConfiguration | |String | | |targetVersionId | |String | | |isSketchOnly | |Boolean | | |sketchIds | |array[String] | | |idTag | |String | | |partNumber | |String | | |referenceId | |String | | |targetDocumentMicroversionId | |String | | |isConfigurable | |Boolean | | |resolvedDocumentMicroversionId | |String | | |idTagIsValid | |Boolean | | |trackNewVersions | |Boolean | | |errorCode | |Integer | | |errorValue | |String | | |errorDescription | |String | | h3. BTAppElementStartTransactionParams ||Field Name||Required||Type||Description|| |parentChangeId | |String | | |returnError | |Boolean | | h3. BTAppElementUpdateParams ||Field Name||Required||Type||Description|| |description | |String | | |changes | |array[BTAppElementChangeParams] | | |transactionId | |String | | |parentChangeId | |String | | |returnError | |Boolean | | h3. BTAppViewParams ||Field Name||Required||Type||Description|| |parameters | |array[Double] | | |occurrenceOrPartIdToGeometryProperties | |map[String, map[String, String]] | | |displayStateId | |String | | |transactionId | |String | | |parentChangeId | |String | | |modelReferenceId | |String | | |viewMatrix | |array[Double] | | |viewDirection | |array[Double] | | |cutPoint | |array[Double] | | |offsetSectionPoints | |array[Double] | | |brokenOutSection | |Boolean | | |cropView | |Boolean | | |bomReferenceId | |String | | |includeHiddenInstances | |Boolean | | |viewScale | |Double | | |showTangentLines | |Boolean | | |computeIntersection | |Boolean | | |isBrokenOutSection | |Boolean | | |isCropView | |Boolean | | |hiddenLines | |String | | |modificationId | |String | | |perspective | |Boolean | | |projectionAngle | |String | | |showThreads | |Boolean | | |isPartialSection | |Boolean | | |brokenOutPointNumbers | |array[Integer] | | |brokenOutEndConditions | |map[String, BTBrokenOutEndCondition] | | |brokenOutBBoxes | |map[String, BTBoundingBox] | | |includeSurfaces | |Boolean | | |isSurface | |Boolean | | |depthSectionEndCondition | |BTBrokenOutEndCondition | | h3. BTApplicationElementThumbnailParams ||Field Name||Required||Type||Description|| |description | |String | | |isPrimary | |Boolean | | |base64EncodedImage | |String | | |uniqueId | |String | | |imageWidth | |Integer | | |imageHeight | |Integer | | h3. BTApplicationElementThumbnailParamsArray ||Field Name||Required||Type||Description|| |thumbnails | |array[BTApplicationElementThumbnailParams] | | h3. BTApproveTranslationDebugParams ||Field Name||Required||Type||Description|| |timestamp | |Long | | h3. BTAssemblyInstanceDefinitionParams ||Field Name||Required||Type||Description|| |isWholePartStudio | |Boolean | | |revision | |String | | |microversionId | |String | | |partId | |String | | |configuration | |String | | |versionId | |String | | |documentId | |String | | |elementId | |String | | |featureId | |String | | |partNumber | |String | | |isAssembly | |Boolean | | h3. BTAssemblyTransformDefinitionParams ||Field Name||Required||Type||Description|| |transform | |array[Double] | | |occurrences | |array[BTOccurrence] | | |isRelative | |Boolean | | h3. BTAssemblyTransformedInstancesDefinitionParams ||Field Name||Required||Type||Description|| |transformGroups | |array[TransformGroup] | | h3. BTAssociativeDataParams ||Field Name||Required||Type||Description|| |type | |String | | |data | |array[BTNameValuePair] | | |microversionId | |String | | |documentMicroversion | |String | | |associativeDataId | |String | | |operation | |String | | |viewId | |String | | |occurrenceId | |String | | |isHiddenBaseView | |Boolean | | |configuration | |String | | |versionId | |String | | |documentId | |String | | |workspaceId | |String | | |elementId | |String | | |idTag | |String | | h3. BTAssociativeFieldParams ||Field Name||Required||Type||Description|| |items | |array[String] | | h3. BTAutoPartNumberingSchemeParams ||Field Name||Required||Type||Description|| |schemeId | |String | | |assemblyPrefix | |String | | |drawingPrefix | |String | | |filePrefix | |String | | |partPrefix | |String | | |nextNumber | |Long | | |nextNumberMinWidth | |Integer | | h3. BTBaseInfo ||Field Name||Required||Type||Description|| |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTBelScriptLibraryVersion ||Field Name||Required||Type||Description|| |major | |Integer | | |minor | |Integer | | |valid | |Boolean | | |point | |Integer | | |versionNumber | |Integer | | h3. BTBetaCapabilityAdminInfo ||Field Name||Required||Type||Description|| |capabilityName | |String | | |approvalsPerHour | |Double | | |autoApprove | |Boolean | | |autoApprovePaid | |Boolean | | |autoApproveOnshape | |Boolean | | |selfServiceDisabled | |Boolean | | |userCount | |Integer | | |userLimit | |Integer | | |eula | |String | | |welcomeHTML | |String | | |userState | |Integer | | |description | |String | | |upgradable | |Boolean | | |userBased | |Boolean | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTBetaCapabilityImportInfo ||Field Name||Required||Type||Description|| |existing | |array[String] | | |failed | |array[String] | | |succeeded | |array[String] | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTBetaCapabilityInfo ||Field Name||Required||Type||Description|| |eula | |String | | |welcomeHTML | |String | | |userState | |Integer | | |description | |String | | |upgradable | |Boolean | | |userBased | |Boolean | | |selfServiceDisabled | |Boolean | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTBetaCapabilityMetricsInfo ||Field Name||Required||Type||Description|| |statePreApproved | |Long | | |stateRequested | |Long | | |stateApproved | |Long | | |stateRemoved | |Long | | |approvedPreApproved | |Long | | |approvedRequested | |Long | | |approvedPaid | |Long | | |approvedOnshape | |Long | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTBetaCapabilityParams ||Field Name||Required||Type||Description|| |name | |String | | |id | |String | | |description | |String | | |capability | |String | | |eula | |String | | |approvalsPerHour | |Double | | |autoApprove | |Boolean | | |autoApprovePaid | |Boolean | | |autoApproveOnshape | |Boolean | | |upgradable | |Boolean | | |userBased | |Boolean | | |selfServiceDisabled | |Boolean | | |userLimit | |Integer | | |welcomeHTML | |String | | h3. BTBetaCapabilitySummaryInfo ||Field Name||Required||Type||Description|| |userState | |Integer | | |description | |String | | |upgradable | |Boolean | | |userBased | |Boolean | | |selfServiceDisabled | |Boolean | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTBetaCapabilityUserInfo ||Field Name||Required||Type||Description|| |capabilityState | |Integer | | |createdAt | |Date | | |planId | |String | | |approvedAt | |Date | | |removedAt | |Date | | |source | |Integer | | |firstName | |String | | |lastName | |String | | |email | |String | | |isGuest | |Boolean | | |isLight | |Boolean | | |globalPermissions | |GlobalPermissionInfo | | |lastLoginTime | |Date | | |company | |BTCompanySummaryInfo | | |state | |Integer | | |image | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTBillingAccountParams ||Field Name||Required||Type||Description|| |address | |BTAddressInfo | | |forceCreate | |Boolean | | |password | |String | | |token | |String | | |companyPlan | |Boolean | | |userId | |String | | |companyId | |String | | |planId | |String | | |seats | |Long | | |domainPrefix | |String | | |paymentType | |Integer | | |trialPeriodDays | |Integer | | |promonthlyEnabled | |Boolean | | |resellerName | |String | | |companyName | |String | | h3. BTBillingAllowedPlansInfo ||Field Name||Required||Type||Description|| |currentPlan | |BTBillingPlanSummaryInfo | | |upgrades | |array[BTBillingPlanSummaryInfo] | | |downgrades | |array[BTBillingPlanSummaryInfo] | | h3. BTBillingPlanBatchParams ||Field Name||Required||Type||Description|| |plans | |array[BTBillingPlanParams] | | h3. BTBillingPlanInfo ||Field Name||Required||Type||Description|| |discountInfo | |BTDiscountInfo | | |group | |String | | |clientId | |String | | |trialPeriodDays | |Integer | | |hidden | |Boolean | | |onshapePlan | |Boolean | | |description | |String | | |companyPlan | |Boolean | | |interval | |String | | |consumableQuantity | |Integer | | |amountCents | |Integer | | |applicationId | |String | | |planType | |Integer | | |deprecated | |Boolean | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTBillingPlanParams ||Field Name||Required||Type||Description|| |name | |String | | |description | |String | | |group | |String | | |planId | |String | | |clientId | |String | | |interval | |String | | |consumableQuantity | |Integer | | |trialPeriodDays | |Integer | | |amountCents | |Integer | | |hidden | |Boolean | | |applicationId | |String | | |planType | |Integer | | h3. BTBillingPlanSummaryInfo ||Field Name||Required||Type||Description|| |hidden | |Boolean | | |onshapePlan | |Boolean | | |description | |String | | |companyPlan | |Boolean | | |interval | |String | | |consumableQuantity | |Integer | | |amountCents | |Integer | | |applicationId | |String | | |planType | |Integer | | |deprecated | |Boolean | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTBoundingBox ||Field Name||Required||Type||Description|| |valid | |Boolean | | |minCorner | |BTVector3d | | |maxCorner | |BTVector3d | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTBoundingBoxParams ||Field Name||Required||Type||Description|| |partQuery | |String | | |partId | |String | | |includeWireBodies | |Boolean | | |displayStateId | |String | | |elementMicroversionId | |String | | |includeHidden | |Boolean | | |documentId | |String | | |workspaceId | |String | | |elementId | |String | | |sketchId | |String | | h3. BTBrokenOutEndCondition ||Field Name||Required||Type||Description|| |uptoPoint3d | |BTVector3d | | |uptoPoint | |array[Double] | | |hasUptoPoint | |Boolean | | |hasOffset | |Boolean | | |offsetDistance | |Double | | |offsetOppositeDirection | |Boolean | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTBulkDocumentUpdateParams ||Field Name||Required||Type||Description|| |documentIds | |String | | |updateProperty | |String | | |skipUpgradeVersion | |Integer | | |skipUpgrade | |Boolean | | |upgradeMode | |String | | |upgradeVersion | |Integer | | h3. BTCacheInfo ||Field Name||Required||Type||Description|| |cacheStats | |map[String, map[String, String]] | | |cacheNames | |array[String] | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTCampaignParams ||Field Name||Required||Type||Description|| |terminated | |Boolean | | |campaignName | |String | | |messages | |array[Message] | | h3. BTCapabilityCheckParams ||Field Name||Required||Type||Description|| |capabilities | |array[String] | | h3. BTCapabilityParams ||Field Name||Required||Type||Description|| |name | |String | | |id | |String | | |type | |String | | |ruleId | |String | | h3. BTCapabilityRuleParams ||Field Name||Required||Type||Description|| |name | |String | | |id | |String | | |description | |String | | |script | |String | | h3. BTCapableInfo ||Field Name||Required||Type||Description|| |capable | |Boolean | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTCardInfo ||Field Name||Required||Type||Description|| |type | |String | | |billingAddress | |BTAddressInfo | | |last4 | |String | | |expMonth | |Integer | | |expYear | |Integer | | h3. BTCardParams ||Field Name||Required||Type||Description|| |address | |BTAddressInfo | | |token | |String | | h3. BTChangeContextParams ||Field Name||Required||Type||Description|| |contextPath | |array[String] | | |contextId | |String | | |description | |String | | h3. BTCloudStorageAccountInfo ||Field Name||Required||Type||Description|| |owner | |BTOwnerInfo | | |treeHref | |String | | |resourceType | |String | | |isMutable | |Boolean | | |isContainer | |Boolean | | |canMove | |Boolean | | |hasPendingOwner | |Boolean | | |description | |String | | |isEnterpriseOwned | |Boolean | | |modifiedAt | |Date | | |createdAt | |Date | | |createdBy | |BTUserBasicSummaryInfo | | |modifiedBy | |BTUserBasicSummaryInfo | | |projectId | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTCloudStorageAccountListInfo ||Field Name||Required||Type||Description|| |next | |String | | |items | |array[BTCloudStorageAccountInfo] | | |href | |String | | |previous | |String | | h3. BTCloudStorageObjectInfo ||Field Name||Required||Type||Description|| |modifiedById | |String | | |mimeType | |String | | |thumbnailInfo | |BTThumbnailInfo | | |cloudStorageProvider | |Integer | | |parentId | |String | | |cloudStorageAccountId | |String | | |cloudStorageObjectId | |String | | |sizeBytes | |Long | | |webViewLink | |String | | |iconLink | |String | | |createdById | |String | | |owner | |BTOwnerInfo | | |treeHref | |String | | |resourceType | |String | | |isMutable | |Boolean | | |isContainer | |Boolean | | |canMove | |Boolean | | |hasPendingOwner | |Boolean | | |description | |String | | |isEnterpriseOwned | |Boolean | | |modifiedAt | |Date | | |createdAt | |Date | | |createdBy | |BTUserBasicSummaryInfo | | |modifiedBy | |BTUserBasicSummaryInfo | | |projectId | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTCloudStorageObjectListInfo ||Field Name||Required||Type||Description|| |next | |String | | |items | |array[BTCloudStorageObjectInfo] | | |href | |String | | |pathToRoot | |array[CloudObjectPathSegment] | | h3. BTCloudStorageProviderObjectInfo ||Field Name||Required||Type||Description|| |cloudProviderId | |Integer | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTColorInfo ||Field Name||Required||Type||Description|| |blue | |Integer | | |green | |Integer | | |red | |Integer | | h3. BTColorParams ||Field Name||Required||Type||Description|| |red | |Integer | | |green | |Integer | | |blue | |Integer | | h3. BTCommentAttachmentInfo ||Field Name||Required||Type||Description|| |fileName | |String | | |mimeType | |String | | |thumbnailFor | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTCommentInfo ||Field Name||Required||Type||Description|| |message | |String | | |state | |Integer | | |elementOccurrences | |array[String] | | |assemblyFeatures | |array[String] | | |canResolveOrReopen | |Boolean | | |canDelete | |Boolean | | |workspaceId | |String | | |releasePackageId | |String | | |versionId | |String | | |documentId | |String | | |createdAt | |Date | | |elementId | |String | | |user | |BTUserSummaryInfo | | |parentId | |String | | |viewData | |BTViewDataInfo | | |elementQuery | |String | | |elementFeature | |String | | |assignee | |BTUserSummaryInfo | | |assignedAt | |Date | | |topLevel | |Boolean | | |reopenedBy | |BTUserSummaryInfo | | |reopenedAt | |Date | | |attachment | |BTCommentAttachmentInfo | | |resolvedBy | |BTUserSummaryInfo | | |resolvedAt | |Date | | |thumbnail | |BTCommentAttachmentInfo | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTCommentNotificationParams ||Field Name||Required||Type||Description|| |commentId | |String | | |action | |String | | h3. BTCommentParams ||Field Name||Required||Type||Description|| |message | |String | | |id | |String | | |versionId | |String | | |documentId | |String | | |workspaceId | |String | | |elementId | |String | | |parentId | |String | | |viewData | |BTViewDataParams | | |elementQuery | |String | | |elementFeature | |String | | |elementOccurrence | |String | | |assemblyFeature | |String | | |assignee | |String | | h3. BTCommentSubscriptionParams ||Field Name||Required||Type||Description|| |documentId | |String | | |subscribed | |Boolean | | h3. BTCompanyActivateParams ||Field Name||Required||Type||Description|| |userId | |String | | |planId | |String | | |seats | |Long | | |paymentType | |Integer | | h3. BTCompanyNoPublicDocumentParams ||Field Name||Required||Type||Description|| |noPublicDocuments | |Boolean | | h3. BTCompanyParams ||Field Name||Required||Type||Description|| |name | |String | | |id | |String | | |address | |BTAddressInfo | | |description | |String | | |domainPrefix | |String | | |ownerId | |String | | h3. BTCompanyPoliciesParams ||Field Name||Required||Type||Description|| |requireTotp | |Boolean | | |useLightUi | |Boolean | | |requireApprovedDrawingTemplates | |Boolean | | |approvedDrawingTemplatesDocumentId | |String | | |addCompanyOwnedLibrariesInUserAccount | |Boolean | | |releaseWorkflowId | |String | | |obsoletionWorkflowId | |String | | |revisionSchemeId | |String | | |requireRevisionForReleasedObjects | |Boolean | | |requirePartNumberForReleasedObjects | |Boolean | | |onlyAdminsCanEditPropertiesOfReleasedObjects | |Boolean | | |onlyAdminsCanDeleteDocumentsContainingReleasedObjects | |Boolean | | |onlyAdminsCanApproveReleases | |Boolean | | |requirePartsAndSubassembliesReleaseWithAssembly | |Boolean | | |requirePartsAndSubassembliesReleaseWithDrawing | |Boolean | | |requireBasePartReleaseWithDerivedPart | |Boolean | | |requireImageReleaseWithDrawing | |Boolean | | |actionShowDrawingsWatermark | |Boolean | | |errorOnFeatureListErrorsDuringRelease | |Boolean | | |errorOnRollbackBarNotAtEndDuringRelease | |Boolean | | |errorOnAssemblyTreeErrorsDuringRelease | |Boolean | | |errorOnPendingContextEditsDuringRelease | |Boolean | | |errorOnPendingDrawingUpdateDuringRelease | |Boolean | | |errorOnPendingDanglingDrawingObjectsDuringRelease | |Boolean | | |approverRequiredDuringRelease | |Boolean | | |noteRequiredDuringRelease | |Boolean | | |requireAllApprovers | |Boolean | | |automaticallyObsoletePreviousReleasedRevisions | |Boolean | | |partNumberingSchemeId | |String | | |requirePeerReview | |Boolean | | |drawingCanDuplicatePartNumber | |Boolean | | |onlyAdminsCanMarkObjectsAsNotRevisionManaged | |Boolean | | h3. BTCompanySummaryInfo ||Field Name||Required||Type||Description|| |state | |Integer | | |type | |Integer | | |enterpriseBaseUrl | |String | | |description | |String | | |ownerId | |String | | |domainPrefix | |String | | |admin | |Boolean | | |noPublicDocuments | |Boolean | | |image | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTCompanyTransferParams ||Field Name||Required||Type||Description|| |currentOwnerId | |String | | |newOwnerId | |String | | h3. BTCompanyUserParams ||Field Name||Required||Type||Description|| |email | |String | | |companyId | |String | | |admin | |Boolean | | |guest | |Boolean | | |light | |Boolean | | h3. BTComponentUsagesSummary ||Field Name||Required||Type||Description|| |hierarchyUnderscore | |BTStandardContentHierarchy | | |count | |Long | | |hierarchy | |BTStandardContentHierarchy | | h3. BTConfigurationIdInfo ||Field Name||Required||Type||Description|| |btdbConfigurationId | |String | | |thumbnailConfigurationId | |String | | h3. BTConfigurationInfo ||Field Name||Required||Type||Description|| |parameters | |array[ConfigurationInfoEntry] | | |isStandardContent | |Boolean | | h3. BTConfigurationParams ||Field Name||Required||Type||Description|| |parameters | |array[ConfigurationEntry] | | |standardContentParametersId | |String | | h3. BTConnection ||Field Name||Required||Type||Description|| h3. BTCopyDocumentParams ||Field Name||Required||Type||Description|| |ownerId | |String | | |projectId | |String | | |parentId | |String | | |betaCapabilityIds | |array[String] | | |ownerTypeIndex | |Integer | | |newName | |String | | |isPublic | |Boolean | | h3. BTCopyElementParams ||Field Name||Required||Type||Description|| |documentIdSource | |String | | |workspaceIdSource | |String | | |elementIdSource | |String | | |anchorElementId | |String | | |isGroupAnchor | |Boolean | | h3. BTCurveDescription ||Field Name||Required||Type||Description|| |type | |String | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTCustomPropertyDefinitionInfo ||Field Name||Required||Type||Description|| |name | |String | | |type | |String | | |description | |String | | |enumDefinition | |array[String] | | |template | |String | | h3. BTCustomPropertyDefinitionParams ||Field Name||Required||Type||Description|| |name | |String | | |type | |String | | |description | |String | | |enumDefinition | |array[String] | | |template | |String | | h3. BTDBViewerCollectionConfig ||Field Name||Required||Type||Description|| |collection | |String | | |db | |String | | |queryFields | |array[String] | | |hiddenFields | |array[String] | | |binaryFields | |array[String] | | |hasCreatedDate | |Boolean | | h3. BTDBViewerConfig ||Field Name||Required||Type||Description|| |id | |String | | |queryFieldLabels | |map[String, String] | | |collectionConfigs | |array[BTDBViewerCollectionConfig] | | |createdBy | |String | | |createdAt | |Date | | |modifiedBy | |String | | |modifiedAt | |Date | | |new | |Boolean | | h3. BTDBViewerQueryParams ||Field Name||Required||Type||Description|| |collection | |String | | |db | |String | | |fieldValues | |map[String, String] | | |fromDate | |Date | | |toDate | |Date | | h3. BTDeviceInfo ||Field Name||Required||Type||Description|| |description | |String | | |version | |BTUserAgentVersion | | |clientType | |String | | |deviceName | |String | | |operatingSystem | |String | | |deviceType | |String | | |browser | |String | | |manufacturer | |String | | |mobile | |Boolean | | h3. BTDeviceTokenParams ||Field Name||Required||Type||Description|| |token | |String | | h3. BTDiffInfo ||Field Name||Required||Type||Description|| |type | |String | | |targetId | |String | | |sourceValue | |String | | |targetValue | |String | | |sourceId | |String | | |changes | |map[String, BTDiffInfo] | | h3. BTDiscountInfo ||Field Name||Required||Type||Description|| |ownerId | |String | | |createdAt | |Date | | |planId | |String | | |createdBy | |BTUserSummaryInfo | | |percentOff | |Integer | | |amountOff | |Integer | | |couponType | |Integer | | |couponValidMonths | |Integer | | |expiresAt | |Date | | |usedAt | |Date | | |trialEndDate | |String | | |accountBalance | |Integer | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTDiscountParams ||Field Name||Required||Type||Description|| |planId | |String | | |percentOff | |Integer | | |amountOff | |Integer | | |couponType | |Integer | | |couponValidMonths | |Integer | | |expiresInDays | |Integer | | h3. BTDocumentCheckAccessParams ||Field Name||Required||Type||Description|| |userIds | |array[String] | | h3. BTDocumentElementInfo ||Field Name||Required||Type||Description|| |name | |String | | |id | |String | | |type | |String | | |microversionId | |String | | |dataType | |String | | |foreignDataId | |String | | |elementType | |String | | |thumbnails | |String | | |filename | |String | | |thumbnailInfo | |BTThumbnailInfo | | |lengthUnits | |String | | |angleUnits | |String | | |massUnits | |String | | h3. BTDocumentInfo ||Field Name||Required||Type||Description|| |owner | |BTOwnerInfo | | |treeHref | |String | | |resourceType | |String | | |isMutable | |Boolean | | |isContainer | |Boolean | | |canMove | |Boolean | | |hasPendingOwner | |Boolean | | |description | |String | | |isEnterpriseOwned | |Boolean | | |modifiedAt | |Date | | |createdAt | |Date | | |createdBy | |BTUserBasicSummaryInfo | | |modifiedBy | |BTUserBasicSummaryInfo | | |projectId | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTDocumentLabelInfo ||Field Name||Required||Type||Description|| |owner | |BTOwnerInfo | | |treeHref | |String | | |resourceType | |String | | |isMutable | |Boolean | | |isContainer | |Boolean | | |canMove | |Boolean | | |hasPendingOwner | |Boolean | | |description | |String | | |isEnterpriseOwned | |Boolean | | |modifiedAt | |Date | | |createdAt | |Date | | |createdBy | |BTUserBasicSummaryInfo | | |modifiedBy | |BTUserBasicSummaryInfo | | |projectId | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTDocumentLabelParams ||Field Name||Required||Type||Description|| |name | |String | | |documentIds | |array[String] | | |ownerId | |String | | |parentLabelId | |String | | h3. BTDocumentMicroversionInfo ||Field Name||Required||Type||Description|| |microversionId | |String | | |workspaceId | |String | | |elementType | |String | | |documentId | |String | | |currentConfiguration | |String | | h3. BTDocumentMigrateParams ||Field Name||Required||Type||Description|| |clusterId | |String | | |documentId | |String | | h3. BTDocumentOptionsParams ||Field Name||Required||Type||Description|| |cppServerMemory | |Integer | | |enableCppServerMemoryDiagnostics | |Boolean | | |skipRetrievalTest | |Boolean | | |extendedDisplayCheck | |Boolean | | |documentMemory | |Integer | | |cppServerLimit | |Integer | | |thumbnailCppServerLimit | |Integer | | |linkedCppServerLimit | |Integer | | |drawingServerMemory | |Integer | | |cppServerDefaultElementLimit | |Integer | | h3. BTDocumentParams ||Field Name||Required||Type||Description|| |name | |String | | |generateUnknownMessages | |Boolean | | |isEmptyContent | |Boolean | | |description | |String | | |tags | |array[String] | | |ownerType | |Integer | | |ownerId | |String | | |projectId | |String | | |parentId | |String | | |betaCapabilityIds | |array[String] | | |isPublic | |Boolean | | |notRevisionManaged | |Boolean | | |ownerEmail | |String | | h3. BTDocumentProcessingInfo ||Field Name||Required||Type||Description|| |owner | |BTOwnerInfo | | |treeHref | |String | | |resourceType | |String | | |isMutable | |Boolean | | |isContainer | |Boolean | | |canMove | |Boolean | | |hasPendingOwner | |Boolean | | |description | |String | | |isEnterpriseOwned | |Boolean | | |modifiedAt | |Date | | |createdAt | |Date | | |createdBy | |BTUserBasicSummaryInfo | | |modifiedBy | |BTUserBasicSummaryInfo | | |projectId | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTDocumentScope ||Field Name||Required||Type||Description|| |assertedElementType | |String | | |configuration | |String | | |versionId | |String | | |documentId | |String | | |workspaceId | |String | | |elementId | |String | | |documentMicroversionId | |String | | h3. BTDocumentSearchHitInfo ||Field Name||Required||Type||Description|| |name | |String | | |type | |String | | |documentId | |String | | |sourceMap | |map[String, Object] | | |highlightedFields | |map[String, array[String]] | | |hit | |BTESDocumentHit | | |versionOrWorkspaceName | |String | | |elementName | |String | | h3. BTDocumentSearchParams ||Field Name||Required||Type||Description|| |type | |String | | |rawQuery | |String | | |offset | |Integer | | |limit | |Integer | | |ownerId | |String | | |parentId | |String | | |documentFilter | |Integer | | |sortColumn | |String | | |sortOrder | |String | | |foundIn | |String | | |when | |String | | h3. BTDocumentSummaryInfo ||Field Name||Required||Type||Description|| |owner | |BTOwnerInfo | | |treeHref | |String | | |resourceType | |String | | |isMutable | |Boolean | | |isContainer | |Boolean | | |canMove | |Boolean | | |hasPendingOwner | |Boolean | | |description | |String | | |isEnterpriseOwned | |Boolean | | |modifiedAt | |Date | | |createdAt | |Date | | |createdBy | |BTUserBasicSummaryInfo | | |modifiedBy | |BTUserBasicSummaryInfo | | |projectId | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTDocumentSummarySearchInfo ||Field Name||Required||Type||Description|| |owner | |BTOwnerInfo | | |treeHref | |String | | |resourceType | |String | | |isMutable | |Boolean | | |isContainer | |Boolean | | |canMove | |Boolean | | |hasPendingOwner | |Boolean | | |description | |String | | |isEnterpriseOwned | |Boolean | | |modifiedAt | |Date | | |createdAt | |Date | | |createdBy | |BTUserBasicSummaryInfo | | |modifiedBy | |BTUserBasicSummaryInfo | | |projectId | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTDocumentVersionElementIds ||Field Name||Required||Type||Description|| |versionId | |String | | |documentId | |String | | |elementId | |String | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTDocumentWithVersionAndElementId ||Field Name||Required||Type||Description|| |documentId | |String | | |documentVersionId | |String | | |elementId | |String | | |partNumber | |String | | |revision | |String | | |validRevisionReference | |Boolean | | |uniqueVersionId | |String | | h3. BTDocumentWithVersionId ||Field Name||Required||Type||Description|| |documentId | |String | | |documentVersionId | |String | | h3. BTDrawingParams ||Field Name||Required||Type||Description|| |location | |BTElementLocationParams | | |size | |String | | |language | |String | | |revision | |String | | |decimalSeparator | |String | | |partQuery | |String | | |partId | |String | | |elementMicroversionId | |String | | |units | |String | | |externalDocumentId | |String | | |externalDocumentVersionId | |String | | |elementConfiguration | |String | | |templateDocumentId | |String | | |templateWorkspaceId | |String | | |templateName | |String | | |templateArgs | |array[String] | | |templateElementId | |String | | |drawingName | |String | | |projection | |String | | |standard | |String | | |border | |Boolean | | |titleblock | |Boolean | | |numberHorizontalZones | |Integer | | |numberVerticalZones | |Integer | | |startZones | |String | | |isSketchOnly | |Boolean | | |documentId | |String | | |workspaceId | |String | | |elementId | |String | | |sketchId | |String | | |sketchIds | |array[String] | | |views | |String | | |computeIntersection | |Boolean | | |documentMicroversionId | |String | | |hiddenLines | |String | | |includeSurfaces | |Boolean | | |isSurface | |Boolean | | |pureSketch | |Boolean | | |partNumber | |String | | |templateVersionId | |String | | |modelType | |String | | h3. BTESDocumentHit ||Field Name||Required||Type||Description|| |name | |String | | |type | |String | | |documentId | |String | | |sourceMap | |map[String, Object] | | |highlightedFields | |map[String, array[String]] | | h3. BTElementLocationParams ||Field Name||Required||Type||Description|| |position | |Integer | | |groupId | |String | | |elementId | |String | | h3. BTElementParams ||Field Name||Required||Type||Description|| |location | |BTElementLocationParams | | |sourceDocumentId | |String | | |sourceWorkspaceId | |String | | |notifyUser | |Boolean | | |format | |String | | |filename | |String | | |documentId | |String | | |mediaType | |String | | |workspaceId | |String | | |elementId | |String | | |translateStoredFile | |Boolean | | |createDrawingIfPossible | |Boolean | | |isInitialUpload | |Boolean | | |foreignId | |String | | |uploadId | |String | | |projectId | |String | | |parentId | |String | | |updateExistingImportFeatures | |Boolean | | |blobMicroversionId | |String | | |originalForeignId | |String | | |blobElementId | |String | | |specifyUnits | |Boolean | | |splitAssembliesIntoMultipleDocuments | |Boolean | | |flattenAssemblies | |Boolean | | |getyAxisIsUp | |Boolean | | |allowFaultyParts | |Boolean | | |unit | |String | | h3. BTElementPropertiesParams ||Field Name||Required||Type||Description|| |properties | |map[String, String] | | |elementId | |String | | |apiConfiguration | |String | | h3. BTElementRenameParams ||Field Name||Required||Type||Description|| |name | |String | | |fromMetadataUpdate | |Boolean | | h3. BTElementThumbnailDataParams ||Field Name||Required||Type||Description|| |encodedBTDBConfigurationId | |String | | h3. BTEnterpriseReportParams ||Field Name||Required||Type||Description|| |name | |String | | |id | |String | | |description | |String | | |ownerId | |String | | |reportId | |String | | |reportName | |String | | |groupName | |String | | |publicReport | |Boolean | | h3. BTExportModelBodiesResponse ||Field Name||Required||Type||Description|| |errorEnum | |String | | |bodies | |array[BTExportModelBody] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTExportModelBody ||Field Name||Required||Type||Description|| |id | |String | | |type | |String | | |edges | |array[BTExportModelEdge] | | |faces | |array[BTExportModelFace] | | |vertices | |array[BTExportModelVertex] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTExportModelCoedge ||Field Name||Required||Type||Description|| |orientation | |Boolean | | |edgeId | |String | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTExportModelEdge ||Field Name||Required||Type||Description|| |id | |String | | |curve | |BTCurveDescription | | |vertices | |array[String] | | |geometry | |BTExportModelEdgeGeometry | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTExportModelEdgeGeometry ||Field Name||Required||Type||Description|| |length | |Double | | |endPoint | |BTVector3d | | |startPoint | |BTVector3d | | |midPoint | |BTVector3d | | |quarterPoint | |BTVector3d | | |startVector | |BTVector3d | | |endVector | |BTVector3d | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTExportModelFace ||Field Name||Required||Type||Description|| |id | |String | | |orientation | |Boolean | | |area | |Double | | |surface | |BTSurfaceDescription | | |loops | |array[BTExportModelLoop] | | |box | |BTBoundingBox | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTExportModelLoop ||Field Name||Required||Type||Description|| |isOuter | |Boolean | | |isInner | |Boolean | | |coedges | |array[BTExportModelCoedge] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTExportModelParams ||Field Name||Required||Type||Description|| |linkDocumentId | |String | | |linkDocumentWorkspaceId | |String | | |isPartingOut | |Boolean | | |includeBendCenterlines | |Boolean | | |batchFlatPatterns | |Boolean | | |splinesAsPolylines | |Boolean | | |workspaceId | |String | | |microversion | |String | | |configuration | |String | | |documentId | |String | | |elementId | |String | | |documentVersionId | |String | | |includeSketches | |Boolean | | |sheetMetalFlat | |Boolean | | |includeBendLines | |Boolean | | |flatten | |Boolean | | |grouping | |String | | |resolution | |String | | |zipSingleFileOutput | |Boolean | | |includeForeignData | |Boolean | | |deepSearchForForeignData | |Boolean | | |includeStd | |Boolean | | |includeReleaseManagementData | |Boolean | | |includeLinkedDocuments | |Boolean | | |extractToS3 | |Boolean | | |scale | |Double | | |mode | |String | | |elementIds | |String | | |userId | |String | | |partIds | |String | | |partQuery | |String | | |angleTolerance | |Double | | |chordTolerance | |Double | | |maxFacetWidth | |Double | | |version | |String | | |format | |String | | |units | |String | | |triggerAutoDownload | |Boolean | | |view | |String | | |storeInDocument | |Boolean | | |cloudStorageAccountId | |String | | |destinationName | |String | | |cloudObjectId | |String | | |minFacetWidth | |Double | | |includeExportIds | |Boolean | | |featureIds | |String | | h3. BTExportModelVertex ||Field Name||Required||Type||Description|| |id | |String | | |point | |BTVector3d | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTExportTessellatedEdgesBody ||Field Name||Required||Type||Description|| |id | |String | | |edges | |array[BTExportTessellatedEdgesEdge] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTExportTessellatedEdgesEdge ||Field Name||Required||Type||Description|| |id | |String | | |vertices | |array[BTVector3d] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTExportTessellatedEdgesResponse ||Field Name||Required||Type||Description|| |errorEnum | |String | | |bodies | |array[BTExportTessellatedEdgesBody] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTExportTessellatedFacesBody ||Field Name||Required||Type||Description|| |id | |String | | |faces | |array[BTExportTessellatedFacesFace] | | |bodyType | |String | | |appearance | |BTGraphicsAppearance | | |facetPoints | |array[BTVector3d] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTExportTessellatedFacesFace ||Field Name||Required||Type||Description|| |id | |String | | |errorMessage | |String | | |facets | |array[BTExportTessellatedFacesFacet] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTExportTessellatedFacesFacet ||Field Name||Required||Type||Description|| |normal | |BTVector3d | | |indices | |array[Integer] | | |vertices | |array[BTVector3d] | | |normals | |array[BTVector3d] | | |textureCoordinates | |array[BTVector2d] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTExportTessellatedFacesResponse ||Field Name||Required||Type||Description|| |bodies | |array[BTExportTessellatedFacesBody] |Array of information for each body. | |errorEnum | |String | | |facetPoints | |array[BTVector3d] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTExtendTrialParams ||Field Name||Required||Type||Description|| |userId | |String | | |extensionDays | |Integer | | h3. BTExternalElementReferenceInfo ||Field Name||Required||Type||Description|| |elementMicroversionId | |String | | |versionId | |String | | |documentId | |String | | |elementId | |String | | h3. BTFSValue ||Field Name||Required||Type||Description|| |valueObject | |Object | | |configurationValueString | |String | | |typeTag | |String | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTFeatureDefinitionResponse ||Field Name||Required||Type||Description|| |feature | |BTMFeature | | |featureState | |BTFeatureState | | |belScriptLibraryVersion | |BTBelScriptLibraryVersion | | |sourceMicroversion | |String | | |rejectMicroversionSkew | |Boolean | | |libraryVersion | |Integer | | |serializationVersion | |String | | |microversionSkew | |Boolean | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTFeatureListResponse ||Field Name||Required||Type||Description|| |features | |array[BTMFeature] | | |isComplete | |Boolean | | |featureStates | |map[String, BTFeatureState] | | |imports | |array[BTMImport] | | |defaultFeatures | |array[BTMFeature] | | |rollbackIndex | |Integer | | |belScriptLibraryVersion | |BTBelScriptLibraryVersion | | |sourceMicroversion | |String | | |rejectMicroversionSkew | |Boolean | | |libraryVersion | |Integer | | |serializationVersion | |String | | |microversionSkew | |Boolean | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTFeatureScriptEvalCall ||Field Name||Required||Type||Description|| |script | |String | | |queries | |map[String, array[String]] | | |belScriptLibraryVersion | |BTBelScriptLibraryVersion | | |sourceMicroversion | |String | | |rejectMicroversionSkew | |Boolean | | |libraryVersion | |Integer | | |serializationVersion | |String | | |microversionSkew | |Boolean | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTFeatureScriptEvalResponse ||Field Name||Required||Type||Description|| |result | |BTFSValue | | |console | |String | | |notices | |array[BTNotice] | | |belScriptLibraryVersion | |BTBelScriptLibraryVersion | | |sourceMicroversion | |String | | |rejectMicroversionSkew | |Boolean | | |libraryVersion | |Integer | | |serializationVersion | |String | | |microversionSkew | |Boolean | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTFeatureState ||Field Name||Required||Type||Description|| |featureStatus | |String | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTFolderInfo ||Field Name||Required||Type||Description|| |owner | |BTOwnerInfo | | |treeHref | |String | | |resourceType | |String | | |isMutable | |Boolean | | |isContainer | |Boolean | | |canMove | |Boolean | | |hasPendingOwner | |Boolean | | |description | |String | | |isEnterpriseOwned | |Boolean | | |modifiedAt | |Date | | |createdAt | |Date | | |createdBy | |BTUserBasicSummaryInfo | | |modifiedBy | |BTUserBasicSummaryInfo | | |projectId | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTFolderParams ||Field Name||Required||Type||Description|| |name | |String | | |description | |String | | |ownerType | |Integer | | |ownerId | |String | | |projectId | |String | | |parentId | |String | | h3. BTFriendInfo ||Field Name||Required||Type||Description|| |imageUrl | |String | | |token | |String | | |firstName | |String | | |lastName | |String | | |email | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTFriendsFromIdsParams ||Field Name||Required||Type||Description|| |ids | |array[String] | | h3. BTGlobalPermissionDefinitionsInfo ||Field Name||Required||Type||Description|| |items | |array[Definition] | | h3. BTGlobalPermissionInfo ||Field Name||Required||Type||Description|| |items | |array[Item] | | h3. BTGlobalPermissionParams ||Field Name||Required||Type||Description|| |globalPermission | |Integer | | |identityParams | |array[BTIdentityParams] | | h3. BTGlobalTreeMagicNodeInfo ||Field Name||Required||Type||Description|| |owner | |BTOwnerInfo | | |treeHref | |String | | |resourceType | |String | | |isMutable | |Boolean | | |isContainer | |Boolean | | |canMove | |Boolean | | |hasPendingOwner | |Boolean | | |description | |String | | |isEnterpriseOwned | |Boolean | | |modifiedAt | |Date | | |createdAt | |Date | | |createdBy | |BTUserBasicSummaryInfo | | |modifiedBy | |BTUserBasicSummaryInfo | | |projectId | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTGlobalTreeNodeInfo ||Field Name||Required||Type||Description|| |owner | |BTOwnerInfo | | |treeHref | |String | | |resourceType | |String | | |isMutable | |Boolean | | |isContainer | |Boolean | | |canMove | |Boolean | | |hasPendingOwner | |Boolean | | |description | |String | | |isEnterpriseOwned | |Boolean | | |modifiedAt | |Date | | |createdAt | |Date | | |createdBy | |BTUserBasicSummaryInfo | | |modifiedBy | |BTUserBasicSummaryInfo | | |projectId | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTGlobalTreeNodeInfoListBTGlobalTreeNodeInfo ||Field Name||Required||Type||Description|| h3. BTGlobalTreeNodeListResponse ||Field Name||Required||Type||Description|| |next | |String | | |items | |array[BTGlobalTreeNodeInfo] | | |href | |String | | |previous | |String | | h3. BTGlobalTreeNodeMoveParams ||Field Name||Required||Type||Description|| |itemsToMove | |array[Item] | | h3. BTGlobalTreeNodeOwnerParams ||Field Name||Required||Type||Description|| |resourceId | |String | | |newOwnerId | |String | | |resourceType | |String | | |newOwnerType | |Integer | | h3. BTGlobalTreeNodeWithChildrenInfo ||Field Name||Required||Type||Description|| |permissionSet | |BTPermissionSet | | |pathToRoot | |array[PathSegment] | | |next | |String | | |items | |array[BTGlobalTreeNodeInfo] | | |href | |String | | |previous | |String | | h3. BTGraphicsAppearance ||Field Name||Required||Type||Description|| |nonTrivial | |Boolean | | |reset | |Boolean | | |color | |array[byte[]] | | |opacity | |Integer | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTIdAndConfiguration ||Field Name||Required||Type||Description|| |configuration | |map[String, BTFSValue] | | |id | |String | | |configurationIsNull | |Boolean | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTIdTranslationInfo ||Field Name||Required||Type||Description|| |sourceDocumentMicroversion | |String | | |targetDocumentMicroversion | |String | | |ids | |array[BTIdTranslationResultInfo] | | |documentId | |String | | |elementId | |String | | h3. BTIdTranslationParams ||Field Name||Required||Type||Description|| |ids | |array[String] | | |linkDocumentId | |String | | |sourceDocumentMicroversion | |String | | |sourceConfiguration | |String | | |targetConfiguration | |String | | h3. BTIdTranslationResultInfo ||Field Name||Required||Type||Description|| |target | |array[String] | | |source | |String | | |status | |String | | h3. BTIdentity ||Field Name||Required||Type||Description|| |identityId | |String | | |identityType | |String | | h3. BTIdentityInfo ||Field Name||Required||Type||Description|| |team | |BTTeamSummaryInfo | | |identityType | |Integer | | |user | |BTUserSummaryInfo | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTIdentityManagementParams ||Field Name||Required||Type||Description|| |name | |String | | |metadataMustBeSigned | |Boolean | | |enabled | |Boolean | | |providerType | |Integer | | |idpCertificate | |String | | |idpEntityId | |String | | |idpRedirectURL | |String | | h3. BTIdentityParams ||Field Name||Required||Type||Description|| |identityId | |String | | |identityType | |Integer | | h3. BTImportCloudObjectParams ||Field Name||Required||Type||Description|| |name | |String | | |public | |Boolean | | |mimeType | |String | | |notifyUser | |Boolean | | |ownerType | |String | | |url | |String | | |cloudStorageProvider | |Integer | | |ownerId | |String | | |cloudStorageAccountId | |String | | |cloudObjectId | |String | | |sizeBytes | |Long | | |accessToken | |String | | |foreignId | |String | | |uploadId | |String | | |projectId | |String | | |parentId | |String | | |updateExistingImportFeatures | |Boolean | | |blobMicroversionId | |String | | |originalForeignId | |String | | |blobElementId | |String | | |specifyUnits | |Boolean | | |splitAssembliesIntoMultipleDocuments | |Boolean | | |flattenAssemblies | |Boolean | | |getyAxisIsUp | |Boolean | | |allowFaultyParts | |Boolean | | |unit | |String | | h3. BTImportForeignDataParams ||Field Name||Required||Type||Description|| |size | |Long | | |fileFormat | |String | | |publicDocument | |Boolean | | |notifyUser | |Boolean | | |ownerType | |String | | |filename | |String | | |documentId | |String | | |mediaType | |String | | |ownerId | |String | | |foreignId | |String | | |uploadId | |String | | |projectId | |String | | |parentId | |String | | |updateExistingImportFeatures | |Boolean | | |blobMicroversionId | |String | | |originalForeignId | |String | | |blobElementId | |String | | |specifyUnits | |Boolean | | |splitAssembliesIntoMultipleDocuments | |Boolean | | |flattenAssemblies | |Boolean | | |getyAxisIsUp | |Boolean | | |allowFaultyParts | |Boolean | | |unit | |String | | h3. BTInAppMessageContent ||Field Name||Required||Type||Description|| |title | |String | | |showItems | |Boolean | | |contentItems | |array[BTInAppMessageContentItem] | | |maxNumSurveyResponses | |Integer | | |state | |String | | h3. BTInAppMessageContentItem ||Field Name||Required||Type||Description|| |contentId | |String | | |title | |String | | |template | |String | | |thumbnail | |String | | |link | |String | | |height | |Integer | | |width | |Integer | | |player | |String | | |pausePoints | |array[Double] | | |position | |String | | |itemTitle | |String | | |verticalOffset | |Integer | | |horizontalOffset | |Integer | | |anchor | |String | | h3. BTInAppMessageInfo ||Field Name||Required||Type||Description|| |context | |Integer | | |content | |array[BTInAppMessageContent] | | |description | |String | | |contentType | |Integer | | |startDate | |Date | | |endDate | |Date | | |ruleId | |String | | |lookerQuery | |Long | | |populationTaskId | |String | | |billingPlanIds | |array[String] | | |domainType | |Integer | | |showOnce | |Boolean | | |displayOrder | |Integer | | |contentIndex | |Integer | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTInAppMessageParams ||Field Name||Required||Type||Description|| |name | |String | | |context | |Integer | | |content | |array[Content] | | |description | |String | | |contentType | |Integer | | |startDate | |Date | | |endDate | |Date | | |ruleId | |String | | |lookerQuery | |Long | | |populationTaskId | |String | | |billingPlanIds | |array[String] | | |domainType | |Integer | | |showOnce | |Boolean | | |displayOrder | |Integer | | h3. BTInsertionLocation ||Field Name||Required||Type||Description|| |orderPreserving | |Boolean | | |adjacentToNode | |Boolean | | |nodeId | |String | | |nodeIdRaw | |BTObjectId | | |childFieldIndex | |Integer | | |before | |Boolean | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTInvitationParams ||Field Name||Required||Type||Description|| |name | |String | | |message | |String | | |id | |String | | |state | |Integer | | |password | |String | | |description | |String | | |source | |Integer | | |cadSystemAtSignup | |String | | |companyPlan | |Boolean | | |eulaAccepted | |Boolean | | |firstName | |String | | |lastName | |String | | |email | |String | | |defaultCompanyName | |String | | |planId | |String | | |seats | |Long | | |role | |Integer | | |countryCode | |String | | |phoneNumber | |String | | |recaptcha | |String | | |inviteFriendRequest | |Boolean | | |companyUserEmails | |array[String] | | |approveUser | |Boolean | | |privacyConsentAccepted | |Boolean | | h3. BTItemParams ||Field Name||Required||Type||Description|| |name | |String | | |companyId | |String | | |publishState | |Integer | | h3. BTLinkToLatestDocumentParams ||Field Name||Required||Type||Description|| |elements | |array[String] | | h3. BTListResponseBTBetaCapabilitySummaryInfo ||Field Name||Required||Type||Description|| |next | |String | | |items | |array[BTBetaCapabilitySummaryInfo] | | |href | |String | | |previous | |String | | h3. BTListResponseBTBetaCapabilityUserInfo ||Field Name||Required||Type||Description|| |next | |String | | |items | |array[BTBetaCapabilityUserInfo] | | |href | |String | | |previous | |String | | h3. BTListResponseBTCloudStorageProviderObjectInfo ||Field Name||Required||Type||Description|| |next | |String | | |items | |array[BTCloudStorageProviderObjectInfo] | | |href | |String | | |previous | |String | | h3. BTListResponseBTFriendInfo ||Field Name||Required||Type||Description|| |next | |String | | |items | |array[BTFriendInfo] | | |href | |String | | |previous | |String | | h3. BTListResponseBTInAppMessageInfo ||Field Name||Required||Type||Description|| |next | |String | | |items | |array[BTInAppMessageInfo] | | |href | |String | | |previous | |String | | h3. BTListResponseBTPurchaseInfo ||Field Name||Required||Type||Description|| |next | |String | | |items | |array[BTPurchaseInfo] | | |href | |String | | |previous | |String | | h3. BTListResponseBTStandardContentHierarchyInfo ||Field Name||Required||Type||Description|| |next | |String | | |items | |array[BTStandardContentHierarchyInfo] | | |href | |String | | |previous | |String | | h3. BTListResponseBTSystemConfigInfo ||Field Name||Required||Type||Description|| |next | |String | | |items | |array[BTSystemConfigInfo] | | |href | |String | | |previous | |String | | h3. BTLocationInfo ||Field Name||Required||Type||Description|| |fromNode | |BTPNode | | |endColumn | |Integer | | |line | |Integer | | |elementMicroversion | |String | | |version | |String | | |document | |String | | |topLevel | |String | | |languageVersion | |Integer | | |moduleIds | |BTDocumentVersionElementIds | | |changeableChildFieldIndices | |array[Integer] | | |column | |Integer | | |endLine | |Integer | | |character | |Integer | | |parseNodeId | |String | | |endCharacter | |Integer | | |parseNodeIdRaw | |BTObjectId | | |nodeId | |String | | |childMapIndices | |array[Integer] | | |atomicChildIndices | |array[Integer] | | |nodeIdRaw | |BTObjectId | | |firstChildField | |Integer | | |childListIndices | |array[Integer] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTLoginParams ||Field Name||Required||Type||Description|| |password | |String | | |email | |String | | |deviceId | |String | | |randomToken | |String | | |totp | |String | | |enableTotp | |Boolean | | |rememberTotp | |Boolean | | |webClientCapabilities | |BTWebClientCapabilitiesParams | | |rendererPerformanceMeasurement | |BTWebRendererPerformanceMeasurementParams | | h3. BTLoginTotpParams ||Field Name||Required||Type||Description|| |totp | |String | | h3. BTMFeature ||Field Name||Required||Type||Description|| |sketch | |Boolean | | |allParameters | |array[BTMParameter] | | |fullFeatureType | |String | | |importedMicroversionId | |BTMicroversionId | | |externalDocumentWithVersionAndElementId | |BTDocumentWithVersionAndElementId | | |importedWorkspaceElementId | |String | | |revisionData | |BTRevisionCustomData | | |namespaceFieldIndex | |Integer | | |regenerateAsVersion | |String | | |plane | |Boolean | | |suppressionStateFieldIndex | |Integer | | |suppressedFieldIndex | |Integer | | |namespace | |String | | |import | |BTPModuleId | | |nodeId | |String | | |combinedNamespace | |String | | |forExport | |Boolean | | |importMicroversion | |String | | |name | |String | | |suppressed | |Boolean | | |parameters | |array[BTMParameter] | | |suppressionState | |BTMSuppressionState | | |featureId | |String | | |subFeatures | |array[BTMFeature] | | |featureType | |String | | |returnAfterSubfeatures | |Boolean | | |changeableChildFieldIndices | |array[Integer] | | |firstChildField | |Integer | | |childListIndices | |array[Integer] | | |suppressedParseNode | |BTNodeReference | | |nameParseNode | |BTNodeReference | | |childNodes | |map[String, BTNodeReference] | | |hasUserCode | |Boolean | | |childLocations | |map[String, BTInsertionLocation] | | |sourceParseTreeNodes | |map[String, array[BTNodeReference]] | | |childMapIndices | |array[Integer] | | |atomicChildIndices | |array[Integer] | | |nodeIdRaw | |BTObjectId | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTMImport ||Field Name||Required||Type||Description|| |import | |BTPModuleId | | |importedExternalDocumentId | |String | | |elementImport | |Boolean | | |importedMicroversionId | |BTMicroversionId | | |externalDocumentWithVersionAndElementId | |BTDocumentWithVersionAndElementId | | |importedWorkspaceElementId | |String | | |revisionData | |BTRevisionCustomData | | |namespaceFieldIndex | |Integer | | |namespace | |String | | |nodeId | |String | | |combinedNamespace | |String | | |forExport | |Boolean | | |importMicroversion | |String | | |path | |String | | |version | |String | | |changeableChildFieldIndices | |array[Integer] | | |childNodes | |map[String, BTNodeReference] | | |hasUserCode | |Boolean | | |childLocations | |map[String, BTInsertionLocation] | | |sourceParseTreeNodes | |map[String, array[BTNodeReference]] | | |childMapIndices | |array[Integer] | | |atomicChildIndices | |array[Integer] | | |nodeIdRaw | |BTObjectId | | |firstChildField | |Integer | | |childListIndices | |array[Integer] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTMParameter ||Field Name||Required||Type||Description|| |valueObject | |Object | | |revisionData | |BTRevisionCustomData | | |configurationValueString | |String | | |directImports | |array[BTMImport] | | |stringValueForProperty | |String | | |parameterId | |String | | |changeableChildFieldIndices | |array[Integer] | | |forExport | |Boolean | | |importMicroversion | |String | | |childNodes | |map[String, BTNodeReference] | | |hasUserCode | |Boolean | | |childLocations | |map[String, BTInsertionLocation] | | |sourceParseTreeNodes | |map[String, array[BTNodeReference]] | | |nodeId | |String | | |childMapIndices | |array[Integer] | | |atomicChildIndices | |array[Integer] | | |nodeIdRaw | |BTObjectId | | |firstChildField | |Integer | | |childListIndices | |array[Integer] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTMSuppressionState ||Field Name||Required||Type||Description|| |forExport | |Boolean | | |importMicroversion | |String | | |childNodes | |map[String, BTNodeReference] | | |changeableChildFieldIndices | |array[Integer] | | |hasUserCode | |Boolean | | |childLocations | |map[String, BTInsertionLocation] | | |sourceParseTreeNodes | |map[String, array[BTNodeReference]] | | |nodeId | |String | | |childMapIndices | |array[Integer] | | |atomicChildIndices | |array[Integer] | | |nodeIdRaw | |BTObjectId | | |firstChildField | |Integer | | |childListIndices | |array[Integer] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTMassPropResponse ||Field Name||Required||Type||Description|| |microversionId | |String | | |bodies | |map[String, BTMassProperties] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTMassProperties ||Field Name||Required||Type||Description|| |hasMass | |Boolean | | |massMissingCount | |Integer | | |mass | |array[Double] | | |volume | |array[Double] | | |periphery | |array[Double] | | |centroid | |array[Double] | | |inertia | |array[Double] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTMatchingStandardContentHierarchyInfo ||Field Name||Required||Type||Description|| |type | |array[String] | | |standardDefault | |String | | |categoryDefault | |String | | |typesDefault | |String | | |typeDefault | |String | | |category | |array[String] | | |standard | |array[String] | | |types | |array[String] | | |componentDocumentId | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTMaterialParams ||Field Name||Required||Type||Description|| |properties | |array[BTMaterialPropertyParams] | | |id | |String | | |displayName | |String | | |libraryName | |String | | |libraryReference | |BTExternalElementReferenceInfo | | h3. BTMaterialPropertyParams ||Field Name||Required||Type||Description|| |name | |String | | |value | |String | | |type | |String | | |description | |String | | |category | |String | | |displayName | |String | | |units | |String | | h3. BTMetadataEnumValueInfo ||Field Name||Required||Type||Description|| |value | |String | | |label | |String | | h3. BTMetadataPropertyConfigParams ||Field Name||Required||Type||Description|| |defaultValue | |String | | |pattern | |String | | |displayName | |String | | |required | |Boolean | | |publishState | |Integer | | |schemaId | |String | | |propertyId | |String | | |minLength | |Integer | | |maxLength | |Integer | | |minValue | |Double | | |maxValue | |Double | | |minDate | |Date | | |maxDate | |Date | | |minCount | |Integer | | |maxCount | |Integer | | |multiline | |Boolean | | |enumValues | |array[map[String, String]] | | h3. BTMetadataPropertyInfo ||Field Name||Required||Type||Description|| |name | |String | | |defaultValue | |Object | | |initialValue | |Object | | |dirty | |Boolean | | |validator | |BTMetadataPropertyValidatorInfo | | |required | |Boolean | | |propertySource | |Integer | | |propertyId | |String | | |editable | |Boolean | | |schemaId | |String | | |valueType | |String | | |enumValues | |array[BTMetadataEnumValueInfo] | | |uiHints | |BTMetadataPropertyUiHintsInfo | | h3. BTMetadataPropertyParams ||Field Name||Required||Type||Description|| |array | |Boolean | | |name | |String | | |id | |String | | |description | |String | | |namespace | |String | | |ownerId | |String | | |propertyConfigParamList | |array[BTMetadataPropertyConfigParams] | | |valueType | |Integer | | |ownerTypeOrdinal | |Integer | | |objectDefName | |String | | |blobMimeType | |String | | |editableInVersion | |Boolean | | |editableInMicroversion | |Boolean | | |searchBoost | |Double | | h3. BTMetadataPropertyUiHintsInfo ||Field Name||Required||Type||Description|| |multiline | |Boolean | | h3. BTMetadataPropertyValidatorInfo ||Field Name||Required||Type||Description|| |max | |BigDecimal | | |min | |BigDecimal | | |pattern | |String | | |minLength | |Integer | | |maxLength | |Integer | | |minDate | |Date | | |maxDate | |Date | | |minCount | |Integer | | |maxCount | |Integer | | h3. BTMetadataSchemaParams ||Field Name||Required||Type||Description|| |objectType | |Integer | | |ownerType | |Integer | | |ownerId | |String | | h3. BTMetricParams ||Field Name||Required||Type||Description|| |systemId | |String | | |propertyMap | |map[String, Object] | | |eventName | |String | | |eventNamespace | |String | | |eventTime | |Date | | |documentId | |String | | |elementId | |String | | |eventType | |Integer | | h3. BTMetricsListParams ||Field Name||Required||Type||Description|| |collectedMetrics | |array[BTMetricParams] | | h3. BTMicroversionId ||Field Name||Required||Type||Description|| |deleted | |Boolean | | |theId | |String | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTMobileNotificationParams ||Field Name||Required||Type||Description|| |itemsToAcknowledge | |array[Item] | | h3. BTModelBodyParams ||Field Name||Required||Type||Description|| |partQuery | |String | | |partId | |String | | |elementMicroversionId | |String | | |configuration | |String | | |documentId | |String | | |workspaceId | |String | | |elementId | |String | | h3. BTModelElementParams ||Field Name||Required||Type||Description|| |name | |String | | h3. BTModelFormatInfo ||Field Name||Required||Type||Description|| |name | |String | | |translatorName | |String | | |couldBeAssembly | |Boolean | | h3. BTModelTessellationParams ||Field Name||Required||Type||Description|| |partIds | |array[String] | | |partQuery | |String | | |angleTolerance | |Double | | |chordTolerance | |Double | | |maxFacetWidth | |Double | | |outputVertexNormals | |Boolean | | |outputFacetNormals | |Boolean | | |outputTextureCoordinates | |Boolean | | |outputIndexTable | |Boolean | | |entityIds | |array[String] | | |outputErrorFaces | |Boolean | | |partId | |String | | |elementMicroversionId | |String | | |configuration | |String | | |documentId | |String | | |workspaceId | |String | | |elementId | |String | | h3. BTMoveElementInfo ||Field Name||Required||Type||Description|| |newDocumentVersionId | |String | | |newDocumentName | |String | | |newWorkspaceId | |String | | |errorMessage | |String | | |newDocumentId | |String | | |elementOriginalToNewMap | |map[String, String] | | |isNewDocument | |Boolean | | h3. BTMoveElementParams ||Field Name||Required||Type||Description|| |name | |String | | |isCopy | |Boolean | | |generateUnknownMessages | |Boolean | | |needNewVersion | |Boolean | | |isDeepCopy | |Boolean | | |anchorElementId | |String | | |description | |String | | |tags | |array[String] | | |targetDocumentId | |String | | |sourceDocumentId | |String | | |sourceWorkspaceId | |String | | |ownerId | |String | | |ownerType | |Integer | | |isGroupAnchor | |Boolean | | |targetWorkspaceId | |String | | |elements | |array[String] | | |projectId | |String | | |parentId | |String | | |isPublic | |Boolean | | |versionName | |String | | |importData | |array[byte[]] | | |elementOriginalToNewMap | |map[String, String] | | |isNewDocument | |Boolean | | |ownerEmail | |String | | h3. BTNameValuePair ||Field Name||Required||Type||Description|| |name | |String | | |value | |String | | h3. BTNamedViewInfo ||Field Name||Required||Type||Description|| |cameraViewport | |array[Double] | | |angle | |Double | | |viewMatrix | |array[Double] | | |perspective | |Boolean | | |sectionPlanes | |array[BTSectionPlaneInfo] | | h3. BTNamedViewsInfo ||Field Name||Required||Type||Description|| |namedViews | |map[String, BTNamedViewInfo] | | h3. BTNextPartNumberParam ||Field Name||Required||Type||Description|| |id | |String | | |mimeType | |String | | |partId | |String | | |elementType | |Integer | | |versionId | |String | | |documentId | |String | | |workspaceId | |String | | |elementId | |String | | |partNumber | |String | | h3. BTNextPartNumbersParam ||Field Name||Required||Type||Description|| |itemPartNumbers | |array[BTNextPartNumberParam] | | |skipPartNumbers | |array[String] | | h3. BTNextRevisionParams ||Field Name||Required||Type||Description|| |revisionNames | |array[String] | | h3. BTNodeReference ||Field Name||Required||Type||Description|| |nodeId | |String | | |nodeIdRaw | |BTObjectId | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTNodeStatus ||Field Name||Required||Type||Description|| |error | |Boolean | | |statusEnum | |String | | |statusType | |String | | |statusMsg | |String | | |faultyParameters | |array[String] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTNotice ||Field Name||Required||Type||Description|| |locationInfos | |array[BTLocationInfo] | | |message | |String | | |stackTrace | |array[BTLocationInfo] | | |type | |String | | |level | |String | | |parameterId | |String | | |changeableChildFieldIndices | |array[Integer] | | |firstChildField | |Integer | | |childListIndices | |array[Integer] | | |tryNode | |BTNodeReference | | |nodeId | |String | | |childMapIndices | |array[Integer] | | |atomicChildIndices | |array[Integer] | | |nodeIdRaw | |BTObjectId | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTNotificationDebugParams ||Field Name||Required||Type||Description|| |debugSubmitted | |Boolean | | h3. BTNotificationParams ||Field Name||Required||Type||Description|| |id | |String | | |userId | |String | | |acknowledged | |Boolean | | |expanded | |Boolean | | |campaignId | |String | | |messageId | |String | | |messageParamsArray | |array[Object] | | |notificationLevel | |String | | |deliverAt | |Date | | |eventKey | |String | | |messageParams | |array[Object] | | h3. BTObjectId ||Field Name||Required||Type||Description|| |empty | |Boolean | | h3. BTOccurrence ||Field Name||Required||Type||Description|| |fullPathAsString | |String | | |rootOccurrence | |Boolean | | |tailInstanceId | |String | | |headInstanceId | |String | | |occurrenceWithoutHead | |BTOccurrence | | |occurrenceWithoutTail | |BTOccurrence | | |path | |array[String] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTOwnerInfo ||Field Name||Required||Type||Description|| |type | |Integer | | |acceptOwnershipTransfer | |Boolean | | |isEnterpriseOwnedResource | |Boolean | | |image | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTPDMMetadataParams ||Field Name||Required||Type||Description|| |name | |String | | |id | |String | | |state | |String | | |description | |String | | |revision | |String | | |customProperties | |array[BTNameValuePair] | | |vendor | |String | | |productLine | |String | | |title1 | |String | | |title2 | |String | | |title3 | |String | | |partId | |String | | |configuration | |String | | |elementId | |String | | |project | |String | | |partNumber | |String | | h3. BTPLiteralString ||Field Name||Required||Type||Description|| |value | |String | | |text | |String | | |shortDescriptor | |String | | |changeableChildFieldIndices | |array[Integer] | | |firstChildField | |Integer | | |atomic | |Boolean | | |startSourceLocation | |Integer | | |endSourceLocation | |Integer | | |documentationType | |String | | |spaceBefore | |BTPSpace | | |spaceAfter | |BTPSpace | | |spaceDefault | |Boolean | | |nodeId | |String | | |childMapIndices | |array[Integer] | | |atomicChildIndices | |array[Integer] | | |nodeIdRaw | |BTObjectId | | |childListIndices | |array[Integer] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTPModuleId ||Field Name||Required||Type||Description|| |importedElementId | |String | | |elementImport | |Boolean | | |potentiallyValid | |Boolean | | |validLegacyVersion | |Boolean | | |pathVersion | |String | | |importedVersionId | |String | | |dbimportString | |String | | |versionAndMicroversion | |String | | |externalImport | |Boolean | | |importedDocumentId | |String | | |legacy | |Boolean | | |externalDocumentWithVersionAndElementId | |BTDocumentWithVersionAndElementId | | |externalDocumentWithVersion | |BTDocumentWithVersionId | | |shortDescriptor | |String | | |path | |BTPLiteralString | | |microversion | |String | | |version | |BTPLiteralString | | |changeableChildFieldIndices | |array[Integer] | | |firstChildField | |Integer | | |spaceBeforePath | |BTPSpace | | |spaceAfterPath | |BTPSpace | | |spaceBeforeVersion | |BTPSpace | | |spaceAfterVersion | |BTPSpace | | |atomic | |Boolean | | |startSourceLocation | |Integer | | |endSourceLocation | |Integer | | |documentationType | |String | | |spaceBefore | |BTPSpace | | |spaceAfter | |BTPSpace | | |spaceDefault | |Boolean | | |nodeId | |String | | |childMapIndices | |array[Integer] | | |atomicChildIndices | |array[Integer] | | |nodeIdRaw | |BTObjectId | | |childListIndices | |array[Integer] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTPNode ||Field Name||Required||Type||Description|| |shortDescriptor | |String | | |atomic | |Boolean | | |startSourceLocation | |Integer | | |endSourceLocation | |Integer | | |documentationType | |String | | |spaceBefore | |BTPSpace | | |changeableChildFieldIndices | |array[Integer] | | |firstChildField | |Integer | | |spaceAfter | |BTPSpace | | |spaceDefault | |Boolean | | |nodeId | |String | | |childMapIndices | |array[Integer] | | |atomicChildIndices | |array[Integer] | | |nodeIdRaw | |BTObjectId | | |childListIndices | |array[Integer] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTPSpace ||Field Name||Required||Type||Description|| |text | |String | | |lines | |array[String] | | |changeableChildFieldIndices | |array[Integer] | | |nodeId | |String | | |childMapIndices | |array[Integer] | | |atomicChildIndices | |array[Integer] | | |nodeIdRaw | |BTObjectId | | |firstChildField | |Integer | | |childListIndices | |array[Integer] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTPartAppearanceInfo ||Field Name||Required||Type||Description|| |color | |BTColorInfo | | |opacity | |Integer | | |isGenerated | |Boolean | | h3. BTPartAppearanceParams ||Field Name||Required||Type||Description|| |color | |BTColorParams | | |opacity | |Integer | | h3. BTPartIdParams ||Field Name||Required||Type||Description|| |ids | |array[String] | | |linkDocumentId | |String | | |configuration | |String | | h3. BTPartMaterialInfo ||Field Name||Required||Type||Description|| |properties | |array[BTPartMaterialPropertyInfo] | | |id | |String | | |displayName | |String | | |libraryName | |String | | |libraryReference | |BTExternalElementReferenceInfo | | h3. BTPartMaterialPropertyInfo ||Field Name||Required||Type||Description|| |name | |String | | |value | |String | | |type | |String | | |description | |String | | |category | |String | | |displayName | |String | | |units | |String | | h3. BTPartMetadataInfo ||Field Name||Required||Type||Description|| |name | |String | | |id | |String | | |state | |String | | |description | |String | | |revision | |String | | |microversionId | |String | | |customProperties | |map[String, String] | | |vendor | |String | | |productLine | |String | | |title1 | |String | | |title2 | |String | | |title3 | |String | | |partQuery | |String | | |partId | |String | | |unflattenedPartId | |String | | |configurationId | |String | | |href | |String | | |thumbnailInfo | |BTThumbnailInfo | | |elementId | |String | | |project | |String | | |material | |BTPartMaterialInfo | | |partNumber | |String | | |bodyType | |String | | |isMesh | |Boolean | | |thumbnailConfigurationId | |String | | |isFlattenedBody | |Boolean | | |referencingConfiguredPartNodeIds | |array[String] | | |appearance | |BTPartAppearanceInfo | | |customPropertyDefinitions | |map[String, BTCustomPropertyDefinitionInfo] | | |isHidden | |Boolean | | |ordinal | |Integer | | |propertySourceTypes | |map[String, Integer] | | h3. BTPartQueryParams ||Field Name||Required||Type||Description|| |linkDocumentId | |String | | |queries | |array[String] | | |configuration | |String | | h3. BTPasswordResetParams ||Field Name||Required||Type||Description|| |id | |String | | |password | |String | | |email | |String | | |secret | |String | | h3. BTPaymentTypeParams ||Field Name||Required||Type||Description|| |userId | |String | | |paymentType | |Integer | | h3. BTPermissionSet ||Field Name||Required||Type||Description|| h3. BTPlanSubscriberInfo ||Field Name||Required||Type||Description|| |state | |Integer | | |firstName | |String | | |lastName | |String | | |email | |String | | |image | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTProjectInfo ||Field Name||Required||Type||Description|| |roleMapEntries | |array[RoleMapEntry] | | |trash | |Boolean | | |permissionSet | |BTPermissionSet | | |permissionScheme | |BTRbacPermissionSchemeInfo | | |owner | |BTOwnerInfo | | |treeHref | |String | | |resourceType | |String | | |isMutable | |Boolean | | |isContainer | |Boolean | | |canMove | |Boolean | | |hasPendingOwner | |Boolean | | |description | |String | | |isEnterpriseOwned | |Boolean | | |modifiedAt | |Date | | |createdAt | |Date | | |createdBy | |BTUserBasicSummaryInfo | | |modifiedBy | |BTUserBasicSummaryInfo | | |projectId | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTProjectParams ||Field Name||Required||Type||Description|| |name | |String | | |roleMap | |map[String, array[BTIdentityParams]] | | |description | |String | | |permissionSchemeId | |String | | |roleIdentityMap | |map[String, array[BTIdentity]] | | h3. BTPropertyValueParam ||Field Name||Required||Type||Description|| |value | |Object | | |propertyId | |String | | h3. BTPurchaseInfo ||Field Name||Required||Type||Description|| |state | |Integer | | |lastModified | |Date | | |subscriptionFields | |Subscription | | |purchaseDate | |Date | | |subscribers | |array[BTPlanSubscriberInfo] | | |pendingCancelation | |Boolean | | |nextCharge | |NextCharge | | |proratedCharges | |array[ProratedCharges] | | |proratedTotal | |Long | | |couponAmountOff | |Long | | |durationMonths | |Integer | | |group | |String | | |duration | |Integer | | |currency | |String | | |lightSeats | |Long | | |accountId | |String | | |planId | |String | | |plan | |BTBillingPlanInfo | | |seats | |Long | | |subscriptionBeginAt | |Date | | |subscriptionEndAt | |Date | | |subscriptionId | |String | | |application | |BTAPIApplicationSummaryInfo | | |clientId | |String | | |paymentType | |Integer | | |amountCents | |Long | | |planType | |Integer | | |card | |BTCardInfo | | |canceledAt | |Date | | |couponPercentOff | |Integer | | |planName | |String | | |actualAmountPaidCents | |Long | | |resellerName | |String | | |trialEnd | |Date | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTPurchaseParams ||Field Name||Required||Type||Description|| |password | |String | | |lightSeats | |Long | | |userId | |String | | |email | |String | | |planId | |String | | |seats | |Long | | |domainPrefix | |String | | |paymentType | |Integer | | |trialPeriodDays | |Integer | | |allowDeprecatedPlan | |Boolean | | |resellerName | |String | | h3. BTPurchaseUserInfo ||Field Name||Required||Type||Description|| |purchase | |BTPurchaseInfo | | |user | |BTUserBasicSummaryInfo | | |consumedQuantity | |Integer | | |purchaseState | |Integer | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTPurchaseUserParams ||Field Name||Required||Type||Description|| |userId | |String | | |consumedQuantity | |Integer | | |purchaseId | |String | | h3. BTQueryRevisionParams ||Field Name||Required||Type||Description|| |nodeIds | |array[String] | | |companyId | |String | | h3. BTRbacPermissionSchemeEntryParams ||Field Name||Required||Type||Description|| |permissionSet | |BTPermissionSet | | |roleId | |String | | h3. BTRbacPermissionSchemeInfo ||Field Name||Required||Type||Description|| |entries | |array[Entry] | | |active | |Boolean | | |predefinedPermissionScheme | |Integer | | |description | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTRbacPermissionSchemeListInfo ||Field Name||Required||Type||Description|| |defaultIndex | |Integer | | |next | |String | | |items | |array[BTRbacPermissionSchemeInfo] | | |href | |String | | |previous | |String | | h3. BTRbacPermissionSchemeParams ||Field Name||Required||Type||Description|| |name | |String | | |description | |String | | |permissionMap | |map[String, BTPermissionSet] | | h3. BTRbacRoleInfo ||Field Name||Required||Type||Description|| |active | |Boolean | | |predefinedRole | |Integer | | |description | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTRbacRoleParams ||Field Name||Required||Type||Description|| |name | |String | | |description | |String | | h3. BTReleasePackageInfo ||Field Name||Required||Type||Description|| |properties | |array[BTMetadataPropertyInfo] | | |isSetup | |Boolean | | |detailed | |Boolean | | |columnNames | |map[String, String] | | |comments | |array[BTCommentInfo] | | |items | |array[BTReleasePackageItemInfo] | | |packageThumbnail | |String | | |description | |String | | |workspaceId | |String | | |isObsoletion | |Boolean | | |versionId | |String | | |documentId | |String | | |companyId | |String | | |workflow | |BTWorkflowInfo | | |isFrozen | |Boolean | | |revisionRuleId | |String | | |linkedVersionIds | |array[String] | | |isDiscarded | |Boolean | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTReleasePackageItem ||Field Name||Required||Type||Description|| |name | |String | | |id | |String | | |state | |Integer | | |revision | |String | | |children | |array[BTReleasePackageItem] | | |mimeType | |String | | |microversionId | |String | | |workspaceId | |String | | |partId | |String | | |elementType | |Integer | | |configuration | |String | | |errors | |array[BTReleasePackageItemError] | | |configurationKey | |String | | |versionId | |String | | |modifiedAt | |Date | | |documentId | |String | | |createdAt | |Date | | |companyId | |String | | |createdBy | |String | | |modifiedBy | |String | | |elementId | |String | | |diffThumbnailConfigurationKey | |String | | |initialRevision | |String | | |revisionRuleId | |String | | |isIncluded | |Boolean | | |remoteState | |Integer | | |smallThumbnailHref | |String | | |isRevisionManaged | |Boolean | | |partNumber | |String | | |rpid | |String | | |obsoletionRevisionId | |String | | h3. BTReleasePackageItemError ||Field Name||Required||Type||Description|| |severity | |Integer | | |message | |String | | h3. BTReleasePackageItemInfo ||Field Name||Required||Type||Description|| |properties | |array[BTMetadataPropertyInfo] | | |mimeType | |String | | |workspaceId | |String | | |partId | |String | | |elementType | |Integer | | |configuration | |String | | |errors | |array[BTReleasePackageItemError] | | |configurationKey | |String | | |versionId | |String | | |documentId | |String | | |companyId | |String | | |elementId | |String | | |diffThumbnailConfigurationKey | |String | | |isIncludedEditable | |Boolean | | |smallThumbnailHref | |String | | |isRevisionManaged | |Boolean | | |rpid | |String | | |obsoletionRevisionId | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTReleasePackageItemParams ||Field Name||Required||Type||Description|| |properties | |array[BTPropertyValueParam] | | |id | |String | | |partId | |String | | |configuration | |String | | |versionId | |String | | |documentId | |String | | |workspaceId | |String | | |elementId | |String | | |isIncluded | |Boolean | | |href | |String | | |partNumber | |String | | h3. BTReleasePackageParams ||Field Name||Required||Type||Description|| |items | |array[BTReleasePackageItemParams] | | h3. BTReleasePackageWorkflowChangeParams ||Field Name||Required||Type||Description|| |workspaceId | |String | | |releasePackageId | |String | | |workflowState | |String | | |isObsoletion | |Boolean | | |versionId | |String | | h3. BTRepairContextParams ||Field Name||Required||Type||Description|| |oldOccurrences | |array[BTOccurrence] | | |newOccurrences | |array[BTOccurrence] | | |contextAssemblyId | |String | | |contextId | |String | | |description | |String | | h3. BTRevisionCustomData ||Field Name||Required||Type||Description|| |validRevisionReference | |Boolean | | |revision | |String | | |partNumber | |String | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTRevisionParams ||Field Name||Required||Type||Description|| |revision | |String | | |elementType | |Integer | | |versionId | |String | | |documentId | |String | | |companyId | |String | | |elementId | |String | | |partNumber | |String | | |insertableId | |String | | |releaseId | |String | | h3. BTRevisionRuleInfo ||Field Name||Required||Type||Description|| |description | |String | | |script | |String | | |companyId | |String | | |revisionList | |array[String] | | |ruleType | |Integer | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTRevisionRuleParams ||Field Name||Required||Type||Description|| |name | |String | | |description | |String | | |script | |String | | |companyId | |String | | |revisionList | |array[String] | | |ruleType | |Integer | | |validationRegex | |String | | h3. BTRootDiffInfo ||Field Name||Required||Type||Description|| |sourceWorkspaceId | |String | | |sourceConfiguration | |String | | |targetConfiguration | |String | | |sourceMicroversionId | |String | | |sourceVersionId | |String | | |targetMicroversionId | |String | | |targetWorkspaceId | |String | | |targetVersionId | |String | | |type | |String | | |targetId | |String | | |sourceValue | |String | | |targetValue | |String | | |sourceId | |String | | |collectionChanges | |map[String, array[BTDiffInfo]] | | |changes | |map[String, BTDiffInfo] | | h3. BTSeatsParams ||Field Name||Required||Type||Description|| |lightSeats | |Long | | |userId | |String | | |seats | |Long | | h3. BTSectionPlaneInfo ||Field Name||Required||Type||Description|| |center | |array[Double] | | |normal | |array[Double] | | |tangent | |array[Double] | | h3. BTSendGridDeliveryEventParams ||Field Name||Required||Type||Description|| |ip | |String | | |timestamp | |Long | | |event | |String | | |smtpid | |String | | |email | |String | | h3. BTSettingInfo ||Field Name||Required||Type||Description|| |value | |Object | | |key | |String | | h3. BTSettingParam ||Field Name||Required||Type||Description|| |value | |Object | | |key | |String | | h3. BTShadedRenderDocumentResponse ||Field Name||Required||Type||Description|| |status | |BTNodeStatus | | |imageData | |array[byte[]] | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTShareEntryParams ||Field Name||Required||Type||Description|| |userId | |String | | |email | |String | | |companyId | |String | | |entryType | |Integer | | |teamId | |String | | |applicationId | |String | | h3. BTShareParams ||Field Name||Required||Type||Description|| |message | |String | | |entries | |array[BTShareEntryParams] | | |permission | |Long | | |encodedConfiguration | |String | | |documentId | |String | | |workspaceId | |String | | |elementId | |String | | |folderId | |String | | |permissionSet | |BTPermissionSet | | |update | |Boolean | | h3. BTSimpleInfo ||Field Name||Required||Type||Description|| |value | |String | | h3. BTStandardContentCustomParameterDefinition ||Field Name||Required||Type||Description|| |id | |BTStandardContentCustomParameterDefinitionId | | |name | |String | | |description | |String | | |createdBy | |String | | |createdAt | |Date | | |modifiedBy | |String | | |modifiedAt | |Date | | |parameterType | |Integer | | |parameterValue | |String | | |isDrivingConfiguration | |Boolean | | |parameterLinkType | |Integer | | |new | |Boolean | | h3. BTStandardContentCustomParameterDefinitionId ||Field Name||Required||Type||Description|| |propertyId | |String | | |ownerId | |String | | |ownerType | |Integer | | |parameterName | |String | | |standard | |String | | |category | |String | | |types | |String | | |type | |String | | h3. BTStandardContentCustomParameterParams ||Field Name||Required||Type||Description|| |isDrivingConfiguration | |Boolean | | |parameterValue | |String | | |ownerType | |Integer | | |parameterType | |Integer | | |parameterName | |String | | |ownerId | |String | | |propertyId | |String | | |type | |String | | |category | |String | | |standard | |String | | |types | |String | | |componentDocumentId | |String | | |disableProduction | |Boolean | | |productionVersionId | |String | | |testVersionId | |String | | h3. BTStandardContentFindUsageParams ||Field Name||Required||Type||Description|| |parameters | |array[BTStandardContentParameterDefinition] | | |componentDocumentId | |String | | |usedFromInDays | |String | | |userId | |String | | |companyId | |String | | h3. BTStandardContentHierarchy ||Field Name||Required||Type||Description|| |id | |String | | |standard | |String | | |category | |String | | |types | |String | | |type | |String | | |documentType | |Integer | | |productionVersionId | |String | | |testVersionId | |String | | |createdAt | |Date | | |modifiedAt | |Date | | |createdBy | |String | | |modifiedBy | |String | | |documentId | |String | | h3. BTStandardContentHierarchyInfo ||Field Name||Required||Type||Description|| |type | |String | | |existingVersions | |array[VersionSpecs] | | |category | |String | | |standard | |String | | |types | |String | | |productionVersionId | |String | | |testVersionId | |String | | |documentType | |Integer | | |defaultWorkspace | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTStandardContentHierarchyParams ||Field Name||Required||Type||Description|| |type | |String | | |category | |String | | |standard | |String | | |types | |String | | |componentDocumentId | |String | | |disableProduction | |Boolean | | |productionVersionId | |String | | |testVersionId | |String | | h3. BTStandardContentHierarchyRenameParams ||Field Name||Required||Type||Description|| |renameTo | |String | | |type | |String | | |category | |String | | |standard | |String | | |types | |String | | |componentDocumentId | |String | | |disableProduction | |Boolean | | |productionVersionId | |String | | |testVersionId | |String | | h3. BTStandardContentParameterDefinition ||Field Name||Required||Type||Description|| |defaultValue | |String | | |parameterId | |String | | |visible | |Boolean | | |isCustomParameter | |Boolean | | |isDrivingConfiguration | |Boolean | | |displayName | |String | | h3. BTStandardContentParams ||Field Name||Required||Type||Description|| |parameters | |array[BTStandardContentParameterDefinition] | | |saveCustomProperties | |Boolean | | |parametersId | |String | | |parametersIdVersion | |String | | |targetDocumentId | |String | | |targetElementId | |String | | h3. BTStandardContentSetRunVersionsParams ||Field Name||Required||Type||Description|| |componentDocumentId | |String | | |productionVersionId | |String | | |testVersionId | |String | | h3. BTStandardContentUsageSummary ||Field Name||Required||Type||Description|| |topUsedComponentsByLatestVersions | |map[String, BTComponentUsagesSummary] | | |topUsedComponentsByWorkspaces | |map[String, BTComponentUsagesSummary] | | |topUsersByLatestVersions | |map[String, BTUserUsagesSummary] | | |topUsersByWorkspaces | |map[String, BTUserUsagesSummary] | | |topComponentsUsedAlongWithByLatestVersions | |map[String, BTComponentUsagesSummary] | | |workspaceUseCount | |Long | | |latestVersionUseCount | |Long | | |versionUseCount | |Long | | |topUsersSummaryDone | |Boolean | | h3. BTStartEditInContextParams ||Field Name||Required||Type||Description|| |microversionId | |String | | |encodedConfiguration | |String | | |contextId | |String | | |description | |String | | h3. BTSubstituteApproverParams ||Field Name||Required||Type||Description|| |identity | |BTIdentityParams | | |enabled | |Boolean | | |companyId | |String | | h3. BTSurfaceDescription ||Field Name||Required||Type||Description|| |type | |String | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTSurveyResponseParams ||Field Name||Required||Type||Description|| |propertyMap | |map[String, Object] | | |msgId | |String | | |surveyType | |Integer | | h3. BTSystemConfigInfo ||Field Name||Required||Type||Description|| |value | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTTagParams ||Field Name||Required||Type||Description|| |tag | |String | | |displayName | |String | | h3. BTTeamInfo ||Field Name||Required||Type||Description|| |active | |Boolean | | |predefinedTeam | |Integer | | |owner | |BTOwnerInfo | | |treeHref | |String | | |resourceType | |String | | |isMutable | |Boolean | | |isContainer | |Boolean | | |canMove | |Boolean | | |hasPendingOwner | |Boolean | | |description | |String | | |isEnterpriseOwned | |Boolean | | |modifiedAt | |Date | | |createdAt | |Date | | |createdBy | |BTUserBasicSummaryInfo | | |modifiedBy | |BTUserBasicSummaryInfo | | |projectId | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTTeamMemberParams ||Field Name||Required||Type||Description|| |email | |String | | |admin | |Boolean | | |teamId | |String | | h3. BTTeamParams ||Field Name||Required||Type||Description|| |name | |String | | |id | |String | | |description | |String | | |ownerType | |Integer | | |ownerId | |String | | h3. BTTeamSummaryInfo ||Field Name||Required||Type||Description|| |active | |Boolean | | |predefinedTeam | |Integer | | |owner | |BTOwnerInfo | | |treeHref | |String | | |resourceType | |String | | |isMutable | |Boolean | | |isContainer | |Boolean | | |canMove | |Boolean | | |hasPendingOwner | |Boolean | | |description | |String | | |isEnterpriseOwned | |Boolean | | |modifiedAt | |Date | | |createdAt | |Date | | |createdBy | |BTUserBasicSummaryInfo | | |modifiedBy | |BTUserBasicSummaryInfo | | |projectId | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTThumbnailInfo ||Field Name||Required||Type||Description|| |sizes | |array[BTThumbnailSizeInfo] | | |secondarySizes | |array[array[BTThumbnailSizeInfo]] | | |id | |String | | |href | |String | | h3. BTThumbnailSizeInfo ||Field Name||Required||Type||Description|| |size | |String | | |sheetName | |String | | |mediaType | |String | | |href | |String | | |uniqueId | |String | | |viewOrientation | |String | | |renderMode | |String | | h3. BTToolTreeParams ||Field Name||Required||Type||Description|| |context | |Integer | | |priority | |Integer | | |id | |String | | |active | |Boolean | | |namespace | |String | | |icon | |String | | |ownerType | |Integer | | |ownerId | |String | | |capability | |String | | |nodeType | |Integer | | |toolName | |String | | |tooltipKey | |String | | |expandedTooltipKey | |String | | |command | |String | | |commandDetails | |String | | |featureSpecName | |String | | |fsVersion | |Integer | | |useDynamicSnippet | |Boolean | | |useHistory | |Boolean | | |mini | |Boolean | | |collectionName | |String | | |iconInitials | |String | | |contextMenu | |String | | |isNewerVersionAvailable | |Boolean | | h3. BTToolTreeUpdateParams ||Field Name||Required||Type||Description|| |remove | |array[String] | | |save | |array[BTToolTreeParams] | | h3. BTTranslateFormatParams ||Field Name||Required||Type||Description|| |linkDocumentId | |String | | |configuration | |String | | |elementId | |String | | |linkDocumentWorkspaceId | |String | | |grouping | |Boolean | | |importInBackground | |Boolean | | |notifyUser | |Boolean | | |partIds | |String | | |triggerAutoDownload | |Boolean | | |connectionId | |String | | |storeInDocument | |Boolean | | |cloudStorageAccountId | |String | | |formatName | |String | | |cloudObjectId | |String | | |versionString | |String | | |sourceName | |String | | |destinationName | |String | | |flatten | |Boolean | | |includeExportIds | |Boolean | | |textAsGeometry | |Boolean | | |showOverriddenDimensions | |Boolean | | |currentSheetOnly | |Boolean | | |imageWidth | |Integer | | |imageHeight | |Integer | | |colorMethod | |String | | |splinesAsPolylines | |Boolean | | |selectablePdfText | |Boolean | | |foreignId | |String | | |uploadId | |String | | |projectId | |String | | |parentId | |String | | |updateExistingImportFeatures | |Boolean | | |blobMicroversionId | |String | | |originalForeignId | |String | | |blobElementId | |String | | |specifyUnits | |Boolean | | |splitAssembliesIntoMultipleDocuments | |Boolean | | |flattenAssemblies | |Boolean | | |getyAxisIsUp | |Boolean | | |allowFaultyParts | |Boolean | | |unit | |String | | h3. BTTranslateInternalParams ||Field Name||Required||Type||Description|| |modelScope | |BTDocumentScope | | |grouping | |Boolean | | |importInBackground | |Boolean | | |notifyUser | |Boolean | | |partIds | |String | | |triggerAutoDownload | |Boolean | | |connectionId | |String | | |storeInDocument | |Boolean | | |cloudStorageAccountId | |String | | |formatName | |String | | |cloudObjectId | |String | | |versionString | |String | | |sourceName | |String | | |destinationName | |String | | |flatten | |Boolean | | |includeExportIds | |Boolean | | |textAsGeometry | |Boolean | | |showOverriddenDimensions | |Boolean | | |currentSheetOnly | |Boolean | | |imageWidth | |Integer | | |imageHeight | |Integer | | |colorMethod | |String | | |splinesAsPolylines | |Boolean | | |selectablePdfText | |Boolean | | |foreignId | |String | | |uploadId | |String | | |projectId | |String | | |parentId | |String | | |updateExistingImportFeatures | |Boolean | | |blobMicroversionId | |String | | |originalForeignId | |String | | |blobElementId | |String | | |specifyUnits | |Boolean | | |splitAssembliesIntoMultipleDocuments | |Boolean | | |flattenAssemblies | |Boolean | | |getyAxisIsUp | |Boolean | | |allowFaultyParts | |Boolean | | |unit | |String | | h3. BTTranslationRequestInfo ||Field Name||Required||Type||Description|| |requestElementId | |String | | |requestState | |String | | |resultExternalDataIds | |array[String] | | |workspaceId | |String | | |resultElementIds | |array[String] | | |resultDocumentId | |String | | |failureReason | |String | | |resultWorkspaceId | |String | | |versionId | |String | | |documentId | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTUniqueDocumentItemParams ||Field Name||Required||Type||Description|| |revision | |String | | |partId | |String | | |elementType | |String | | |versionId | |String | | |documentId | |String | | |workspaceId | |String | | |elementId | |String | | |partNumber | |String | | |apiConfiguration | |String | | h3. BTUpdateDocumentThumbnailParams ||Field Name||Required||Type||Description|| |elementUpdateParams | |array[BTUpdateElementThumbnailParams] | | |elementParamsByWorkspace | |map[String, array[BTUpdateElementThumbnailParams]] | | |elementParamsByVersion | |map[String, array[BTUpdateElementThumbnailParams]] | | h3. BTUpdateElementThumbnailParams ||Field Name||Required||Type||Description|| |encodedConfigurationId | |String | | |versionId | |String | | |workspaceId | |String | | |elementId | |String | | h3. BTUpdateExternalReferenceParams ||Field Name||Required||Type||Description|| |description | |String | | |oldVersionIdToNewVersionId | |map[String, String] | | |oldVersionIdToNodeIds | |map[String, array[String]] | | |elementIds | |array[String] | | |autoUpdate | |Boolean | | h3. BTUpdateInContextParams ||Field Name||Required||Type||Description|| |microversionId | |BTMicroversionId | | |encodedContextConfiguration | |String | | |useLatestMicroversion | |Boolean | | |contextId | |String | | |description | |String | | h3. BTUpdateRbacRoleParams ||Field Name||Required||Type||Description|| |name | |String | | |description | |String | | h3. BTUpdateReferenceParams ||Field Name||Required||Type||Description|| |referenceUpdates | |array[UpdateParams] | | h3. BTUpdateReleasePackageParams ||Field Name||Required||Type||Description|| |properties | |array[BTPropertyValueParam] | | |itemIds | |array[String] | | |items | |array[BTReleasePackageItemParams] | | h3. BTUpdateVersionThumbnailParams ||Field Name||Required||Type||Description|| |versionIds | |array[BTIdAndConfiguration] | | |forceUpdate | |Boolean | | h3. BTUpgradeOnDemandParams ||Field Name||Required||Type||Description|| |notificationId | |String | | |targetVersion | |Integer | | |connectionId | |String | | h3. BTUploadParams ||Field Name||Required||Type||Description|| |name | |String | | |state | |String | | |documentName | |String | | |elementId | |String | | |cloudStorageAccountId | |String | | h3. BTUploadStateParams ||Field Name||Required||Type||Description|| |state | |String | | h3. BTUserActivationParams ||Field Name||Required||Type||Description|| |id | |String | | |password | |String | | |firstName | |String | | |lastName | |String | | |email | |String | | |defaultCompanyName | |String | | |role | |Integer | | |phoneNumber | |String | | h3. BTUserAgentVersion ||Field Name||Required||Type||Description|| |patchVersion | |Integer | | |majorVersion | |Integer | | |minorVersion | |Integer | | h3. BTUserAppSettingsInfo ||Field Name||Required||Type||Description|| |settings | |array[BTSettingInfo] | | h3. BTUserAppSettingsParams ||Field Name||Required||Type||Description|| |settings | |array[BTSettingParam] | | h3. BTUserBasicSummaryInfo ||Field Name||Required||Type||Description|| |state | |Integer | | |image | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTUserEmailParams ||Field Name||Required||Type||Description|| |password | |String | | |primary | |Boolean | | |userId | |String | | |email | |String | | h3. BTUserEmailVerifyParams ||Field Name||Required||Type||Description|| |userId | |String | | |email | |String | | |secret | |String | | |requestId | |String | | h3. BTUserNotificationPrefLevelsInfo ||Field Name||Required||Type||Description|| |levelsInfoList | |array[LevelInfo] | | h3. BTUserNotificationPrefParams ||Field Name||Required||Type||Description|| |type | |Integer | | |level | |Integer | | |objectType | |Integer | | |objectId | |String | | h3. BTUserParams ||Field Name||Required||Type||Description|| |name | |String | | |message | |String | | |id | |String | | |state | |Integer | | |password | |String | | |description | |String | | |source | |Integer | | |forumId | |String | | |token | |String | | |cadSystemAtSignup | |String | | |companyPlan | |Boolean | | |eulaAccepted | |Boolean | | |firstName | |String | | |lastName | |String | | |email | |String | | |defaultCompanyName | |String | | |planId | |String | | |seats | |Long | | |role | |Integer | | |countryCode | |String | | |phoneNumber | |String | | |recaptcha | |String | | |inviteFriendRequest | |Boolean | | |approveUser | |Boolean | | |upgradeToEducationPlan | |Boolean | | h3. BTUserSettingsParams ||Field Name||Required||Type||Description|| |value | |String | | |key | |String | | |id | |String | | |keyValues | |map[String, String] | | |substituteApprovers | |array[BTSubstituteApproverParams] | | h3. BTUserSummaryInfo ||Field Name||Required||Type||Description|| |source | |Integer | | |firstName | |String | | |lastName | |String | | |email | |String | | |isGuest | |Boolean | | |isLight | |Boolean | | |globalPermissions | |GlobalPermissionInfo | | |lastLoginTime | |Date | | |company | |BTCompanySummaryInfo | | |state | |Integer | | |image | |String | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTUserTotpParams ||Field Name||Required||Type||Description|| |id | |String | | |password | |String | | h3. BTUserUpdateParams ||Field Name||Required||Type||Description|| |name | |String | | |id | |String | | |description | |String | | |forumId | |String | | |firstName | |String | | |lastName | |String | | |defaultCompanyName | |String | | |countryCode | |String | | |oldPassword | |String | | |newPassword | |String | | |phoneNumber | |String | | h3. BTUserUpdateSpecsParams ||Field Name||Required||Type||Description|| |specSignatureToVersion | |map[String, String] | | h3. BTUserUsagesSummary ||Field Name||Required||Type||Description|| |ownerName | |String | | |ownerId | |String | | |ownerType | |String | | |count | |Long | | h3. BTUserWebPreferencesParams ||Field Name||Required||Type||Description|| |id | |String | | |userId | |String | | |preferenceName | |String | | |retinaDisplaySetting | |String | | h3. BTVector2d ||Field Name||Required||Type||Description|| |x | |Double | | |y | |Double | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTVector3d ||Field Name||Required||Type||Description|| |x | |Double | | |y | |Double | | |z | |Double | | |typeId | |Integer | | |exportTypeName | |String | | |connectionSource | |BTConnection | | |unknownClass | |Boolean | | h3. BTVersionInfo ||Field Name||Required||Type||Description|| |parent | |String | | |type | |String | | |description | |String | | |microversion | |String | | |creator | |BTUserBasicSummaryInfo | | |modifiedAt | |Date | | |documentId | |String | | |createdAt | |Date | | |lastModifier | |BTUserBasicSummaryInfo | | |thumbnail | |BTThumbnailInfo | | |overrideDate | |Date | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTVersionOrWorkspaceInfo ||Field Name||Required||Type||Description|| |id | |String | | |type | |String | | h3. BTVersionOrWorkspaceParams ||Field Name||Required||Type||Description|| |name | |String | | |description | |String | | |microversionId | |String | | |readOnly | |Boolean | | |isRelease | |Boolean | | |fromHistory | |Boolean | | |versionId | |String | | |documentId | |String | | |workspaceId | |String | | |clientInteractionMode | |String | | h3. BTViewDataInfo ||Field Name||Required||Type||Description|| |isPerspective | |Boolean | | |cameraViewport | |array[Double] | | |angle | |Double | | |viewMatrix | |array[Double] | | h3. BTViewDataParams ||Field Name||Required||Type||Description|| |isPerspective | |Boolean | | |cameraViewport | |array[Double] | | |angle | |Double | | |viewMatrix | |array[Double] | | h3. BTWebClientCapabilitiesParams ||Field Name||Required||Type||Description|| |oesStandardDerivativesUnderscore | |Boolean | | |vendor | |String | | |depthTexture | |Boolean | | |renderer | |String | | |angleInstancedArrays | |Boolean | | |extTextureFilterAnisotropic | |Boolean | | |oesElementIndexUint | |Boolean | | |oesTextureFloat | |Boolean | | |oesTextureFloatLinear | |Boolean | | |oesTextureHalfFloat | |Boolean | | |oesTextureHalfFloatLinear | |Boolean | | |oesVertexArrayObject | |Boolean | | |compressedTextureS3tc | |Boolean | | |drawBuffers | |Boolean | | |has3dMouse | |Boolean | | |screenWidth | |Integer | | |screenHeight | |Integer | | |devicePixelRatio | |Double | | h3. BTWebRendererPerformanceMeasurementParams ||Field Name||Required||Type||Description|| |vendor | |String | | |renderer | |String | | |trianglesPerSecond | |Float | | |linesPerSecond | |Float | | h3. BTWebhookOptions ||Field Name||Required||Type||Description|| |collapseEvents | |Boolean | | h3. BTWebhookParams ||Field Name||Required||Type||Description|| |id | |String | | |events | |array[String] | | |options | |BTWebhookOptions | | |data | |String | | |partId | |String | | |filter | |String | | |url | |String | | |userId | |String | | |versionId | |String | | |documentId | |String | | |companyId | |String | | |clientId | |String | | |workspaceId | |String | | |elementId | |String | | |projectId | |String | | |folderId | |String | | h3. BTWorkflowInfo ||Field Name||Required||Type||Description|| |actions | |array[BTActionInfo] | | |state | |BTWorkflowStateInfo | | |rejectedBy | |array[String] | | |isSetup | |Boolean | | |approvedBy | |array[String] | | |isFrozen | |Boolean | | |isInitialState | |Boolean | | |approverIds | |array[String] | | |notifierIds | |array[String] | | |workflowId | |String | | |isDiscarded | |Boolean | | |metadataState | |String | | h3. BTWorkflowStateInfo ||Field Name||Required||Type||Description|| |name | |String | | |value | |Integer | | |displayName | |String | | h3. BTWorkspaceInfo ||Field Name||Required||Type||Description|| |isReadOnly | |Boolean | | |canDelete | |Boolean | | |parent | |String | | |type | |String | | |description | |String | | |microversion | |String | | |creator | |BTUserBasicSummaryInfo | | |modifiedAt | |Date | | |documentId | |String | | |createdAt | |Date | | |lastModifier | |BTUserBasicSummaryInfo | | |thumbnail | |BTThumbnailInfo | | |parents | |array[BTVersionInfo] | | |overrideDate | |Date | | |name | |String | | |id | |String | | |href | |String | | |viewRef | |String | | h3. BTWorkspacePartParams ||Field Name||Required||Type||Description|| |name | |String | | |description | |String | | |revision | |String | | |customProperties | |array[BTNameValuePair] | | |vendor | |String | | |productLine | |String | | |title1 | |String | | |title2 | |String | | |title3 | |String | | |partId | |String | | |configuration | |String | | |elementId | |String | | |project | |String | | |connectionId | |String | | |material | |BTMaterialParams | | |partNumber | |String | | |appearance | |BTPartAppearanceParams | | |customPropertyDefinitions | |array[BTCustomPropertyDefinitionParams] | | |applyUpdateToAllConfigurations | |Boolean | | h3. BodyPart ||Field Name||Required||Type||Description|| |contentDisposition | |ContentDisposition | | |entity | |Object | | |headers | |BodyPart_headers | | |mediaType | |BodyPart_mediaType | | |messageBodyWorkers | |MessageBodyWorkers | | |parent | |MultiPart | | |providers | |Object | | |parameterizedHeaders | |BodyPart_headers | | h3. BodyPart_headers ||Field Name||Required||Type||Description|| |empty | |Boolean | | h3. BodyPart_mediaType ||Field Name||Required||Type||Description|| |type | |String | | |subtype | |String | | |parameters | |map[String, String] | | |wildcardType | |Boolean | | |wildcardSubtype | |Boolean | | h3. Callback ||Field Name||Required||Type||Description|| |extensions | |map[String, Object] | | |getDollarref | |String | | |empty | |Boolean | | h3. Card ||Field Name||Required||Type||Description|| |id | |String | | |object | |String | | |account | |String | | |customer | |String | | |metadata | |map[String, String] | | |addressCity | |String | | |addressCountry | |String | | |addressLine1 | |String | | |addressLine1Check | |String | | |addressLine2 | |String | | |addressState | |String | | |addressZip | |String | | |addressZipCheck | |String | | |availablePayoutMethods | |array[String] | | |brand | |String | | |country | |String | | |currency | |String | | |cvcCheck | |String | | |defaultForCurrency | |Boolean | | |dynamicLast4 | |String | | |expMonth | |Integer | | |expYear | |Integer | | |fingerprint | |String | | |funding | |String | | |last4 | |String | | |name | |String | | |recipient | |String | | |status | |String | | |threeDSecure | |ThreeDSecure | | |tokenizationMethod | |String | | |description | |String | | |iin | |String | | |issuer | |String | | |type | |String | | |instanceURL | |String | | h3. ClientLogEntry ||Field Name||Required||Type||Description|| |logger | |String | | |message | |String | | |level | |String | | |timestamp | |Long | | |url | |String | | h3. CloudObjectPathSegment ||Field Name||Required||Type||Description|| |cloudStorageProviderType | |Integer | | |cloudStorageAccountId | |String | | |name | |String | | |id | |String | | |treeHref | |String | | |resourceType | |String | | |subType | |Integer | | h3. Components ||Field Name||Required||Type||Description|| |schemas | |map[String, Schema] | | |responses | |map[String, ApiResponse] | | |parameters | |map[String, Parameter] | | |examples | |map[String, Example] | | |requestBodies | |map[String, RequestBody] | | |headers | |map[String, Header] | | |securitySchemes | |map[String, SecurityScheme] | | |links | |map[String, Link] | | |callbacks | |map[String, Callback] | | |extensions | |map[String, Object] | | h3. ConfigurationEntry ||Field Name||Required||Type||Description|| |parameterId | |String | | |parameterValue | |String | | h3. ConfigurationInfoEntry ||Field Name||Required||Type||Description|| |parameterDisplayValue | |String | | |explicit | |Boolean | | |parameterId | |String | | |parameterValue | |String | | |parameterName | |String | | h3. Contact ||Field Name||Required||Type||Description|| |name | |String | | |url | |String | | |email | |String | | |extensions | |map[String, Object] | | h3. Content ||Field Name||Required||Type||Description|| |empty | |Boolean | | h3. ContentDisposition ||Field Name||Required||Type||Description|| |type | |String | | |parameters | |map[String, String] | | |fileName | |String | | |creationDate | |Date | | |modificationDate | |Date | | |readDate | |Date | | |size | |Long | | h3. ContentItem ||Field Name||Required||Type||Description|| |link | |String | | |position | |String | | |width | |Integer | | |height | |Integer | | |title | |String | | |contentId | |String | | |itemTitle | |String | | |template | |String | | |thumbnail | |String | | |player | |String | | |pausePoints | |array[Double] | | |anchor | |String | | |verticalOffset | |Integer | | |horizontalOffset | |Integer | | h3. Coupon ||Field Name||Required||Type||Description|| |id | |String | | |object | |String | | |amountOff | |Long | | |created | |Long | | |currency | |String | | |duration | |String | | |durationInMonths | |Integer | | |livemode | |Boolean | | |maxRedemptions | |Long | | |metadata | |map[String, String] | | |percentOff | |Integer | | |redeemBy | |Long | | |timesRedeemed | |Integer | | |valid | |Boolean | | h3. Customer ||Field Name||Required||Type||Description|| |id | |String | | |object | |String | | |accountBalance | |Long | | |businessVatId | |String | | |created | |Long | | |currency | |String | | |defaultSource | |String | | |deleted | |Boolean | | |delinquent | |Boolean | | |description | |String | | |discount | |Discount | | |email | |String | | |livemode | |Boolean | | |metadata | |map[String, String] | | |shipping | |ShippingDetails | | |sources | |ExternalAccountCollection | | |subscriptions | |CustomerSubscriptionCollection | | |cards | |CustomerCardCollection | | |defaultCard | |String | | |nextRecurringCharge | |NextRecurringCharge | | |subscription | |Subscription | | |trialEnd | |Long | | |defaultSourceObject | |ExternalAccount | | h3. CustomerCardCollection ||Field Name||Required||Type||Description|| |data | |array[Card] | | |totalCount | |Integer | | |hasMore | |Boolean | | |requestOptions | |RequestOptions | | |requestParams | |map[String, Object] | | |url | |String | | |count | |Integer | | h3. CustomerSubscriptionCollection ||Field Name||Required||Type||Description|| |data | |array[Subscription] | | |totalCount | |Integer | | |hasMore | |Boolean | | |requestOptions | |RequestOptions | | |requestParams | |map[String, Object] | | |url | |String | | |count | |Integer | | h3. Definition ||Field Name||Required||Type||Description|| |name | |String | | |sortOrder | |Integer | | |description | |String | | |code | |Integer | | h3. Discount ||Field Name||Required||Type||Description|| |id | |String | | |object | |String | | |coupon | |Coupon | | |customer | |String | | |end | |Long | | |start | |Long | | |subscription | |String | | h3. Discriminator ||Field Name||Required||Type||Description|| |propertyName | |String | | |mapping | |map[String, String] | | h3. Encoding ||Field Name||Required||Type||Description|| |contentType | |String | | |headers | |map[String, Header] | | |style | |String | | |explode | |Boolean | | |allowReserved | |Boolean | | |extensions | |map[String, Object] | | h3. Entry ||Field Name||Required||Type||Description|| |permissionSet | |BTPermissionSet | | |role | |BTRbacRoleInfo | | h3. Example ||Field Name||Required||Type||Description|| |summary | |String | | |description | |String | | |value | |Object | | |externalValue | |String | | |getDollarref | |String | | |extensions | |map[String, Object] | | h3. ExternalAccount ||Field Name||Required||Type||Description|| |id | |String | | |object | |String | | |account | |String | | |customer | |String | | |metadata | |map[String, String] | | |instanceURL | |String | | h3. ExternalAccountCollection ||Field Name||Required||Type||Description|| |data | |array[ExternalAccount] | | |totalCount | |Integer | | |hasMore | |Boolean | | |requestOptions | |RequestOptions | | |requestParams | |map[String, Object] | | |url | |String | | |count | |Integer | | h3. ExternalDocumentation ||Field Name||Required||Type||Description|| |description | |String | | |url | |String | | |extensions | |map[String, Object] | | h3. FormDataBodyPart ||Field Name||Required||Type||Description|| |contentDisposition | |ContentDisposition | | |entity | |Object | | |headers | |BodyPart_headers | | |mediaType | |BodyPart_mediaType | | |messageBodyWorkers | |MessageBodyWorkers | | |parent | |MultiPart | | |providers | |Object | | |name | |String | | |value | |String | | |formDataContentDisposition | |FormDataContentDisposition | | |simple | |Boolean | | |parameterizedHeaders | |BodyPart_headers | | h3. FormDataContentDisposition ||Field Name||Required||Type||Description|| |type | |String | | |parameters | |map[String, String] | | |fileName | |String | | |creationDate | |Date | | |modificationDate | |Date | | |readDate | |Date | | |size | |Long | | |name | |String | | h3. FormDataMultiPart ||Field Name||Required||Type||Description|| |contentDisposition | |ContentDisposition | | |entity | |Object | | |headers | |BodyPart_headers | | |mediaType | |BodyPart_mediaType | | |messageBodyWorkers | |MessageBodyWorkers | | |parent | |MultiPart | | |providers | |Object | | |bodyParts | |array[BodyPart] | | |fields | |map[String, array[FormDataBodyPart]] | | |parameterizedHeaders | |BodyPart_headers | | h3. GlobalPermissionInfo ||Field Name||Required||Type||Description|| |accessReports | |Boolean | | |createProject | |Boolean | | |approveReleases | |Boolean | | |createReleases | |Boolean | | |shareForAnonymousAccess | |Boolean | | |manageRbac | |Boolean | | |manageUsers | |Boolean | | |manageGuestUsers | |Boolean | | |deletePermanently | |Boolean | | |adminEnterprise | |Boolean | | h3. Header ||Field Name||Required||Type||Description|| |description | |String | | |getDollarref | |String | | |required | |Boolean | | |deprecated | |Boolean | | |style | |String | | |explode | |Boolean | | |schema | |Schema | | |examples | |map[String, Example] | | |example | |Object | | |extensions | |map[String, Object] | | h3. Info ||Field Name||Required||Type||Description|| |title | |String | | |description | |String | | |termsOfService | |String | | |contact | |Contact | | |license | |License | | |version | |String | | |extensions | |map[String, Object] | | h3. Item ||Field Name||Required||Type||Description|| |id | |String | | h3. JsonNode ||Field Name||Required||Type||Description|| |array | |Boolean | | |null | |Boolean | | |float | |Boolean | | |textual | |Boolean | | |nodeType | |String | | |object | |Boolean | | |valueNode | |Boolean | | |containerNode | |Boolean | | |missingNode | |Boolean | | |pojo | |Boolean | | |number | |Boolean | | |integralNumber | |Boolean | | |floatingPointNumber | |Boolean | | |short | |Boolean | | |int | |Boolean | | |long | |Boolean | | |double | |Boolean | | |bigDecimal | |Boolean | | |bigInteger | |Boolean | | |boolean | |Boolean | | |binary | |Boolean | | h3. LevelInfo ||Field Name||Required||Type||Description|| |name | |String | | |index | |Integer | | |description | |String | | h3. License ||Field Name||Required||Type||Description|| |name | |String | | |url | |String | | |extensions | |map[String, Object] | | h3. Link ||Field Name||Required||Type||Description|| |operationRef | |String | | |operationId | |String | | |parameters | |map[String, String] | | |requestBody | |Object | | |headers | |map[String, Header] | | |description | |String | | |getDollarref | |String | | |extensions | |map[String, Object] | | |server | |Server | | h3. MediaType ||Field Name||Required||Type||Description|| |schema | |Schema | | |examples | |map[String, Example] | | |example | |Object | | |encoding | |map[String, Encoding] | | |extensions | |map[String, Object] | | h3. Message ||Field Name||Required||Type||Description|| |id | |String | | |defaultTitle | |String | | |defaultTemplate | |String | | |messageLevel | |String | | h3. MessageBodyWorkers ||Field Name||Required||Type||Description|| h3. MultiPart ||Field Name||Required||Type||Description|| |contentDisposition | |ContentDisposition | | |entity | |Object | | |headers | |BodyPart_headers | | |mediaType | |BodyPart_mediaType | | |messageBodyWorkers | |MessageBodyWorkers | | |parent | |MultiPart | | |providers | |Object | | |bodyParts | |array[BodyPart] | | |parameterizedHeaders | |BodyPart_headers | | h3. NextCharge ||Field Name||Required||Type||Description|| |total | |Long | | |interval | |String | | |amount | |Long | | |currentPeriodEnd | |Date | | h3. NextRecurringCharge ||Field Name||Required||Type||Description|| |amount | |Long | | |date | |String | | h3. OAuthFlow ||Field Name||Required||Type||Description|| |authorizationUrl | |String | | |tokenUrl | |String | | |refreshUrl | |String | | |scopes | |OAuthFlow_scopes | | |extensions | |map[String, Object] | | h3. OAuthFlow_scopes ||Field Name||Required||Type||Description|| |extensions | |map[String, Object] | | |empty | |Boolean | | h3. OAuthFlows ||Field Name||Required||Type||Description|| |implicit | |OAuthFlow | | |password | |OAuthFlow | | |clientCredentials | |OAuthFlow | | |authorizationCode | |OAuthFlow | | |extensions | |map[String, Object] | | h3. OpenAPI ||Field Name||Required||Type||Description|| |openapi | |String | | |info | |Info | | |externalDocs | |ExternalDocumentation | | |servers | |array[Server] | | |security | |array[SecurityRequirement] | | |tags | |array[Tag] | | |paths | |OAuthFlow_scopes | | |components | |Components | | |extensions | |map[String, Object] | | h3. Operation ||Field Name||Required||Type||Description|| |tags | |array[String] | | |summary | |String | | |description | |String | | |externalDocs | |ExternalDocumentation | | |operationId | |String | | |parameters | |array[Parameter] | | |requestBody | |RequestBody | | |responses | |Operation_responses | | |callbacks | |map[String, Callback] | | |deprecated | |Boolean | | |security | |array[SecurityRequirement] | | |servers | |array[Server] | | |extensions | |map[String, Object] | | h3. Operation_responses ||Field Name||Required||Type||Description|| |extensions | |map[String, Object] | | |default | |ApiResponse | | |empty | |Boolean | | h3. Parameter ||Field Name||Required||Type||Description|| |name | |String | | |in | |String | | |description | |String | | |required | |Boolean | | |deprecated | |Boolean | | |allowEmptyValue | |Boolean | | |getDollarref | |String | | |style | |String | | |explode | |Boolean | | |allowReserved | |Boolean | | |schema | |Schema | | |examples | |map[String, Example] | | |example | |Object | | |content | |BodyPart_headers | | |extensions | |map[String, Object] | | h3. ParameterizedHeader ||Field Name||Required||Type||Description|| |value | |String | | |parameters | |map[String, String] | | h3. PathItem ||Field Name||Required||Type||Description|| |summary | |String | | |description | |String | | |get | |Operation | | |put | |Operation | | |post | |Operation | | |delete | |Operation | | |options | |Operation | | |head | |Operation | | |patch | |Operation | | |trace | |Operation | | |servers | |array[Server] | | |parameters | |array[Parameter] | | |getDollarref | |String | | |extensions | |map[String, Object] | | h3. PathSegment ||Field Name||Required||Type||Description|| |name | |String | | |id | |String | | |treeHref | |String | | |resourceType | |String | | |subType | |Integer | | h3. Paths ||Field Name||Required||Type||Description|| |extensions | |map[String, Object] | | |empty | |Boolean | | h3. Plan ||Field Name||Required||Type||Description|| |id | |String | | |object | |String | | |amount | |Long | | |created | |Long | | |currency | |String | | |interval | |String | | |intervalCount | |Integer | | |livemode | |Boolean | | |metadata | |map[String, String] | | |name | |String | | |statementDescriptor | |String | | |trialPeriodDays | |Integer | | |statementDescription | |String | | h3. ProratedCharges ||Field Name||Required||Type||Description|| |description | |String | | |date | |Date | | |amount | |Long | | h3. RequestBody ||Field Name||Required||Type||Description|| |description | |String | | |content | |BodyPart_headers | | |required | |Boolean | | |extensions | |map[String, Object] | | |getDollarref | |String | | h3. RequestOptions ||Field Name||Required||Type||Description|| |apiKey | |String | | |stripeVersion | |String | | |idempotencyKey | |String | | |stripeAccount | |String | | |connectTimeout | |Integer | | |readTimeout | |Integer | | h3. RoleMapEntry ||Field Name||Required||Type||Description|| |identities | |array[BTIdentityInfo] | | |role | |BTRbacRoleInfo | | h3. Schema ||Field Name||Required||Type||Description|| |title | |String | | |multipleOf | |BigDecimal | | |maximum | |BigDecimal | | |exclusiveMaximum | |Boolean | | |minimum | |BigDecimal | | |exclusiveMinimum | |Boolean | | |maxLength | |Integer | | |minLength | |Integer | | |pattern | |String | | |maxItems | |Integer | | |minItems | |Integer | | |uniqueItems | |Boolean | | |maxProperties | |Integer | | |minProperties | |Integer | | |required | |array[String] | | |type | |String | | |not | |Schema | | |properties | |map[String, Schema] | | |default | |Object | | |description | |String | | |format | |String | | |getDollarref | |String | | |nullable | |Boolean | | |readOnly | |Boolean | | |writeOnly | |Boolean | | |externalDocs | |ExternalDocumentation | | |deprecated | |Boolean | | |xml | |XML | | |extensions | |map[String, Object] | | |discriminator | |Discriminator | | |enum | |array[Object] | | h3. Scopes ||Field Name||Required||Type||Description|| |extensions | |map[String, Object] | | |empty | |Boolean | | h3. SecurityRequirement ||Field Name||Required||Type||Description|| |empty | |Boolean | | h3. SecurityScheme ||Field Name||Required||Type||Description|| |type | |String | | |description | |String | | |name | |String | | |getDollarref | |String | | |in | |String | | |scheme | |String | | |bearerFormat | |String | | |flows | |OAuthFlows | | |openIdConnectUrl | |String | | |extensions | |map[String, Object] | | h3. Server ||Field Name||Required||Type||Description|| |url | |String | | |description | |String | | |variables | |OAuthFlow_scopes | | |extensions | |map[String, Object] | | h3. ServerVariable ||Field Name||Required||Type||Description|| |description | |String | | |extensions | |map[String, Object] | | |default | |String | | |enum | |array[String] | | h3. ServerVariables ||Field Name||Required||Type||Description|| |extensions | |map[String, Object] | | |empty | |Boolean | | h3. ShippingDetails ||Field Name||Required||Type||Description|| |address | |Address | | |name | |String | | |phone | |String | | h3. Subscription ||Field Name||Required||Type||Description|| |id | |String | | |object | |String | | |applicationFeePercent | |Double | | |billing | |String | | |cancelAtPeriodEnd | |Boolean | | |canceledAt | |Long | | |created | |Long | | |currentPeriodEnd | |Long | | |currentPeriodStart | |Long | | |customer | |String | | |daysUntilDue | |Integer | | |discount | |Discount | | |endedAt | |Long | | |metadata | |map[String, String] | | |plan | |Plan | | |quantity | |Integer | | |start | |Long | | |status | |String | | |taxPercent | |Double | | |trialEnd | |Long | | |trialStart | |Long | | |customerObject | |Customer | | |subscriptionItems | |SubscriptionItemCollection | | h3. SubscriptionItem ||Field Name||Required||Type||Description|| |id | |String | | |object | |String | | |created | |Long | | |plan | |Plan | | |quantity | |Integer | | h3. SubscriptionItemCollection ||Field Name||Required||Type||Description|| |data | |array[SubscriptionItem] | | |totalCount | |Integer | | |hasMore | |Boolean | | |requestOptions | |RequestOptions | | |requestParams | |map[String, Object] | | |url | |String | | |count | |Integer | | h3. Tag ||Field Name||Required||Type||Description|| |name | |String | | |description | |String | | |externalDocs | |ExternalDocumentation | | |extensions | |map[String, Object] | | h3. ThreeDSecure ||Field Name||Required||Type||Description|| |id | |String | | |object | |String | | |amount | |Long | | |authenticated | |Boolean | | |card | |Card | | |created | |Long | | |currency | |String | | |livemode | |Boolean | | |redirectURL | |String | | |status | |String | | h3. TransformGroup ||Field Name||Required||Type||Description|| |instances | |array[BTAssemblyInstanceDefinitionParams] | | |transform | |array[Double] | | h3. UpdateParams ||Field Name||Required||Type||Description|| |idsToUpdate | |array[String] | | |fromReference | |BTUniqueDocumentItemParams | | |toReference | |BTUniqueDocumentItemParams | | h3. VersionSpecs ||Field Name||Required||Type||Description|| |versionId | |String | | |versionName | |String | | h3. XML ||Field Name||Required||Type||Description|| |name | |String | | |namespace | |String | | |prefix | |String | | |attribute | |Boolean | | |wrapped | |Boolean | | |extensions | |map[String, Object] | |