onshape-clients/cwiki/confluence-markup.txt

The meta package for creating the various Onshape clients

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