部品の関連に用いる REST API
Windchill には、部品の関連にアクセスするための REST API が用意されています。この API は、読み取り専用の情報を ThingWorx などの Web サービスに公開するものです。HTTP リクエストを作成できるものであれば、あらゆるクライアントで使用できます。
|
|
以下のことに注意してください。
• これらの API のユーザーインタフェースは提供されていません。
• 多くの定義において、Windchill のオブジェクト ID (OID) が使用されます。
|
• /v1/partsrelations - 指定した基準に一致するすべての後継オブジェクトと代替オブジェクトを返します。
◦ 入力:
▪ source - OID 名のカンマ区切り値リストである Windchill ソース式。
▪ target - OID 名のカンマ区切り値リストである Windchill ターゲット式。
▪ type - タイプ名のカンマ区切り値リストである Windchill タイプ式。
▪ select - プロパティ名のカンマ区切り値リストである OData 選択式。サービスは、返す属性のデフォルトリストを定義している場合があります。アスタリスク (*) が指定されている場合、返される結果リストには、Windchill の「タイプおよび属性の管理」ユーティリティで定義されたオブジェクトのすべての属性が含まれています。
▪ securityContext - セキュリティコンテキストの Windchill OID、または解析することでナビゲーション基準を生成できるセキュリティコンテキスト名または JSON。サーチ対象のオブジェクトに作業版数が適用されていない場合、セキュリティコンテキストを指定する必要はありません。指定しない場合は最新版が選択されます。
◦ 出力:
▪ 部品のリスト、またはエラーコードとエラーメッセージ。
• /v1/partsrelations/alternates - 指定した基準に一致するすべての代替オブジェクトを返します。
◦ 入力:
▪ source - OID 名のカンマ区切り値リストである Windchill ソース式。
▪ target - OID 名のカンマ区切り値リストである Windchill ターゲット式。
▪ select - プロパティ名のカンマ区切り値リストである OData 選択式。サービスは、返す属性のデフォルトリストを定義している場合があります。アスタリスク (*) が指定されている場合、返される結果リストには、Windchill の「タイプおよび属性の管理」ユーティリティで定義されたオブジェクトのすべての属性が含まれています。
▪ securityContext - セキュリティコンテキストの Windchill OID、または解析することでナビゲーション基準を生成できるセキュリティコンテキスト名または JSON。サーチ対象のオブジェクトに作業版数が適用されていない場合、セキュリティコンテキストを指定する必要はありません。指定しない場合は最新版が選択されます。
◦ 出力:
▪ 部品のリスト、またはエラーコードとエラーメッセージ。
• /v1/partsrelations/supersession - 指定した基準に一致するすべての後継オブジェクトを返します。
◦ 入力:
▪ source - OID 名のカンマ区切り値リストである Windchill ソース式。
▪ target - OID 名のカンマ区切り値リストである Windchill ターゲット式。
▪ select - プロパティ名のカンマ区切り値リストである OData 選択式。サービスは、返す属性のデフォルトリストを定義している場合があります。アスタリスク (*) が指定されている場合、返される結果リストには、Windchill の「タイプおよび属性の管理」ユーティリティで定義されたオブジェクトのすべての属性が含まれています。
▪ securityContext - セキュリティコンテキストの Windchill OID、または解析することでナビゲーション基準を生成できるセキュリティコンテキスト名または JSON。サーチ対象のオブジェクトに作業版数が適用されていない場合、セキュリティコンテキストを指定する必要はありません。指定しない場合は最新版が選択されます。
◦ 出力:
▪ 部品のリスト、またはエラーコードとエラーメッセージ。
• /v1/partsrelations/alternate/{id} -指定した ID を持つ代替オブジェクトを返します。
◦ 入力:
▪ id - Windchilll OIR の数字部分。
このパラメータは必須です。
▪ select - プロパティ名のカンマ区切り値リストである OData 選択式。サービスは、返す属性のデフォルトリストを定義している場合があります。アスタリスク (*) が指定されている場合、返される結果リストには、Windchill の「タイプおよび属性の管理」ユーティリティで定義されたオブジェクトのすべての属性が含まれています。
◦ 出力:
▪ 代替オブジェクト、またはエラーコードとエラーメッセージ。
• /v1/partsrelations/supersession/{id} - 指定した ID を持つ後継オブジェクトを返します。
◦ 入力:
▪ id - Windchilll OIR の数字部分。
このパラメータは必須です。
▪ select - プロパティ名のカンマ区切り値リストである OData 選択式。サービスは、返す属性のデフォルトリストを定義している場合があります。アスタリスク (*) が指定されている場合、返される結果リストには、Windchill の「タイプおよび属性の管理」ユーティリティで定義されたオブジェクトのすべての属性が含まれています。
◦ 出力:
▪ 後継オブジェクト、またはエラーコードとエラーメッセージ。
