OnShape Connector

Коннектор OnShape

Интеграция Tulip с OnShape

Введение

REST API Onshape позволяет пользователям взаимодействовать с Onshape, имея соответствующий доступ к своим учетным записям Onshape. Целью данного коннектора является интеграция Tulip с Onshape с помощью HTTP-коннекторов и предоставление нашим клиентам готового коннектора, который можно импортировать в свой экземпляр.

Назначение

Мы собираемся осветить различные функции коннектора, которые могут быть созданы путем выполнения HTTP-вызовов к REST API Onshape для взаимодействия с системой Onshape, чтобы продемонстрировать различные действия чтения и записи в Onshape, которые могут быть использованы для различных сценариев использования.

API Doc

[Onshape API Overview](https://onshape-public.github.io/docs/apioverview/

аутентификация)

Предварительные требования

1. Создайте учетную запись в Onshape и настройте учетные данные OAuth2.
2. Зарегистрируйте API с необходимыми диапазонами в Onshape.

Детали подключения Tulip

В Tulip необходимо настроить следующую информацию

Connectors.

1. Running On: Cloud Connector Host
2. Хост: cad.onshape.com
3. Порт: 443
4. TLS: Да

OAuth 2: аутентификация будет перенесена на все

функции коннектора

Функции коннектора

Получить все документы

Назначение

Этот коннектор получает все документы в рабочем пространстве Onshape пользователя.

Конечная точка

HTTP GET вызов конечной точки: https://cad.onshape.com:443/api/documents.

Требуемый ввод

Входные данные не требуются

Требуемый выходной экстрактор

1. Идентификатор документа: Уникальный идентификатор документа, который будет использоваться для выполнения других задач.
2. Имя документа: Отображаемое имя документа.
3. ID рабочей области: уникальный идентификатор рабочей области документа, которая будет использоваться для выполнения других задач.
4. Дополнительные параметры, возвращаемые вместе с ответом, включаются в состав выходных параметров.

Получить все элементы определенного документа

Назначение

Данный коннектор позволяет получить все элементы определенного документа, передав необходимые входные данные.

Конечная точка

HTTP GET вызов конечной точки: https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements

Необходимые входные данные

Ниже перечислены параметры URL, которые необходимо передать

1. Идентификатор документа
2. Идентификатор рабочей области

Требуемый выходной экстрактор

1. Element ID: Уникальный идентификатор элемента, который будет использоваться для выполнения других задач.
2. Element Name (Имя элемента): Отображаемое имя элемента.
3. Element Type (Тип элемента): Тип элемента.
4. Дополнительные параметры, возвращаемые вместе с ответом, включаются в состав выходных параметров.

Получить свойства элемента

Назначение

Данный коннектор позволяет получить все свойства элемента определенного типа, входящего в состав документа.

Конечная точка

HTTP GET вызов конечной точки: https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements?elementType={ElementType}&elementId={ElementID}

Необходимые параметры

Ниже перечислены параметры URL, которые необходимо передать

1. ID документа
2. ID рабочей области
3. Идентификатор элемента
4. Тип элемента

Требуемый выходной экстрактор

1. Идентификатор элемента: Уникальный идентификатор элемента, который будет использоваться для выполнения других задач.
2. Element Name (Имя элемента): Отображаемое имя элемента.
3. Element Type (Тип элемента): Тип элемента.
4. Дополнительные параметры, возвращаемые вместе с ответом, включаются в состав выходных параметров.

Получение сведений о корпусе студийной части

Назначение

Данный коннектор позволяет получить все данные о теле элемента Part Studio конкретного документа, передав необходимые входные данные.

Конечная точка

HTTP GET вызов конечной точки: https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bodydetails

Необходимые параметры

Ниже перечислены параметры URL, которые необходимо передать

1. Идентификатор документа
2. ID рабочей области
3. Идентификатор элемента

Требуемый выходной экстрактор

1. Идентификатор тела: Уникальный идентификатор органа, который будет использоваться для выполнения других задач.
2. Body Type (Тип тела): Тип тела части.
3. Дополнительные параметры, возвращаемые вместе с ответом, включаются в состав выходных параметров.

Получить ограничительные рамки студии деталей

Назначение

Данный коннектор позволяет получить все ограничивающие рамки элемента Part Studio конкретного документа, передав необходимые входные данные.

Конечная точка

HTTP GET вызов конечной точки: https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes

Необходимые параметры

Ниже перечислены параметры URL, которые необходимо передать

1. Идентификатор документа
2. ID рабочей области
3. Идентификатор элемента

Требуемый выход Экстрактор

1. Low X: Значение lowX.
2. Low Y: Значение lowY.
3. Low Z: Значение lowZ.
4. High X: Значение highX.
5. High Y: Значение highY.
6. High Z: значение highZ.

Получение метаданных отдельной детали

Назначение

Данный коннектор позволяет получить метаданные отдельной части элемента Part Studio конкретного документа, передав ему необходимые входные данные.

Конечная точка

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. Дополнительные параметры, возвращаемые вместе с ответом, включаются в состав выходных параметров.

Получить определение сборки

Назначение

Данный коннектор позволяет получить определение сборки элемента Assembly конкретного документа, передав ему необходимые входные данные.

Конечная точка

HTTP GET вызов конечной точки: https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}.

Необходимые входные данные

Ниже перечислены параметры URL, которые необходимо передать

1. Идентификатор документа
2. ID рабочей области
3. Идентификатор элемента

Требуемый выходной экстрактор

1. Instance ID: Уникальный идентификатор экземпляра, который будет использоваться для выполнения других задач.
2. Instance Name: Имя экземпляра.
3. Дополнительные параметры, возвращаемые вместе с ответом, включаются в состав выходных параметров.

Получить граничные поля сборки

Назначение

Данный коннектор, передав необходимые входные данные, получит все граничные поля элемента Assembly определенного документа.

Конечная точка

HTTP GET вызов конечной точки: https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes

Необходимые параметры

Ниже перечислены параметры URL, которые необходимо передать

1. Идентификатор документа
2. ID рабочей области
3. Идентификатор элемента

Требуемый выход Экстрактор

1. Low X: Значение lowX.
2. Low Y: Значение lowY.
3. Low Z: Значение lowZ.
4. High X: Значение highX.
5. High Y: Значение highY.
6. High Z: значение highZ.

Получить спецификацию материалов для сборки

Назначение

Данный коннектор позволяет получить спецификацию материалов элемента Assembly конкретного документа, передав ему необходимые входные данные.

Конечная точка

HTTP GET вызов конечной точки https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bom

Необходимые входные данные

Ниже перечислены параметры URL, которые необходимо передать

1. Идентификатор документа
2. ID рабочей области
3. Идентификатор элемента

Требуемый выходной экстрактор

1. Bill Material ID: Уникальный идентификатор таблицы Bill of Material.
2. Bill Material Name: Имя таблицы Bill of Material.
3. Bill Material Type: Тип таблицы Bill of Material.
4. Дополнительные параметры, возвращаемые вместе с ответом, включаются в состав выходных параметров.