Conector OnShape

Conector OnShape

Integración de Tulip con OnShape

Introducción

La API REST de Onshape permite a los usuarios interactuar con Onshape teniendo el acceso adecuado a sus respectivas cuentas de Onshape. El objetivo de este conector es integrar Tulip con Onshape utilizando conectores HTTP y proporcionar a nuestros clientes un conector listo para usar que puede ser importado en su instancia.

Propósito

Vamos a destacar diferentes funciones del conector que se puede construir haciendo llamadas HTTP a Onshape REST API para interactuar con el sistema Onshape para mostrar varias acciones de lectura y escritura en el Onshape que podría ser aprovechado para diversos casos de uso.

Documento API

[Descripción general de la API de Onshape](https://onshape-public.github.io/docs/apioverview/

autenticación)

Requisitos previos

1. Crear una cuenta en Onshape y configurar las credenciales OAuth2.
2. Registro de la API con los ámbitos necesarios en Onshape.

Detalles de la conexión Tulip

La siguiente información necesitaría ser configurada en Tulip's

Conectores.

1. Ejecutando en: Cloud Connector Host
2. Host: cad.onshape.com
3. Puerto:443
4. TLS: Sí

OAuth 2: La autenticación se llevará a cabo a todos los

las funciones del conector

Funciones del conector

Obtener todos los documentos

Propósito

Este conector obtendrá todos los documentos del espacio de trabajo Onshape de un usuario.

Punto final

Llamada HTTP GET al punto final: https://cad.onshape.com:443/api/documents

Entrada requerida

No se requieren entradas

Salida requerida Extractor

1. ID del documento: Identificador único del Documento que se utilizará para realizar las demás tareas.
2. Nombre del documento: El nombre para mostrar del Documento.
3. ID del espacio de trabajo: Identificador único del espacio de trabajo del documento que se utilizará para realizar las demás tareas.
4. Los parámetros adicionales que se devuelven con la respuesta se incluyen como parte de los parámetros de salida.

Obtener todos los elementos de un documento específico

Propósito

Este conector obtendrá todos los elementos de un documento específico pasando las entradas requeridas.

Punto final

Llamada HTTP GET al punto final: https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements

Entradas necesarias

Los siguientes son los parámetros de URL que deben pasarse

1. ID de documento
2. ID del espacio de trabajo

Salida requerida Extractor

1. ID de elemento: Identificador único del elemento que se utilizará para realizar las demás tareas.
2. Nombre del elemento: El nombre para mostrar del Elemento.
3. Tipo de elemento: El tipo del Elemento.
4. Los parámetros adicionales que se devuelven con la respuesta se incluyen como parte de los parámetros de salida.

Obtener propiedades de un elemento

Propósito

Este conector obtiene todas las propiedades de un elemento específico de un documento.

Punto final

Llamada HTTP GET al punto final: https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements?elementType={ElementType}&elementId={ElementID}

Entrada obligatoria

A continuación se indican los parámetros de URL que deben introducirse

1. ID de documento
2. ID del espacio de trabajo
3. ID de elemento
4. Tipo de elemento

Extractor de salida requerido

1. ID del elemento: Identificador único del Elemento que se utilizará para realizar las demás tareas.
2. Nombre del elemento: Nombre para mostrar del elemento.
3. Tipo de elemento: El tipo del Elemento.
4. Los parámetros adicionales que se devuelven con la respuesta se incluyen como parte de los parámetros de salida.

Obtener detalles del cuerpo del estudio de piezas

Propósito

Este conector obtendrá todos los detalles del cuerpo de un elemento de Part Studio de un documento específico pasando las entradas requeridas.

Punto final

Llamada HTTP GET al punto final: https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bodydetails

Entrada obligatoria

A continuación se indican los parámetros de URL que deben introducirse

1. ID de documento
2. ID del espacio de trabajo
3. ID de elemento

Salida requerida Extractor

