オンシェイプ・コネクター

OnShapeコネクタ

チューリップとOnShapeの統合

はじめに

OnshapeのREST APIにより、ユーザーはOnshapeアカウントに設定された適切なアクセス権を使ってOnshapeとやり取りすることができます。このコネクタの目的は、HTTPコネクタを使用してOnshapeとTulipを統合し、インスタンスにインポートできるすぐに使えるコネクタをお客様に提供することです。

目的

Onshape REST APIをHTTPコールしてOnshapeシステムと対話することで、さまざまなユースケースに活用できるOnshape上のさまざまな読み取りと書き込みのアクションを紹介します。

APIドキュメント

[オンシェイプAPI概要](https://onshape-public.github.io/docs/apioverview/

認証)

前提条件

1. Onshapeでアカウントを作成し、OAuth2認証情報を設定します。
2. Onshapeに必要なスコープでAPIを登録します。

チューリップ接続の詳細

以下の情報をTulipで設定する必要があります。

コネクタ

1. 実行中: クラウドコネクタホスト
2. ホスト：cad.onshape.com
3. ポート:443
4. TLS: はい

OAuth 2: 認証はすべての

コネクタ機能

コネクタ機能

すべてのドキュメントを取得

目的

このコネクタは、ユーザーのOnshapeワークスペース内のすべてのドキュメントを取得します。

エンドポイント

エンドポイントへの HTTP GET コール： https://cad.onshape.com:443/api/documents

必要な入力

入力不要

必要な出力 Extractor

1. ドキュメントID：他のタスクを実行するために使用されるドキュメントの一意識別子。
2. Document Name（ドキュメント名）：文書の表示名。
3. Workspace ID ： 他の タ ス ク を実行す る ために用い ら れ る 文書 ワ ー ク スペース の一意な識別子。
4. レスポンスとともに返される追加パラメータは、出力パラメータの一部として含まれる。

特定のドキュメントの全要素を取得する

目的

このコネクタは、必要な入力を渡すことで、特定のドキュメントのすべての要素を取得します。

エンドポイント

エンドポイントへの HTTP GET コール： https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements

必須入力

渡される URL パラメータは以下のとおりです。

1. ドキュメントID
2. ワークスペースID

必須出力 抽出子

1. 要素ID：他のタスクを実行するために使用される要素の一意の識別子。
2. 要素名：要素の表示名。
3. 要素タイプ：要素のタイプ。
4. レスポンスとともに返される追加パラメータは、出力パラメータの一部として含まれます。

要素のプロパティの取得

目的

このコネクタは、ドキュメントの特定の要素タイプ部分のすべての要素プロパティをフェッチします。

エンドポイント

https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements?elementType={ElementType}&elementId={ElementID} エンドポイントへの HTTP GET 呼び出し。

必須入力

渡されるURLパラメータは以下の通り。

1. ドキュメントID
2. ワークスペースID
3. 要素ID
4. 要素タイプ

必須 出力エクストラクタ

1. 要素ID：他のタスクを実行するために使用される要素の一意の識別子。
2. 要素名：要素の表示名。
3. 要素タイプ：要素のタイプ。
4. レスポンスとともに返される追加パラメータは、出力パラメータの一部として含まれます。

パートスタジオボディの詳細の取得

目的

このコネクタは、必要な入力を渡すことで、特定のドキュメントのパートスタジオ要素のすべてのボディの詳細をフェッチします。

エンドポイント

エンドポイントへの HTTP GET コール： https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bodydetails

必須入力

渡すべきURLパラメータは以下の通りである。

1. ドキュメントID
2. ワークスペースID
3. 要素ID

必要な出力エクストラクタ

1. ボディID：他のタスクを実行するために使用されるBodyの一意識別子。
2. ボディタイプ：パートボディのタイプ。
3. レスポンスと共に返される追加パラメータは、出力パラメータの一部として含まれます。

パートスタジオバウンディングボックスの取得

目的

このコネクタは、必要な入力を渡すことで、特定のドキュメントのパートスタジオ要素のすべてのバウンディングボックスをフェッチします。

エンドポイント

エンドポイントへの HTTP GET 呼び出し： https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes

必須入力

渡すべきURLパラメータは以下の通り。

1. ドキュメントID
2. ワークスペースID
3. 要素ID

必須出力 Extractor

1. 低X：lowX の値。
2. Low Y：lowYの値。
3. Low Z: lowZ の値。
4. High X：高Xの値。
5. High Y：highYの値。
6. High Z：highZの値。

個々の部品のメタデータを取得する

目的

このコネクタは、必要な入力を渡すことで、特定のドキュメントのパートスタジオ要素の個々のパートのメタデータをフェッチします。

エンドポイント

エンドポイントへの HTTP GET 呼び出し： https://cad.onshape.com:443/api/metadata/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/p/{PartID}

必須入力

渡されるURLパラメータは以下の通り。

1. ドキュメントID
2. ワークスペースID
3. 要素ID
4. パートID

必要な出力エクストラクタ

1. パートID：他のタスクを実行するために使用されるパートの一意の識別子。
2. Part Type（パートタイプ）：パートタイプ。
3. レスポンスとともに返される追加パラメータは、出力パラメータの一部として含まれる。

アセンブリ定義の取得

目的

このコネクタは、必要な入力を渡すことで、特定のドキュメントのアセンブリ要素のアセンブリ定義をフェッチします。

エンドポイント

エンドポイントへの HTTP GET 呼び出し： https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}

必須入力

渡される URL パラメータは以下のとおりです。

1. ドキュメントID
2. ワークスペースID
3. 要素 ID

必要な出力エクストラクタ

1. Instance ID：他のタスクの実行に使用されるインスタンスの一意の識別子。
2. インスタンス名：インスタンス名。
3. レスポンスとともに返される追加パラメータは、出力パラメータの一部として含まれます。

アセンブリのバウンディングボックスの取得

目的

このコネクタは、必要な入力を渡して、特定のドキュメントのアセンブリ要素のすべてのバウンディング・ボックスを取得します。

エンドポイント

エンドポイントへの HTTP GET コール： https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes

必須入力

渡すべきURLパラメータは以下の通り。

1. ドキュメントID
2. ワークスペースID
3. 要素ID

必須出力 Extractor

1. 低X：lowX の値。
2. Low Y：lowYの値。
3. Low Z: lowZ の値。
4. High X：高Xの値。
5. High Y：highYの値。
6. 高Z：高Zの値。

組立部品表の取得

目的

このコネクタは、必要な入力を渡すことにより、特定のドキュメントのアセンブリ要素の部品表をフェッチします。

エンドポイント

エンドポイントへの HTTP GET コール https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bom

必須入力

渡される URL パラメータは以下のとおりです。

1. ドキュメントID
2. ワークスペースID
3. 要素 ID

必須 出力エクストラクタ

1. 部品表ID：部品表テーブルの一意の識別子。
2. 部品表名：部品表名。
3. 部品表タイプ：部品表タイプ。
4. レスポンスと共に返される追加パラメータは、出力パラメータの一部として含まれます。