调用每个 API 时,都需要作为输入传入该 API 的版本。在未来发行版中,可能会支持同一 API 的多个版本。此发行版中只有 version 1。
引入了中断性变更时,将会为 API 发布一个新版本。如果任何 API 升级到新版本时会中断使用此 API 的应用程序,则可以将该变更定义为中断性变更。如果应用程序实施者希望迁移到新版本 API,则需要更新其应用程序中的调用以引用新版本,应该考虑到该应用程序需要进行一些返工才能使用 API 的新版本。
如果应用程序不需要使用 API 将引入的新功能,则可以继续引用应用程序中当前调用的版本,从而不必担心应用程序在升级时中断。
可能存在对 API 进行更新但不创建新版本的情况。例如,为使 API 正常运行,可能需要进行一些错误修复或安全修复。
系统集成者必须定义可以执行 API 的非管理员角色。管理员可以使用
SetPermission 服务向其他用户授予执行权限,也可以使用
RevokePermission 服务撤销给定权限。有关详情,请参阅
访问控制 API主题。
假设我们有一个名为 "Operators" 的用户组。最初,该组中的用户无权访问 API 服务。
要授予权限,管理员可以使用以下输入调用 SetPermission 服务:
调用成功后,"Operators" 组中的用户即可在 PTC-PLM.Windchill.BillOfProcess.Part 事物上启动 Search 服务。
{
"inputs": {
"roleName": "Operators",
"apis": [
{
"thingName": "PTC-PLM.Windchill.BillOfProcess.Part",
"serviceName": "Search"
}
]
},
"version": "1"
}
要撤销权限,管理员可以使用以下输入调用 RevokePermission 服务:
{
"inputs": {
"roleName": "Operators",
"apis": [
{
"thingName": "PTC-PLM.Windchill.BillOfProcess.Part",
"serviceName": "Search"
}
]
},
"version": "1"
所有 API 的输出均采用公用通信对象格式。有关此格式的详情,请参阅帮助中心中的
公用通信对象结构主题。