获取供应商列表
功能介绍
获取供应商列表。
URI
GET /v1/{project_id}/vendors
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
参数解释: 供应商个数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
vendors |
Array of VendorDto objects |
参数解释: 供应商列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 供应商ID。 约束限制: 不涉及 取值范围: 长度范围为0到128个字符。 默认取值: 不涉及 |
domain_id |
String |
参数解释: 账号ID。 约束限制: 不涉及 取值范围: 长度范围为1到32个字符,支持字母、数字、下划线(_)和中划线(-)。 默认取值: 不涉及 |
name |
String |
参数解释: 名称。 约束限制: 不涉及 取值范围: 长度范围为1到100个字符。 默认取值: 不涉及 |
logo |
String |
参数解释: logo图片base64编码。 约束限制: 不涉及 取值范围: 长度范围为0到1500000个字符。 默认取值: 不涉及 |
请求示例
查询供应商列表。
https://{endpoint}/v1/{project_id}/vendors
响应示例
状态码:200
OK
{ "vendors" : [ { "id" : "09e517572000d42f0ffbc00161366480", "domain_id" : "09e517572000d42f0ffbc00161363380", "name" : "test", "logo" : "data:image/png;base64,iVBOxxxxx" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。