Histórico da Página

...

pi-metada-v1

Requisito

Nenhum.

Descrição

Retorna o metadados para carregamento inicial dos campos da tela de listagem de anexos, bem como as ações padrão desta tela. Dependendo do tipo de evento informado na requisição, retorna também os campos e ações que irão ser carregados na tela de criação dos anexos.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para a busca do aprovador:

queryParams → type=edit: para buscar o metadado de edição (tela "Novo" para criação de anexo). Ex de requisição: http://cancun:8680/dts/datasul-rest/resources/prg/cdp/v1/supplyDocuments/metadata?type=edit

queryParams → type=list: para buscar o metadado de listagem (tela de listagem de anexos).

Ex de requisição:

http://cancun:8680/dts/datasul-rest/resources/prg/cdp/v1/supplyDocuments/metadata?type=list

cEvent

CHARACTER

INPUT

Tipo do evento enviado por query-param: se for to tipo list, envia por json os campos e ações para a tela de listagem, e se for do tipo edit, retorna no json, os campos e ações que irão compor a tela de criação de anexos.

cVersion

CHARACTER

INPUT

Versão da API

oOutput

JsonObject

OUTPUT

Json de retorno.

Evento do tipo "list": retorna os campos e ações que irão compor a tela de listagem

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

Evento do tipo "edit": retorna os campos padrão que irão compor a tela de inclusão de anexo

{
    "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"
            }
        ]
    }
}

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo de busca do metadados.

Retorno

Dados principais para inicialização do APP com os dados da listagem dos anexos ou os dados para ediçao de um novo anexo, ou ainda, erros ocorridos durante o processo de busca.

pi-query-v1

Requisito

Nenhum.

Descrição

Busca os dados dos anexos para o tipo de processo e chave informado

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Queryparams:

processType: tipo do processo. Os tipos devem ser cadastrados na include de view-as uninc\i01un403.i.

processKey: chave do processo

Ex. de requisição:

http://vigia:8480/dts/datasul-rest/resources/prg/cdp/v1/supplyDocuments?processType=8&processKey=1234%7CABC

A URL de requisição deve ser enviada no formato encode, visto que a chave do processo pode ser composta com “|” (pipe) na URL.

aResult

JsonArray

OUTPUT

Json de retorno com os dados da consulta

{
    "total": 4,
    "totalHits": 4,
    "hasNext": false,
    "items": [
        {
            "creationUserName": "Super",
            "documentDir": "c:\\tmp\\ERP\\1\\550433\\dd2a4055701ceb6736790124a6c2a2d8.ts",
            "creationUser": "super",
            "documentDescription": "teste",
            "processKey": "550433",
            "documentId": 696,
            "processType": 1,
            "documentName": "general-pt.ts",
            "documentSize": "163 Bytes",
            "processTypeDescription": "Ordem de Compra",
            "creationDatetime": "2022-03-17T09:52:56.000"
        },
        {
            "creationUserName": "Super",
            "documentDir": "c:\\tmp\\ERP\\1\\550433\\7881f0f9bd7d6fa0633d17db145d1692.jpg",
            "creationUser": "super",
            "documentDescription": "Capa de chuva",
            "processKey": "550433",
            "documentId": 697,
            "processType": 1,
            "documentName": "capa1.jpg",
            "documentSize": "48,63 KB",
            "processTypeDescription": "Ordem de Compra",
            "creationDatetime": "2022-03-17T17:39:28.000"
        },
        {
            "creationUserName": "Super",
            "documentDir": "c:\\tmp\\ERP\\1\\550433\\498d7c5fe9e3db173142da6722bd2ede.csv",
            "creationUser": "super",
            "documentDescription": "teste csv",
            "processKey": "550433",
            "documentId": 710,
            "processType": 1,
            "documentName": "OCS_SEM_PROGORDEMSUP.csv",
            "documentSize": "110,56 KB",
            "processTypeDescription": "Ordem de Compra",
            "creationDatetime": "2022-03-21T08:47:02.000"
        },
        {
            "creationUserName": "Super",
            "documentDir": "c:\\tmp\\ERP\\1\\550433\\69b5de8e9ed69ab1d4dcd736dbd706fb.txt",
            "creationUser": "super",
            "documentDescription": "",
            "processKey": "550433",
            "documentId": 711,
            "processType": 1,
            "documentName": "Arquivo_TXT_Exemplo.txt",
            "documentSize": "283 Bytes",
            "processTypeDescription": "Ordem de Compra",
            "creationDatetime": "2022-03-21T08:48:48.000"
        }
    ]
}

