OnShape csatlakozó

OnShape csatlakozó

A Tulip és az OnShape integrálása

Bevezetés

Az Onshape REST API-ja lehetővé teszi, hogy a felhasználók interakcióba léphessenek az Onshape-pal, ha megfelelő hozzáféréssel rendelkeznek a megfelelő Onshape-fiókjukhoz. Ennek a csatlakozónak az a célja, hogy a Tulipot a HTTP-csatlakozók segítségével integrálja az Onshape-be, és ügyfeleinknek egy olyan out of box csatlakozót biztosítson, amelyet be lehet importálni a példányukba.

Cél

Különböző csatlakozó funkciókat fogunk kiemelni, amelyek az Onshape REST API HTTP-hívások végrehajtásával építhetők az Onshape rendszerrel való interakcióhoz, hogy bemutassuk a különböző olvasási és írási műveleteket az Onshape-en, amelyeket különböző felhasználási esetekben lehet kihasználni.

API-dokumentum

Onshape API áttekintés

hitelesítés)

Előfeltételek

1. Hozzon létre egy fiókot az Onshape-en és konfigurálja az OAuth2 hitelesítő adatokat.
2. Regisztrálja az API-t a szükséges hatókörökkel az Onshape-ben.

Tulip kapcsolat részletei

A következő információkat kellene konfigurálni a Tulipban

Csatlakozók.

1. Futtatás: Cloud Connector Host
2. Host: cad.onshape.com
3. Port: 443
4. TLS: Igen

OAuth 2: A hitelesítés átvitelre kerül az összes

a csatlakozó funkcióira

Csatlakozó funkciók

Minden dokumentum lekérése

Cél

Ez a csatlakozó lekérdezi a felhasználó Onshape munkaterületén található összes dokumentumot.

Végpont

HTTP GET hívás a következő végpontra: https://cad.onshape.com:443/api/documents

Szükséges bemenet

Nincs szükség bemenetre

Kötelező kimenet Extractor

1. Dokumentum azonosító: A dokumentum egyedi azonosítója, amely a többi feladat elvégzéséhez használatos.
2. Dokumentum neve: A dokumentum megjelenített neve.
3. Munkaterület azonosítója: A dokumentum munkaterületének egyedi azonosítója, amelyet a többi feladat elvégzéséhez használnak.
4. A válasszal együtt visszaküldött további paraméterek a kimeneti paraméterek részeként szerepelnek.

Egy adott dokumentum összes elemének lekérdezése

Cél

Ez a csatlakozó egy adott dokumentum összes elemét lekérdezi a szükséges bemenetek átadásával.

Végpont

HTTP GET hívás a következő végpontra: https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements.

Kötelező bemenet

A következő URL-paramétereket kell átadni

1. Dokumentum azonosítója
2. Munkaterület azonosítója

Kötelező kimenet Extractor

1. Elemazonosító: Az Elem egyedi azonosítója, amelyet a többi feladat végrehajtásához használunk.
2. Elem neve: Az Elem megjelenített neve.
3. Elemtípus: Az Elem típusa.
4. A válasszal együtt visszaküldött további paraméterek a kimeneti paraméterek részeként szerepelnek.

Elemtulajdonságok lekérdezése

Cél

Ez a csatlakozó a dokumentum egy adott elemtípusú részének összes elemtulajdonságát lekérdezi.

Végpont

HTTP GET hívás a végpontra: https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements?elementType={ElementType}&elementId={ElementID}

Kötelező bemenet

A következő URL-paramétereket kell átadni

1. Dokumentum azonosítója
2. Munkatér ID
3. Elem azonosítója
4. Elem típusa

Kötelező kimeneti kivonat

1. Elemazonosító: A többi feladat elvégzéséhez használt elem egyedi azonosítója.
2. Elem neve: Az Elem megjelenített neve.
3. Elemtípus: Az Elem típusa.
4. A válasszal együtt visszaküldött további paraméterek a kimeneti paraméterek részeként szerepelnek.

Részstúdió testének részleteinek lekérdezése

Cél

Ez a csatlakozó egy adott dokumentum Part Studio elemének összes testadatát lekérdezi a szükséges bemenetek átadásával.

Végpont

