Connettore OnShape

Connettore OnShape

Integrazione di Tulip con OnShape

Introduzione

L'API REST di Onshape consente agli utenti di interagire con Onshape avendo il giusto accesso impostato sui rispettivi account Onshape. L'obiettivo di questo connettore è integrare Tulip con Onshape utilizzando i connettori HTTP e fornire ai nostri clienti un connettore pronto all'uso che possa essere importato nella loro istanza.

Scopo

Verranno evidenziate le diverse funzioni del connettore che possono essere costruite effettuando chiamate HTTP all'API REST di Onshape per interagire con il sistema Onshape e mostrare varie azioni di lettura e scrittura su Onshape che potrebbero essere sfruttate per vari casi d'uso.

Documento API

[Panoramica dell'API di Onshape](https://onshape-public.github.io/docs/apioverview/

autenticazione)

Prerequisiti

1. Creare un account su Onshape e configurare le credenziali OAuth2.
2. Registrare l'API con gli ambiti richiesti in Onshape.

Dettagli della connessione Tulip

È necessario configurare le seguenti informazioni su Tulip

Connettori.

1. In esecuzione su: Host del connettore cloud
2. Host: cad.onshape.com
3. Porta: 443
4. TLS: Sì

OAuth 2: l'autenticazione verrà trasferita a tutte le

le funzioni del connettore

Funzioni del connettore

Ottieni tutti i documenti

Scopo

Questo connettore recupera tutti i documenti presenti nell'area di lavoro Onshape di un utente.

Punto finale

Chiamata HTTP GET all'endpoint: https://cad.onshape.com:443/api/documents

Input richiesti

Nessun input richiesto

Estrattore di output richiesto

1. ID documento: Identificatore univoco del documento che verrà utilizzato per eseguire gli altri compiti.
2. Nome del documento: Il nome visualizzato del documento.
3. ID spazio di lavoro: identificatore univoco dello spazio di lavoro del documento che verrà utilizzato per eseguire le altre operazioni.
4. I parametri aggiuntivi restituiti con la risposta sono inclusi nei parametri di output.

Ottenere tutti gli elementi di un documento specifico

Scopo

Questo connettore recupera tutti gli elementi di un documento specifico passando gli input richiesti.

Punto finale

Chiamata HTTP GET all'endpoint: https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elementi

Input richiesti

I parametri URL da passare sono i seguenti

1. ID documento
2. ID spazio di lavoro

Estrattore di output richiesto

1. ID elemento: Identificatore univoco dell'elemento che verrà utilizzato per eseguire gli altri compiti.
2. Nome elemento: Il nome visualizzato dell'elemento.
3. Tipo di elemento: Il tipo di elemento.
4. I parametri aggiuntivi restituiti con la risposta sono inclusi nei parametri di output.

Ottenere le proprietà dell'elemento

Scopo

Questo connettore recupera tutte le proprietà di un elemento specifico di un tipo di documento.

Punto finale

Chiamata HTTP GET all'endpoint: https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements?elementType={ElementType}&elementId={ElementID}

Input richiesti

I parametri URL da passare sono i seguenti

1. ID documento
2. ID spazio di lavoro
3. ID elemento
4. Tipo di elemento

Estrattore di output richiesto

1. ID elemento: Identificatore univoco dell'elemento che verrà utilizzato per eseguire gli altri compiti.
2. Nome elemento: Il nome visualizzato dell'elemento.
3. Tipo di elemento: Il tipo di elemento.
4. I parametri aggiuntivi che vengono restituiti con la risposta sono inclusi come parte dei parametri di output.

Ottieni dettagli del corpo dello studio di parti

Scopo

Questo connettore recupera tutti i dettagli del corpo di un elemento Part Studio di un documento specifico passando gli input richiesti.

Punto finale

Chiamata HTTP GET all'endpoint: https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bodydetails

Input richiesti

