oRest:getPathParamsRequest

Responsável por retornar os parâmetros informados na requisição via URI (path param)

Sintaxe

getPathParamsRequest()

Retorno

Nome	Tipo	Descrição
jParams	JsonObject	objeto json com parametros $p a t h p a r a m$ da requisição

Observações

Para visualizar o exemplo, execute seu serviço rest com a URI: /documentation/getPathParamsRequest/TOTVS

Exemplos

#include "tlpp-core.th"
#include "tlpp-rest.th"

@Get("/documentation/getPathParamsRequest/:cKey")
Function u_fGetPathParamsRequest()
  local cResponse := ""
  local cRet      := ""
  local jParams := JsonObject():New()
  
  jParams := oRest:getPathParamsRequest()
  cRet    := jParams['cKey']
  if (valtype(cRet) == 'C')
    cResponse := '{"getPathParamsRequest":"' + cValToChar(cRet) + '"}' //cRet vai ter valor igual a "TOTVS"
  else
      cResponse := '{"getPathParamsRequest": "metodo getPathParamsRequest nao foi executado"}'
  endif
return oRest:setResponse(cResponse)

Abrangência

07/2019

Atenção:

Os objetos JSON retornados por métodos de oRest, como por exemplo oRest:getQueryRequest(), são referências ao objeto existente no REST e não uma cópia.

Existem alguns motivos para ser uma referência, são eles:

Melhorar performance do serviço;
Economia de memória;
Evitar que seja necessário limpar o objeto na saída da implementação do serviço REST.

Portanto, é imprescindível que não se manipule diretamente o Objeto, pois isso irá refletir nas próximas requisições, causando problemas difíceis de serem detectados.

Métodos:

oRest:getPathParamsRequest()
oRest:getQueryRequest()
oRest:getHeaderRequest()
oRest:getThreadPoolTlppData()
oRest:getServerTlppData()
oRest:getThreadPoolUserData()
oRest:getThreadPoolServerUserData()
oRest:getHeaderResponse()

Árvore de páginas