API REST do Formbuilder

O serviço de Construtor de Formulários disponibiliza um endpoint REST para leitura de respostas preenchidas por usuários da plataforma.

GET /lumis/service/formbuilder/rest/forms/{formId}/answers

Retorna um JSON com os campos e uma lista com as respostas do formulário identificado pelo formId na URL.
É possível especificar o número de respostas que serão retornadas e o número de respostas que devem ser puladas, veja a tabela de parâmetros abaixo. Com isso, é possível paginar a requisição.

Esta operação requer cabeçalhos na requisição compatíveis com:

Cabeçalho	Valor
Accept	application/json

Parâmetros da Requisição

Os parâmetros da requisição devem ser passados na query string da URL:

Parâmetro	Requerido	Descrição	Tipo
formId	Sim	O identificador único do formulário com as respostas desejadas.	guid
maxResults	Não	Número máximo de respostas que devem ser retornadas. O valor padrão é 1000, e deve estar entre 0 e 1000.	número inteiro
startAt	Não	Número de respostas que devem ser puladas. O valor padrão é 0. Pode ser utilizado para paginar os resultados.	número inteiro
answerStatus	Não	Filtra as respostas pelo status de processamento. Pode ter os valores `NOT_PROCESSED` ou `PROCESSED`.	string

Resposta de Sucesso

Quando a operação é bem sucedida, a resposta conterá um objeto JSON com as informações sobre o formulário desejado.

Resposta de Erro

Esta operação responde como erro o objeto JSON padrão de erro.

Exemplos de Requisição

GET /lumis/service/formbuilder/rest/forms/2C9280849150FA1E019150FD0B35017A/answers/ HTTP/1.1
Accept: application/json
(... outros cabeçalhos ...)

Limitando o resultado para 50 respostas e retornando a terceira página de respostas:

GET /lumis/service/formbuilder/rest/forms/2C9280849150FA1E019150FD0B35017A/answers/?maxResults=50&startAt=100 HTTP/1.1
Accept: application/json
(... outros cabeçalhos ...)

Exemplo de Resposta de Sucesso

	
		{
			"maxResults": 1000,
  			"startAt": 0,
  			"totalCount": 1,
			"firstUrl": "http://localhost:8080/lumis/service/formbuilder/rest/forms/402880A191805FBE019180623B74003B/answers/",
			"nextUrl": null,
			"previousUrl": null,
			"lastUrl": null,
			"fields": {
				"2C9280849150FA1E019150FEC82901C0": {
					"id": "2C9280849150FA1E019150FEC82901C0",
      				"formId": "402880A191805FBE019180623B74003B",
					"helpText": "Help Text multiple answers",
					"options": {
						"1": "Option 1",
						"2": "Option 2"
					},
					"position": 1,
					"type": "CHECKBOX",
					"title": "Multiple Answers",
					"required": true,
					"fieldId": "multiple_answers",
					"additionalText": null,
      				"maxLength": null,
      				"headingText": null,
      				"headingLevel": 1
				},
				"2C928084915453D70191545CBEDE00AC": {
					"id": "2C928084915453D70191545CBEDE00AC",
      				"formId": "402880A191805FBE019180623B74003B",
					"helpText": "Help Text short text",
					"position": 2,
					"type": "SHORTTEXT",
					"title": "Short Text",
					"required": false,
					"fieldId": "short_text",
					"additionalText": null,
      				"maxLength": null,
      				"headingText": null,
      				"headingLevel": 1
				}
			},
			"answers": [
				{
					"answerDate": "2024-08-15 04:48:35.0",
					"answerValues": {
						"2C9280849150FA1E019150FEC82901C0": {
							"1": true,
							"2": true
						},
						"2C928084915453D70191545CBEDE00AC": "Answer to short text"
					},
					"id": "2C928084915453D70191545DBE1C00C3",
					"user": "Administrator",
					"status": "NOT_PROCESSED"
				}
			]
		}