Buscar listagens de cadastros diversos (Queries - listas) — APIs da Admissão Digital

As Queries descritas nesta documentação retornam a lista de registros de alguns tipos de cadastros existentes na base, como por exemplo: empresas, filiais e cargos.

Esta documentação explica como fazer requisições para as queries que estão disponíveis nas APIs da Admissão Digital.

• URL
• Cabeçalho
• Queries:
  • Empresas (companyQuery)
  • Filiais (branchOfficeQuery)
  • Cargos (jobPositionQuery)
• Filtros

URL

Substitua<url_plataforma>*pela URL correspondente ao seu ambiente. Se for o ambiente de produção, substitua por:*https://platform.senior.com.br

Substitua<query>pelo nome de uma das queries abaixo, referente ao registro que quer buscar com a API.

Cabeçalho (Header)

Substitua<access_token>pela chave de acesso obtida a partir da API de autenticação na plataforma.

areaQuery

Retorna uma lista das áreas existentes.

Parâmetros:

Respostas:

  {
    "result": [
      {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Área",
      "code" : "1234"
      }
    ]
  }

  {
    "message": "string",
    "reason": "BAD_REQUEST"
  }

companyQuery

Retorna uma lista das empresas existentes.

Parâmetros:

Respostas:

  {
    "result": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "companyName": "SENIOR SISTEMAS",
        "code" : "1234"
      }
    ]
  }

  {
    "message": "string",
    "reason": "BAD_REQUEST"
  }

branchOfficeQuery

Retorna uma lista das filiais existentes.

Parâmetros:

Respostas:

  {
    "result": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "branchOfficeName": "SENIOR SISTEMAS S/A",
        "tradingName": "SENIOR SISTEMAS",
        "code" : "1234"
      }
    ]
  }

  {
    "message": "company is required",
    "reason": "BAD_REQUEST"
  }

jobPositionQuery

Retorna uma lista dos cargos existentes.

Parâmetros:

Respostas:

  {
    "result": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "ANALISTA DE SISTEMAS II",
        "code" : "1234"
      }
    ]
  }

  {
    "message": "string",
    "reason": "BAD_REQUEST"
  }

Filtros adicionais (opcionais)

Os filtros listados a seguir permitem restringir os resultados retornados pelas queries. Para usar estes filtros, você precisa concatená-los na URL da requisição.

Exemplo:

https://platform.senior.com.br/t/senior.com.br/bridge/1.0/rest/hcm/onboardingintegration/queries/jobPositionQuery?size=10&offset=1&filter=id gt 2 and id lt 5