HTTP GET hívás a következő végpontra: https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bodydetails.

Kötelező bemenet

A következő URL paramétereket kell átadni

1. Dokumentum azonosítója
2. Munkatér ID
3. Elem azonosítója

Kötelező kimenet Extractor

1. Testazonosító: A többi feladat elvégzéséhez használt Test egyedi azonosítója.
2. Test típusa: A rész testtípusa.
3. A válasszal együtt visszaküldött további paraméterek a kimeneti paraméterek részeként szerepelnek.

Part Studio Bounding Boxes lekérdezése

Cél

Ez a csatlakozó egy adott dokumentum Part Studio elemének összes határoló dobozát lekérdezi a szükséges bemenetek átadásával.

Végpont

HTTP GET hívás a következő végpontra: https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes

Kötelező bemenet

A következő URL paramétereket kell átadni

1. Dokumentum azonosítója
2. Munkatér ID
3. Elem azonosítója

Kötelező kimenet Extractor

1. Alacsony X: LowX értéke.
2. Low Y: A lowY értéke.
3. Low Z: A lowZ értéke.
4. High X: HighX értéke.
5. High Y: A highY értéke.
6. High Z: A highZ értéke.

Egyedi alkatrész metaadatainak lekérdezése

Cél

Ez a csatlakozó a szükséges bemeneti adatok megadásával egy adott dokumentum Part Studio elemének egy egyedi részének metaadatát hívja le.

Végpont

HTTP GET hívás a következő végponthoz: https://cad.onshape.com:443/api/metadata/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/p/{PartID}

Kötelező bemenet

Az alábbi URL paramétereket kell átadni

1. Dokumentum azonosítója
2. Munkatér ID
3. Elem azonosítója
4. Rész azonosítója

Kötelező kimeneti kivonatoló

1. Rész ID: A többi feladat elvégzéséhez használt rész egyedi azonosítója.
2. Rész típusa: A rész típusa.
3. A válasszal együtt visszaküldött további paraméterek a kimeneti paraméterek részeként szerepelnek.

Szerelvénydefiníció lekérdezése

Cél

Ez a csatlakozó a szükséges bemenetek átadásával egy adott dokumentum egy Assembly elemének összeállítási definícióját kéri le.

Végpont

HTTP GET hívás a következő végpontra: https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}

Kötelező bemenet

A következő URL-paramétereket kell átadni

1. Dokumentum azonosítója
2. Munkaterület azonosítója
3. Elem azonosítója

Kötelező kimenet Extractor

1. Instance ID: Az Instance egyedi azonosítója, amely a többi feladat elvégzéséhez használatos.
2. Példány neve: Az instancia neve.
3. A válasszal együtt visszaküldött további paraméterek a kimeneti paraméterek részeként szerepelnek.

Egy összeállítás határoló dobozainak lekérdezése

Cél

Ez a csatlakozó a szükséges bemeneti adatok megadásával egy adott dokumentum Assembly elemének összes határoló dobozát lekérdezi.

Végpont

HTTP GET hívás a következő végpontra: https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes

Szükséges bemenet

A következő URL paramétereket kell átadni

1. Dokumentum azonosítója
2. Munkatér ID
3. Elem azonosítója

Kötelező kimenet Extractor

1. Alacsony X: LowX értéke.
2. Low Y: A lowY értéke.
3. Low Z: A lowZ értéke.
4. High X: HighX értéke.
5. High Y: A highY értéke.
6. High Z: A highZ értéke.

Összeszerelési anyagjegyzék lekérése

Cél

Ez a csatlakozó a szükséges bemeneti adatok megadásával egy adott dokumentum Assembly elemének anyagjegyzékét kéri le.

Végpont

HTTP GET hívás a https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bom végpontra.

Szükséges bemenet

A következő URL paramétereket kell átadni

1. Dokumentum azonosítója
2. Munkaterület azonosítója
3. Elem azonosítója

Kötelező kimenet Extractor

1. Bill Material ID: Az anyagjegyzék táblázat egyedi azonosítója.
2. Bill Material Name: A Bill of Material tábla neve.
3. Bill Material Type: A Bill of Material tábla típusa.
4. A válasszal együtt visszaküldött további paraméterek a kimeneti paraméterek részeként szerepelnek.