...
Nome | Tipo | Descrição | Obrigatório | Referência |
cVerb | - | PUT, POST, GET ou DELETE | X | |
cId | Caracter | ID para diferenciar e possibilitar a criação de métodos que utilizam verbos http repetidos | ||
cDescription | Caracter | Descrição do método REST | X | |
cSintax | Caracter | Sintaxe HTTP da chamada REST. Esta informação é utilizada apenas para documentação do REST. | ||
cPath | Caracter | Definição do endpoint que irá acionar aquele método. *Pode conter agrupamento, o nome da classe e os pathparms. (A partir da release 12.1.23 da lib, em jan./2019). | ||
QueryParms | - | Indica os parâmetros, separados por vírgulas, que este método receberá via QueryString. O parâmetros indicados aqui devem ser declarados como WSDATA. | ||
PathParms | - | Indica os parâmetros, separados por vírgulas, que este método receberá via path, ou seja, como parte da URL. | ||
HeaderParms | - | Indica os parâmetros, separados por vírgulas, que este método receberá via Header na requisição HTTP. | ||
WsRestFul | Caracter | Indica o nome da classe, do serviço, que o método atual pertence. | X |
...
Exemplo de uma classe com diferentes tipos de configuração de path (disponibilizados no release 12.1.23):
#INCLUDE 'totvs.ch'
#INCLUDE "restful.ch"
...