Expandir

title	HOST

Método GET:HOST

Retorna o endereço base definido para as requisições REST.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_reference >,"GET", "HOST" ) => CHAR

Retorno

Tipo	Descrição
`CHAR`	Endereço base das requisições REST.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

#------------------------#
 FUNCTION LREST_getHOST()
#------------------------#
    DEFINE l_host CHAR(200)

    LET l_host = _ADVPL_get_property(m_rest_reference,"HOST")
 END FUNCTION

Expandir

title	GET

Método GET:GET

Efetua uma requisição GET e retorna verdadeiro se a requisição foi efetuada com sucesso.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_reference >,"GET", < l_path >, [ l_headers ]) => SMALLINT

Parâmetros

Nome	Tipo	Descrição	Obrigatório?	Padrão
`l_path`	`CHAR`	Caminho do serviço REST para requisição.	Sim
`l_headers`	`CHAR`	Lista de cabeçalhos específicos da requisição.¹	Não

¹ Por ser uma lista de valores, os cabeçalhos precisam ser informados no formato {{"Header1: Content1"},{"Header2: Content2"}}.

Exemplo: {{"Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="}}.

Retorno

Tipo	Descrição
`SMALLINT`	Verdadeiro se a requisição foi efetuada com sucesso.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

#------------------------------------------------------------------------------#
FUNCTION LREST_getGET()
#------------------------------------------------------------------------------#
    DEFINE l_status SMALLINT

    LET l_status = _ADVPL_get_property(m_rest_reference,"GET","/posts")

    IF  l_status THEN
        CALL CONOUT("OK.:",_ADVPL_get_property(m_rest_reference,"RESULT"))
    ELSE
        CALL CONOUT("NOK:",_ADVPL_get_property(m_rest_reference,"ERROR_MESSAGE"))
    END IF
END FUNCTION

Observação

Para recuperar o resultado da requisição, utilize o método RESULT.
Para recuperar a mensagem de erro, no caso da requisição não ter sido executada, utilize o método ERROR_MESSAGE.

Expandir

title	POST

Método GET:POST