1. ID del cuerpo: Identificador único del Cuerpo que se utilizará para realizar las demás tareas.
2. Tipo de cuerpo: El tipo de cuerpo de la parte.
3. Los parámetros adicionales que se devuelven con la respuesta se incluyen como parte de los parámetros de salida.

Obtener cuadros delimitadores de estudio de pieza

Propósito

Este conector obtendrá todos los cuadros delimitadores de un elemento de Part Studio de un documento específico pasando las entradas requeridas.

Punto final

Llamada HTTP GET al punto final: https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes

Entrada obligatoria

A continuación se indican los parámetros de URL que deben introducirse

1. ID de documento
2. ID del espacio de trabajo
3. ID de elemento

Salida requerida Extractor

1. X bajo: Valor de lowX.
2. Low Y: Valor de lowY.
3. Low Z: Valor de lowZ.
4. Alto X: Valor de highX.
5. Alto Y: Valor de altoY.
6. Alto Z: Valor de altoZ.

Obtener metadatos de una pieza individual

Propósito

Este conector obtendrá los metadatos de una parte individual de un elemento Part Studio de un documento específico pasando las entradas requeridas.

Punto final

Llamada HTTP GET al punto final: https://cad.onshape.com:443/api/metadata/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/p/{PartID}

Entrada obligatoria

A continuación se indican los parámetros de URL que deben introducirse

1. ID de documento
2. ID del espacio de trabajo
3. ID de elemento
4. ID de parte

Extractor de salida requerido

1. ID de parte: Identificador único de la Parte que se utilizará para realizar las demás tareas.
2. Tipo de parte: El tipo de parte.
3. Los parámetros adicionales que se devuelven con la respuesta se incluyen como parte de los parámetros de salida.

Obtener definición de conjunto

Propósito

Este conector obtendrá la definición de ensamblaje de un elemento de ensamblaje de un documento específico pasando las entradas requeridas.

Punto final

Llamada HTTP GET al punto final: https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}

Entrada obligatoria

A continuación se indican los parámetros de URL que deben introducirse

1. ID de documento
2. ID del espacio de trabajo
3. ID de elemento

Salida requerida Extractor

1. ID de Instancia: Identificador único de la Instancia que se utilizará para realizar las demás tareas.
2. Nombre de Instancia: Nombre de la Instancia.
3. Los parámetros adicionales que se devuelven con la respuesta se incluyen como parte de los parámetros de salida.

Obtener cajas delimitadoras de un ensamblaje

Propósito

Este conector obtendrá todos los cuadros delimitadores de un elemento Ensamblado de un documento específico pasando las entradas requeridas.

Punto final

Llamada HTTP GET al punto final: https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes

Entrada obligatoria

A continuación se indican los parámetros de URL que deben introducirse

1. ID de documento
2. ID del espacio de trabajo
3. ID de elemento

Salida requerida Extractor

1. X bajo: Valor de lowX.
2. Low Y: Valor de lowY.
3. Low Z: Valor de lowZ.
4. Alto X: Valor de highX.
5. Alto Y: Valor de altoY.
6. Alto Z: Valor de altoZ.

Obtener lista de materiales de montaje

Propósito

Este conector obtendrá la lista de materiales de un elemento Ensamblado de un documento específico pasando las entradas requeridas.

Punto final

Llamada HTTP GET al punto final https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bom

Entrada obligatoria

A continuación se indican los parámetros de URL que deben introducirse

1. ID de documento
2. ID del espacio de trabajo
3. ID de elemento

Salida requerida Extractor

1. Bill Material ID: Identificador único de la tabla Bill of Material.
2. Nombre de la Lista de Materiales: Nombre de la tabla Bill of Material.
3. Tipo de Lista de Materiales: Tipo de la tabla de lista de materiales.
4. Los parámetros adicionales que se devuelven con la respuesta se incluyen como parte de los parámetros de salida.