OnShape Verbinder

OnShape Verbinder

Integration von Tulip mit OnShape

Einführung

Die REST-API von Onshape ermöglicht es den Benutzern, mit Onshape zu interagieren, wenn sie den richtigen Zugang zu ihren jeweiligen Onshape-Konten haben. Das Ziel dieses Konnektors ist es, Tulip mit Onshape unter Verwendung von HTTP-Konnektoren zu integrieren und unseren Kunden einen sofort einsatzbereiten Konnektor zu bieten, der in ihre Instanz importiert werden kann.

Zweck

Wir werden verschiedene Konnektor-Funktionen hervorheben, die durch HTTP-Aufrufe an die Onshape REST API erstellt werden können, um mit dem Onshape-System zu interagieren und verschiedene Lese- und Schreibaktionen auf Onshape zu zeigen, die für verschiedene Anwendungsfälle genutzt werden können.

API-Dokument

[Onshape API Übersicht](https://onshape-public.github.io/docs/apioverview/

Authentifizierung)

Vorraussetzungen

1. Erstellen Sie ein Konto bei Onshape und konfigurieren Sie die OAuth2-Anmeldedaten.
2. Registrieren Sie API mit den erforderlichen Bereichen in Onshape.

Tulip-Verbindungsdetails

Die folgenden Informationen müssen in Tulip's konfiguriert werden

Konnektoren.

1. Läuft auf: Cloud Connector Host
2. Rechner: cad.onshape.com
3. Anschluss:443
4. TLS: Ja

OAuth 2: Die Authentifizierung wird an alle

die Connector-Funktionen

Konnektor-Funktionen

Alle Dokumente abrufen

Zweck

Dieser Connector ruft alle Dokumente im Onshape-Arbeitsbereich eines Benutzers ab.

Endpunkt

HTTP GET-Aufruf an den Endpunkt: https://cad.onshape.com:443/api/documents

Erforderliche Eingabe

Keine Eingaben erforderlich

Erforderlicher Output Extraktor

1. Dokument-ID: Eindeutiger Bezeichner des Dokuments, der für die Ausführung der anderen Aufgaben verwendet wird.
2. Dokument-Name: Der Anzeigename des Dokuments.
3. Workspace ID: Eindeutiger Bezeichner des Dokument-Arbeitsbereichs, der für die Ausführung der anderen Aufgaben verwendet wird.
4. Zusätzliche Parameter, die mit der Antwort zurückgegeben werden, sind in den Ausgabeparametern enthalten.

Alle Elemente eines bestimmten Dokuments abrufen

Zweck

Mit diesem Konnektor werden alle Elemente eines bestimmten Dokuments abgerufen, indem die erforderlichen Eingaben übergeben werden.

Endpunkt

HTTP-GET-Aufruf an den Endpunkt: https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements

Erforderliche Eingaben

Die folgenden URL-Parameter sind zu übergeben

1. Dokument-ID
2. Arbeitsbereich-ID

Erforderliche Ausgabe Extraktor

1. Element-ID: Eindeutiger Bezeichner des Elements, der für die Ausführung der anderen Aufgaben verwendet wird.
2. Element-Name: Der Anzeigename des Elements.
3. Element-Typ: Der Typ des Elements.
4. Zusätzliche Parameter, die mit der Antwort zurückgegeben werden, sind in den Ausgabeparametern enthalten.

Element-Eigenschaften abrufen

Zweck

Dieser Konnektor ruft alle Elementeigenschaften eines bestimmten Elementtyps in einem Dokument ab.

Endpunkt

HTTP-GET-Aufruf an den Endpunkt: https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements?elementType={ElementType}&elementId={ElementID}

Erforderliche Eingaben

Die folgenden URL-Parameter sind zu übergeben

1. Dokument-ID
2. Arbeitsbereich-ID
3. Element-ID
4. Element-Typ

Erforderlicher Output-Extraktor

1. Element-ID: Eindeutiger Bezeichner des Elements, der für die Ausführung der anderen Aufgaben verwendet wird.
2. Element-Name: Der Anzeigename des Elements.
3. Element-Typ: Der Typ des Elements.
4. Zusätzliche Parameter, die mit der Antwort zurückgegeben werden, sind in den Ausgabeparametern enthalten.

Get Part Studio Body Details

Zweck

Dieser Konnektor ruft alle Body-Details eines Part Studio-Elements eines bestimmten Dokuments ab, indem er die erforderlichen Eingaben übergibt.

Endpunkt

HTTP GET-Aufruf an den Endpunkt: https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bodydetails

Erforderliche Eingaben

Die folgenden URL-Parameter sind zu übergeben

