Parâmetro | Descrição |
|---|---|
| JsonObject | Objeto JSON recebido como parâmetro pela procedure da requisição (contendo o conteúdo completo da requisição) |
Nome | Descrição | |
|---|---|---|
| getURI | Recupera a URL da requisição. | |
| getMethod | Recupera o Método da Requisição (GET, POST, DELETE, etc). | |
| getPathParams | Retorna um objeto JsonArray com os parâmetros PATH da requisição. Exemplo:
| |
| getQueryParams | Retorna um objeto JsonObject com os parâmetros QUERY da requisição. Exemplo:
| |
| getPayload | Retorna um objeto JsonObject com o corpo da requsição. | |
| getPayloadLongChar | Retorna um LONGCHAR com o corpo da requsição. | |
| getPageSize | Recupera o tamanho da página, caso tenha sido passado como parâmetro. Exemplo: /prg/tstun/V1/totvs-fwk-rest-tstun-prg/getAttributes?page=5&pageSize=20&fields=fields1&expand=expandValue1&filter=filterValue1 | |
| getPage | Recupera o número da página, caso tenha sido passado como parâmetro. Exemplo: /prg/tstun/V1/totvs-fwk-rest-tstun-prg/getAttributes?page=5&pageSize=20&fields=fields1&expand=expandValue1&filter=filterValue1 | |
| getStartRow | Recupera a posição do registro inicial a ser pesquisado de acordo com o número e tamanho da página (caso tenha sido passado como parâmetro). Exemplo: /prg/tstun/V1/totvs-fwk-rest-tstun-prg/getAttributes?page=5&pageSize=20&fields=fields1&expand=expandValue1&filter=filterValue1 Retorna: (5 * 20) + 1 = 81 | |
| getFields | Retorna um objeto JsonArray com os campos a serem pesquisados, caso tenha sido passado como parâmetro. Exemplo: /prg/tstun/V1/totvs-fwk-rest-tstun-prg/getAttributes?page=5&pageSize=20&fields=fields1&expand=expandValue1&filter=filterValue1
| |
| getFieldsChar | Retorna um LONGCHAR com os campos a serem pesquisados separados por vírgula. | |
| getOrder | Retorna um objeto JsonArray com os campos a serem ordenados, caso tenha sido passado como parâmetro. Exemplo: /prg/tstun/V1/totvs-fwk-rest-tstun-prg/getAttributes?page=5&pageSize=20&fields=fields1&order=fields1&expand=expandValue1&filter=filterValue1
| |
| getOrderChar | Retorna um LONGCHAR com os campos a serem ordenados separados por vírgula. | |
| getExpand | Retorna um objeto JsonArray com os campos a serem expandidos, caso tenha sido passado como parâmetro. Exemplo: /prg/tstun/V1/totvs-fwk-rest-tstun-prg/getAttributes?page=5&pageSize=20&fields=fields1&order=fields1&expand=expandValue1&filter=filterValue1
| |
| getExpandChar | Retorna um LONGCHAR com os campos a serem expandidos separados por vírgula. |