lHasNext

LOGICAL

OUTPUT

retorno lógico indicando se há mais de uma página

iTotalHits

INTEGER

OUTPUT

total de registros

RowErrors

TEMP-TABLE

OUTPUT

tabela temporária com os erros do processo

Retorno

Dados dos anexos do processo/chave

pi-upload-v1

Requisito

Nenhum.

Descrição

Faz o upload do arquivo do usuário na criação de um novo anexo.

Realiza validações do usuário para acesso:

Se é aprovador;
Se possui algum documento configurado para aprovação;
Se existe estabelecimento configurado para aprovação (MLA0000)

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para a validação do aprovador:

pathParamsqueryparams: Informar na seguinte ordem: validateUserInfo e código do aprovador.Exemplo

{
    "pathParams": [
    "validateUserInfo",
    "super"
  ],
}

files=<arquivo> → arquivo que será feito o upload

oOutput

JsonObject

OUTPUT

Campo indicando se o usuário está válido:Json contendo o nome do arquivo e o conteúdo do arquivo em Base64.

Exemplo

{

"status": 200,
"payload": {

"

total

fileName":

1,
"hasNext": false

"teste.txt",

"

items

content":

[
      {
        "passed": true
      }
    ]
  }
}

"aXN0byDDqSB1bSB0ZXN0ZQ=="

}

RowErrors Temp-table OUTPUT Informações sobre os erros ocorridos durante o processo de validaçãoupload.

Retorno

Indica se o usuário está válido e caso não esteja, os erros de validação.Upload do arquivo

pi-

metadata

download-v1
Requisito	Nenhum

Sintaxe

RUN pi-metadata-v1 in handle (INPUT <JsonObject>,

INPUT <CHARACTER>,

OUTPUT DATASET <JsonObject>,

OUTPUT TABLE <temp-table>)→ edit: tela de inclusão de

.
Descrição

Retorna o json com os campos e ações que irão compor a tela dinâmica dos anexos conforme o evento:

→ list: tela de listagem dos anexos com as ações de Incluir, Excluir e Exluir todos.

Faz o upload do arquivo do usuário na criação de um novo anexo.
Parâmetros	Tipo	Input/Output	Descrição
oInput

cEvent

JsonObject

cVersion

oOutput

RowErrors

Número da ordem de compra

Data da cotação para conversão

Código da moeda para conversão

Informações da ordem de compra

Erros ocorridos no processo

Retorno

Retorna um dataset contendos informações da ordem de compra, parcelas, cotações, requisições, recebimentos, alterações, eventos e unidades de negócio e uma temp-table com os erros ocorridos durante o processo.

EPCafterLoadOrdemCompraApós buscar informações relacionadas a ordem detalhadaParâmetrosDescriçãoHandle_ttOrdemCompraHandle da temp-table com informações da ordem de compra: ttOrdemCompraHandle_ ttPrazoCompraHandle da temp-table com informações das parcelas: ttPrazoCompraHandle_ttCotacaoItemHandle da temp-table com informações das cotações: ttCotacaoItemHandle_ttAltPedHandle da temp-table com informações das altrerações do pedido: ttAltPedHandle_ttRecebimentoHandle da temp-table com informações do recebimento: ttRecebimentoHandle_ttEventoPedHandle da temp-table com informações dos eventos do pedido: ttEventoPedHandle_ttItRequisicaoHandle da temp-table com informações de item de requisição: ttItRequisicaoHandle_ttUnidNegocHandle da te

INPUT	Parâmetros para a validação do aprovador: queryparams: files=<arquivo> → arquivo que será feito o upload
oOutput	JsonObject	OUTPUT	Json contendo o nome do arquivo e o conteúdo do arquivo em Base64. Exemplo { "fileName": "teste.txt", "content": "aXN0byDDqSB1bSB0ZXN0ZQ==" }
RowErrors	Temp-table	OUTPUT	Informações sobre os erros ocorridos durante o processo de upload.
Retorno	Upload do arquivo

Árvore de páginas

Versões comparadas

Versão antiga 7

Nova versão 8

Chave