检索软件组件 (v2)

在线编辑

9.2.14 可查阅 9.2.14。 您可以在 api/sam/v2/software_components 元素上使用 GET 操作来请求有关目录中软件组件的信息。 API 将返回现有组件的详细信息以及有关已除去组件的历史数据。

许可权

表示用户的图标。 您必须拥有 "查看软件目录和签名 "权限才能执行此任务。

资源 URL

https://server_url:server_port/api/sam/v2/software_components

资源信息

表 1. 资源信息
操作详细信息 描述
HTTP 方法 GET
请求头
Accept-Language（可选）
  • 使用: 用于协商响应的语言。 如果不指定该头，将以服务器语言返回内容。
  • 值: en-US (仅支持英语)
Token
  • 使用: 用于认证 REST API 请求。 当您将 api_token_in_url_enabled 参数的值设置为 false时，头是必需的。 否则，您可以在请求标头或 URL 中指定令牌。 更多信息，请参阅： 验证 REST API 请求。
  • 值: 在 License Metric Tool 中生成的字母数字字符串
请求格式 application/json
响应头
Content-Type
  • 使用: 指定响应的内容类型。
  • 值： application/json
Content-Language
  • 使用: 指定响应内容的语言。 如果不指定该头，将以服务器语言返回内容。
  • 值 :en-US ， ...
响应有效内容 Software Components 元素
响应格式 application/json
响应码

200 – OK

500 – “Bad Request”，如果查询参数包含错误或缺失

模式描述

要检索此 REST API 返回的所有列及其描述的列表，请使用以下请求。
GET https://server_url:server_port/api/sam/v2/schemas/software_component.json

可用列

表 2. 可用栏目
列 描述 缺省情况下显示 类型
id 组件实例的标识。 ✓ 数值
name 组件的名称。 ✓ 字符串
release 组件的发行版。 ✓ 字符串
guid 组件 GUID。 ✓ 字符串
is_ibm 有关组件是否由 IBM提供的信息。 布尔值

适用的关联

您还可以从以下关联中检索数据:

查询参数

表 3. 查询参数
参数 描述 必填 值
columns[] 指定要检索的列。 如果未指定此参数，那么将仅检索缺省列。
示例: 检索组件名称和标识
URL?columns[]=name&columns[]=id
 字符串
order 指定如何对返回的数据排序。 对列进行排序的缺省方向是升序。 如果要指定降序排序，请将 desc 附加到列名称。
示例: 按组件标识降序排序
URL?order[]=id desc
 字母数字
limit 指定要检索的行数。 如果省略此参数，将检索所有的行。
示例: 检索 100 条记录
URL?limit=100
 数值
offset 指定要为获取检索结果而跳过的行数。 您可以将其与用于对结果编写页码的限制参数一起使用。
示例: 从记录 150 之后开始检索 50 条记录
URL?limit=50&offset=150
 数值
criteria 检索与特定条件匹配的记录。 该参数应具有以下结构 (写在一行中):
<criteria> ::= <left-brace> <boolean-operator> <colon> <left-bracket> 
<criterion> [{ <comma> <criterion> }...] <right-bracket> <right-brace>
<boolean-operator> ::= "and" | "or"
<criterion> ::= <criteria> | <left-bracket> <column> <comma> <operator> <comma> <value> <right-bracket>
<column> ::= <json-string>
<operator> ::= <json-string>
<value> ::= <json-array> | <json-string> | <json-number> | <json-null>

有关操作符的更多信息，请参阅常用连接器和操作符。

 字符串

示例对话-缺省列

请求
GET https://server_url:server_port/api/sam/v2/software_components
请求头
Accept: application/json 
Accept-Language: en-US
Token: <token>
响应主体
[{
"id":1,
"name":"DB2 8.1",
"release":8,
"guid":"XYZ",
"is_ibm":1,
}]

示例对话-关联

请求
GET https://server_url:server_port/api/sam/v2/software_components
?columns[]=id&columns[]=name&columns[]=tags.name
请求头
Accept: application/json 
Accept-Language: en-US
Token: <token>
响应主体
[{
"id":1,
"name":"DB2 8.1",
"tags":
[{"name":"ibm"}]
}]