01. VISÃO GERAL

Este documento apresenta os parâmetros de entrada e o retorno da API de GET de candidatura.

  • A implementação das integrações via API deve ser realizada pelo cliente, que será responsável pelos custos e pelo desenvolvimento envolvidos.

02. ENDPOINT E PARÂMETROS DE ENTRADA

Endpoint da API que será utilizado para inserir e atualizar dados:

URL baseEndpoint
https://api-centraldorecrutador.totvs.app/recruitment-integration{URL base}/api/v1/job-application/{jobApplicationId}/annotations

Para utitlizar essa api, é preciso recuperar o id da candidatura, que pode ser consultado por aqui


2.1 - DADOS ENVIADOS 

Descrição detalhada do objeto dentro do jobApplicationStatusChangeCommand:3/3

jobApplicationIdID único que representa a candidaturatexto (string)

(seleção)

titleTítulo da anotaçãotexto (string)(seleção)
annotation

Descrição da anotação

texto (string)

(seleção)

attachments

Arquivo de anexo

file

(erro)

Retorno:


Valor string

O retorno é uma string que é o identificador do processo que será utilizado no endpoint de consulta para checar o status do processamento do lote