Windchill REST Services 알아보기

WRS(Windchill REST Services)의 OData 서비스를 도메인이라고 합니다. 도메인은 Windchill 객체 유형과 객체 컬렉션을 OData 엔티티 유형 및 엔티티 세트로 노출합니다.

1. OData: 
OData는 웹 API를 위한 표준 프로토콜로, 데이터 검색, 필터링, 정렬 및 조작을 위한 일관된 방식을 제공합니다.

2. 엔티티: 
엔티티는 OData에서 데이터를 나타내는 기본 단위입니다. 각 엔티티는 고유한 식별자와 속성을 가지고 있습니다.

3. 엔티티 세트: 
엔티티 세트는 특정 유형의 엔티티 컬렉션을 나타냅니다. 
예를 들어, "제품" 엔티티 세트는 "제품" 엔티티 여러 개를 포함할 수 있습니다.

 

도메인 ?

한국인터넷정보센터(KRNIC)

 

□ 도메인 작동 방식:

• 도메인 정의:
  도메인은 Windchill 객체 유형과 객체 컬렉션을 OData 엔티티 유형 및 엔티티 세트로 매핑합니다. 이는 OData 용어로 Windchill 데이터를 표현하는 방법을 정의합니다.
• OData 요청 처리:
  클라이언트는 OData 표준을 사용하여 도메인에 대한 요청을 보냅니다. 예를 들어, 특정 제품을 검색하거나 제품 엔티티를 만들려는 요청을 보낼 수 있습니다.
• Windchill 데이터 액세스: 도메인은 Windchill 서버와 상호 작용하여 요청된 데이터를 검색, 조작 및 반환합니다.
• OData 응답 반환:
  도메인은 OData 표준 형식의 응답을 클라이언트에게 반환합니다. 응답에는 요청된 데이터, 페이징 정보 및 기타 메타데이터가 포함될 수 있습니다.

 

□ 도메인의 장점:

• 간편한 데이터 액세스:
  OData 표준을 사용하여 다양한 프로그래밍 언어와 도구에서 Windchill 데이터에 액세스할 수 있습니다.
• 향상된 유연성: 
  도메인은 특정 데이터에 대한 액세스를 제공하도록 구성될 수 있어 특정 요구 사항을 충족하는 맞춤형 API를 만들 수 있습니다.
• 개선된 성능: 
  도메인은 특정 데이터에 대한 빠르고 효율적인 액세스를 제공하도록 설계되었습니다.

 

• 제품 도메인:
  이 도메인은 제품 데이터(예: 부품, 어셈블리, 도면)에 대한 OData 엔티티 유형 및 엔티티 세트를 정의할 수 있습니다. 클라이언트는 OData 요청을 사용하여 특정 제품을 검색하거나 제품 엔티티를 만들거나 업데이트할 수 있습니다.
• 문서 도메인: 
  이 도메인은 문서 데이터(예: 보고서, 지침, 사양)에 대한 OData 엔티티 유형 및 엔티티 세트를 정의할 수 있습니다. 클라이언트는 OData 요청을 사용하여 특정 문서를 검색하거나 문서 엔티티를 만들거나 업데이트할 수 있습니다.

---

REAR_TRACK CAD 부품에 액세스하기 위한 RESTful URL

 

1. 서비스 루트 : 구성표, 호스트 및 포트 번호가 포함됩니다. 이는 Windchill 서버 및 아키텍처 컨텍스트입니다.
2. Windchill 도메인 버전:
   클라이언트가 애플리케이션의 이전 버전과의 호환성을 위해 특정 버전의 도메인을 필요로 하지 않는 한 이를 URL에 포함하는 것은 선택 사항입니다.
   
   
3. 도메인 식별자는 리소스 경로의 일부입니다.
   도메인이라는 관리 영역을 식별합니다. 이 예에서는 CAD 문서 관리 도메인입니다.
   
   
4. 도메인은 Windchill 엔티티 컬렉션에 액세스하는 데 사용됩니다. 이 예에서 URL은 CAD 문서 엔티티를 요청합니다.
   
   
5. 쿼리 옵션: 
   응답을 수정하고 정확히 필요한 것을 가져오거나 변경하기 위해 엔드포인트에 보낼 수 있는 매개변수입니다. 이 URL에서는 REAR_TRACK이라는 CAD 부품과 동일한 번호 속성을 필터링합니다. 백분율은 백분율 인코딩 구문입니다. %27은 인코딩된 아포스트로피이고 %20은 인코딩된 공백입니다. 이 구문은 자동으로 추가됩니다.

 

□ Windchill REST 서비스의 메서드 (동사)

연산자라고도 불리는 메서드는 HTTP 명령을 통해 데이터를 제어하는 ​​동사입니다. 예를 들어 Windchill에서 부품을 가져오려면 GET 동사를 사용하고 Windchill/servlet/odata/v5/ProdMgmt/Parts URI로 요청을 보냅니다.  메서드는 일반적으로 HTTP 작업 유형(예: GET, POST, PUT, DELETE) 및 요청하려는 리소스에 따라 구분됩니다.

1. 일반적인 Windchill REST 서비스 메서드 유형( HTTP 작업 유형):

• GET:
  리소스의 현재 표현을 검색합니다. 예를 들어 GET /part/12345는 파트 ID 12345의 정보를 반환합니다.
• POST:
  리소스를 생성합니다. 예를 들어 POST /part는 새 파트를 생성하고 요청 본문에 파트 데이터를 포함합니다.
• PUT:
  기존 리소스를 업데이트합니다. 예를 들어 PUT /part/12345는 파트 ID 12345를 업데이트하고 요청 본문에 업데이트된 파트 데이터를 포함합니다.
• DELETE: 
  리소스를 삭제합니다. 예를 들어 DELETE /part/12345는 파트 ID 12345를 삭제합니다.

2. Windchill REST 서비스에서 사용되는 일반적인 리소스 유형:

• 파트: 제품의 구성 요소를 나타냅니다.
• 도큐먼트: 설계 도면, 사양 및 기타 관련 문서와 같은 Windchill에서 관리되는 파일을 나타냅니다.
• 워크플로: 작업을 자동화하는 데 사용되는 비즈니스 프로세스를 나타냅니다.
• 사용자: Windchill 시스템에 액세스할 수 있는 개인을 나타냅니다.

Windchill REST 서비스를 사용하는 방법:
Windchill REST 서비스를 사용하려면 다음을 수행해야 합니다.

Windchill REST API 문서: 
PTC는 Windchill REST API를 위한 포괄적인 문서를 제공합니다. 
이 문서에는 모든 사용 가능한 메서드, 리소스 및 헤더에 대한 자세한 정보가 포함되어 있습니다. 
https://support.ptc.com/help/windchill_rest_services/r2.2/en/

인증: 
Windchill REST 서비스에 액세스하려면 유효한 Windchill 사용자 인증 정보를 제공해야 합니다. 
인증 방법은 사용 중인 Windchill 배포에 따라 다릅니다.

HTTP 클라이언트: 
Windchill REST 서비스를 호출하는 데 사용할 수 있는 HTTP 클라이언트 라이브러리 또는 도구를 선택해야 합니다. 
인기있는 옵션으로는 cURL, Postman 및 Python의 requests 모듈이 포함됩니다.

 

 Basic REST Operations 예제 사이트 :

 

PTC Help Center

 

Windchill REST 서비스는 Windchill 시스템의 데이터에 액세스하고 조작하기 위한 강력한 도구입니다. REST API 및 HTTP 클라이언트에 대한 기본 지식만 있으면 다양한 작업을 수행하는 데 사용할 수 있습니다.