1. Dokument-ID
2. Arbeitsbereich-ID
3. Element-ID

Erforderlicher Output-Extraktor

1. Body-ID: Eindeutiger Bezeichner des Bodys, der für die Ausführung der anderen Aufgaben verwendet wird.
2. Körper-Typ: Der Body-Typ des Teils.
3. Zusätzliche Parameter, die mit der Antwort zurückgegeben werden, sind in den Ausgabeparametern enthalten.

Part Studio Bounding Boxes abrufen

Zweck

Dieser Konnektor ruft alle Bounding Boxes eines Part Studio-Elements eines bestimmten Dokuments ab, indem er die erforderlichen Eingaben übergibt.

Endpunkt

HTTP GET-Aufruf an den Endpunkt: https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes

Erforderliche Eingabe

Die folgenden URL-Parameter sind zu übergeben

1. Dokument-ID
2. Arbeitsbereich-ID
3. Element-ID

Erforderlicher Output Extraktor

1. Niedrig X: Wert von lowX.
2. Low Y: Wert von lowY.
3. Niedrig Z: Wert von niedrig Z.
4. Hoch X: Wert von highX.
5. Hoch Y: Wert von hochY.
6. Hoch Z: Wert von hochZ.

Metadaten eines einzelnen Teils abrufen

Zweck

Dieser Konnektor ruft die Metadaten eines einzelnen Teils eines Part Studio-Elements eines bestimmten Dokuments ab, indem er die erforderlichen Eingaben übergibt.

Endpunkt

HTTP GET-Aufruf an den Endpunkt: https://cad.onshape.com:443/api/metadata/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/p/{PartID}

Erforderliche Eingabe

Die folgenden URL-Parameter sind zu übergeben

1. Dokument-ID
2. Arbeitsbereich-ID
3. Element-ID
4. Teil-ID

Erforderlicher Output-Extraktor

1. Teil-ID: Eindeutiger Bezeichner des Teils, der für die Ausführung der anderen Aufgaben verwendet wird.
2. Teil-Typ: Der Teiltyp.
3. Zusätzliche Parameter, die mit der Antwort zurückgegeben werden, sind in den Ausgabeparametern enthalten.

Baugruppen-Definition abrufen

Zweck

Dieser Konnektor ruft die Assembly-Definition eines Assembly-Elements eines bestimmten Dokuments ab, indem er die erforderlichen Eingaben übergibt.

Endpunkt

HTTP GET-Aufruf an den Endpunkt: https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}

Erforderliche Eingaben

Die folgenden URL-Parameter sind zu übergeben

1. Dokument-ID
2. Arbeitsbereich-ID
3. Element-ID

Erforderlicher Output-Extraktor

1. Instanz-ID: Eindeutiger Bezeichner der Instanz, die für die Ausführung der anderen Aufgaben verwendet wird.
2. Instanz-Name: Der Name der Instanz.
3. Zusätzliche Parameter, die mit der Antwort zurückgegeben werden, sind in den Ausgabeparametern enthalten.

Bounding Boxes einer Baugruppe abrufen

Zweck

Dieser Konnektor ruft alle Bounding Boxes eines Assembly-Elements eines bestimmten Dokuments ab, indem er die erforderlichen Eingaben übergibt.

Endpunkt

HTTP GET-Aufruf an den Endpunkt: https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes

Erforderliche Eingabe

Die folgenden URL-Parameter sind zu übergeben

1. Dokument-ID
2. Arbeitsbereich-ID
3. Element-ID

Erforderlicher Output Extraktor

1. Niedrig X: Wert von lowX.
2. Low Y: Wert von lowY.
3. Niedrig Z: Wert von niedrig Z.
4. Hoch X: Wert von highX.
5. Hoch Y: Wert von hochY.
6. Hoch Z: Wert von hochZ.

Get Assembly Bill of Materials

Zweck

Dieser Konnektor ruft die Stückliste eines Baugruppenelements eines bestimmten Dokuments ab, indem er die erforderlichen Eingaben übergibt.

Endpunkt

HTTP GET-Aufruf an den Endpunkt https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bom

Erforderliche Eingaben

Die folgenden URL-Parameter sind zu übergeben

1. Dokument-ID
2. Arbeitsbereich-ID
3. Element-ID

Erforderlicher Output-Extraktor

1. Bill Material ID: Eindeutiger Bezeichner der Bill of Material Tabelle.
2. Name des Stücklistenmaterials: Der Name der Tabelle Bill of Material.
3. Stückliste Materialtyp: Der Typ der Bill of Material-Tabelle.
4. Zusätzliche Parameter, die mit der Antwort zurückgegeben werden, sind in den Ausgabeparametern enthalten.