Endpoint: Listando Chamados

Endpoint que permite a listagem dos chamados criados na plataforma da SULTS.

URL: https://api.sults.com.br/api/v1/chamado/ticket

Método: GET

A busca da lista de chamados é 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

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
id	Integer	Código do chamado
situacao	Integer referente a um dos valores abaixo: 1 – Novo Chamado 2 – Concluído 3 – Resolvido 4 – Em Andamento 5 – Aguardando Solicitante 6 – Aguardando Responsável	Situação atual do chamado
solicitante	Integer	Código do solicitante do chamado
tipo	Integer referente a um dos valores abaixo: 1 – Chamado de administrador para administrador 2 – Chamado de unidade para administrador 3 – Chamado de administrador para unidade	Tipo do chamado
responsavel	Integer	Código da pessoa responsável pelo chamado
unidade	Integer	Código da empresa de destino do chamado
abertoStart	String	Data de abertura do chamado. Busca os chamados a partir da data informada. Essa data deve ser uma string em UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
abertoEnd	String	Data de abertura do chamado. Busca os chamados anteriores à data informada. Essa data deve ser uma string em UTC ISO 8601. Exemplo: 2021-08-06T18:02:55Z
concluidoStart	String	Data de conclusão do chamado. Busca os chamados concluídos a partir da data informada. Essa data deve ser uma string em UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
concluidoEnd	String	Data de conclusão do chamado. Busca os chamados concluídos anteriores à data informada. Essa data deve ser uma string em UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z

Exemplo

fetch("https://api.sults.com.br/api/v1/chamado/ticket?start=0&limit=100&abertoStart=2021-08-06T18:02:55Z&abertoEnd=2022-02-01T00:02:55Z", {
	method: "GET",
	headers: {
		"Authorization":"<token_de_acesso>",
		"Content-Type":"application/json;charset=UTF-8"
	}
})

Resposta

{
	"data":[
		{
			"id":2,
			"titulo":"Teste",
			"solicitante":{
				"id":42,
				"nome":"Solicitante Teste "
			},
			"responsavel":{
				"id":41,
				"nome":"Responsavel Teste"
			},
			"unidade":{
				"id":65,
				"nome":"Unidade Teste"
			},
			"departamento":{
				"id":6,
				"nome":"Departamento Teste"
			},
			"assunto":{
				"id":42,
				"nome":"Assunto Teste"
			},
			"apoio":[
				{
					"pessoa":{
						"id":41,
						"nome":"Pessoa apoio Teste"
					},
					"departamento":{
						"id":6,
						"nome":"Departamento Teste"
					},
					"pessoaUnidade":false
				}
			],
			"etiqueta":[
				{
					"id":3,
					"nome":"P2",
					"cor":"#00c875"
				}
			],
                        "tipo": 1,
			"aberto":"2022-06-27T13:15:26Z",
			"resolvido":"2022-06-27T13:15:26Z",
			"concluido":"2022-06-27T13:15:26Z",
			"resolverPlanejado":"2022-06-27T13:15:26Z",
			"resolverEstipulado":"2022-06-27T13:15:26Z",
			"avaliacaoNota":5,
			"avaliacaoObservacao":"",
			"situacao":2
		}
	],
	"start":0,
	"limit":100,
	"totalPage":1,
	"size":1
}

Campos da resposta

Campos principais

Nome Atributo	Tipo	Descrição
id	Integer	Código do chamado
titulo	String	Título do chamado
solicitante	Objeto Pessoa: – id – nome	Pessoa que fez a solicitação do chamado
responsavel	Objeto Pessoa: – id – nome	Pessoa de suporte como apoio para ajudar o atendimento
unidade	Objeto Empresa: – id – nome	Empresa de destino do chamado
departamento	Objeto Departamento: – id – nome	Departamento ao qual o chamado foi solicitado
assunto	Objeto Assunto: – id – nome	Assunto do chamado
etiqueta	Lista de Objeto Etiqueta: – id – nome – cor	Etiquetas adicionadas para o chamado
apoio	Lista de Objeto Apoio	Lista de pessoas adicionadas como apoio para o atendimento do chamado. Os campos relacionados a esse objeto estão listados em uma tabela abaixo.
tipo	Integer referente a um dos valores abaixo: 1 – Chamado de administrador para administrador 2 – Chamado de unidade para administrador 3 – Chamado de administrador para unidade	Tipo do chamado
aberto	String	Data em que o chamado foi aberto. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
resolvido	String	Data em que o chamado foi marcado como resolvido. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
concluido	String	Data em que o chamado foi marcado como concluído. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
resolverPlanejado	String	Data inicialmente planejada para resolver o chamado. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
resolverEstipulado	String	Prazo atual para resolver o chamado. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
avaliacaoNota	Integer	Nota de avaliação do atendimento do chamado.
avaliacaoObservacao	String	Comentário da avaliação do atendimento do chamado.
situacao	Integer referente a um dos valores abaixo: 1 – Novo Chamado 2 – Concluido 3 – Resolvido 4 – Em Andamento 5 – Aguardando Solicitante 6 – Aguardando Responsável	Situação atual do chamado.

Campos do Objeto Apoio

Nome Atributo	Tipo	Descrição
pessoa	Objeto Pessoa: – id – nome	Pessoa de suporte como apoio para ajudar no atendimento do chamado
departamento	Objeto Departamento: – id – nome	Departamento da empresa adicionada como apoio para ajudar no atendimento do chamado
pessoaUnidade	Boolean	true – a pessoa desse apoio é um colaborador da unidade do chamado. false – a pessoa desse apoio é um administrador da empresa principal.

Atualizado em 01/11/2022