Ferramentas do usuário

Ferramentas do site


enduser:erp:developer:integracao:integracaowebservice:anexos:material

GET - Consulta anexos de materiais

Este método consulta os anexos e desenhos vinculados aos materiais do Prosyst. Na consulta geral, os filtros informados são combinados por interseção. Sem filtros de material, são considerados os materiais ativos que possuem arquivos.

A rota por código resolve somente o material informado na URL. Aceitando o código interno e, quando habilitado, o código editável. Nessa rota, os filtros de seleção do material são ignorados, mas os filtros de extensão, origem e paginação são aplicados.

Exemplo URL

Consulta geral:

api/anexos/material

Consulta de um material:

api/anexos/material/{codigo}

Parâmetros da URL

NomeTipoTamanhoDescriçãoObrigatório?
codigoStringCódigo interno ou identificador aceito pelo cadastro de materiais. Utilizado somente na rota por código.Sim, na rota por código

Parâmetros do Header

NomeDescrição
authToken adquirido no Login.
Content-Typeapplication/json

Parâmetros do Body

NomeTipoTamanhoDescriçãoObrigatório?
CodigosArray de LongCódigos internos dos materiais.Não
CodigosEditaveisArray de StringCódigos editáveis dos materiais.Não
CodigoInicialLongCódigo interno inicial da faixa.Não
CodigoFinalLongCódigo interno final da faixa.Não
ClasseIntegerClasse do material.Não
TipoIntegerTipo do material.Não
SituacaoStringSituação do material: ativo ou cancelado. Padrão: ativo.Não
DataAlteracaoInicialStringData inicial nos formatos dd-MM-yyyy ou yyyy-MM-ddTHH:mm:ss.Não
DataAlteracaoFinalStringData final nos formatos dd-MM-yyyy ou yyyy-MM-ddTHH:mm:ss.Não
ExtensoesArray de StringExtensões aceitas, com ou sem ponto. Exemplo: pdf ou .jpg.Não
IncluirAnexosBooleanInclui arquivos da tabela ANEXO. Padrão: true.Não
IncluirDesenhosBooleanInclui arquivos e imagens da tabela DESMATER. Padrão: true.Não
PaginaIntegerNúmero da página, iniciando em 1. Padrão: 1.Não
TamanhoPaginaIntegerQuantidade de arquivos por página, de 1 a 500. Padrão: 500.Não

Os campos Codigos, CodigosEditaveis, CodigoInicial, CodigoFinal, Classe, Tipo e Situacao não selecionam o registro na rota por código. Valores inválidos ainda podem ser recusados pela validação compartilhada.

Exemplo de Body

{
    "Codigos": [1001, 1002],
    "CodigosEditaveis": ["001001", "001002"],
    "CodigoInicial": 1000,
    "CodigoFinal": 2000,
    "Classe": 10,
    "Tipo": 1,
    "Situacao": "ativo",
    "DataAlteracaoInicial": "01-01-2026",
    "DataAlteracaoFinal": "31-12-2026",
    "Extensoes": ["pdf", "jpg"],
    "IncluirAnexos": true,
    "IncluirDesenhos": true,
    "Pagina": 1,
    "TamanhoPagina": 50
}

Sucesso

{
    "TotalRegistros": 1,
    "BemSucedido": true,
    "Dados": [
        {
            "Origem": "anexo",
            "CodigoMaterial": 1001,
            "CodigoMaterialEditavel": "001001",
            "NomeArquivo": "manual.pdf",
            "Extensao": ".pdf",
            "ConteudoBase64": "JVBERi0xLjQ..."
        }
    ]    
}
enduser/erp/developer/integracao/integracaowebservice/anexos/material.txt · Última modificação: por 127.0.0.1

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki