FINA040VA - WS REST FWMODEL

ÍNDICE

Visión general
Servicios disponibles
Ejemplo de utilización
1. PUT
2. GET
Asuntos relacionados

01. VISIÓN GENERAL

Para clientes que tienen rutinas o aplicaciones personalizadas y necesitan consultar y modificar las informaciones en la rutina Valores accesorios(FINA040VA), se pusieron a disposición métodos Web Service REST.

02. SERVICIOS DISPONIBLES

GET Consulta	POST Inclusión	PUT Modificación	DELETE Borrado

03. EJEMPLO DE UTILIZACIÓN

Para realizar pruebas, puede utilizarse cualquier programa de su preferencia, que pruebe API Web Service REST.

Como ejemplos de programas, podemos citar el SoapUI o Postman . Ambas son excelentes aplicaciones.

Los siguientes ejemplos se mostrarán utilizando el programa Postman, ejecutando los métodos GET, POST, PUT y DELETE.

Para inclusión o modificación del registro, puede utilizar la misma estructura (body), los campos pueden incluirse dentro de la tag FIELDS.
Para más detalles referentes al montaje de la estructura, vea el siguiente modelo.

Donde:

id: es la id de la API

operation: es el código de la operación, valor estándar: 1,

pk: es la clave primaria del alias del modelo de datos codificado en base64,

models: son los modelos de negocio de cada API, es decir, modelo de datos de MVC, que está definido por:

id: es el modelo de datos definido en MVC

modeltype: es tipo de modelo de datos, "FIELDS" o "GRID"

fields: es un vector con los campos, definido por:

id: es el nombre del campo

order: orden del campo en la tabla SBE

value: es el valor del campo

Importante

Por estándar, para realizar una consulta, modificación o borrado de un determinado dato del servidor por medio de los métodos GET, PUT o DELETE, es necesario informar la PK (Primary Key), valor de la clave primaria del alias del modelo, codificado en base64, en caso contrario no informado, se devolverán los registros de acuerdo con su paginación.

a. PUT

Devolución - Modelo estructura PUT

