Histórico da Página

Parâmetros para a busca de metadados:

pathParams:  Informar: metadata.

• list: Metadados da tela de listagem
• edit: Metadados da tela de inclusão do arquivo

{
    "queryParams": {
    "type": "list"
  },
    "pathParams": [
       "metadata"
    ],
}

Retorno contendo metadados com campos e ações conforme parâmetros recebidos:

• Metadados List:

  {
    "keepfilters": false,
    "literals": {},
    "validateFields": [],
    "title": "Documentos",
    "fields": [
        {
            "visible": false,
            "property": "documentId",
            "label": "Código",
            "type": "number",
            "key": true,
            "order": 1
        },
        {
            "property": "processTypeDescription",
            "width": "15%",
            "label": "Tipo Processo",
            "type": "string",
            "order": 2
        },
        {
            "property": "processKey",
            "width": "15%",
            "label": "Chave Processo",
            "type": "string",
            "order": 3
        },
        {
            "property": "documentName",
            "width": "20%",
            "label": "Documento",
            "type": "string",
            "order": 4
        },
        {
            "property": "documentSize",
            "width": "5%",
            "label": "Tamanho",
            "type": "string",
            "order": 5
        },
        {
            "property": "documentDescription",
            "width": "25%",
            "label": "Descrição",
            "type": "string",
            "order": 6
        }
    ],
    "tableCustomActions": [],
    "actions": {
        "new": "/new",
        "removeAll": true,
        "remove": true
    },
    "pageCustomActions": []
}                                                                                 

Para verificar o que significa cada campo de listagem, conferir abaixo: 

• keepFilters: Mantém na modal de Busca Avançada os valores preenchidos do último filtro realizado pelo usuário
• literals: Objeto com as literais usadas
• validateFields: Lista que define os campos que irão disparar o validate do form
• title: Título da página
• fields: São os campos a serem apresentados na tabela, sendo eles: 
  • property: Nome de referência do campo
  • label: Rótulo do campo exibido
  • type: Tipo do valor campo
  • key: Valor lógico que indica se o campo é chave
  • order: Informa a ordem de exibição do campo
  • visible: Indica se o campo será visível
  • width: Tamanho do campo

• tableCustomActions: Lista de ações customizadas da tabela que serão incorporadas às ações informadas através da propriedade actions
• actions:Ações que o usuário poderá executar na página através de botões
  • new: Rota ou função para criar um novo recurso, caso seja preenchida

• • habilita a ação de "Novo" na tela de listagem para criação de um novo anexo
  • remove: Habilita a ação de exclusão na tabela
  • removeAll: Habilita a ação de exclusão em lote na página

• pageCustomActions:

• Lista de ações customizadas da

• página que serão incorporadas às ações informadas através da propriedade actions. Essas ações ficam localizadas na parte superior da página em botões com ações

• Metadados Edit:

  {
    "defaultFields": [
        {
            "gridColumns": 4,
            "divider": "Processo",
            "label": "Tipo Processo",
            "property": "processType",
            "disabled": true,
            "options": [
                {
                    "value": 1,
                    "label": "Ordem de Compra"
                }
            ]
        },
        {
            "gridColumns": 4,
            "label": "Chave",
            "property": "processKey",
            "disabled": true
        },
        {
            "autoUpload": true,
            "gridColumns": 4,
            "divider": "Anexar Documento",
            "label": "Selecione o documento",
            "property": "documentUpload",
            "required": true,
            "type": "upload"
        },
        {
            "maxLength": 200,
            "gridColumns": 4,
            "label": "Descrição",
            "property": "documentDescription",
            "rows": 4
        }
    ],
    "title": "Novo Documento",
    "breadcrumb": {
        "items": [
            {
                "link": "/",
                "label": "Documentos"
            },
            {
                "link": "/new",
                "label": "Novo Documento"
            }
        ]
    }
}                                                                              

