추가 Windchill 기능 > 서비스 정보 관리 > Windchill Service Parts 정보 > Windchill Service Parts REST API
  
Windchill Service Parts REST API
Windchill Service Parts에서는 부품 목록, 부품 목록 항목 및 일러스트레이션 데이터에 액세스하기 위한 REST API를 제공합니다. API는 ThingWorx와 같은 웹 서비스에 읽기 전용 정보를 노출합니다. HTTP 요청이 가능한 클라이언트에서 이러한 API를 사용할 수 있습니다.
* 
이러한 API에 대한 사용자 인터페이스는 제공되지 않습니다.
/v1/partslists - 지정된 조건과 일치하는 모든 부품 목록을 반환합니다.
입력:
select - 질의에 의해 반환되는 부품 목록의 등록 정보(속성)를 결정합니다.
쉼표로 구분된 등록 정보 이름 목록인 OData 선택 표현식입니다. 등록 정보 이름은 객체 유형에 대한 Windchill 유형 및 속성 매니저에 나타난 등록 정보의 내부 이름이어야 합니다.
Windchill 유형 및 속성 매니저에 정의된 PartsList 객체 유형의 모든 속성을 포함하려면 별표(*)를 지정합니다.
목록을 비워 두면 등록 정보의 기본 목록을 반환합니다.
이 매개변수는 선택사항입니다.
filter - 질의에 대한 필터를 정의합니다.
<propertyName> <operator> '<value>' [and | or | not]... 형태의 OData 필터 조건입니다. 여기서 operatoreq, ne, le 또는 다른 OData 비교 연산자입니다.
예: number eq '0000222341'.
이 매개변수는 선택사항입니다.
navigationCriteria - 반환되는 부품 목록의 목록에 컨트롤을 더 추가합니다.
탐색 조건에 대해 구문 분석 가능한 탐색 조건 이름 또는 JSON이거나 탐색 조건의 Windchill 객체 식별자(OID)입니다.
검색한 객체가 이터레이션되지 않는 경우 탐색 조건을 지정할 필요가 없습니다.
값을 지정하지 않은 경우 최신 버전이 선택됩니다.
이 매개변수는 선택사항입니다.
출력:
부품 목록(PartsList 객체)의 목록 또는 오류 코드와 오류 메시지입니다.
오류 코드를 참조하십시오.
/v1/partslists/{partsListId} - 지정된 ID를 가진 부품 목록을 반환합니다.
입력:
partsListId - 조직 컨텍스트에서 부품 목록의 식별자를 지정합니다.
값은 <organizationName><delimiter><number> 형식(예: Demo Organization_0000222341)이어야 합니다.
이 매개변수는 필수입니다.
select - 질의에 의해 반환되는 부품 목록에 대해 표시되는 등록 정보(속성)를 결정합니다.
쉼표로 구분된 등록 정보 이름 목록인 OData 선택 표현식입니다. 등록 정보 이름은 객체 유형에 대한 Windchill 유형 및 속성 매니저에 나타난 등록 정보의 내부 이름이어야 합니다.
Windchill 유형 및 속성 매니저에 정의된 PartsList 객체 유형의 모든 속성을 포함하려면 별표(*)를 지정합니다.
이 매개변수는 선택사항입니다.
출력:
단일 부품 목록(PartsList 객체) 또는 오류 코드와 오류 메시지입니다.
오류 코드를 참조하십시오.
/v1/partslists/{partsListId}/items - 지정된 부품 목록의 모든 부품 목록 항목을 반환합니다.
입력:
partsListId - 조직 컨텍스트에서 부품 목록의 식별자를 지정합니다.
값은 <organizationName><delimiter><number> 형식(예: Demo Organization_0000222341)이어야 합니다.
이 매개변수는 필수입니다.
select - 질의에 의해 반환되는 부품 목록 항목의 등록 정보(속성)를 결정합니다.
쉼표로 구분된 등록 정보 이름 목록인 OData 선택 표현식입니다. 등록 정보 이름은 객체 유형에 대한 Windchill 유형 및 속성 매니저에 나타난 등록 정보의 내부 이름이어야 합니다.
Windchill 유형 및 속성 매니저에 정의된 PartsListItem 객체 유형의 모든 속성을 포함하려면 별표(*)를 지정합니다.
이 매개변수는 선택사항입니다.
filter - 질의에 대한 필터를 정의합니다.
<propertyName> <operator> '<value>' [and | or | not]... 형태의 OData 필터 조건입니다. 여기서 operatoreq, ne, le 또는 다른 OData 비교 연산자입니다.
예: number eq '0000222341'.
이 매개변수는 선택사항입니다.
출력:
부품 목록 항목(PartsListItem 객체)의 목록 또는 오류 코드와 오류 메시지입니다.
오류 코드를 참조하십시오.
/v1/partslists/{partsListId}/items/{partsListItemId} - 지정된 부품 목록에서 지정된 ID를 가진 부품 목록 항목을 반환합니다.
입력:
partsListId - 조직 컨텍스트에서 부품 목록의 식별자를 지정합니다.
값은 <organizationName><delimiter><number> 형식(예: Demo Organization_0000222341)이어야 합니다.
이 매개변수는 필수입니다.
partsListItemId - 부품 목록 항목의 식별자를 지정합니다.
부품 목록 항목은 부품 목록의 하위 항목이므로 하위 항목 식별자로 충분합니다.
이 매개변수는 필수입니다.
select - 질의에 의해 반환되는 부품 목록 항목의 등록 정보(속성)를 결정합니다.
쉼표로 구분된 등록 정보 이름 목록인 OData 선택 표현식입니다. 등록 정보 이름은 객체 유형에 대한 Windchill 유형 및 속성 매니저에 나타난 등록 정보의 내부 이름이어야 합니다.
Windchill 유형 및 속성 매니저에 정의된 PartsListItem 객체 유형의 모든 속성을 포함하려면 별표(*)를 지정합니다.
이 매개변수는 선택사항입니다.
출력:
단일 부품 목록 항목(PartsListItem 객체) 또는 오류 코드와 오류 메시지입니다.
오류 코드를 참조하십시오.
/v1/partslists/{partsListId}/items/{partsListItemId}/part - 지정된 부품 목록에서 지정된 부품 목록 항목과 연관된 부품을 반환합니다.
입력:
partsListId - 조직 컨텍스트에서 부품 목록의 식별자를 지정합니다.
값은 <organizationName><delimiter><number> 형식(예: Demo Organization_0000222341)이어야 합니다.
이 매개변수는 필수입니다.
partsListItemId - 부품 목록 항목의 식별자를 지정합니다.
부품 목록 항목은 부품 목록의 하위 항목이므로 하위 항목 식별자로 충분합니다.
이 매개변수는 필수입니다.
select - 질의에 의해 반환되는 부품의 등록 정보(속성)를 결정합니다.
쉼표로 구분된 등록 정보 이름 목록인 OData 선택 표현식입니다. 등록 정보 이름은 객체 유형에 대한 Windchill 유형 및 속성 매니저에 나타난 등록 정보의 내부 이름이어야 합니다.
Windchill 유형 및 속성 매니저에 정의된 객체 유형의 모든 속성을 포함하려면 별표(*)를 지정합니다.
이 매개변수는 선택사항입니다.
출력:
단일 부품 객체 또는 오류 코드와 오류 메시지입니다.
오류 코드를 참조하십시오.
/v1/partslists/{partsListId}/itemrelations - 지정된 부품 목록의 모든 항목 관계(대용 및 보조 부품)를 반환합니다.
입력:
partsListId - 조직 컨텍스트에서 부품 목록의 식별자를 지정합니다.
값은 <organizationName><delimiter><number> 형식(예: Demo Organization_0000222341)이어야 합니다.
이 매개변수는 필수입니다.
select - 질의에 의해 반환되는 대용 및 보조 부품에 대해 표시되는 등록 정보(속성)를 결정합니다.
쉼표로 구분된 등록 정보 이름 목록인 OData 선택 표현식입니다. 등록 정보 이름은 객체 유형에 대한 Windchill 유형 및 속성 매니저에 나타난 등록 정보의 내부 이름이어야 합니다.
Windchill 유형 및 속성 매니저에 정의된 PartsListItemSubstituteLink 및 SupplementaryReplacementLink 객체 유형의 모든 속성을 포함하려면 별표(*)를 지정합니다.
이 매개변수는 선택사항입니다.
navigationCriteria - 반환되는 보조 및 대용 부품의 목록에 컨트롤을 더 추가합니다.
탐색 조건에 대해 구문 분석 가능한 탐색 조건 이름 또는 JSON이거나 탐색 조건의 Windchill 객체 식별자(OID)입니다.
검색한 객체가 이터레이션되지 않는 경우 탐색 조건을 지정할 필요가 없습니다.
값을 지정하지 않은 경우 최신 버전이 선택됩니다.
이 매개변수는 선택사항입니다.
출력:
대용 부품(PartsListItemSubstituteLink 객체) 및 보조 부품(SupplementaryReplacementLink 객체)의 목록 또는 오류 코드와 오류 메시지입니다.
오류 코드를 참조하십시오.
/v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations - 지정된 부품 목록의 지정된 부품 목록 항목에 대한 모든 항목 관계(대용 및 보조 부품)를 반환합니다.
입력:
partsListId - 조직 컨텍스트에서 부품 목록의 식별자를 지정합니다.
값은 <organizationName><delimiter><number> 형식(예: Demo Organization_0000222341)이어야 합니다.
이 매개변수는 필수입니다.
partsListItemId - 부품 목록 항목의 식별자를 지정합니다.
부품 목록 항목은 부품 목록의 하위 항목이므로 하위 항목 식별자로 충분합니다.
이 매개변수는 필수입니다.
select - 질의에 의해 반환되는 대용 및 보조 부품에 대해 표시되는 등록 정보(속성)를 결정합니다.
쉼표로 구분된 등록 정보 이름 목록인 OData 선택 표현식입니다. 등록 정보 이름은 객체 유형에 대한 Windchill 유형 및 속성 매니저에 나타난 등록 정보의 내부 이름이어야 합니다.
Windchill 유형 및 속성 매니저에 정의된 PartsListItemSubstituteLink 및 SupplementaryReplacementLink 객체 유형의 모든 속성을 포함하려면 별표(*)를 지정합니다.
이 매개변수는 선택사항입니다.
navigationCriteria - 반환되는 보조 및 대용 부품의 목록에 컨트롤을 더 추가합니다.
탐색 조건에 대해 구문 분석 가능한 탐색 조건 이름 또는 JSON이거나 탐색 조건의 Windchill 객체 식별자(OID)입니다.
검색한 객체가 이터레이션되지 않는 경우 탐색 조건을 지정할 필요가 없습니다.
값을 지정하지 않은 경우 최신 버전이 선택됩니다.
이 매개변수는 선택사항입니다.
출력:
대용 부품(PartsListItemSubstituteLink 객체) 및 보조 부품(SupplementaryReplacementLink 객체)의 목록 또는 오류 코드와 오류 메시지입니다.
오류 코드를 참조하십시오.
/v1/partslists/{partsListId}/itemrelations/substitute - 지정된 부품 목록의 모든 대용 부품을 반환합니다.
입력:
partsListId - 조직 컨텍스트에서 부품 목록의 식별자를 지정합니다.
값은 <organizationName><delimiter><number> 형식(예: Demo Organization_0000222341)이어야 합니다.
이 매개변수는 필수입니다.
select - 질의에 의해 반환되는 대용 부품에 대해 표시되는 등록 정보(속성)를 결정합니다.
쉼표로 구분된 등록 정보 이름 목록인 OData 선택 표현식입니다. 등록 정보 이름은 객체 유형에 대한 Windchill 유형 및 속성 매니저에 나타난 등록 정보의 내부 이름이어야 합니다.
Windchill 유형 및 속성 매니저에 정의된 PartsListItemSubstituteLink 객체 유형의 모든 속성을 포함하려면 별표(*)를 지정합니다.
이 매개변수는 선택사항입니다.
filter - 질의에 대한 필터를 정의합니다.
<propertyName> <operator> '<value>' [and | or | not]... 형태의 OData 필터 조건입니다. 여기서 operatoreq, ne, le 또는 다른 OData 비교 연산자입니다.
예: number eq '0000222341'.
이 매개변수는 선택사항입니다.
출력:
대용 부품(PartsListItemSubstituteLink 객체)의 목록 또는 오류 코드와 오류 메시지입니다.
오류 코드를 참조하십시오.
/v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations/substitute – 지정된 부품 목록의 지정된 부품 목록 항목에 대한 모든 대용 부품을 반환합니다.
입력:
partsListId - 조직 컨텍스트에서 부품 목록의 식별자를 지정합니다.
값은 <organizationName><delimiter><number> 형식(예: Demo Organization_0000222341)이어야 합니다.
이 매개변수는 필수입니다.
partsListItemId - 부품 목록 항목의 식별자를 지정합니다.
부품 목록 항목은 부품 목록의 하위 항목이므로 하위 항목 식별자로 충분합니다.
이 매개변수는 필수입니다.
select - 질의에 의해 반환되는 대용 부품에 대해 표시되는 등록 정보(속성)를 결정합니다.
쉼표로 구분된 등록 정보 이름 목록인 OData 선택 표현식입니다. 등록 정보 이름은 객체 유형에 대한 Windchill 유형 및 속성 매니저에 나타난 등록 정보의 내부 이름이어야 합니다.
Windchill 유형 및 속성 매니저에 정의된 PartsListItemSubstituteLink 객체 유형의 모든 속성을 포함하려면 별표(*)를 지정합니다.
이 매개변수는 선택사항입니다.
출력:
대용 부품(PartsListItemSubstituteLink 객체)의 목록 또는 오류 코드와 오류 메시지입니다.
오류 코드를 참조하십시오.
/v1/partslists/{partsListId}/itemrelations/supplementary - 지정된 부품 목록의 모든 보조 부품을 반환합니다.
입력:
partsListId - 조직 컨텍스트에서 부품 목록의 식별자를 지정합니다.
값은 <organizationName><delimiter><number> 형식(예: Demo Organization_0000222341)이어야 합니다.
이 매개변수는 필수입니다.
select - 질의에 의해 반환되는 보조 부품에 대해 표시되는 등록 정보(속성)를 결정합니다.
쉼표로 구분된 등록 정보 이름 목록인 OData 선택 표현식입니다. 등록 정보 이름은 객체 유형에 대한 Windchill 유형 및 속성 매니저에 나타난 등록 정보의 내부 이름이어야 합니다.
Windchill 유형 및 속성 매니저에 정의된 SupplementaryReplacementLink 객체 유형의 모든 속성을 포함하려면 별표(*)를 지정합니다.
이 매개변수는 선택사항입니다.
filter - 질의에 대한 필터를 정의합니다.
<propertyName> <operator> '<value>' [and | or | not]... 형태의 OData 필터 조건입니다. 여기서 operatoreq, ne, le 또는 다른 OData 비교 연산자입니다.
예: number eq '0000222341'.
이 매개변수는 선택사항입니다.
출력:
보조 부품(SupplementaryReplacementLink 객체)의 목록 또는 오류 코드와 오류 메시지입니다.
오류 코드를 참조하십시오.
/v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations/supplementary - 지정된 부품 목록의 지정된 부품 목록 항목에 대한 모든 보조 부품을 반환합니다.
입력:
partsListId - 조직 컨텍스트에서 부품 목록의 식별자를 지정합니다.
값은 <organizationName><delimiter><number> 형식(예: Demo Organization_0000222341)이어야 합니다.
이 매개변수는 필수입니다.
partsListItemId - 부품 목록 항목의 식별자를 지정합니다.
부품 목록 항목은 부품 목록의 하위 항목이므로 하위 항목 식별자로 충분합니다.
이 매개변수는 필수입니다.
select - 질의에 의해 반환되는 보조 부품에 대해 표시되는 등록 정보(속성)를 결정합니다.
쉼표로 구분된 등록 정보 이름 목록인 OData 선택 표현식입니다. 등록 정보 이름은 객체 유형에 대한 Windchill 유형 및 속성 매니저에 나타난 등록 정보의 내부 이름이어야 합니다.
Windchill 유형 및 속성 매니저에 정의된 SupplementaryReplacementLink 객체 유형의 모든 속성을 포함하려면 별표(*)를 지정합니다.
이 매개변수는 선택사항입니다.
navigationCriteria - 반환되는 보조 부품의 목록에 컨트롤을 더 추가합니다.
탐색 조건에 대해 구문 분석 가능한 탐색 조건 이름 또는 JSON이거나 탐색 조건의 Windchill 객체 식별자(OID)입니다.
검색한 객체가 이터레이션되지 않는 경우 탐색 조건을 지정할 필요가 없습니다.
값을 지정하지 않은 경우 최신 버전이 선택됩니다.
이 매개변수는 선택사항입니다.
출력:
보조 부품(SupplementaryReplacementLink 객체)의 목록 또는 오류 코드와 오류 메시지입니다.
오류 코드를 참조하십시오.
/v1/partslists/{partsListId}/illustrations - 지정된 부품 목록의 모든 일러스트레이션을 반환합니다.
입력:
partsListId - 조직 컨텍스트에서 부품 목록의 식별자를 지정합니다.
값은 <organizationName><delimiter><number> 형식(예: Demo Organization_0000222341)이어야 합니다.
이 매개변수는 필수입니다.
select - 질의에 의해 반환되는 일러스트레이션에 대해 표시되는 등록 정보(속성)를 결정합니다.
쉼표로 구분된 등록 정보 이름 목록인 OData 선택 표현식입니다. 등록 정보 이름은 객체 유형에 대한 Windchill 유형 및 속성 매니저에 나타난 등록 정보의 내부 이름이어야 합니다.
Windchill 유형 및 속성 매니저에 정의된 DynamicDocument 객체 유형의 모든 속성을 포함하려면 별표(*)를 지정합니다.
이 매개변수는 선택사항입니다.
filter - 질의에 대한 필터를 정의합니다.
<propertyName> <operator> '<value>' [and | or | not]... 형태의 OData 필터 조건입니다. 여기서 operatoreq, ne, le 또는 다른 OData 비교 연산자입니다.
예: number eq '0000222341'.
이 매개변수는 선택사항입니다.
출력:
일러스트레이션(DynamicDocument 객체)의 목록 또는 오류 코드와 오류 메시지입니다.
오류 코드를 참조하십시오.
/v1/partslists/{partsListId}/illustrations/{illustrationId} - 지정된 부품 목록에서 지정된 ID를 가진 일러스트레이션을 반환합니다.
입력:
partsListId - 조직 컨텍스트에서 부품 목록의 식별자를 지정합니다.
값은 <organizationName><delimiter><number> 형식(예: Demo Organization_0000222341)이어야 합니다.
이 매개변수는 필수입니다.
illustrationId - 일러스트레이션의 식별자를 지정합니다.
일러스트레이션은 부품 목록의 하위 항목이므로 하위 항목 식별자로 충분합니다.
이 매개변수는 필수입니다.
select - 질의에 의해 반환되는 일러스트레이션에 대해 표시되는 등록 정보(속성)를 결정합니다.
쉼표로 구분된 등록 정보 이름 목록인 OData 선택 표현식입니다. 등록 정보 이름은 객체 유형에 대한 Windchill 유형 및 속성 매니저에 나타난 등록 정보의 내부 이름이어야 합니다.
Windchill 유형 및 속성 매니저에 정의된 DynamicDocument 객체 유형의 모든 속성을 포함하려면 별표(*)를 지정합니다.
이 매개변수는 선택사항입니다.
출력:
단일 일러스트레이션(DynamicDocument 객체) 또는 오류 코드와 오류 메시지입니다.
오류 코드를 참조하십시오.
/v1/partslists/{partsListId}/illustrations/{illustrationId}/image - 지정된 부품 목록에서 지정된 일러스트레이션과 연관된 이미지를 반환합니다.
입력:
partsListId - 조직 컨텍스트에서 부품 목록의 식별자를 지정합니다.
값은 <organizationName><delimiter><number> 형식(예: Demo Organization_0000222341)이어야 합니다.
이 매개변수는 필수입니다.
illustrationId - 일러스트레이션의 식별자를 지정합니다.
일러스트레이션은 부품 목록의 하위 항목이므로 하위 항목 식별자로 충분합니다.
이 매개변수는 필수입니다.
select - 질의에 의해 반환되는 이미지에 대해 표시되는 등록 정보(속성)를 결정합니다.
쉼표로 구분된 등록 정보 이름 목록인 OData 선택 표현식입니다. 등록 정보 이름은 객체 유형에 대한 Windchill 유형 및 속성 매니저에 나타난 등록 정보의 내부 이름이어야 합니다.
Windchill 유형 및 속성 매니저에 정의된 객체 유형의 모든 속성을 포함하려면 별표(*)를 지정합니다.
이 매개변수는 선택사항입니다.
출력:
단일 이미지 객체 또는 오류 코드와 오류 메시지입니다.
오류 코드를 참조하십시오.
오류 코드
이 테이블에서는 이러한 서비스를 실행하는 중에 발생할 수 있는 오류 코드와 메시지에 대해 설명합니다.
코드
설명
200
성공적인 응답
400
URL 또는 질의 매개변수의 형식이 잘못됨
404
지정된 객체가 없음
500
예기치 않은 오류