POST neutronapi/postdocumentos
Recebe uma janela com os campos preenchidos. Preencha no mínimo o ID da janela. Para os campos preencha no mínimo: Nome, ValorInicial e TipoCampo. Para janela do tipo Tarefa preencha o Filtro.
Dados da requisição
Pârametros
Nenhum parâmetro encontrado.
Parâmetros no corpo do HTML (Body)
Uma janela do tipo Pesquisa ou Tarefa.
Janela
| Nome | Descrição | Tipo | Informações adicionais |
|---|---|---|---|
| ID |
ID da janela. |
integer | |
| IDRepositorio |
ID do repositório que a janela está vinculada. |
integer | |
| NomeRepositorio |
Nome do repositório que a janele está vinculada. |
string | |
| TipoJanela |
Tipo da janela (PESQUISA, ARMAZENAGEM, RESULTADOS ou INFORMACAO). |
string | |
| ProximaJanela |
ID da próxima janela. A janela de pesquisa está vinculada a uma janela de resultado. A janela de resultado está vinculada a uma janela de informação. |
integer | |
| NomeJanela |
Nome da janela. |
string | |
| Filtro |
Critério de pesquisa previamente definido pelo administrador. Ex: CAMPO="VALOR" AND DATA="27/11/2018". A sintax utilizada é SQL. |
string | |
| QuantidadeDocumentos |
Indica a quantidade de documentos vinculadas a janela. Usada na atividade para mostrar ao usuário o total de documentos antes de realizar a busca. |
integer | |
| Campos |
Lista com os campos vinculados a janela. |
Coleção de Campo | |
| CamposSistema |
Lista com os campos de sistema. |
Coleção de Campo | |
| PermissaoRepositorio |
Indica a Permissão do usuário no Repositório. |
string | |
| CertificadoOrganizacao |
Indica se o certificado da organização será usado ao armazenar um documento. |
boolean | |
| CertificadoUsuario |
Indica se o certificado do usuário será usado ao armazenar um documento. |
boolean | |
| PrazoExpiracao |
Prazo de Expiração do Documento enviado para Certificação |
integer | |
| IdPortal |
ID do Documento enviado para o Portal de Certificação |
integer | |
| FullText | boolean | ||
| VisivelNomeRepositorio | boolean | ||
| VisivelWeb | boolean | ||
| VisivelMobile | boolean | ||
| VisivelNomeJanela | boolean | ||
| IdAtividade | integer |
Formato da requisição
application/json, text/json
Exemplo:
{
"id": 1,
"idRepositorio": 2,
"nomeRepositorio": "texto 3",
"tipoJanela": "texto 4",
"proximaJanela": 5,
"nomeJanela": "texto 6",
"filtro": "texto 7",
"quantidadeDocumentos": 8,
"campos": [
{
"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"
}
],
"camposSistema": [
{
"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"
}
],
"permissaoRepositorio": "texto 9",
"certificadoOrganizacao": true,
"certificadoUsuario": true,
"prazoExpiracao": 12,
"idPortal": 13,
"fullText": true,
"visivelNomeRepositorio": true,
"visivelWeb": true,
"visivelMobile": true,
"visivelNomeJanela": true,
"idAtividade": 19
}
Informações de retorno
Descrição do retorno
Retorna uma lista com os documentos.
Coleção de Documento
| Nome | Descrição | Tipo | Informações adicionais |
|---|---|---|---|
| IDDOC |
IDDOC do documento. |
integer | |
| Usuario |
Usuário que armazenaou o documento. |
string | |
| DataHora |
Data e hora de armazenagem. |
date | |
| Tamanho |
Tamanho em bytes do documento. Este valor representa a soma de todas as páginas. |
integer | |
| IDRepositorio |
ID do repositório que o documento está vinculado. |
integer | |
| NomeDocumento |
Nome do Documento. |
string | |
| Campos |
Lista com os campos. |
Coleção de Campo | |
| Items |
Lista com o nome do campo e valor. |
Dictionary of string [key] and string [value] | |
| Paginas |
Lista com as páginas do documento. |
Coleção de Pagina | |
| NumPaginas |
Quantidade de páginas/arquivos que o documento possui. |
integer | |
| DWDOCID |
Código do documento no DocuWare. Esse campo é usado somente quando os documentos originais estão armazenados no DocuWare. |
integer | |
| StatusDoc |
Status do documento. I: Com imagem. B: Lote. |
string | |
| ExtensaoDoc | string | ||
| IDOriginal | integer | ||
| NrVersao | integer |
Formato do retorno
application/json, text/json
Exemplo:
[
{
"iddoc": 1,
"usuario": "texto 2",
"dataHora": "2025-04-11T06:51:16.8037691-03:00",
"tamanho": 4,
"idRepositorio": 5,
"nomeDocumento": "texto 6",
"campos": [
{
"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"
}
],
"items": {
"texto 1": "texto 2",
"texto 3": "texto 4"
},
"paginas": [
{
"iddoc": 1,
"numPagina": 2,
"extensao": "texto 3",
"disco": 4,
"microfilme": 5,
"fotograma": "texto 6",
"caminho": "texto 7",
"subPasta": "texto 8"
},
{
"iddoc": 1,
"numPagina": 2,
"extensao": "texto 3",
"disco": 4,
"microfilme": 5,
"fotograma": "texto 6",
"caminho": "texto 7",
"subPasta": "texto 8"
}
],
"numPaginas": 7,
"dwdocid": 8,
"statusDoc": "texto 9",
"extensaoDoc": "texto 10",
"idOriginal": 11,
"nrVersao": 12
},
{
"iddoc": 1,
"usuario": "texto 2",
"dataHora": "2025-04-11T06:51:16.8037691-03:00",
"tamanho": 4,
"idRepositorio": 5,
"nomeDocumento": "texto 6",
"campos": [
{
"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"
}
],
"items": {
"texto 1": "texto 2",
"texto 3": "texto 4"
},
"paginas": [
{
"iddoc": 1,
"numPagina": 2,
"extensao": "texto 3",
"disco": 4,
"microfilme": 5,
"fotograma": "texto 6",
"caminho": "texto 7",
"subPasta": "texto 8"
},
{
"iddoc": 1,
"numPagina": 2,
"extensao": "texto 3",
"disco": 4,
"microfilme": 5,
"fotograma": "texto 6",
"caminho": "texto 7",
"subPasta": "texto 8"
}
],
"numPaginas": 7,
"dwdocid": 8,
"statusDoc": "texto 9",
"extensaoDoc": "texto 10",
"idOriginal": 11,
"nrVersao": 12
}
]