Campo Dinâmico Resource

POST /campo-dinamico

Request Body
media type data type
application/json CampoDinamicoWs (JSON)
application/xml CampoDinamicoWs (Anonymous) (XML)
Response Body
media type data type description
application/json object (JSON)
application/xml anyType (XML)

Example

Request
POST /campo-dinamico
Content-Type: application/json
Accept: application/json

                
{
  "codigo" : 12345,
  "nome" : "...",
  "textoAjuda" : "...",
  "visivel" : true,
  "obrigatorio" : true,
  "listaMultipla" : true,
  "campoDinamicoTipo" : "DATA",
  "valorPadraoCampoTexto" : "...",
  "valorPadraoCampoNumero" : 12345,
  "valorPadraoCampoData" : 12345,
  "valorPadraoCampoBoolean" : true,
  "aba" : {
    "chave" : 12345,
    "valor" : "..."
  },
  "modulo" : "tarefa-tipo",
  "posicaoTela" : 12345,
  "campoDinamicoItemLista" : [ {
    "codigo" : 12345,
    "nome" : "...",
    "posicao" : 12345,
    "padrao" : true
  }, {
    "codigo" : 12345,
    "nome" : "...",
    "posicao" : 12345,
    "padrao" : true
  } ],
  "campoDinamicoItemLabel" : [ {
    "codigo" : 12345,
    "nome" : "...",
    "padrao" : true
  }, {
    "codigo" : 12345,
    "nome" : "...",
    "padrao" : true
  } ]
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

PUT /campo-dinamico

Request Body
media type data type
application/json CampoDinamicoWs (JSON)
application/xml CampoDinamicoWs (Anonymous) (XML)

Example

Request
PUT /campo-dinamico
Content-Type: application/json

                
{
  "codigo" : 12345,
  "nome" : "...",
  "textoAjuda" : "...",
  "visivel" : true,
  "obrigatorio" : true,
  "listaMultipla" : true,
  "campoDinamicoTipo" : "LABEL",
  "valorPadraoCampoTexto" : "...",
  "valorPadraoCampoNumero" : 12345,
  "valorPadraoCampoData" : 12345,
  "valorPadraoCampoBoolean" : true,
  "aba" : {
    "chave" : 12345,
    "valor" : "..."
  },
  "modulo" : "tarefa-evento",
  "posicaoTela" : 12345,
  "campoDinamicoItemLista" : [ {
    "codigo" : 12345,
    "nome" : "...",
    "posicao" : 12345,
    "padrao" : true
  }, {
    "codigo" : 12345,
    "nome" : "...",
    "posicao" : 12345,
    "padrao" : true
  } ],
  "campoDinamicoItemLabel" : [ {
    "codigo" : 12345,
    "nome" : "...",
    "padrao" : true
  }, {
    "codigo" : 12345,
    "nome" : "...",
    "padrao" : true
  } ]
}
Response
HTTP/1.1 204 No Content

POST /campo-dinamico-dado

Request Parameters
name type description constraints
executar-contagem query boolean
ordenacao-chave query  
ordenacao-tipo query  
pagina query int
quan-registros query int
Request Body
media type data type
application/json CampoDinamicoDadoConsultaFiltroWs (JSON)
application/xml CampoDinamicoDadoConsultaFiltroWs (Anonymous) (XML)
Response Body
media type data type description
application/json CampoDinamicoDadoConsultaWs (JSON)
application/xml CampoDinamicoDadoConsultaWs (Anonymous) (XML)

Example

Request
POST /campo-dinamico-dado
Content-Type: application/json
Accept: application/json

                
{
  "modulo" : "processo-risco-tipo",
  "codigosCamposDinamico" : [ 12345, 12345 ],
  "codigosRegistrosVinculo" : [ 12345, 12345 ]
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "totalRegistros" : 12345,
  "campoDinamicoDado" : [ {
    "modulo" : "...",
    "codigoRegistroVinculo" : 12345,
    "codigoCampoDinamicoDado" : 12345,
    "codigoCampoDinamico" : 12345,
    "codigoAba" : 12345,
    "nomeCampoDinamico" : "...",
    "campoDinamicoTipo" : "NUMERO",
    "valorCampoTexto" : "...",
    "valorCampoNumero" : 12345,
    "valorCampoData" : 12345,
    "valorCampoBoolean" : true,
    "visivel" : true,
    "obrigatorio" : true,
    "campoDinamicoItemLista" : [ {
      "codigo" : 12345,
      "nome" : "...",
      "posicao" : 12345,
      "padrao" : true
    }, {
      "codigo" : 12345,
      "nome" : "...",
      "posicao" : 12345,
      "padrao" : true
    } ],
    "campoDinamicoItemLabel" : [ {
      "codigo" : 12345,
      "nome" : "...",
      "padrao" : true
    }, {
      "codigo" : 12345,
      "nome" : "...",
      "padrao" : true
    } ],
    "itensSelecionadosLista" : [ 12345, 12345 ],
    "itensSelecionadosLabel" : [ {
      "chave" : 12345,
      "valor" : "..."
    }, {
      "chave" : 12345,
      "valor" : "..."
    } ],
    "campoDinamicoItemListaSelecionado" : 12345,
    "textoAjuda" : "..."
  }, {
    "modulo" : "...",
    "codigoRegistroVinculo" : 12345,
    "codigoCampoDinamicoDado" : 12345,
    "codigoCampoDinamico" : 12345,
    "codigoAba" : 12345,
    "nomeCampoDinamico" : "...",
    "campoDinamicoTipo" : "LABEL",
    "valorCampoTexto" : "...",
    "valorCampoNumero" : 12345,
    "valorCampoData" : 12345,
    "valorCampoBoolean" : true,
    "visivel" : true,
    "obrigatorio" : true,
    "campoDinamicoItemLista" : [ {
      "codigo" : 12345,
      "nome" : "...",
      "posicao" : 12345,
      "padrao" : true
    }, {
      "codigo" : 12345,
      "nome" : "...",
      "posicao" : 12345,
      "padrao" : true
    } ],
    "campoDinamicoItemLabel" : [ {
      "codigo" : 12345,
      "nome" : "...",
      "padrao" : true
    }, {
      "codigo" : 12345,
      "nome" : "...",
      "padrao" : true
    } ],
    "itensSelecionadosLista" : [ 12345, 12345 ],
    "itensSelecionadosLabel" : [ {
      "chave" : 12345,
      "valor" : "..."
    }, {
      "chave" : 12345,
      "valor" : "..."
    } ],
    "campoDinamicoItemListaSelecionado" : 12345,
    "textoAjuda" : "..."
  } ]
}

GET /campo-dinamico/{codigo-campo-dinamico}

Request Parameters
name type description constraints
codigo-campo-dinamico path long
Response Body
media type data type description
application/json CampoDinamicoWs (JSON)
application/xml CampoDinamicoWs (Anonymous) (XML)

Example

Request
GET /campo-dinamico/{codigo-campo-dinamico}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "codigo" : 12345,
  "nome" : "...",
  "textoAjuda" : "...",
  "visivel" : true,
  "obrigatorio" : true,
  "listaMultipla" : true,
  "campoDinamicoTipo" : "NUMERO",
  "valorPadraoCampoTexto" : "...",
  "valorPadraoCampoNumero" : 12345,
  "valorPadraoCampoData" : 12345,
  "valorPadraoCampoBoolean" : true,
  "aba" : {
    "chave" : 12345,
    "valor" : "..."
  },
  "modulo" : "calculadora-prazos",
  "posicaoTela" : 12345,
  "campoDinamicoItemLista" : [ {
    "codigo" : 12345,
    "nome" : "...",
    "posicao" : 12345,
    "padrao" : true
  }, {
    "codigo" : 12345,
    "nome" : "...",
    "posicao" : 12345,
    "padrao" : true
  } ],
  "campoDinamicoItemLabel" : [ {
    "codigo" : 12345,
    "nome" : "...",
    "padrao" : true
  }, {
    "codigo" : 12345,
    "nome" : "...",
    "padrao" : true
  } ]
}

