Consulta de todos los departamentos por nombre
Descripción
Esta API es utilizada por un administrador de empresa para consultar todos los departamentos por nombre.
SLA
Tasa de éxito de solicitudes: > 99.99%
Retraso de la petición TP99: 224 ms
Depuración
Puede depurar esta API en API Explorer.
Prototipo
|
Método de solicitud |
GET |
|---|---|
|
Dirección de solicitud |
/v1/usg/dcs/member/dept |
|
Protocolo de transporte |
HTTPS |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Localización |
Descripción |
|---|---|---|---|---|
|
deptName |
Sí |
String |
Query |
Nombre del departamento. El valor puede contener de 1 a 128 caracteres. |
|
X-Access-Token |
Sí |
String |
Header |
Token de autorización. Utilice el valor de accessToken en la respuesta a la solicitud de Autenticación de un ID de aplicación. |
|
X-Request-Id |
No |
String |
Header |
ID de solicitud, que se utiliza para el seguimiento y la localización de fallos. Se recomienda utilizar un UUID. Si este parámetro no se incluye, se genera automáticamente un ID de solicitud. |
|
Accept-Language |
No |
String |
Header |
Idioma. Valores: zh-CN para chino (predeterminado) y en-US para inglés. |
Códigos de estado
|
Código de estado de HTTP |
Descripción |
|---|---|
|
200 |
Operación exitosa. |
|
400 |
Parámetros inválidos. |
|
401 |
La autenticación no se realiza o falla. |
|
403 |
Permisos insuficientes. |
|
500 |
Excepción del servidor. |
Parámetros de respuesta
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
[Array element] |
Array of QueryDeptResultDTO |
Lista de departamentos. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
corpId |
String |
ID de la empresa. |
|
deptCode |
String |
Código de departamento, que es único en una empresa. |
|
deptCodePath |
String |
Ruta del código del departamento. |
|
deptLevel |
Integer |
Nivel de departamento. |
|
deptName |
String |
Nombre del departamento. |
|
deptNamePath |
String |
Ruta del nombre del departamento. |
|
designatedOutDeptCodes |
Array of IdMarkDTO objects |
Lista de departamentos que pueden acceder a este departamento. |
|
inPermission |
String |
Permisos de usuarios en otros departamentos para acceder a detalles de usos en este departamento. |
|
isLeafNode |
Boolean |
Si el departamento tiene subdepartamentos. |
|
note |
String |
Observaciones. |
|
outPermission |
String |
Permisos de los usuarios en este departamento para acceder a detalles de usos en otros departamentos. |
|
parentDeptCode |
String |
ID del departamento principal. |
|
sortLevel |
Integer |
Número de secuencia del departamento. |
Ejemplo de solicitud
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)
Ejemplo de respuesta
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 error
Si se devuelve un código de error que comienza con MMC o USG cuando utiliza esta API, corrija el error siguiendo las instrucciones proporcionadas enCentro de errores de la API de Huawei Cloud.
Ejemplo 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
