其他 Windchill 功能 > 服務資訊管理 > 關於 Windchill Service Parts > Windchill Service Parts REST API
  
Windchill Service Parts REST API
Windchill Service Parts 提供用於存取零件清單、零件清單項目與插圖資料的 REST API。這些 API 會向 web 服務 (如 ThingWorx) 顯露唯讀資訊。能夠進行 HTTP 請求的任何用戶端都可以使用這些 API。
* 
未提供這些 API 的使用者介面。
• /v1/partslists － 傳回所有符合指定條件的零件清單
◦ 輸入：
▪ select － 決定由查詢傳回的零件清單內容 (屬性)
屬於以逗號分隔的內容名稱清單的 OData select 運算式。內容名稱必須是內容的內部名稱，因為它會顯示在物件類型的 Windchill「類型及屬性管理員」中。
指定星號 (*) 以包括 Windchill「類型及屬性管理員」中所定義 PartsList 物件類型的所有屬性。
將清單保留空白可傳回內容的預設清單。
此參數是選用的。
▪ 篩選器 － 定義查詢的篩選器
OData 篩選器條件，格式為 <propertyName> <operator> '<value>' [and | or | not]...，其中 operator 為 eq 或 ne 或 le 或其他 OData 比較運算子。
例如，number eq '0000222341'。
此參數是選用的。
▪ navigationCriteria － 針對傳回的零件清單的清單，新增進一步控制
導覽條件的 Windchill 物件識別元 (OID) 或導覽條件名稱，或可進行導覽條件語法分析的 JSON。
如果搜尋的物件尚未版序化，則不必指定導覽條件。
如果未指定該值，則會選擇最新版本。
此參數是選用的。
◦ 輸出：
▪ 零件清單的清單 (PartsList 物件) 或錯誤代碼與錯誤訊息
請參閱錯誤代碼。
• /v1/partslists/{partsListId} - 傳回具有指定 ID 的零件清單
◦ 輸入：
▪ partsListId - 在組織前後關聯中指定零件清單的識別元
該值的格式必須為 <organizationName><delimiter><number>，例如 Demo Organization_0000222341。
必須使用這個參數。
▪ select - 決定由查詢傳回的零件清單所顯示的內容 (屬性)
屬於以逗號分隔的內容名稱清單的 OData select 運算式。內容名稱必須是內容的內部名稱，因為它會顯示在物件類型的 Windchill「類型及屬性管理員」中。
指定星號 (*) 以包括 Windchill「類型及屬性管理員」中所定義 PartsList 物件類型的所有屬性。
此參數是選用的。
◦ 輸出：
▪ 單一零件清單 (PartsList 物件) 或錯誤代碼與錯誤訊息
請參閱錯誤代碼。
• /v1/partslists/{partsListId}/items - 傳回指定零件清單中的所有零件清單項目
◦ 輸入：
▪ partsListId - 在組織前後關聯中指定零件清單的識別元
該值的格式必須為 <organizationName><delimiter><number>，例如 Demo Organization_0000222341。
必須使用這個參數。
▪ select - 決定由查詢傳回的零件清單項目內容 (屬性)
屬於以逗號分隔的內容名稱清單的 OData select 運算式。內容名稱必須是內容的內部名稱，因為它會顯示在物件類型的 Windchill「類型及屬性管理員」中。
指定星號 (*) 以包括 Windchill「類型及屬性管理員」中所定義 PartsListItem 物件類型的所有屬性。
此參數是選用的。
▪ 篩選器 － 定義查詢的篩選器
OData 篩選器條件，格式為 <propertyName> <operator> '<value>' [and | or | not]...，其中 operator 為 eq 或 ne 或 le 或其他 OData 比較運算子。
例如，number eq '0000222341'。
此參數是選用的。
◦ 輸出：
▪ 零件清單項目的清單 (PartsListItem 物件) 或錯誤代碼與錯誤訊息
請參閱錯誤代碼。
• /v1/partslists/{partsListId}/items/{partsListItemId} - 傳回指定零件清單中具有指定 ID 的零件清單項目
◦ 輸入：
▪ partsListId - 在組織前後關聯中指定零件清單的識別元
該值的格式必須為 <organizationName><delimiter><number>，例如 Demo Organization_0000222341。
必須使用這個參數。
▪ partsListItemId - 指定零件清單項目的識別元
由於零件清單項目是零件清單的子代，因此使用子代識別元就足夠了。
必須使用這個參數。
▪ select - 決定由查詢傳回的零件清單項目內容 (屬性)
屬於以逗號分隔的內容名稱清單的 OData select 運算式。內容名稱必須是內容的內部名稱，因為它會顯示在物件類型的 Windchill「類型及屬性管理員」中。
指定星號 (*) 以包括 Windchill「類型及屬性管理員」中所定義 PartsListItem 物件類型的所有屬性。
此參數是選用的。
◦ 輸出：
▪ 單一零件清單項目 (PartsListItem 物件) 或錯誤代碼與錯誤訊息
請參閱錯誤代碼。
• /v1/partslists/{partsListId}/items/{partsListItemId}/part - 傳回指定零件清單中與指定零件清單項目關聯的零件
◦ 輸入：
▪ partsListId - 在組織前後關聯中指定零件清單的識別元
該值的格式必須為 <organizationName><delimiter><number>，例如 Demo Organization_0000222341。
必須使用這個參數。
▪ partsListItemId - 指定零件清單項目的識別元
由於零件清單項目是零件清單的子代，因此使用子代識別元就足夠了。
必須使用這個參數。
▪ select - 決定由查詢傳回的零件內容 (屬性)
屬於以逗號分隔的內容名稱清單的 OData select 運算式。內容名稱必須是內容的內部名稱，因為它會顯示在物件類型的 Windchill「類型及屬性管理員」中。
指定星號 (*) 以包括 Windchill「類型及屬性管理員」中所定義物件類型的所有屬性。
此參數是選用的。
◦ 輸出：
▪ 單一零件物件或錯誤代碼與錯誤訊息
▪ 請參閱錯誤代碼。
• /v1/partslists/{partsListId}/itemrelations － 傳回指定零件清單中的所有項目關係 (特定替代零件與補充零件)
◦ 輸入：
▪ partsListId - 在組織前後關聯中指定零件清單的識別元
該值的格式必須為 <organizationName><delimiter><number>，例如 Demo Organization_0000222341。
必須使用這個參數。
▪ select - 決定由查詢傳回的特定替代零件和補充零件所顯示的內容 (屬性)
屬於以逗號分隔的內容名稱清單的 OData select 運算式。內容名稱必須是內容的內部名稱，因為它會顯示在物件類型的 Windchill「類型及屬性管理員」中。
指定星號 (*) 以包括 Windchill「類型及屬性管理員」中所定義 PartsListItemSubstituteLink 和 SupplementaryReplacementLink 物件類型的所有屬性。
此參數是選用的。
▪ navigationCriteria - 針對傳回的補充零件和特定替代零件的清單，新增進一步控制
導覽條件的 Windchill 物件識別元 (OID) 或導覽條件名稱，或可進行導覽條件語法分析的 JSON。
如果搜尋的物件尚未版序化，則不必指定導覽條件。
如果未指定該值，則會選擇最新版本。
此參數是選用的。
◦ 輸出：
▪ 特定替代零件 (PartsListItemSubstituteLink 物件) 和補充零件 (SupplementaryReplacementLink 物件) 或錯誤代碼與錯誤訊息
請參閱錯誤代碼。
• /v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations － 傳回指定零件清單中指定零件清單項目的所有項目關係 (特定替代零件與補充零件)
◦ 輸入：
▪ partsListId - 在組織前後關聯中指定零件清單的識別元
該值的格式必須為 <organizationName><delimiter><number>，例如 Demo Organization_0000222341。
必須使用這個參數。
▪ partsListItemId - 指定零件清單項目的識別元
由於零件清單項目是零件清單的子代，因此使用子代識別元就足夠了。
必須使用這個參數。
▪ select - 決定由查詢傳回的特定替代零件和補充零件所顯示的內容 (屬性)
屬於以逗號分隔的內容名稱清單的 OData select 運算式。內容名稱必須是內容的內部名稱，因為它會顯示在物件類型的 Windchill「類型及屬性管理員」中。
指定星號 (*) 以包括 Windchill「類型及屬性管理員」中所定義 PartsListItemSubstituteLink 和 SupplementaryReplacementLink 物件類型的所有屬性。
此參數是選用的。
▪ navigationCriteria - 針對傳回的補充零件和特定替代零件的清單，新增進一步控制
導覽條件的 Windchill 物件識別元 (OID) 或導覽條件名稱，或可進行導覽條件語法分析的 JSON。
如果搜尋的物件尚未版序化，則不必指定導覽條件。
如果未指定該值，則會選擇最新版本。
此參數是選用的。
◦ 輸出：
▪ 特定替代零件 (PartsListItemSubstituteLink 物件) 和補充零件 (SupplementaryReplacementLink 物件) 或錯誤代碼與錯誤訊息
請參閱錯誤代碼。
• /v1/partslists/{partsListId}/itemrelations/substitute - 傳回指定零件清單中的所有特定替代零件
◦ 輸入：
▪ partsListId - 在組織前後關聯中指定零件清單的識別元
該值的格式必須為 <organizationName><delimiter><number>，例如 Demo Organization_0000222341。
必須使用這個參數。
▪ select - 決定由查詢傳回的特定替代零件所顯示的內容 (屬性)
屬於以逗號分隔的內容名稱清單的 OData select 運算式。內容名稱必須是內容的內部名稱，因為它會顯示在物件類型的 Windchill「類型及屬性管理員」中。
指定星號 (*) 以包括 Windchill「類型及屬性管理員」中所定義 PartsListItemSubstituteLink 物件類型的所有屬性。
此參數是選用的。
▪ 篩選器 － 定義查詢的篩選器
OData 篩選器條件，格式為 <propertyName> <operator> '<value>' [and | or | not]...，其中 operator 為 eq 或 ne 或 le 或其他 OData 比較運算子。
例如，number eq '0000222341'。
此參數是選用的。
◦ 輸出：
▪ 特定替代零件的清單 (PartsListItemSubstituteLink 物件) 或錯誤代碼與錯誤訊息
請參閱錯誤代碼。
• /v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations/substitute - 傳回指定零件清單中指定零件清單項目的所有特定替代零件
◦ 輸入：
▪ partsListId - 在組織前後關聯中指定零件清單的識別元
該值的格式必須為 <organizationName><delimiter><number>，例如 Demo Organization_0000222341。
必須使用這個參數。
▪ partsListItemId - 指定零件清單項目的識別元
由於零件清單項目是零件清單的子代，因此使用子代識別元就足夠了。
必須使用這個參數。
▪ select - 決定由查詢傳回的特定替代零件所顯示的內容 (屬性)
屬於以逗號分隔的內容名稱清單的 OData select 運算式。內容名稱必須是內容的內部名稱，因為它會顯示在物件類型的 Windchill「類型及屬性管理員」中。
指定星號 (*) 以包括 Windchill「類型及屬性管理員」中所定義 PartsListItemSubstituteLink 物件類型的所有屬性。
此參數是選用的。
◦ 輸出：
▪ 特定替代零件的清單 (PartsListItemSubstituteLink 物件) 或錯誤代碼與錯誤訊息
請參閱錯誤代碼。
• /v1/partslists/{partsListId}/itemrelations/supplementary - 傳回指定零件清單中的所有補充零件
◦ 輸入：
▪ partsListId - 在組織前後關聯中指定零件清單的識別元
該值的格式必須為 <organizationName><delimiter><number>，例如 Demo Organization_0000222341。
必須使用這個參數。
▪ select - 決定由查詢傳回的補充零件所顯示的內容 (屬性)
屬於以逗號分隔的內容名稱清單的 OData select 運算式。內容名稱必須是內容的內部名稱，因為它會顯示在物件類型的 Windchill「類型及屬性管理員」中。
指定星號 (*) 以包括 Windchill「類型及屬性管理員」中所定義 SupplementaryReplacementLink 物件類型的所有屬性。
此參數是選用的。
▪ 篩選器 － 定義查詢的篩選器
OData 篩選器條件，格式為 <propertyName> <operator> '<value>' [and | or | not]...，其中 operator 為 eq 或 ne 或 le 或其他 OData 比較運算子。
例如，number eq '0000222341'。
此參數是選用的。
◦ 輸出：
▪ 補充零件的清單 (SupplementaryReplacementLink 物件) 或錯誤代碼與錯誤訊息
請參閱錯誤代碼。
• /v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations/supplementary - 傳回指定零件清單中指定零件清單項目的所有補充零件
◦ 輸入：
▪ partsListId - 在組織前後關聯中指定零件清單的識別元
該值的格式必須為 <organizationName><delimiter><number>，例如 Demo Organization_0000222341。
必須使用這個參數。
▪ partsListItemId - 指定零件清單項目的識別元
由於零件清單項目是零件清單的子代，因此使用子代識別元就足夠了。
必須使用這個參數。
▪ select - 決定由查詢傳回的補充零件所顯示的內容 (屬性)
屬於以逗號分隔的內容名稱清單的 OData select 運算式。內容名稱必須是內容的內部名稱，因為它會顯示在物件類型的 Windchill「類型及屬性管理員」中。
指定星號 (*) 以包括 Windchill「類型及屬性管理員」中所定義 SupplementaryReplacementLink 物件類型的所有屬性。
此參數是選用的。
▪ navigationCriteria - 針對傳回的補充零件的清單，新增進一步控制
導覽條件的 Windchill 物件識別元 (OID) 或導覽條件名稱，或可進行導覽條件語法分析的 JSON。
如果搜尋的物件尚未版序化，則不必指定導覽條件。
如果未指定該值，則會選擇最新版本。
此參數是選用的。
◦ 輸出：
▪ 補充零件的清單 (SupplementaryReplacementLink 物件) 或錯誤代碼與錯誤訊息
請參閱錯誤代碼。
• /v1/partslists/{partsListId}/illustrations - 傳回指定零件清單中的所有插圖
◦ 輸入：
▪ partsListId - 在組織前後關聯中指定零件清單的識別元
該值的格式必須為 <organizationName><delimiter><number>，例如 Demo Organization_0000222341。
必須使用這個參數。
▪ select - 決定由查詢傳回的插圖所顯示的內容 (屬性)
屬於以逗號分隔的內容名稱清單的 OData select 運算式。內容名稱必須是內容的內部名稱，因為它會顯示在物件類型的 Windchill「類型及屬性管理員」中。
指定星號 (*) 以包括 Windchill「類型及屬性管理員」中所定義 DynamicDocument 物件類型的所有屬性。
此參數是選用的。
▪ 篩選器 － 定義查詢的篩選器
OData 篩選器條件，格式為 <propertyName> <operator> '<value>' [and | or | not]...，其中 operator 為 eq 或 ne 或 le 或其他 OData 比較運算子。
例如，number eq '0000222341'。
此參數是選用的。
◦ 輸出：
▪ 插圖的清單 (DynamicDocument 物件) 或錯誤代碼與錯誤訊息
請參閱錯誤代碼。
• /v1/partslists/{partsListId}/illustrations/{illustrationId} - 傳回指定零件清單中具有指定 ID 的插圖
◦ 輸入：
▪ partsListId - 在組織前後關聯中指定零件清單的識別元
該值的格式必須為 <organizationName><delimiter><number>，例如 Demo Organization_0000222341。
必須使用這個參數。
▪ illustrationId - 指定插圖的識別元
由於插圖是零件清單的子代，因此使用子代識別元就足夠了。
必須使用這個參數。
▪ select - 決定由查詢傳回的插圖所顯示的內容 (屬性)
屬於以逗號分隔的內容名稱清單的 OData select 運算式。內容名稱必須是內容的內部名稱，因為它會顯示在物件類型的 Windchill「類型及屬性管理員」中。
指定星號 (*) 以包括 Windchill「類型及屬性管理員」中所定義 DynamicDocument 物件類型的所有屬性。
此參數是選用的。
◦ 輸出：
▪ 單一插圖 (DynamicDocument 物件) 或錯誤代碼與錯誤訊息
請參閱錯誤代碼。
• /v1/partslists/{partsListId}/illustrations/{illustrationId}/image - 傳回指定零件清單中與指定插圖關聯的圖像
◦ 輸入：
▪ partsListId - 在組織前後關聯中指定零件清單的識別元
該值的格式必須為 <organizationName><delimiter><number>，例如 Demo Organization_0000222341。
必須使用這個參數。
▪ illustrationId - 指定插圖的識別元
由於插圖是零件清單的子代，因此使用子代識別元就足夠了。
必須使用這個參數。
▪ select - 決定由查詢傳回的圖像所顯示的內容 (屬性)
屬於以逗號分隔的內容名稱清單的 OData select 運算式。內容名稱必須是內容的內部名稱，因為它會顯示在物件類型的 Windchill「類型及屬性管理員」中。
指定星號 (*) 以包括 Windchill「類型及屬性管理員」中所定義物件類型的所有屬性。
此參數是選用的。
◦ 輸出：
▪ 單一圖像物件或錯誤代碼與錯誤訊息
請參閱錯誤代碼。
錯誤代碼
此表格描述您在執行這些服務時可能遇到的錯誤代碼與訊息。
代碼
描述
200
成功回應
400
URL 或查詢參數格式不正確
404
指定的物件不存在
500
未預期錯誤