Windchill Service Parts の REST API
Windchill Service Parts には、部品リスト、部品リストアイテム、イラストレーションのデータにアクセスするための REST API が用意されています。この API は、読み取り専用の情報を ThingWorx などの Web サービスに公開するものです。HTTP リクエストを作成できるものであれば、あらゆるクライアントで使用できます。
|
|
これらの API のユーザーインタフェースは提供されていません。
|
• /v1/partslists - 指定された条件に一致するすべての部品リストを返します。
◦ 入力:
▪ select - 照会から返される部品リストのプロパティ (属性) を指定します。
プロパティ名のカンマ区切り値リストである
OData 選択式です。プロパティ名は、オブジェクトタイプの
Windchill タイプおよび属性マネージャに表示されるプロパティの内部名にする必要があります。
アスタリスク (*) を指定すると、Windchill タイプおよび属性マネージャで定義した PartsList オブジェクトタイプの属性がすべて対象になります。
リストを空欄のままにすると、プロパティのデフォルトリストが返されます。
このパラメータはオプションです。
▪ filter - 照会のフィルタを定義します。
<propertyName> <operator> '<value>' [and | or | not]... という形式の
OData フィルタ基準です。
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 選択式です。プロパティ名は、オブジェクトタイプの
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 フィルタ基準です。
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 選択式です。プロパティ名は、オブジェクトタイプの
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 - 返される推奨部品と代用部品のリストを、さらにきめ細かく制御します。
ナビゲーション基準またはナビゲーション基準名の Windchill オブジェクト識別子 (OID)、または解析することでナビゲーション基準を生成できる JSON。
サーチ対象のオブジェクトに作業版数が適用されていない場合、ナビゲーション基準を指定する必要はありません。
この値を指定しない場合は最新版が選択されます。
このパラメータはオプションです。
◦ 出力:
▪ 代用部品 (PartsListItemSubstituteLink オブジェクト) と推奨部品 (SupplementaryReplacementLink オブジェクト) のリスト、またはエラーコードとエラーメッセージ。
エラーコードを参照してください。
• /v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations - 指定された部品リスト内の指定された部品リストアイテムについて、すべてのアイテムの関連 (代用部品と推奨部品) を返します。
◦ 入力:
▪ partsListId - 組織コンテキストに含まれている部品リストの識別子を指定します。
この値は、<organizationName><delimiter><number> という形式にする必要があります (例: Demo Organization_0000222341)。
このパラメータは必須です。
▪ partsListItemId - 部品リストアイテムの識別子を指定します。
部品リストアイテムは部品リストの子であるため、子の識別子で十分です。
このパラメータは必須です。
▪ select - 照会から返される代用部品と推奨部品について表示するプロパティ (属性) を指定します。
プロパティ名のカンマ区切り値リストである
OData 選択式です。プロパティ名は、オブジェクトタイプの
Windchill タイプおよび属性マネージャに表示されるプロパティの内部名にする必要があります。
アスタリスク (*) を指定すると、Windchill タイプおよび属性マネージャで定義した PartsListItemSubstituteLink オブジェクトタイプおよび SupplementaryReplacementLink オブジェクトタイプの属性がすべて対象になります。
このパラメータはオプションです。
▪ navigationCriteria - 返される推奨部品と代用部品のリストを、さらにきめ細かく制御します。
ナビゲーション基準またはナビゲーション基準名の Windchill オブジェクト識別子 (OID)、または解析することでナビゲーション基準を生成できる JSON。
サーチ対象のオブジェクトに作業版数が適用されていない場合、ナビゲーション基準を指定する必要はありません。
この値を指定しない場合は最新版が選択されます。
このパラメータはオプションです。
◦ 出力:
▪ 代用部品 (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 フィルタ基準です。
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 選択式です。プロパティ名は、オブジェクトタイプの
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 フィルタ基準です。
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 選択式です。プロパティ名は、オブジェクトタイプの
Windchill タイプおよび属性マネージャに表示されるプロパティの内部名にする必要があります。
アスタリスク (*) を指定すると、Windchill タイプおよび属性マネージャで定義した SupplementaryReplacementLink オブジェクトタイプの属性がすべて対象になります。
このパラメータはオプションです。
▪ navigationCriteria - 返される推奨部品のリストを、さらにきめ細かく制御します。
ナビゲーション基準またはナビゲーション基準名の Windchill オブジェクト識別子 (OID)、または解析することでナビゲーション基準を生成できる JSON。
サーチ対象のオブジェクトに作業版数が適用されていない場合、ナビゲーション基準を指定する必要はありません。
この値を指定しない場合は最新版が選択されます。
このパラメータはオプションです。
◦ 出力:
▪ 推奨部品のリスト (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 フィルタ基準です。
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 選択式です。プロパティ名は、オブジェクトタイプの
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
|
予期しないエラーです。
|
