Złącze OnShape

Konektor OnShape

Integracja Tulip z OnShape

Wprowadzenie

Interfejs API REST Onshape umożliwia użytkownikom interakcję z Onshape, mając odpowiedni dostęp do ich odpowiednich kont Onshape. Celem tego konektora jest integracja Tulip z Onshape przy użyciu konektorów HTTP i zapewnienie naszym klientom gotowego konektora, który można zaimportować do ich instancji.

Cel

Zamierzamy wyróżnić różne funkcje łączników, które można zbudować, wykonując wywołania HTTP do interfejsu API REST Onshape w celu interakcji z systemem Onshape, aby zaprezentować różne akcje odczytu i zapisu w Onshape, które można wykorzystać w różnych przypadkach użycia.

API Doc

[Przegląd API Onshape](https://onshape-public.github.io/docs/apioverview/

uwierzytelnianie)

Wymagania wstępne

1. Utwórz konto w Onshape i skonfiguruj poświadczenia OAuth2.
2. Zarejestruj API z wymaganymi zakresami w Onshape.

Szczegóły połączenia Tulip

Następujące informacje muszą zostać skonfigurowane w Tulip's

Konektory.

1. Uruchomione: Host Cloud Connector
2. Host: cad.onshape.com
3. Port:443
4. TLS: Tak

OAuth 2: Uwierzytelnianie zostanie przeniesione do wszystkich

funkcji Connector

Funkcje łącznika

Pobierz wszystkie dokumenty

Cel

Ten konektor pobiera wszystkie dokumenty z obszaru roboczego Onshape użytkownika.

Punkt końcowy

Wywołanie HTTP GET do punktu końcowego: https://cad.onshape.com:443/api/documents

Wymagane dane wejściowe

Dane wejściowe nie są wymagane

Wymagane dane wyjściowe Extractor

1. Identyfikator dokumentu: Unikalny identyfikator dokumentu, który będzie używany do wykonywania innych zadań.
2. Document Name: Wyświetlana nazwa dokumentu.
3. Workspace ID: Unikalny identyfikator obszaru roboczego dokumentu, który będzie używany do wykonywania innych zadań.
4. Dodatkowe parametry zwracane wraz z odpowiedzią są częścią parametrów wyjściowych.

Pobierz wszystkie elementy określonego dokumentu

Cel

Ten łącznik pobiera wszystkie elementy określonego dokumentu, przekazując wymagane dane wejściowe.

Punkt końcowy

Wywołanie HTTP GET do punktu końcowego: https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements

Wymagane dane wejściowe

Poniżej przedstawiono parametry adresu URL, które należy przekazać

1. Identyfikator dokumentu
2. Identyfikator obszaru roboczego

Wymagane dane wyjściowe Extractor

1. Element ID: Unikalny identyfikator elementu, który będzie używany do wykonywania innych zadań.
2. Nazwa elementu: Wyświetlana nazwa elementu.
3. Element Type: Typ elementu.
4. Dodatkowe parametry zwracane wraz z odpowiedzią są dołączane jako część parametrów wyjściowych.

Pobierz właściwości elementu

Cel

Ten łącznik pobiera wszystkie właściwości elementu określonego typu elementu części dokumentu.

Punkt końcowy

Wywołanie HTTP GET do punktu końcowego: https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements?elementType={ElementType}&elementId={ElementID}

Wymagane dane wejściowe

Poniżej przedstawiono parametry adresu URL, które należy przekazać

1. Identyfikator dokumentu
2. Identyfikator obszaru roboczego
3. Identyfikator elementu
4. Typ elementu

Wymagany ekstraktor danych wyjściowych

1. Identyfikator elementu: Unikalny identyfikator elementu, który będzie używany do wykonywania innych zadań.
2. Nazwa elementu: Wyświetlana nazwa elementu.
3. Element Type: Typ elementu.
4. Dodatkowe parametry zwracane wraz z odpowiedzią są dołączane jako część parametrów wyjściowych.

Get Part Studio Body Details

Cel

Ten łącznik pobierze wszystkie szczegóły ciała elementu Part Studio określonego dokumentu, przekazując wymagane dane wejściowe.

Punkt końcowy

Wywołanie HTTP GET do punktu końcowego: https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bodydetails

Wymagane dane wejściowe

Poniżej przedstawiono parametry adresu URL, które należy przekazać

