Departamentos

(GET) employeejourney/queries/getDepartment

https://platform.senior.com.br/t/senior.com.br/bridge/1.0/rest/hcm/employeejourney/queries/getDepartment

Um "department", para o HCM, é uma entidade que representam as informações de departamentos cadastrados - mesmo sem colaboradores vinculados. Algumas dessas informações são: ID, nome, posição, endereço, data de criação, código de tabela, código, data de histórico e data de expiração. Estas informações podem ser visualizadas pelo colaborador na tela de Departamentos, no módulo do Painel de Gestão.

Esse endpoint é utilizado para obter as informações dos Centros de Custos cadastrados na base do HCM. Esse endpoint é utilizado para obter as informações dos departamentos cadastrados na base do HCM. Todos os endpoints do serviço da jornada do colaborador só podem ser acessados por usuários ou aplicações com o permissionamento correto com um limite máximo de 100 itens por página de retorno. Campos não preenchidos não são retornados.

O payload de cada departamento consiste de:

        {
            "id": "Id departamento",
            "tableCode": código da tabela,
            "code": "código do departamento cadastrado",
            "position": "Posição",
            "name": "Nome do departamento",
            "creationDate": "data de criação",
            "historicExpirationDate": "Histórico de expiração",
            "address": {
                "id": "idEndereço",
                "additional": "complemento",
                "neighborhood": "Bairro",
                "address": "endereço",
                "city": {
                    "id": "id da cidade",
                    "name": "Nome da cidade",
                    "state": {
                        "id": "Id do Estado",
                        "abbreviation": "Abreviação do Estado ex: SC",
                        "name": "Nome do estado"
                    },
                    "code": Código
                }
            }
        }

Uso dos filtros:

É possível filtrar os resultados seguindo estas diretivas.

Casos de uso:

• Buscar todos os departamentos cadastrados no sistema:

  https://api.senior.com.br/hcm/employeejourney/queries/getDepartment

  

• Buscar todos os departamentos que possuem um endereço cadastrado:

  .../getDepartment?filter=address.id is not null

  

• Buscar os endereços de todos os departamentos que possuem o endereço em uma determinada cidade:

  .../getDepartment?filter=address.id is not null and address.city.name='nomedacidade'

  

• Buscar departamento pelo nome:

  .../getDepartment?filter=name='Nome'

  

• Buscar departamento pelo código:

  .../getDepartment?filter=code='codigo'

  

• Buscar todos os departamentos com determinado nome usando containing:

  .../getDepartment?filter=containing(name, 'nome departamento')

  

• Filtrando por quatidade de retorno por página usando ordenação:

  .../getDepartment?size=2&offset=0&orderby=name