Consulta de todos os departamentos por nome
Descrição
Esta API é usada por um administrador empresarial para consultar todos os departamentos pelo nome.
SLA
Taxa de sucesso de solicitação: > 99,99%
Atraso na solicitação TP99: 224 ms
Depuração
Você pode depurar essa API no API Explorer.
Protótipo
|
Método de solicitação |
GET |
|---|---|
|
Endereço de solicitação |
/v1/usg/dcs/member/dept |
|
Protocolo de transporte |
HTTPS |
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Localização |
Descrição |
|---|---|---|---|---|
|
deptName |
Sim |
String |
Consulta |
Nome do departamento. O valor pode conter de 1 a 128 caracteres. |
|
X-Access-Token |
Sim |
String |
Cabeçalho |
Token de autorização. Use o valor de accessToken na resposta à solicitação de Autenticação de um ID de aplicação. |
|
X-Request-Id |
Não |
String |
Cabeçalho |
ID da solicitação, que é usado para rastreamento e localização de falhas. É aconselhável usar um UUID. Se este parâmetro não for transportado, um ID de solicitação é gerado automaticamente. |
|
Accept-Language |
Não |
String |
Cabeçalho |
Idioma. Valores: zh-CN para chinês (padrão) e en-US para inglês. |
Códigos de status
|
Código de status HTTP |
Descrição |
|---|---|
|
200 |
Operação bem-sucedida. |
|
400 |
Parâmetros inválidos. |
|
401 |
A autenticação não é executada ou falha. |
|
403 |
Permissões insuficientes. |
|
500 |
Exceção do servidor. |
Parâmetros de resposta
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
[Array element] |
Array of QueryDeptResultDTO |
Lista do departamento. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
corpId |
String |
ID empresarial. |
|
deptCode |
String |
Código de departamento, que é único em uma empresa. |
|
deptCodePath |
String |
Caminho do código do departamento. |
|
deptLevel |
Integer |
Nível do departamento. |
|
deptName |
String |
Nome do departamento. |
|
deptNamePath |
String |
Caminho do nome do departamento. |
|
designatedOutDeptCodes |
Array of IdMarkDTO objects |
Lista de departamentos que têm permissão para acessar este departamento. |
|
inPermission |
String |
Permissões de usuários em outros departamentos para acessar detalhes de usos neste departamento. |
|
isLeafNode |
Boolean |
Se o departamento tem subdepartamentos. |
|
note |
String |
Observações. |
|
outPermission |
String |
Permissões de usuários neste departamento para acessar detalhes de usos em outros departamentos. |
|
parentDeptCode |
String |
ID do departamento pai. |
|
sortLevel |
Integer |
Número de sequência do departamento. |
Exemplo de solicitação
GET /v1/usg/dcs/member/dept?deptName=wangyue Connection: keep-alive X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
Exemplo de resposta
HTTP/1.1 200
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 539e8b710378987ffc5eb844b5e5c290
[
{
"deptCode": "1",
"deptLevel": 1,
"deptName": "wangyue",
"deptNamePath": "wangyue",
"isLeafNode": false,
"parentDeptCode": null,
"deptCodePath": "1",
"note": null,
"corpId": "15659",
"inPermission": "UNLIMITED",
"outPermission": "UNLIMITED",
"sortLevel": 10000,
"designatedOutDeptCodes": []
}
]
Códigos de erro
Se um código de erro começando com MMC ou USG for retornado quando você usar essa API, corrija a falha seguindo as instruções fornecidas na Centro de erros da API da Huawei Cloud.
Exemplo de comando cURL
curl -k -i -X GET -H 'X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki' https://api.meeting.huaweicloud.com/v1/usg/dcs/member/dept?deptName=wangyue
