"Create and transform assembly instances" post request example

connor_holjes

Can anyone post an example of the body for this? Just looking to insert a part into an assembly with some given translation and rotation...

Jake_Rosenfeld

Hi @connor_holjes

Currently, assembly transformations mustn't change the geometry of the part being inserted/transformed.  For this reason, certain affine transforms (e.g. shears, reflections)  are not valid assembly transforms.  If you want a mirrored version of your part, you would have to mirror it in the part studio, and then insert that into the assembly.

Sorry for the trouble; if you would like to see this functionality implemented please vote on this improvement request:
https://forum.onshape.com/discussion/5763/mirror-feature-for-assembly-workflow

mark_noyes

The configuration query parameter value is an encoded configuration string. If you don't already have this as the output of another API call you can get one by calling the POST /api/elements/d/:did/e/:eid/configurationencodings API.  Before calling that you probably need to call the GET /api/partstudios/d/:did/w/:wid/e/:eid/configuration API in order to determine the correct id values to use. 

As an example, I just created a simple part studio configuration with one input with valid values Smaller (originally with the name "Default") and Bigger. I call the get configuration API and it tells me that there is one configuration parameter:

 {
            "type": 105,
            "typeName": "BTMConfigurationParameterEnum",
            "message": {
                "enumName": "List_KAziYCON7D1YBU_conf",
                "options": [
                    {
                        "type": 592,
                        "typeName": "BTMEnumOption",
                        "message": {
                            "option": "Default",
                            "optionName": "Smaller"
                        }
                    },
                    {
                        "type": 592,
                        "typeName": "BTMEnumOption",
                        "message": {
                            "option": "Bigger",
                            "optionName": "Bigger"
                        }
                    }
                ],
                "defaultValue": "Default",
                "parameterId": "List_KAziYCON7D1YBU",
                "parameterName": "Configuration"
            }
        }

 Suppose I want what the user sees as Configuration=Smaller. I need to specify id values rather than name values to the configurationencodings API, so I will use parameterId="List_KAziYCON7D1YBU" and parameterValue="Default".

I can then call the configurationencodings API passing the body:

<div>{ "parameters": [</div><div>&nbsp; { "parameterId": "List_KAziYCON7D1YBU",</div><div>&nbsp; &nbsp;"parameterValue": "Default" }</div><div>&nbsp; ]</div><div>}</div>

and it returns the response:

<pre>{</pre><pre>    "encodedId": "List_KAziYCON7D1YBU=Default"</pre><pre>}</pre>

So correct configuration string to pass to the insert and transform instance API is "List_KAziYCON7D1YBU=Default".

connor_holjes

Made some progress, was able to get the partId inserted into the assembly, looks like at the origin. If I try and do a translation though I get this error:

{
    "moreInfoUrl": "",
    "message": "Provided transform matrix is not a rigid rotation.",
    "status": 400,
    "code": 9999
}

connor_holjes

Okay more progress... so I am using the 4x4 translation matrix but I get the same error as before if I try and do a reflection...?
   "transform": [

      -1,0,0,0,

      0,1,0,0,

      0,0,1,0,

      0,0,0,1

   ]

Jake_Rosenfeld

Hi @connor_holjes

Currently, assembly transformations mustn't change the geometry of the part being inserted/transformed.  For this reason, certain affine transforms (e.g. shears, reflections)  are not valid assembly transforms.  If you want a mirrored version of your part, you would have to mirror it in the part studio, and then insert that into the assembly.

Sorry for the trouble; if you would like to see this functionality implemented please vote on this improvement request:
https://forum.onshape.com/discussion/5763/mirror-feature-for-assembly-workflow

connor_holjes

Okay! Another question. How Can I specify the configuration. Does not seem to be changing the part?

connor_holjes

{

   "transformGroups": [{

   "transform": [0, -1, 0, 2, 1, 0, 0, 2, 0, 0, 1, 0, 0, 0, 0, 1],

   "instances": [{

      "partId": "XXX",

      "configuration": "24",

      "documentId": "asdjsdu0a9doasnasdasdas",

      "elementId": "aasoidua332asdsdasda"

   }]

}],

"microversionId": ""

}

"24" is the name of my configuration but it keeps inserting the "Default"

mark_noyes

The configuration query parameter value is an encoded configuration string. If you don't already have this as the output of another API call you can get one by calling the POST /api/elements/d/:did/e/:eid/configurationencodings API.  Before calling that you probably need to call the GET /api/partstudios/d/:did/w/:wid/e/:eid/configuration API in order to determine the correct id values to use. 

As an example, I just created a simple part studio configuration with one input with valid values Smaller (originally with the name "Default") and Bigger. I call the get configuration API and it tells me that there is one configuration parameter:

 {
            "type": 105,
            "typeName": "BTMConfigurationParameterEnum",
            "message": {
                "enumName": "List_KAziYCON7D1YBU_conf",
                "options": [
                    {
                        "type": 592,
                        "typeName": "BTMEnumOption",
                        "message": {
                            "option": "Default",
                            "optionName": "Smaller"
                        }
                    },
                    {
                        "type": 592,
                        "typeName": "BTMEnumOption",
                        "message": {
                            "option": "Bigger",
                            "optionName": "Bigger"
                        }
                    }
                ],
                "defaultValue": "Default",
                "parameterId": "List_KAziYCON7D1YBU",
                "parameterName": "Configuration"
            }
        }

 Suppose I want what the user sees as Configuration=Smaller. I need to specify id values rather than name values to the configurationencodings API, so I will use parameterId="List_KAziYCON7D1YBU" and parameterValue="Default".

I can then call the configurationencodings API passing the body:

<div>{ "parameters": [</div><div>&nbsp; { "parameterId": "List_KAziYCON7D1YBU",</div><div>&nbsp; &nbsp;"parameterValue": "Default" }</div><div>&nbsp; ]</div><div>}</div>

and it returns the response:

<pre>{</pre><pre>    "encodedId": "List_KAziYCON7D1YBU=Default"</pre><pre>}</pre>

So correct configuration string to pass to the insert and transform instance API is "List_KAziYCON7D1YBU=Default".

connor_holjes

Very helpful thank you! Just to clarify, is the configurationencodings API 'encoding' anything or is it just concatenating the parmaId and the paramVal? Just want to avoid making another request if that is all that is happening.

mark_noyes

In many cases it is simple and you could easily form the configuration string yourself, as you suspect. With multiple inputs the inputs also need a ';' separator. Things get trickier if the values contain any non-alpha-numeric characters and there is some additional encoding that gets done. Therefore, we do recommend that you use the API to avoid surprises.