Endpoint: Listando Interações de um Plano de Ação

Endpoint que permite a listagem das interações de um plano de ação criado na plataforma da SULTS.

URL: https://api.sults.com.br/api/v1checklist/avaliacao/plano-acao/<planoAcaoId>/interacao

Método: GET

A busca da lista de interações é paginada. O endpoint é limitado a 100 registros por página.

Parâmetros

Headers

Header	Valor
Authorization	<token_de_acesso>
Content-Type	application/json;charset=UTF-8

Path parameters

Filtro	Valor	Descrição
planoAcaoId	Integer	Código do Plano de Ação

Query parameters

Filtro	Valor	Descrição
start	Integer	Início da paginação (número da página). Padrão 0
limit	Integer	Número de registros por página. Máximo 100. Padrão 100

Exemplo

fetch("https://api.sults.com.br/api/v1/checklist/avaliacao/plano-acao/60/interacao", {
	method: "GET",
	headers: {
		"Authorization":"<token_de_acesso>",
		"Content-Type":"application/json;charset=UTF-8"
	}
})

Resposta

{
    "data": [
        {
            "id": 60,
            "dtInteracao": "2020-08-05T22:22:06Z",
            "messagemHtml": "<p>teste</p>",
            "pessoa": {
                "id": 105,
                "nome": "User Teste 2"
            },
            "tipoInteracao": 2
        },
        {
            "id": 208,
            "dtInteracao": "2022-11-17T13:11:04Z",
            "pessoa": {
                "id": 108,
                "nome": "User Teste"
            },
            "tipoInteracao": 7,
            "quandoSeraFeito": "2022-08-31T03:00:00Z",
            "quandoSeraFeitoAnterior": "2018-08-31T03:00:00Z"
        },
        {
            "id": 209,
            "dtInteracao": "2022-11-17T13:14:01Z",
            "messagemHtml": "<p>Aprovado</p>",
            "pessoa": {
                "id": 108,
                "nome": "User Teste"
            },
            "tipoInteracao": 3
        },
        {
            "id": 210,
            "dtInteracao": "2022-11-17T16:33:53Z",
            "pessoa": {
                "id": 108,
                "nome": "User Teste"
            },
            "tipoInteracao": 6,
            "anexo": [
                {
                    "id": 67,
                    "dtCriacao": "2022-11-17T16:33:55Z",
                    "nome": "teste.jpeg",
                    "url": "https://sults.com/teste.jpeg",
                    "tamanho": 3949
                }
            ]
        },
        {
            "id": 211,
            "dtInteracao": "2022-11-17T16:34:17Z",
            "messagemHtml": "<p>Comentário</p>",
            "pessoa": {
                "id": 108,
                "nome": "User Teste"
            },
            "tipoInteracao": 1
        }
    ],
    "start": 0,
    "limit": 100,
    "size": 6,
    "totalPage": 1
}

Campos da resposta

Campos principais

Nome Atributo	Tipo	Descrição
id	Integer	Código da interação do Plano de Ação
mensagemHtml	String	Mensagem da interação do Plano de Ação
pessoa	Objeto Pessoa	Pessoa que fez a interação do Plano de Ação
dtInteracao	String	Data em que foi criada a interação do Plano de Ação. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
tipoInteracao	Integer referente ao tipo de interação: 1- Comentário 2- Mudança de Situação Resolvido 3- Mudança de Situação Concluído 4- Mudança de Situação Andamento 5- Mudança de Situação Rejeitado 6- Anexo 7- Mudança de Prazo	Tipo da interação do Plano de Ação
quandoSeraFeito	String	Data de quando será executado o que foi proposto no Plano de Ação. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
quandoSeraFeitoAnterior	String	Data anterior de quando será executado o que foi proposto no Plano de Ação. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
anexo	Lista de Objeto Anexo	Lista de arquivos de anexo da interação do Plano de Ação

Campos do Objeto Pessoa

Nome Atributo	Tipo	Descrição
id	Integer	Código da Pessoa
nome	String	Nome da Pessoa

Campos do Objeto Anexo

Nome Atributo	Tipo	Descrição
id	Integer	Código do Anexo
nome	String	Nome do arquivo de Anexo
dtCriacao	String	Data em que foi feito o upload do arquivo. A data é apresentada no formato UTC ISO 8601 Exemplo: 2021-08-06T18:02:55Z
url	String	Link de download do arquivo de Anexo
tamanho	Long	Tamanho do arquivo de Anexo