其他 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 选择表达式。属性名称必须为属性内部名称，如对象类型的 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。
此参数为必填参数。
▪ 选择 - 用于确定针对由查询返回的部件列表显示的特性 (属性)
是一个以逗号分隔的属性名称列表的 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 objects) 和补充部件 (SupplementaryReplacementLink objects) 或错误代码和错误消息
请参阅错误代码。
• /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 objects) 和补充部件 (SupplementaryReplacementLink objects) 或错误代码和错误消息
请参阅错误代码。
• /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
意外错误