Conector OnShape

Conector OnShape

Integração do Tulip com o OnShape

Introdução

A API REST da Onshape permite que os usuários interajam com a Onshape tendo o acesso correto definido em suas respectivas contas Onshape. O objetivo desse conector é integrar a Tulip com a Onshape usando conectores HTTP e fornecer aos nossos clientes um conector pronto para uso que possa ser importado para sua instância.

Objetivo

Destacaremos diferentes funções de conector que podem ser criadas por meio de chamadas HTTP para a API REST da Onshape para interagir com o sistema Onshape e mostrar várias ações de leitura e gravação na Onshape que podem ser aproveitadas para vários casos de uso.

Documento da API

[Visão geral da API do Onshape](https://onshape-public.github.io/docs/apioverview/

authentication)

Pré-requisitos

1. Criar uma conta na Onshape e configurar as credenciais OAuth2.
2. Registre a API com os escopos necessários na Onshape.

Detalhes da conexão Tulip

As informações a seguir precisariam ser configuradas no Tulip's

Conectores.

1. Em execução: host do conector de nuvem
2. Host: cad.onshape.com
3. Porta:443
4. TLS: Sim

OAuth 2: a autenticação será transferida para todas as

as funções do conector

Funções do conector

Obter todos os documentos

Objetivo

Esse conector buscará todos os documentos no espaço de trabalho Onshape de um usuário.

Ponto de extremidade

Chamada HTTP GET para o ponto de extremidade: https://cad.onshape.com:443/api/documents

Entrada necessária

Não são necessárias entradas

Extrator de saída necessário

1. ID do documento: Identificador exclusivo do documento que será usado para executar as outras tarefas.
2. Nome do documento: O nome de exibição do documento.
3. ID do espaço de trabalho: Identificador exclusivo do espaço de trabalho do documento que será usado para executar as outras tarefas.
4. Parâmetros adicionais que são retornados com a resposta são incluídos como parte dos parâmetros de saída.

Obter todos os elementos de um documento específico

Objetivo

Esse conector buscará todos os elementos de um documento específico passando as entradas necessárias.

Ponto final

Chamada HTTP GET para o ponto de extremidade: https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements

Entrada obrigatória

A seguir estão os parâmetros de URL que devem ser passados

1. ID do documento
2. ID do espaço de trabalho

Extrator de saída obrigatório

1. ID do elemento: Identificador exclusivo do elemento que será usado para executar as outras tarefas.
2. Nome do elemento: O nome de exibição do elemento.
3. Element Type (Tipo de elemento): O tipo do elemento.
4. Parâmetros adicionais que são retornados com a resposta são incluídos como parte dos parâmetros de saída.

Obter propriedades do elemento

Objetivo

Esse conector buscará todas as propriedades do elemento de uma parte específica do tipo de elemento de um documento.

Ponto de extremidade

Chamada HTTP GET para o ponto de extremidade: https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements?elementType={ElementType}&elementId={ElementID}

Entrada obrigatória

A seguir estão os parâmetros de URL que devem ser passados

1. ID do documento
2. ID do espaço de trabalho
3. ID do elemento
4. Tipo de elemento

Extrator de saída obrigatório

1. ID do elemento: Identificador exclusivo do elemento que será usado para executar as outras tarefas.
2. Nome do elemento: O nome de exibição do elemento.
3. Element Type (Tipo de elemento): O tipo do elemento.
4. Parâmetros adicionais que são retornados com a resposta são incluídos como parte dos parâmetros de saída.

Obter detalhes do corpo do Part Studio

Finalidade

Esse conector buscará todos os detalhes do corpo de um elemento do Part Studio de um documento específico, passando as entradas necessárias.

Ponto final

Chamada HTTP GET para o ponto de extremidade: https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bodydetails

Entrada obrigatória

A seguir estão os parâmetros de URL que devem ser passados

1. ID do documento
2. ID do espaço de trabalho
3. ID do elemento

