Linha Microsiga Protheus - Inglês

Páginas filhas
  • NGF - FINA710 - Endpoint Tables

Versões comparadas

Versão antiga 1

changes.mady.by.user Usuário desconhecido (thayna.souza)

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Usuário desconhecido (thayna.souza)

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

NGF - FINA710 - Endpoint Tables

  Draft

01. OVERVIEW

Return a list of records based on the filters forwarded from a table, with only the following tables possible: FWP, SE1, SE2, SA1, SA2, SA6, SEA.

02. ENDPOINT

Method used: GET
Any table: /api/gfin/v1/Tables/<table alias>

03. REQUEST PARAMETERS

        Table Alias: Defines the table to be used for listing. Possible values: FWP, SE1, SE2, SA1, SA2, SA6, SEA.
Query parameters:

Attribute

Type

Description

Default

page

numeric

page number

1

pagesize

numeric

page size

10

filter

character

(optional) filters in oData pattern

-

order

character

(optional) display order for the records

-

fields

character

fields for the return

-

folders

character

'S' to return the folders configuration

-

Example:queryParam

/api/gfin/v1/Tables/SE1?pagesize=10&page=1&allfields=true
  

/api/gfin/v1/Tables/SE1?pagesize=10&page=1&fields=e1_hist,e1_numbor
  

/api/gfin/v1/Tables/SE1?filter=(E1_NUM eq '000000229' or E1_NUM eq '000000230')
  


Folders
/api/gfin/v1/Tables/se1?folder=S&filter=e1_filial eq 'D MG 01' and e1_prefixo eq 
'' and e1_num eq '000000001' and e1_parcela eq '' and e1_tipo eq 'NF'

04. API RESPONSE

Json Object

Attribute

Type

Description

items

Array

list of documents

hasnext

Logical

true if there is a next page

struct

Array

struct of the returned fields

modeAccess.Company

Character

Company access mode

modeAccess.Unit

Character

Unit access mode

modeAccess.Branch

Character

Branch access mode

folders.order

Character

Folder order

folder.label

Character

Folder name