Use esta API para consultar a lista de departamentos da organização.
|
Edições compatíveis |
Enterprise Dedicated Edition |
Endpoints de serviço
Obtenha o endpoint de serviço e substitua {domain} na sintaxe de requisição da API pelo seu endpoint.
Informações de autorização
|
Produto |
Recurso |
Permissão necessária |
|
Organization Management |
Departamentos da organização |
Somente leitura |
Sintaxe da requisição
GET https://{domain}/oapi/v1/platform/organizations/{organizationId}/departments
Descrição da requisição |
Consultar a lista de departamentos da organização
Consultar todos os subdepartamentos de um departamento específico
|
Cabeçalhos da requisição (Headers) |
|
|
O token de acesso. Consulte Token de acesso para obter detalhes. Exemplo: pt-0fh3****0fbG_35af****0484. |
|
Parâmetros da requisição |
|
|
organizationId ID da organização. Acesse a página System Management no console do Organization Management para obter o ID da organização (organizationId). |
|
|
parentId ID do departamento pai. |
|
|
page Página atual. |
|
|
perPage Número de entradas por página. Valores válidos: |
Parâmetros de resposta |
Exemplo de resposta
|
|
creatorId ID do criador. |
|
|
hasSub Indica se o departamento tem subdepartamentos. |
|
|
id ID do departamento. |
|
|
name Nome do departamento. |
|
|
organizationId ID da organização. |
|
|
parentId ID do departamento pai. |
Cabeçalho de resposta
|
Parâmetro |
Descrição |
Valor de exemplo |
|
x-next-page |
Próxima página. |
1 |
|
x-page |
Página atual. |
2 |
|
x-per-page |
Número de entradas por página. |
1 |
|
x-prev-page |
Página anterior. |
2 |
|
x-total |
Número total de entradas. |
1 |
|
x-total-pages |
Número total de páginas. |
10 |
Códigos de erro
Para mais informações, consulte a Central de códigos de erro.