Extrator de saída obrigatório

1. ID do corpo: Identificador exclusivo do corpo que será usado para executar as outras tarefas.
2. Body Type (Tipo de corpo): O tipo de corpo da parte.
3. Parâmetros adicionais que são retornados com a resposta são incluídos como parte dos parâmetros de saída.

Obter caixas delimitadoras do Part Studio

Finalidade

Esse conector buscará todas as caixas delimitadoras de um elemento do Part Studio de um documento específico, passando as entradas necessárias.

Ponto final

Chamada HTTP GET para o ponto de extremidade: https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes

Entrada obrigatória

A seguir estão os parâmetros de URL que devem ser passados

1. ID do documento
2. ID do espaço de trabalho
3. ID do elemento

Extrator de saída obrigatório

1. Low X: Valor de lowX.
2. Low Y: Valor de lowY.
3. Low Z: Valor de lowZ.
4. High X: Valor de highX.
5. High Y: Valor de highY.
6. High Z: Valor de highZ.

Obter metadados de uma peça individual

Finalidade

Esse conector buscará os metadados de uma parte individual de um elemento do Part Studio de um documento específico, passando as entradas necessárias.

Ponto de extremidade

Chamada HTTP GET para o ponto de extremidade: https://cad.onshape.com:443/api/metadata/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/p/{PartID}

Entrada obrigatória

A seguir estão os parâmetros de URL que devem ser passados

1. ID do documento
2. ID do espaço de trabalho
3. ID do elemento
4. ID da parte

Extrator de saída necessário

1. ID da parte: Identificador exclusivo da parte que será usada para executar as outras tarefas.
2. Part Type (Tipo de peça): O tipo de parte.
3. Parâmetros adicionais que são retornados com a resposta são incluídos como parte dos parâmetros de saída.

Obter definição de montagem

Finalidade

Esse conector buscará a definição de montagem de um elemento de montagem de um documento específico, passando as entradas necessárias.

Ponto final

Chamada HTTP GET para o ponto de extremidade: https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}

Entrada obrigatória

A seguir estão os parâmetros de URL que devem ser passados

1. ID do documento
2. ID do espaço de trabalho
3. ID do elemento

Extrator de saída obrigatório

1. ID da instância: identificador exclusivo da instância que será usada para executar as outras tarefas.
2. Nome da instância: O nome da instância.
3. Parâmetros adicionais que são retornados com a resposta são incluídos como parte dos parâmetros de saída.

Obter caixas delimitadoras de um conjunto

Objetivo

Esse conector buscará todas as caixas delimitadoras de um elemento de montagem de um documento específico, passando as entradas necessárias.

Ponto final

Chamada HTTP GET para o ponto de extremidade: https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes

Entrada obrigatória

A seguir estão os parâmetros de URL que devem ser passados

1. ID do documento
2. ID do espaço de trabalho
3. ID do elemento

Extrator de saída obrigatório

1. Low X: Valor de lowX.
2. Low Y: Valor de lowY.
3. Low Z: Valor de lowZ.
4. High X: Valor de highX.
5. High Y: Valor de highY.
6. High Z: Valor de highZ.

Obter lista de materiais de montagem

Finalidade

Esse conector buscará a lista de materiais de um elemento de montagem de um documento específico, passando as entradas necessárias.

Ponto de extremidade

Chamada HTTP GET para o ponto de extremidade https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bom

Entrada obrigatória

A seguir estão os parâmetros de URL que devem ser passados

1. ID do documento
2. ID do espaço de trabalho
3. ID do elemento

Extrator de saída obrigatório

1. Bill Material ID: Identificador exclusivo da tabela Bill of Material.
2. Nome do material de faturamento: O nome da tabela Bill of Material.
3. Bill Material Type (Tipo de material de faturamento): O tipo da tabela Bill of Material.
4. Parâmetros adicionais que são retornados com a resposta são incluídos como parte dos parâmetros de saída.