I parametri URL da passare sono i seguenti

1. ID documento
2. ID spazio di lavoro
3. ID elemento

Estrattore di output richiesto

1. ID corpo: Identificatore univoco del corpo che verrà utilizzato per eseguire gli altri compiti.
2. Tipo di corpo: Il tipo di corpo della parte.
3. I parametri aggiuntivi che vengono restituiti con la risposta sono inclusi come parte dei parametri di output.

Ottenere i riquadri di delimitazione dello studio di parti

Scopo

Questo connettore recupera tutti i riquadri di delimitazione di un elemento Part Studio di un documento specifico passando gli input richiesti.

Punto finale

Chiamata HTTP GET all'endpoint: https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes

Input richiesti

I parametri URL da passare sono i seguenti

1. ID documento
2. ID spazio di lavoro
3. ID elemento

Estrattore di output richiesto

1. Basso X: Valore di lowX.
2. Low Y: valore di lowY.
3. Low Z: valore di lowZ.
4. Alto X: Valore di highX.
5. Alto Y: valore di altoY.
6. Alto Z: valore di altoZ.

Ottenere i metadati di una singola parte

Scopo

Questo connettore recupera i metadati di una singola parte di un elemento Part Studio di un documento specifico passando gli input richiesti.

Punto finale

Chiamata HTTP GET all'endpoint: https://cad.onshape.com:443/api/metadata/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/p/{PartID}

Input richiesti

I parametri URL da passare sono i seguenti

1. ID documento
2. ID spazio di lavoro
3. ID elemento
4. ID parte

Estrattore di output richiesto

1. ID parte: Identificatore univoco della parte che verrà utilizzata per eseguire gli altri compiti.
2. Tipo di parte: Il tipo di parte.
3. I parametri aggiuntivi che vengono restituiti con la risposta sono inclusi come parte dei parametri di output.

Ottieni definizione di assieme

Scopo

Questo connettore recupera la definizione di assieme di un elemento Assembly di un documento specifico passando gli input richiesti.

Punto finale

Chiamata HTTP GET all'endpoint: https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}

Input richiesti

I parametri URL da passare sono i seguenti

1. ID documento
2. ID spazio di lavoro
3. ID elemento

Estrattore di output richiesto

1. ID istanza: identificatore univoco dell'istanza che verrà utilizzata per eseguire gli altri compiti.
2. Nome istanza: Il nome dell'istanza.
3. I parametri aggiuntivi che vengono restituiti con la risposta sono inclusi come parte dei parametri di output.

Ottenere i rettangoli di selezione di un assieme

Scopo

Questo connettore recupera tutti i riquadri di delimitazione di un elemento Assembly di un documento specifico, passando gli input richiesti.

Punto finale

Chiamata HTTP GET all'endpoint: https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes

Input richiesti

I parametri URL da passare sono i seguenti

1. ID documento
2. ID spazio di lavoro
3. ID elemento

Estrattore di output richiesto

1. Basso X: Valore di lowX.
2. Low Y: valore di lowY.
3. Low Z: valore di lowZ.
4. Alto X: Valore di highX.
5. Alto Y: valore di altoY.
6. Alto Z: valore di altoZ.

Ottenere la distinta base dell'assemblaggio

Scopo

Questo connettore recupera la distinta base di un elemento Assembly di un documento specifico passando gli input richiesti.

Punto finale

Chiamata HTTP GET all'endpoint https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bom

Input richiesti

I parametri URL da passare sono i seguenti

1. ID documento
2. ID spazio di lavoro
3. ID elemento

Estrattore di output richiesto

1. ID distinta materiali: identificatore univoco della tabella della distinta materiali.
2. Nome della distinta materiali: Nome della tabella della distinta materiali.
3. Tipo di materiale della distinta: Il tipo di tabella della distinta materiali.
4. I parametri aggiuntivi restituiti con la risposta sono inclusi nei parametri di output.