GET /campo-dinamico/consulta-itens-label-nome-modulo/{codigo-campo-dinamico}

Request Parameters
name type description constraints multivalued
codigo-campo-dinamico path long no
codigos-item-label-ignorar query long yes
modulo query   no
nome-campo-dinamico query   no
Response Body
media type data type description
application/json CampoDinamicoItemLabelsWs (JSON)
application/xml CampoDinamicoItemLabelsWs (Anonymous) (XML)

Example

Request
GET /campo-dinamico/consulta-itens-label-nome-modulo/{codigo-campo-dinamico}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "campoDinamicoItemLabel" : [ {
    "codigo" : 12345,
    "nome" : "...",
    "padrao" : true
  }, {
    "codigo" : 12345,
    "nome" : "...",
    "padrao" : true
  } ]
}

GET /campo-dinamico/consulta-itens-lista/{codigo-campo-dinamico}

Request Parameters
name type description constraints
codigo-campo-dinamico path long
Response Body
media type data type description
application/json CampoDinamicoItemListasWs (JSON)
application/xml CampoDinamicoItemListasWs (Anonymous) (XML)

Example

Request
GET /campo-dinamico/consulta-itens-lista/{codigo-campo-dinamico}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "campoDinamicoItemLista" : [ {
    "codigo" : 12345,
    "nome" : "...",
    "posicao" : 12345,
    "padrao" : true
  }, {
    "codigo" : 12345,
    "nome" : "...",
    "posicao" : 12345,
    "padrao" : true
  } ]
}

