OnShape 커넥터
Tulip과 OnShape 통합
소개
Onshape의 REST API를 사용하면 사용자가 각자의 Onshape 계정에 대한 올바른 액세스 권한을 가지고 Onshape와 상호 작용할 수 있습니다. 이 커넥터의 목표는 HTTP 커넥터를 사용하여 Tulip과 Onshape를 통합하고 고객에게 인스턴스로 가져올 수 있는 즉시 사용 가능한 커넥터를 제공하는 것입니다.
목적
다양한 사용 사례에 활용할 수 있는 온쉐이프에 대한 다양한 읽기 및 쓰기 작업을 보여주기 위해 온쉐이프 REST API에 대한 HTTP 호출을 수행하여 온쉐이프 시스템과 상호 작용할 수 있는 다양한 커넥터 기능을 강조할 것입니다.
API 문서
[Onshape API 개요](https://onshape-public.github.io/docs/apioverview/
인증)
사전 요구 사항
- Onshape에서 계정을 만들고 OAuth2 자격 증명을 구성합니다.
- Onshape에서 필요한 범위로 API를 등록합니다.
튤립 연결 세부 정보
Tulip의 다음 정보를 구성해야 합니다.
커넥터.
- 실행 대상: 클라우드 커넥터 호스트
- 호스트: cad.onshape.com
- 포트: 443
- TLS: 예
OAuth 2: 인증이 모든
커넥터 기능
커넥터 함수
모든 문서 가져오기
목적
이 커넥터는 사용자 온셰이프 워크스페이스의 모든 문서를 가져옵니다.
엔드포인트
엔드포인트에 대한 HTTP GET 호출: https://cad.onshape.com:443/api/documents
필수 입력
입력이 필요하지 않습니다.
필수 출력 추출기
- 문서 ID: 다른 작업을 수행하는 데 사용되는 문서의 고유 식별자입니다.
- 문서 이름: 문서의 표시 이름입니다.
- 워크스페이스 ID: 다른 작업을 수행하는 데 사용되는 문서 워크스페이스의 고유 식별자입니다.
- 응답과 함께 반환되는 추가 매개변수는 출력 매개변수의 일부로 포함됩니다.
특정 문서의 모든 요소 가져오기
목적
이 커넥터는 필요한 입력을 전달하여 특정 문서의 모든 요소를 가져옵니다.
엔드포인트
엔드포인트에 대한 HTTP GET 호출: https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements
필수 입력
전달할 URL 매개변수는 다음과 같습니다.
- 문서 ID
- 워크스페이스 ID
필수 출력 추출기
- 요소 ID: 다른 작업을 수행하는 데 사용되는 요소의 고유 식별자입니다.
- 요소 이름: 요소의 표시 이름입니다.
- 요소 유형: 요소 유형: 요소의 유형입니다.
- 응답과 함께 반환되는 추가 매개변수는 출력 매개변수의 일부로 포함됩니다.
요소 속성 가져오기
목적
이 커넥터는 문서의 특정 엘리먼트 유형 부분의 모든 엘리먼트 속성을 가져옵니다.
엔드포인트
엔드포인트에 대한 HTTP GET 호출: https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements?elementType={ElementType}&elementId={ElementID}
필수 입력
전달할 URL 매개 변수는 다음과 같습니다.
- 문서 ID
- 워크스페이스 ID
- 요소 ID
- 요소 유형
필수 출력 추출기
- 요소 ID: 다른 작업을 수행하는 데 사용되는 요소의 고유 식별자입니다.
- 요소 이름: 요소의 표시 이름입니다.
- 요소 유형: 요소 유형: 요소의 유형입니다.
- 응답과 함께 반환되는 추가 파라미터는 출력 파라미터의 일부로 포함됩니다.
파트 스튜디오 본체 세부 정보 가져오기
목적
이 커넥터는 필요한 입력을 전달하여 특정 문서의 파트 스튜디오 요소의 모든 본문 세부 정보를 가져옵니다.
엔드포인트
엔드포인트에 대한 HTTP GET 호출: https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bodydetails
필수 입력
전달할 URL 매개변수는 다음과 같습니다.
- 문서 ID
- 워크스페이스 ID
- 요소 ID
필수 출력 추출기
- 본문 ID: 다른 작업을 수행하는 데 사용되는 본문의 고유 식별자입니다.
- 바디 유형: 파트 바디 유형입니다.
- 응답과 함께 반환되는 추가 파라미터는 출력 파라미터의 일부로 포함됩니다.
파트 스튜디오 바운딩 박스 가져오기
목적
이 커넥터는 필요한 입력을 전달하여 특정 문서의 파트 스튜디오 요소의 모든 바운딩 박스를 가져옵니다.
엔드포인트
엔드포인트에 대한 HTTP GET 호출: https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes
필수 입력
전달할 URL 매개변수는 다음과 같습니다.
- 문서 ID
- 워크스페이스 ID
- 요소 ID
필수 출력 추출기
- 낮은 X: 낮은 X의 값입니다.
- Low Y: lowY의 값입니다.
- Low Z: lowZ의 값입니다.
- High X: 높은 X의 값입니다.
- High Y: highY의 값입니다.
- High Z: highZ의 값입니다.
개별 파트의 메타데이터 가져오기
목적
이 커넥터는 필요한 입력을 전달하여 특정 문서의 파트 스튜디오 요소에 있는 개별 파트의 메타데이터를 가져옵니다.
엔드포인트
엔드포인트에 대한 HTTP GET 호출: https://cad.onshape.com:443/api/metadata/d/{문서ID}/w/{워크스페이스ID}/e/{요소ID}/p/{PartID}
필수 입력
전달할 URL 매개변수는 다음과 같습니다.
- 문서 ID
- 워크스페이스 ID
- 요소 ID
- 파트 ID
필수 출력 추출기
- 파트 ID: 다른 작업을 수행하는 데 사용되는 파트의 고유 식별자입니다.
- 파트 유형: 부품 유형: 부품 유형입니다.
- 응답과 함께 반환되는 추가 파라미터는 출력 파라미터의 일부로 포함됩니다.
어셈블리 정의 가져오기
목적
이 커넥터는 필요한 입력을 전달하여 특정 문서의 어셈블리 요소에 대한 어셈블리 정의를 가져옵니다.
엔드포인트
엔드포인트에 대한 HTTP GET 호출: https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}
필수 입력
전달해야 하는 URL 매개변수는 다음과 같습니다.
- 문서 ID
- 워크스페이스 ID
- 요소 ID
필수 출력 추출기
- 인스턴스 ID: 다른 작업을 수행하는 데 사용되는 인스턴스의 고유 식별자입니다.
- 인스턴스 이름: 인스턴스 이름입니다.
- 응답과 함께 반환되는 추가 매개 변수는 출력 매개 변수의 일부로 포함됩니다.
어셈블리의 바운딩 박스 가져오기
목적
이 커넥터는 필요한 입력을 전달하여 특정 문서의 어셈블리 요소의 모든 바운딩 박스를 가져옵니다.
엔드포인트
엔드포인트에 대한 HTTP GET 호출: https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes
필수 입력
전달할 URL 매개변수는 다음과 같습니다.
- 문서 ID
- 워크스페이스 ID
- 요소 ID
필수 출력 추출기
- 낮은 X: 낮은 X의 값입니다.
- Low Y: lowY의 값입니다.
- Low Z: lowZ의 값입니다.
- High X: 높은 X의 값입니다.
- High Y: highY의 값입니다.
- High Z: highZ의 값입니다.
어셈블리 자재 명세서 가져오기
목적
이 커넥터는 필요한 입력을 전달하여 특정 문서의 어셈블리 요소의 자재 명세서를 가져옵니다.
엔드포인트
엔드포인트 https://cad.onshape.com:443/api/assemblies/d/{도큐먼트ID}/w/{워크스페이스ID}/e/{엘리먼트ID}/bom에 대한 HTTP GET 호출
필수 입력
전달해야 하는 URL 매개변수는 다음과 같습니다.
- 문서 ID
- 워크스페이스 ID
- 요소 ID
필수 출력 추출기
- Bill Material ID: 자재 명세서 테이블의 고유 식별자입니다.
- 자재 명세서 이름: 자재 명세서 테이블 이름입니다.
- 자재 명세서 유형: BOM 테이블 유형입니다.
- 응답과 함께 반환되는 추가 매개변수는 출력 매개변수의 일부로 포함됩니다.