{
    "id": "FINA040VA",
    "operation": 4,
    "pk": "RCBNRyAwMSBEIE1HIDAxICAgIDAwMDM4NiAgICBORiAwMDAwMDEwMQ==",
    "models": [
        {
            "id": "SE1MASTER",
            "modeltype": "FIELDS",
            "fields": [
            ],
            "models": [
						{
							"id": "FK7DETAIL",
							"modeltype": "GRID",
							"optional": 1,
							"struct": [
                    ],
                    "ítems": [
                        {
                            "id": 1,
                            "deleted": 0,
                            "fields": [
                            ]
                        }
                    ]
                },
                {
                    "id": "FKDDETAIL",
                    "modeltype": "GRID",
                    "struct": [
                    ],
                    "ítems": [
                        {
                            "id": 1,
                            "deleted": 0,
                            "fields": [
                                {
                                    "id": "FKD_CODIGO",
                                    "value": "000004"
                                },
                                {
                                    "id": "FKD_VALOR",
                                    "value": "1100.00"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}

b. GET

Devolución - Modelo estructura GET

{
    "id": "FINA040VA",
    "operation": 1,
    "pk": "RCBNRyAwMSBEIE1HIDAxICAgIDAwMDM4NiAgICBORiAwMDAwMDEwMQ==",
    "models": [
        {
            "id": "SE1MASTER",
            "modeltype": "FIELDS",
            "fields": [
                {
                    "id": "E1_FILIAL",
                    "order": 1,
                    "value": "D MG 01"
                },
                {
                    "id": "E1_NUM",
                    "order": 3,
                    "value": "000386"
                },
                {
                    "id": "E1_TIPO",
                    "order": 5,
                    "value": "FACTURA"
                },
                {
                    "id": "E1_NATUREZ",
                    "order": 6,
                    "value": "001"
                },
                {
                    "id": "E1_CLIENTE",
                    "order": 9,
                    "value": "000001"
                },
                {
                    "id": "E1_LOJA",
                    "order": 10,
                    "value": "01"
                },
                {
                    "id": "E1_NOMCLI",
                    "order": 11,
                    "value": "CLIENTE ESTÁNDAR"
                },
                {
                    "id": "E1_EMISSAO",
                    "order": 12,
                    "value": "20151008"
                },
                {
                    "id": "E1_VENCTO",
                    "order": 13,
                    "value": "20151008"
                },
                {
                    "id": "E1_VENCREA",
                    "order": 14,
                    "value": "20151008"
                },
                {
                    "id": "E1_VALOR",
                    "order": 15,
                    "value": "9000.00"
                },
                {
                    "id": "E1_EMIS1",
                    "order": 24,
                    "value": "20151008"
                },
                {
                    "id": "E1_SITUACA",
                    "order": 31,
                    "value": "0"
                },
                {
                    "id": "E1_SALDO",
                    "order": 33,
                    "value": "9000.00"
                },
                {
                    "id": "E1_MOEDA",
                    "order": 48,
                    "value": "1"
                },
                {
                    "id": "E1_OCORREN",
                    "order": 57,
                    "value": "01"
                },
                {
                    "id": "E1_VLCRUZ",
                    "order": 62,
                    "value": "9000.00"
                },
                {
                    "id": "E1_STATUS",
                    "order": 64,
                    "value": "A"
                },
                {
                    "id": "E1_ORIGEM",
                    "order": 65,
                    "value": "FINA040"
                },
                {
                    "id": "E1_FLUXO",
                    "order": 68,
                    "value": "S"
                },
                {
                    "id": "E1_TIPODES",
                    "order": 71,
                    "value": "1"
                },
                {
                    "id": "E1_FILORIG",
                    "order": 85,
                    "value": "D MG 01"
                },
                {
                    "id": "E1_MULTNAT",
                    "order": 101,
                    "value": "2"
                },
                {
                    "id": "E1_PROJPMS",
                    "order": 102,
                    "value": "2"
                },
                {
                    "id": "E1_DESDOBR",
                    "order": 103,
                    "value": "2"
                },
                {
                    "id": "E1_MODSPB",
                    "order": 105,
                    "value": "1"
                },
                {
                    "id": "E1_SCORGP",
                    "order": 146,
                    "value": "2"
                },
                {
                    "id": "E1_RELATO",
                    "order": 177,
                    "value": "2"
                },
                {
                    "id": "E1_APLVLMN",
                    "order": 187,
                    "value": "1"
                },
                {
                    "id": "E1_VLMINIS",
                    "order": 196,
                    "value": "1"
                },
                {
                    "id": "E1_TPDESC",
                    "order": 200,
                    "value": "C"
                },
                {
                    "id": "E1_RATFIN",
                    "order": 201,
                    "value": "2"
                },
                {
                    "id": "E1_MSUIDT",
                    "order": 231,
                    "value": "E79042B9-11BB-4A1A-AF62-F85C6C337A0D"
                }
            ],
            "models": [
                {
                    "id": "FK7DETAIL",
                    "modeltype": "GRID",
                    "optional": 1,
                    "struct": [
                        {
                            "id": "FK7_FILIAL",
                            "order": 1
                        },
                        {
                            "id": "FK7_IDDOC",
                            "order": 2
                        },
                        {
                            "id": "FK7_ALIAS",
                            "order": 3
                        },
                        {
                            "id": "FK7_CHAVE",
                            "order": 4
                        },
                        {
                            "id": "FK7_FILTIT",
                            "order": 5
                        },
                        {
                            "id": "FK7_PREFIX",
                            "order": 6
                        },
                        {
                            "id": "FK7_NUM",
                            "order": 7
                        },
                        {
                            "id": "FK7_PARCEL",
                            "order": 8
                        },
                        {
                            "id": "FK7_TIPO",
                            "order": 9
                        },
                        {
                            "id": "FK7_CLIFOR",
                            "order": 10
                        }
                    ],
                    "ítems": [
                        {
                            "id": 1,
                            "deleted": 0,
                            "fields": [
                                {
                                    "id": "FK7_FILIAL",
                                    "value": "D MG 01"
                                },
                                {
                                    "id": "FK7_IDDOC",
                                    "value": "242940befdd2400085327422191116f6"
                                },
                                {
                                    "id": "FK7_ALIAS",
                                    "value": "SE1"
                                },
                                {
                                    "id": "FK7_CHAVE",
                                    "value": "D MG 01 |   |000386   | |FACTURA |000001|01"
                                },
                                {
                                    "id": "FK7_FILTIT",
                                    "value": "D MG 01"
                                },
                                {
                                    "id": "FK7_NUM",
                                    "value": "000386"
                                },
                                {
                                    "id": "FK7_TIPO",
                                    "value": "FACTURA"
                                },
                                {
                                    "id": "FK7_CLIFOR",
                                    "value": "000001"
                                }
                            ]
                        }
                    ]
                },
                {
                    "id": "FKDDETAIL",
                    "modeltype": "GRID",
                    "optional": 1,
                    "struct": [
                        {
                            "id": "FKD_FILIAL",
                            "order": 1
                        },
                        {
                            "id": "FKD_CODIGO",
                            "order": 2
                        },
                        {
                            "id": "FKD_VALOR",
                            "order": 8
                        },
                        {
                            "id": "FKD_IDDOC",
                            "order": 9
                        },
                        {
                            "id": "FKD_SALDO",
                            "order": 10
                        },
                        {
                            "id": "FKD_DTBAIX",
                            "order": 11
                        },
                        {
                            "id": "FKD_VLCALC",
                            "order": 13
                        },
                        {
                            "id": "FKD_VLINFO",
                            "order": 14
                        },
                        {
                            "id": "FKD_IDFKD",
                            "order": 15
                        }
                    ],
                    "ítems": [
                        {
                            "id": 1,
                            "deleted": 0,
                            "fields": [
                                {
                                    "id": "FKD_FILIAL",
                                    "value": "D MG 01"
                                },
                                {
                                    "id": "FKD_CODIGO",
                                    "value": "000004"
                                },
                                {
                                    "id": "FKD_VALOR",
                                    "value": "1000.00"
                                },
                                {
                                    "id": "FKD_IDDOC",
                                    "value": "242940befdd2400085327422191116f6"
                                },
                                {
                                    "id": "FKD_VLCALC",
                                    "value": "1000.00"
                                },
                                {
                                    "id": "FKD_IDFKD",
                                    "value": "C95E4F8636D04E118E3DAC5AFCAD9E8A"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}

04. ASUNTOS RELACIONADOS

FWRestModel - API RESTful de los modelos de datos del Protheus

Integración del Easy Import Control vía API REST

Atalhos

Árvore de páginas

ÍNDICE

01. VISIÓN GENERAL

02. SERVICIOS DISPONIBLES

03. EJEMPLO DE UTILIZACIÓN

04. ASUNTOS RELACIONADOS