1. Identyfikator dokumentu
2. Identyfikator obszaru roboczego
3. Identyfikator elementu

Wymagane dane wyjściowe Extractor

1. Body ID: Unikalny identyfikator Body, który będzie używany do wykonywania innych zadań.
2. Body Type: Typ elementu Body.
3. Dodatkowe parametry zwracane wraz z odpowiedzią są uwzględniane jako część parametrów wyjściowych.

Get Part Studio Bounding Boxes

Cel

Ten łącznik pobiera wszystkie obwiednie elementu Part Studio określonego dokumentu, przekazując wymagane dane wejściowe.

Punkt końcowy

Wywołanie HTTP GET do punktu końcowego: https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes

Wymagane dane wejściowe

Poniżej przedstawiono parametry adresu URL, które należy przekazać

1. Identyfikator dokumentu
2. Identyfikator obszaru roboczego
3. Identyfikator elementu

Wymagane wyjście Extractor

1. Low X: Wartość lowX.
2. Low Y: Wartość lowY.
3. Low Z: Wartość lowZ.
4. High X: Wartość highX.
5. High Y: Wartość highY.
6. High Z: Wartość highZ.

Pobieranie metadanych pojedynczej części

Cel

Ten łącznik pobiera metadane pojedynczej części elementu Part Studio określonego dokumentu, przekazując wymagane dane wejściowe.

Punkt końcowy

Wywołanie HTTP GET do punktu końcowego: https://cad.onshape.com:443/api/metadata/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/p/{PartID}

Wymagane dane wejściowe

Poniżej przedstawiono parametry adresu URL, które należy przekazać

1. Identyfikator dokumentu
2. Identyfikator obszaru roboczego
3. Identyfikator elementu
4. Identyfikator części

Wymagany ekstraktor danych wyjściowych

1. Identyfikator części: Unikalny identyfikator części, która będzie używana do wykonywania innych zadań.
2. Part Type: Typ części.
3. Dodatkowe parametry zwracane wraz z odpowiedzią są uwzględniane jako część parametrów wyjściowych.

Get Assembly Definition

Cel

Ten łącznik pobiera definicję zespołu elementu Assembly określonego dokumentu, przekazując wymagane dane wejściowe.

Punkt końcowy

Wywołanie HTTP GET do punktu końcowego: https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}

Wymagane dane wejściowe

Poniżej przedstawiono parametry adresu URL, które należy przekazać

1. Identyfikator dokumentu
2. Identyfikator obszaru roboczego
3. Identyfikator elementu

Wymagane dane wyjściowe Extractor

1. Instance ID: Unikalny identyfikator instancji, która będzie używana do wykonywania innych zadań.
2. Instance Name: Nazwa wystąpienia.
3. Dodatkowe parametry zwracane wraz z odpowiedzią są uwzględniane jako część parametrów wyjściowych.

Get Bounding Boxes of an Assembly

Cel

Ten łącznik pobiera wszystkie obwiednie elementu Assembly określonego dokumentu, przekazując wymagane dane wejściowe.

Punkt końcowy

Wywołanie HTTP GET do punktu końcowego: https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes

Wymagane dane wejściowe

Poniżej przedstawiono parametry adresu URL, które należy przekazać

1. Identyfikator dokumentu
2. Identyfikator obszaru roboczego
3. Identyfikator elementu

Wymagane wyjście Extractor

1. Low X: Wartość lowX.
2. Low Y: Wartość lowY.
3. Low Z: Wartość lowZ.
4. High X: Wartość highX.
5. High Y: Wartość highY.
6. High Z: Wartość highZ.

Get Assembly Bill of Materials

Cel

Ten łącznik pobiera zestawienie materiałów elementu Assembly określonego dokumentu, przekazując wymagane dane wejściowe.

Punkt końcowy

Wywołanie HTTP GET do punktu końcowego https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bom

Wymagane dane wejściowe

Poniżej przedstawiono parametry adresu URL, które należy przekazać

1. Identyfikator dokumentu
2. Identyfikator obszaru roboczego
3. Identyfikator elementu

Wymagane dane wyjściowe Extractor

1. Bill Material ID: Unikalny identyfikator tabeli Bill of Material.
2. Bill Material Name: Nazwa tabeli Bill of Material.
3. Bill Material Type: Typ tabeli Bill of Material.
4. Dodatkowe parametry zwracane wraz z odpowiedzią są dołączane jako część parametrów wyjściowych.