Efetua uma requisição POST e retorna verdadeiro se a requisição foi efetuada com sucesso.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_reference >,"POST", < l_path >, [ l_headers ], [ l_post_params ]) => SMALLINT

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_path`	`CHAR`	Caminho do serviço REST para requisição.	Sim
`l_headers`	`CHAR`	Lista de cabeçalhos específicos da requisição.¹	Não
`l_post_params`	`CHAR`	Conteúdo do corpo da requisição (geralmente conteúdo no formato JSON).	Não

¹ Por ser uma lista de valores, os cabeçalhos precisam ser informados no formato "{""Header1: Content1," "Header2: Content2""}".

Exemplo: "{""Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==""}".

Retorno

Tipo	Descrição
`SMALLINT`	Verdadeiro se a requisição foi efetuada com sucesso.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

#------------------------#
 FUNCTION LREST_getPOST()
#------------------------#
    DEFINE l_status SMALLINT
 
    LET l_status = _ADVPL_get_property(m_rest_reference,"POST","/posts","{}")
 
    IF  l_status THEN
        CALL CONOUT("OK.:",_ADVPL_get_property(m_rest_reference,"RESULT"))
    ELSE
        CALL CONOUT("NOK:",_ADVPL_get_property(m_rest_reference,"ERROR_MESSAGE"))
    END IF
 END FUNCTION

Observação

Para recuperar o resultado da requisição, utilize o método RESULT.
Para recuperar a mensagem de erro, no caso da requisição não ter sido executada, utilize o método ERROR_MESSAGE.

Expandir

title	PUT

Método PUT

Efetua uma requisição PUT e retorna verdadeiro se a requisição foi efetuada com sucesso.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_reference >,"PUT", < l_path >, [ l_headers ]) => SMALLINT

Parâmetros

Nome	Tipo	Descrição	Obrigatório?	Padrão
`l_path`	`CHAR`	Caminho do serviço REST para requisição.	Sim
`l_headers`	`CHAR`	Lista de cabeçalhos específicos da requisição.¹	Não

¹ Por ser uma lista de valores, os cabeçalhos precisam ser informados no formato {{"Header1: Content1"},{"Header2: Content2"}}. Exemplo: {{"Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="}}.

Retorno

Tipo	Descrição
`SMALLINT`	Verdadeiro se a requisição foi efetuada com sucesso.

Exemplo

Bloco de código

title	Exemplo SQLCODE
linenumbers	true

#------------------------------------------------------------------------------#
FUNCTION LREST_getPUT()
#------------------------------------------------------------------------------#
    DEFINE l_status SMALLINT

    LET l_status = _ADVPL_get_property(m_rest_reference,"PUT","/posts/1")

    IF  l_status THEN
        CALL CONOUT("OK.:",_ADVPL_get_property(m_rest_reference,"RESULT"))
    ELSE
        CALL CONOUT("NOK:",_ADVPL_get_property(m_rest_reference,"ERROR_MESSAGE"))
    END IF
END FUNCTION

Observação

Para recuperar o resultado da requisição, utilize o método RESULT.
Para recuperar a mensagem de erro, no caso da requisição não ter sido executada, utilize o método ERROR_MESSAGE.

Expandir

title	DELETE

Método GET:DELETE

Efetua uma requisição DELETE e retorna verdadeiro se a requisição foi efetuada com sucesso.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_reference >,"DELETE", < l_path >, [ l_headers ]) => SMALLINT

Parâmetros

Nome	Tipo	Descrição	Obrigatório?	Padrão
`l_path`	`CHAR`	Caminho do serviço REST para requisição.	Sim
`l_headers`	`CHAR`	Lista de cabeçalhos específicos da requisição.¹	Não

¹ Por ser uma lista de valores, os cabeçalhos precisam ser informados no formato {{"Header1: Content1"},{"Header2: Content2"}}.

Exemplo: {{"Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="}}.

Retorno

Tipo	Descrição
`SMALLINT`	Verdadeiro se a requisição foi efetuada com sucesso.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

#------------------------------------------------------------------------------#
FUNCTION LREST_getDELETE()
#------------------------------------------------------------------------------#
    DEFINE l_status SMALLINT

    LET l_status = _ADVPL_get_property(m_rest_reference,"DELETE","/posts/1")

    IF  l_status THEN
        CALL CONOUT("OK.:",_ADVPL_get_property(m_rest_reference,"RESULT"))
    ELSE
        CALL CONOUT("NOK:",_ADVPL_get_property(m_rest_reference,"ERROR_MESSAGE"))
    END IF
END FUNCTION

Observação

Para recuperar o resultado da requisição, utilize o método RESULT.
Para recuperar a mensagem de erro, no caso da requisição não ter sido executada, utilize o método ERROR_MESSAGE.

Expandir

title	RESULT

Método GET:RESULT

Retorna o resultado da requisição REST executada.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_reference >,"RESULT") => CHAR

Retorno

Tipo	Descrição
`CHAR`	Resultado obtido na execução da requisição REST.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

#--------------------------#
 FUNCTION LREST_getRESULT()
#--------------------------#
    DEFINE l_status SMALLINT

    LET l_status = _ADVPL_get_property(m_rest_reference,"GET","/posts")

    IF  l_status THEN
        CALL CONOUT("OK.:",_ADVPL_get_property(m_rest_reference,"RESULT"))
    ELSE
        CALL CONOUT("NOK:",_ADVPL_get_property(m_rest_reference,"ERROR_MESSAGE"))
    END IF
 END FUNCTION

Observação

Para recuperar o resultado da requisição, utilize o método RESULT.
Para recuperar a mensagem de erro, no caso da requisição não ter sido executada, utilize o método ERROR_MESSAGE.

...

Páginas filhas

Versões comparadas

Versão antiga 19

Nova versão 20

Chave

Sintaxe

Retorno

Exemplo

Método GET:GET

Sintaxe

Parâmetros

Retorno

Exemplo

Observação

Método GET:POST

Sintaxe

Parâmetros

Retorno

Exemplo

Observação

Método PUT

Sintaxe

Parâmetros

Retorno

Exemplo

Observação

Método GET:DELETE

Sintaxe

Parâmetros

Retorno

Exemplo

Observação

Método GET:RESULT

Sintaxe

Retorno

Exemplo

Observação

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 19

Nova versão 20

Chave

Método GET:HOST

Sintaxe

Retorno

Exemplo

Método GET:GET

Sintaxe

Parâmetros

Retorno

Exemplo

Observação

Método GET:POST

Sintaxe

Parâmetros

Retorno

Exemplo

Observação

Método PUT

Sintaxe

Parâmetros

Retorno

Exemplo

Observação

Método GET:DELETE

Sintaxe

Parâmetros

Retorno

Exemplo

Observação

Método GET:RESULT

Sintaxe

Retorno

Exemplo

Observação