Documentos

Listagem de document types e respectivos slugs (identificadores dos documentos)

POST Url Produção: https://api.acessorh.com.br Url Homologação: https://api.rh.homolog.acesso.io Endpoint: /v1/config/available-documents

Headers

Key
Type
Description

Authorization*

string

Token de acesso adquirido pela plataforma Identity (bearer)

Exemplo de requisição:

curl --location 'https://api.acessorh.com.br/v1/config/available-documents' \
--header 'Authorization: Bearer TOKEN DE AUTENTICAÇÃO'

Exemplo de response:

{
    "data": [
        {
            "id": "91b8e5ca-3817-4a82-b9e8-87d4a50421a4",
            "slug": "vspp",
            "title": "vspp",
            "kind": "hardcoded"
        },
        {
            "id": "6d58e6f3-5501-40b3-b1fb-3e6949d19960",
            "slug": "cpf",
            "title": "cpf",
            "kind": "hardcoded"
        },
        {
            "id": "93c3527c-1bed-45d0-8725-1705e580357d",
            "slug": "escolaridade",
            "title": "escolaridade",
            "kind": "hardcoded"
        },
        .
        .
        .
        ]
}
  • O "id" é usado para identificar o tipo do documento e é possível usa-lo no array de "docs" da api de "create position"

  • O "slug" é o identificador do documento na resposta da api de "get position"

  • O "kind" direciona a forma em que o documento é registrado no banco de dados e serve como direcionamento para identificar onde os metadados serão devolvidos na consulta do "get position"

Obs 1: Produção tem uma lista fixa de uids e homologação tem outra. Obs 2: Sempre que um novo documento for criado, é possível consultar o uid, slug e kind dele executando novamente a api.

Atualizado

Isto foi útil?