GET /campo-dinamico/obter-campos-por-modulo/{codigo-modulo}

Request Parameters
name type description constraints
codigo-modulo path long
Response Body
media type data type description
application/json CamposDinamicosConsultaModuloWs (JSON)
application/xml CamposDinamicosConsultaModuloWs (Anonymous) (XML)

Example

Request
GET /campo-dinamico/obter-campos-por-modulo/{codigo-modulo}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "campoDinamicoConsultaModuloWs" : [ {
    "codigo" : 12345,
    "nome" : "...",
    "listaMultipla" : true,
    "campoDinamicoTipo" : "TEXTO_LONGO",
    "modulo" : "processo-orgao-judicial"
  }, {
    "codigo" : 12345,
    "nome" : "...",
    "listaMultipla" : true,
    "campoDinamicoTipo" : "CHECKBOX",
    "modulo" : "atendimento-pessoa"
  } ]
}

GET /campo-dinamico/{codigo-modulo}/{codigo-aba}

Request Parameters
name type description constraints
codigo-aba path long
codigo-modulo path long
Response Body
media type data type description
application/json CamposDinamicosWs (JSON)
application/xml CamposDinamicosWs (Anonymous) (XML)

Example

Request
GET /campo-dinamico/{codigo-modulo}/{codigo-aba}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "campoDinamicoWs" : [ {
    "codigo" : 12345,
    "nome" : "...",
    "textoAjuda" : "...",
    "visivel" : true,
    "obrigatorio" : true,
    "listaMultipla" : true,
    "campoDinamicoTipo" : "TEXTO_CURTO",
    "valorPadraoCampoTexto" : "...",
    "valorPadraoCampoNumero" : 12345,
    "valorPadraoCampoData" : 12345,
    "valorPadraoCampoBoolean" : true,
    "aba" : {
      "chave" : 12345,
      "valor" : "..."
    },
    "modulo" : "relatorio",
    "posicaoTela" : 12345,
    "campoDinamicoItemLista" : [ {
      "codigo" : 12345,
      "nome" : "...",
      "posicao" : 12345,
      "padrao" : true
    }, {
      "codigo" : 12345,
      "nome" : "...",
      "posicao" : 12345,
      "padrao" : true
    } ],
    "campoDinamicoItemLabel" : [ {
      "codigo" : 12345,
      "nome" : "...",
      "padrao" : true
    }, {
      "codigo" : 12345,
      "nome" : "...",
      "padrao" : true
    } ]
  }, {
    "codigo" : 12345,
    "nome" : "...",
    "textoAjuda" : "...",
    "visivel" : true,
    "obrigatorio" : true,
    "listaMultipla" : true,
    "campoDinamicoTipo" : "TEXTO_CURTO",
    "valorPadraoCampoTexto" : "...",
    "valorPadraoCampoNumero" : 12345,
    "valorPadraoCampoData" : 12345,
    "valorPadraoCampoBoolean" : true,
    "aba" : {
      "chave" : 12345,
      "valor" : "..."
    },
    "modulo" : "pagamento",
    "posicaoTela" : 12345,
    "campoDinamicoItemLista" : [ {
      "codigo" : 12345,
      "nome" : "...",
      "posicao" : 12345,
      "padrao" : true
    }, {
      "codigo" : 12345,
      "nome" : "...",
      "posicao" : 12345,
      "padrao" : true
    } ],
    "campoDinamicoItemLabel" : [ {
      "codigo" : 12345,
      "nome" : "...",
      "padrao" : true
    }, {
      "codigo" : 12345,
      "nome" : "...",
      "padrao" : true
    } ]
  } ]
}

GET /campo-dinamico/consulta-itens-label-nome-aba/{codigo-aba}/{codigo-campo-dinamico}

Request Parameters
name type description constraints multivalued
codigo-aba path long no
codigo-campo-dinamico path long no
codigos-item-label-ignorar query long yes
nome-campo-dinamico query   no
Response Body
media type data type description
application/json CampoDinamicoItemLabelsWs (JSON)
application/xml CampoDinamicoItemLabelsWs (Anonymous) (XML)

Example

Request
GET /campo-dinamico/consulta-itens-label-nome-aba/{codigo-aba}/{codigo-campo-dinamico}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "campoDinamicoItemLabel" : [ {
    "codigo" : 12345,
    "nome" : "...",
    "padrao" : true
  }, {
    "codigo" : 12345,
    "nome" : "...",
    "padrao" : true
  } ]
}