GET neutronapi/dossie/{idDossie}/getcamposagrupador

Recupera a lista de Campos Agrupador do Dossie

Dados da requisição

Pârametros

NomeDescriçãoTipoInformações adicionais
idDossie

integer

Required

Parâmetros no corpo do HTML (Body)

Nenhum parâmetro na corpo do HTML

Informações de retorno

Descrição do retorno

Coleção de Campo

NomeDescriçãoTipoInformações adicionais
ID

ID do campo.

integer

Nome

Nome interno do campo. Este deve ser o nome da coluna no banco de dados.

string

Apelido

Apelido do campo. Esta informação será apresentada na tela para o usuário.

string

TipoCampo

Tipo do campo.

string

Tamanho

Quantidade de caracteres máxima do campo. Utilizada somente para campos do tipo TEXTO.

integer

CasasDecimais

Quantidade de casas decimais utilizada. Esta informação será usada apenas para campos do tipo NUMÉRICO.

integer

Ordem

Valor iniciado em 0 para definir a ordenação em que os dados serão recuperados do banco de dados.

integer

Obrigatorio

Indica se o campo é obrigatório e não pode ficar vazio.

boolean

NomeDocumento

Indica se o valor do campo será usado para renomear o arquivo no download. True indica que será usado, caso contrário não será. Somente um campo em cada repositório pode estar marcado como NomeDocumento=True.

boolean

ValorInicial

Valor inicial do campo. Para campo do tipo TEXTO este será o único valor considerado.

string

ValorFinal

Valor final do campo. Utilizado nos campos de DATA e NUMÉRICO para pesquisar por intervalos.

string

ListaMultiValorado

Valores para os campos do tipo Multi Valorado.

Coleção de string

Bloqueado

Indica se o campo deve ser apresentado ao usuário como somente leitura. Este campo não pode sofrer alteração.

boolean

Visivel

Inidica se o campo deve ser apresentado ao usuário. True indica que sim, caso contrário não deve ser exibido este campo.

boolean

Lista_Padrao

boolean

TipoEntrada

Tipo de entrada.

string

ListaSelecao

Lista de seleção vinculada a este campo. Somente será carregada para campos do tipo TEXTO.

ListaSelecao

Mascara

Expressão regular usada para validar a indexação do campo.

string

Formato do retorno

application/json, text/json

Exemplo:
[
  {
    "id": 1,
    "nome": "texto 2",
    "apelido": "texto 3",
    "tipoCampo": "texto 4",
    "tamanho": 5,
    "casasDecimais": 6,
    "ordem": 7,
    "obrigatorio": true,
    "nomeDocumento": true,
    "valorInicial": "texto 10",
    "valorFinal": "texto 11",
    "listaMultiValorado": [
      "texto 1",
      "texto 2"
    ],
    "bloqueado": true,
    "visivel": true,
    "lista_Padrao": true,
    "tipoEntrada": "texto 15",
    "listaSelecao": {
      "id": 1,
      "nome": "texto 2",
      "tipo": "texto 3",
      "filtros": [
        "texto 1",
        "texto 2"
      ],
      "valores": [
        "texto 1",
        "texto 2"
      ],
      "valoresTabela": [
        {
          "valoR1": "texto 1",
          "valoR2": "texto 2",
          "valoR3": "texto 3",
          "valoR4": "texto 4",
          "valoR5": "texto 5"
        },
        {
          "valoR1": "texto 1",
          "valoR2": "texto 2",
          "valoR3": "texto 3",
          "valoR4": "texto 4",
          "valoR5": "texto 5"
        }
      ],
      "campo": "texto 4",
      "campoValor": "texto 5"
    },
    "mascara": "texto 16"
  },
  {
    "id": 1,
    "nome": "texto 2",
    "apelido": "texto 3",
    "tipoCampo": "texto 4",
    "tamanho": 5,
    "casasDecimais": 6,
    "ordem": 7,
    "obrigatorio": true,
    "nomeDocumento": true,
    "valorInicial": "texto 10",
    "valorFinal": "texto 11",
    "listaMultiValorado": [
      "texto 1",
      "texto 2"
    ],
    "bloqueado": true,
    "visivel": true,
    "lista_Padrao": true,
    "tipoEntrada": "texto 15",
    "listaSelecao": {
      "id": 1,
      "nome": "texto 2",
      "tipo": "texto 3",
      "filtros": [
        "texto 1",
        "texto 2"
      ],
      "valores": [
        "texto 1",
        "texto 2"
      ],
      "valoresTabela": [
        {
          "valoR1": "texto 1",
          "valoR2": "texto 2",
          "valoR3": "texto 3",
          "valoR4": "texto 4",
          "valoR5": "texto 5"
        },
        {
          "valoR1": "texto 1",
          "valoR2": "texto 2",
          "valoR3": "texto 3",
          "valoR4": "texto 4",
          "valoR5": "texto 5"
        }
      ],
      "campo": "texto 4",
      "campoValor": "texto 5"
    },
    "mascara": "texto 16"
  }
]