• defaultFields: Armazena as informações dos campos padrões do formulários: 
  • gridColumns: Tamanho de exibição do campo em telas.
  • divider: Exibirá um divisor acima, utilizando o seu conteudo como título
  • label: Rótulo do campo exibido
  • property: Nome de referência do campo
  • disabled: Função que deve retornar um booleano para habilitar ou desabilitar a ação para o registro selecionado
  • options: Lista de opções que serão exibidos em um componente, podendo selecionar uma opção.
    • value: Valor que será usado como referência para exibição do conteúdo na coluna, representa o tipo de processo
    • label: Rótulo do campo exibido, referenciando o nome do tipo de processo
• autoUpload: Define se o envio do arquivo será automático ao selecionar o mesmo
• required: Indica que o campo será obrigatório
• type: Tipo do valor campo
• maxLength: Tamanho máximo de caracteres
• rows: Quantidade de linhas exibidas no campo "Descrição"
• title: Título da página
• breadcrumb: Objeto com propriedades do breadcrumb, componente que gera uma estrutura de navegação que apresenta ao usuário a localização da URL atual, exibindo as antecessoras conforme é realizado a navegação na aplicação:
  • items: Lista de itens do breadcrumb:
    • link: Url do item
    • label: Rótulo do item

Parâmetros para download do anexo:

pathParams:  Informar: download e ID do documento.

{
    "pathParams": [
    "download",
    "402"
  ],
}

Retorno das informações do arquivo que está sendo realizado o download:

{
    "headers": {
        "Content-Type": "application/octet-stream"
    },
    "payload": {
        "file": {
            "FN_File": "Evidencia_COD_DMANSUPIMPA2-605.docx",
            "DN_File": "UEsDBBQABgAIAAAAIQBkdsOlw57DhwEAAMOKCQAAEwAIAltD..."
        }
    }
}

Para verificar o que significa cada campo, conferir abaixo: 

• File : contém as informações do anexo
  • FN_File: Nome do arquivo com extensão, vindo da tabela arquivo_docto.
  • DN_File: Conteúdo do arquivo em base64.  

Parâmetros para eliminação de anexo individual:

pathParams:  Informar: ID do anexo.

{
    "pathParams": [
       "1234"
    ],
}

Informações da exclusão:

Não há retorno direto via Output nesse método. Em caso de sucesso na exclusão individual ou lote, será retornado vazio e o statusCode 204 (No Content).

A montagem do JsonObject e seu retorno ocorrerá na API de comunicações, cdp/supplyDocuments com base no conteúdo vindo da temp-table RowErrors. Para informações de modelos das mensagens retornadas, vide campo da RowErrors abaixo.

Informações sobre os erros ocorridos durante o processo:

A temp-table vem populada com registros criados na API de documentos (cdp/apiDocuments), devido a erros ocorridos durante o processo de eliminação.

Esses registros serão usados para a montagem da mensagem de erro que será retornada via OUTPUT de um JsonObject, na API de comunicação (cdp/supplyDocuments), conforme cada caso específico. 

Parâmetros para criação:

Payload:

{
         "processType":1,
         "processKey":"12345|10",
         "documentName":"testeArquivo.txt",
         "documentDescription":"teste de arquivo",
         "documentFile": "JC9CVVNJTkVTU0hVQi9Gb250ZXNfRG9jL1N1c3RlbnRhY2FvL1YxMS9WMTEv..."
 }

Informações do anexo criado:

{
    "items": [
        {
            "creationUserName": "Super",
            "documentDir": "\\\\moitas\\tmp\\ERP\\1\\12345\\10\\3c3bbcd88a4f01fb34fb63ae7f845f6c.txt",
            "creationUser": "super",
            "documentDescription": "teste de arquivo",
            "processKey": "12345|10",
            "documentId": 725,
            "processType": 1,
            "documentName": "testeArquivo.txt",
            "documentSize": "74 Bytes",
            "processTypeDescription": "Ordem de Compra",
            "creationDatetime": "2022-03-29T10:59:46.376"
        }
    ]
}

Para verificar o que significa cada campo conferir nas temp-tables no final desta documentação:

• ttDocumentFile: Contém os campos a serem retornados na busca dos documentos do processo.