查询组织
功能介绍
应用服务器可调用此接口查询单个组织信息，包含组织名称、ID及组织的属性值。
URI
GET /v1/iotfm/organizations/{organization_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
organization_id |
是 |
String |
参数说明：组织ID。 取值范围：长度固定24，只允许大小写字母、数字的组合。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数说明：用户Token。通过调用 生成Token 接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 |
|
X-Instance-Id |
是 |
String |
参数说明：实例ID。通过访问智能设施云平台界面后获取，智能设施云平台资源均为实例级隔离，所有业务接口必须填写正确的实例ID才能被成功调用。 取值范围：长度8-36，只允许大小写字母、数字和-字符的组合。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数说明：组织ID。 取值范围：长度固定24，只允许大小写字母、数字的组合。 |
|
name |
String |
参数说明：组织名。 取值范围：长度1-256。 |
|
parent_id |
String |
参数说明：父级组织ID。 取值范围：长度固定24，只允许大小写字母、数字的组合。 |
|
children_count |
Integer |
参数说明：直接下级数量。 取值范围：大小为0-100。 |
|
parent_name |
String |
参数说明：父级组织名。 取值范围：长度1-256。 |
|
properties |
Map<String,String> |
参数说明：属性键值对。 |
|
create_time |
String |
参数说明：创建时间，格式为：yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。 取值范围：长度0-20。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数说明：错误码。 取值范围：长度8-36。 |
|
error_msg |
String |
参数说明：错误描述。 取值范围：长度2-512。 |
请求示例
查询组织
GET https://{endpoint}/v1/iotfm/organizations/abcdefaaaaaaaaaaaaaaaaaaaa
响应示例
状态码：200
Organization Information
{
"name" : "DemoOrg0",
"id" : "abcdefaaaaaaaaaaaaaaaaaaaa"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Organization Information |
|
400 |
Error response |
