---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# HttpRequestData - com escopo

# HttpRequestData - com escopo {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 11 min. de leitura

A API HttpRequestData fornece métodos para criar e manipular uma solicitação REST antes de aplicar uma assinatura e enviá-la para um endpoint.  
Gere solicitações de assinatura de saída usando essas APIs na seguinte ordem:

1. HttpRequestData: crie a solicitação de API.
2. AuthCredential: crie um objeto de credencial ou atualize um existente. Use a credencial para assinar a solicitação por meio da classe RequestAuthAPI.
3. RequestAuthAPI: assine a solicitação e retorne um objeto HttpRequestAuthedData.
4. HttpRequestAuthedData: obtenha informações sobre a solicitação assinada.
5. GlideHTTPRequest: envia a solicitação assinada.
{#HttpRequestDataAPI__ol_gvv_22t_tjb}

Antes de usar essas APIs, você deve [configurar um algoritmo de autenticação](https://www.servicenow.com/docs/access?context=configure-authentication-algorithm&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US) para assinar a solicitação e associá-la à credencial usada para autenticar a solicitação.

Use esta API em scripts com escopo com o identificador de namespace `sn_auth`. Você pode instanciar esta classe usando o construtor ou pode retornar um objeto HttpRequestData do método getHttpRequestData() na classe RequestAuthAPI.

## HttpRequestData - HttpRequestData() {#ariaid-title2}

Instancia um objeto HttpRequestData.
{#HttpRD-HttpRD__table_qmp_t4x_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 1. Parâmetros]

{#HttpRD-HttpRD__table_qmp_t4x_sjb}  

    var httpRequestData = new sn_auth.HttpRequestData();

## HttpRequestData - addHeader(Chave de cadeia de caracteres Valor de cadeia de caracteres) {#ariaid-title3}

Adiciona um cabeçalho ao objeto HttpRequestData.
{#HttpRD-addHeader_S_S__table_u2f_lsx_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| chave | Cadeia de caracteres | Nome do cabeçalho HTTP. |
| valor | Cadeia de caracteres | Valor do cabeçalho HTTP. |
[Tabela 2. Parâmetros]

{#HttpRD-addHeader_S_S__table_u2f_lsx_sjb} {#HttpRD-addHeader_S_S__table_v2f_lsx_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 3. Retorna]

{#HttpRD-addHeader_S_S__table_v2f_lsx_sjb}  
Este exemplo cria uma carga de solicitação REST.

    var endpoint= "https://s3.amazonaws.com";
    var httpRequestData = new sn_auth.HttpRequestData();
    httpRequestData.setEndpoint(endpoint);
    httpRequestData.setService('s3');
    httpRequestData.setRegion('us-east-1');
    httpRequestData.setHttpMethod("PUT");
    var content = "Action=SendMessage&MessageBody=This is a test message";
    httpRequestData.setContent(content);
    httpRequestData.addHeader('x-amz-acl', 'public-read' );

## HttpRequestData -- addQueryParam(Chave de cadeia de caracteres, valor de cadeia de caracteres) {#ariaid-title4}

Adiciona um parâmetro de consulta ao objeto HttpRequestData.
{#HttpRD-addQueryParam_S_S__table_u2f_lsx_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| chave | Cadeia de caracteres | Nome do parâmetro de consulta. |
| valor | Cadeia de caracteres | Valor do parâmetro de consulta. |
[Tabela 4. Parâmetros]

{#HttpRD-addQueryParam_S_S__table_u2f_lsx_sjb} {#HttpRD-addQueryParam_S_S__table_lbc_nsx_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 5. Retorna]

{#HttpRD-addQueryParam_S_S__table_lbc_nsx_sjb}  

    var endpoint= "https://third-party-endpoint";
    var httpRequestData = new sn_auth.HttpRequestData();
    httpRequestData.setEndpoint(endpoint);
    httpRequestData.setService('s3');
    httpRequestData.setRegion('us-east-1');
    httpRequestData.setHttpMethod('put');
    var content = "Action=SendMessage&MessageBody=This is a test message";
    httpRequestData.setContent(content);
    httpRequestData.addQueryParam('api_version', 'v2 );
    ​

## HttpRequestData - deleteHeader(cadeia de caracteres chave) {#ariaid-title5}

Remove um cabeçalho do objeto HttpRequestData.
{#HttpRD-deleteHeader_S__table_rrt_4sx_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| chave | Cadeia de caracteres | Nome do cabeçalho HTTP a ser removido. |
[Tabela 6. Parâmetros]

{#HttpRD-deleteHeader_S__table_rrt_4sx_sjb} {#HttpRD-deleteHeader_S__table_srt_4sx_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 7. Retorna]

{#HttpRD-deleteHeader_S__table_srt_4sx_sjb}  

    var endpoint= "https://s3.amazonaws.com";
    var httpRequestData = new sn_auth.HttpRequestData();
    httpRequestData.setEndpoint(endpoint);
    httpRequestData.setService('s3');
    httpRequestData.setRegion('us-east-1');
    httpRequestData.setHttpMethod('put');
    var content = "Action=SendMessage&MessageBody=This is a test message";
    httpRequestData.setContent(content);
    httpRequestData.deleteHeader('x-amz-acl');

## HttpRequestData -- getConnectionAliasID() {#ariaid-title6}

Retorna o sys_id do alias de conexão e credencial associado à etapa REST Integration Hub.
Você pode passar o sys_id para a API ConnectionInfoProvider para recuperar informações sobre a conexão.  
Nota:  
Você só pode usar este método em uma Integration Hub etapa REST. Para obter mais informações, consulte [Etapa REST](https://www.servicenow.com/docs/access?context=rest-request-action-designer&version=xanadu&pubname=xanadu-build-workflows&ft:locale=en-US).
{#HttpRD-getConnectionAliasID__table_oxs_qsx_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 8. Parâmetros]

{#HttpRD-getConnectionAliasID__table_oxs_qsx_sjb} {#HttpRD-getConnectionAliasID__table_pxs_qsx_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Sys_id do registro de alias da tabela Aliases de conexão e credencial \[sys_alias\] associada à solicitação. |
[Tabela 9. Retorna]

{#HttpRD-getConnectionAliasID__table_pxs_qsx_sjb}  

    var httpRequestData = new sn_auth.HttpRequestData();
    var id = httpRequestData.getConnectionAliasID();
     
    var credential = new sn_cc.ConnectionInfoProvider().
    var connectionInfo = credential.getConnectionInfo(id);

## HttpRequestData -- getConnectionExtendedAttribute(cadeia de caracteres name) {#ariaid-title7}

Retorna o valor de um atributo de conexão associado ao alias de conexão e credencial associado à Integration Hub etapa REST.
Nota:  
Você só pode usar este método em uma Integration Hub etapa REST. Para obter mais informações, consulte [Etapa REST](https://www.servicenow.com/docs/access?context=rest-request-action-designer&version=xanadu&pubname=xanadu-build-workflows&ft:locale=en-US).

Para obter mais informações sobre atributos de conexão, consulte [Criação de atributos de conexão para o Hub de integração](https://www.servicenow.com/docs/access?context=create-connection-attributes&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US).
{#HttpRD-getConnectionExtendedAttribute_S__table_kjk_tsx_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nome | Cadeia de caracteres | Nome do atributo de conexão. |
[Tabela 10. Parâmetros]

{#HttpRD-getConnectionExtendedAttribute_S__table_kjk_tsx_sjb} {#HttpRD-getConnectionExtendedAttribute_S__table_ljk_tsx_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Valor do atributo de conexão. |
[Tabela 11. Retorna]

{#HttpRD-getConnectionExtendedAttribute_S__table_ljk_tsx_sjb}  
Este exemplo retorna o valor de um atributo de conexão definido no alias de conexão e credencial associado à etapa REST.

    var httpRequestData = new sn_auth.HttpRequestData();​
    gs.info("API Version is: " + httpRequestData.getConnectionExtendedAttribute('api_version'));

## HttpRequestData -- getContent() {#ariaid-title8}

Retorna o conteúdo da solicitação no objeto HttpRequestData.
{#HttpRD-getContent__table_ivs_xsx_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 12. Parâmetros]

{#HttpRD-getContent__table_ivs_xsx_sjb} {#HttpRD-getContent__table_jvs_xsx_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Conteúdo da solicitação. |
[Tabela 13. Retorna]

{#HttpRD-getContent__table_jvs_xsx_sjb}  

    var endpoint= "https://s3.amazonaws.com";
    var httpRequestData = new sn_auth.HttpRequestData();
    httpRequestData.setEndpoint(endpoint);
    httpRequestData.setService('s3');
    httpRequestData.setRegion('us-east-1');
    httpRequestData.setHttpMethod('put');
    var content = "Action=SendMessage&MessageBody=This is a test message";
    httpRequestData.setContent(content);
    httpRequestData.addHeader('x-amz-acl' , 'public-read' );
    var ct = httpRequestData.getContent();

Saída:

    Action=SendMessage&MessageBody=This is a test message

## HttpRequestData -- getDate() {#ariaid-title9}

Retorna a data em que a solicitação foi assinada.
{#HttpRD-getDate__table_jf4_zsx_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 14. Parâmetros]

{#HttpRD-getDate__table_jf4_zsx_sjb} {#HttpRD-getDate__table_kf4_zsx_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| Número | A diferença entre 1º de janeiro de 1970 UTC e quando a solicitação foi assinada. Unidade: Milissegundos |
[Tabela 15. Retorna]

{#HttpRD-getDate__table_kf4_zsx_sjb}  

    var endpoint= "https://s3.amazonaws.com";​
    var httpRequestData = new sn_auth.HttpRequestData();​
    httpRequestData.setEndpoint(endpoint);​
    httpRequestData.addQueryParam("list-type", "2");​
    httpRequestData.setService('s3');​
    httpRequestData.setHttpMethod('get');​

    gs.info( "Date: " + httpRequestData.getDate());

Saída:

    Date: 1349333576093

## HttpRequestData -- getDirective() {#ariaid-title10}

Retorna se a assinatura é aplicada à solicitação no cabeçalho ou como um parâmetro de consulta.
Por padrão, o sistema aplica a assinatura ao cabeçalho. Você pode aplicar a assinatura como um parâmetro de consulta usando a API setDirective().
{#HttpRD-getDirective__table_rjy_btx_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 16. Parâmetros]

{#HttpRD-getDirective__table_rjy_btx_sjb} {#HttpRD-getDirective__table_sjy_btx_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Se a assinatura é aplicada ao cabeçalho ou como um parâmetro de consulta. Os valores incluem: * CABEÇALHO: a assinatura é aplicada ao cabeçalho da solicitação. * CONSULTA: a assinatura é aplicada como um parâmetro de consulta. {#HttpRD-getDirective__ul_xdw_v5b_5jb} |
[Tabela 17. Retorna]

{#HttpRD-getDirective__table_sjy_btx_sjb}  

    var endpoint= "https://s3.amazonaws.com";​
    var httpRequestData = new sn_auth.HttpRequestData();​
    httpRequestData.setEndpoint(endpoint);​
    httpRequestData.addQueryParam("list-type", "2");​
    httpRequestData.setService('s3');​
    httpRequestData.setHttpMethod('get');​

    gs.info( "Signature applied to: " + httpRequestData.getDirective() );

Saída:

    Signature applied to: HEADER

## HttpRequestData -- getEndpoint() {#ariaid-title11}

Retorna o endpoint definido para a solicitação.
{#HttpRD-getEndpoint__table_pwp_dtx_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 18. Parâmetros]

{#HttpRD-getEndpoint__table_pwp_dtx_sjb} {#HttpRD-getEndpoint__table_qwp_dtx_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Endpoint definido para a solicitação. |
[Tabela 19. Retorna]

{#HttpRD-getEndpoint__table_qwp_dtx_sjb}  

    var endpoint= "https://s3.amazonaws.com";​
    var httpRequestData = new sn_auth.HttpRequestData();​
    httpRequestData.setEndpoint(endpoint);​
    httpRequestData.addQueryParam("list-type", "2");​
    httpRequestData.setService('s3');​
    httpRequestData.setHttpMethod('get');​
    httpRequestData.setDirective("query");​
    ​
    gs.info( "Endpoint is: " + httpRequestData.getEndpoint() );

Saída:

    Endpoint is: https://s3.amazonaws.com

## HttpRequestData -- getExpiry() {#ariaid-title12}

Retorna o tempo em segundos antes que a assinatura expire a partir de quando a solicitação foi assinada usando o método generateAuth() na classe RequestAuthAPI.
A expiração é normalmente definida pelo serviço de terceiros para o qual você está enviando a solicitação, que substitui qualquer valor definido pelo método setExpiry(). Por exemplo, se a expiração for definida como 900 segundos pelo serviço de terceiros e você usar o método setExpiry() para definir a expiração para 300 segundos, o método getExpiry() retornará 900 segundos.
{#HttpRD-getExpiry__table_vr1_ftx_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 20. Parâmetros]

{#HttpRD-getExpiry__table_vr1_ftx_sjb} {#HttpRD-getExpiry__table_wr1_ftx_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| Número | Tempo antes de a assinatura expirar. Unidade: segundos |
[Tabela 21. Retorna]

{#HttpRD-getExpiry__table_wr1_ftx_sjb}  

    var endpoint= "https://s3.amazonaws.com";​
    var httpRequestData = new sn_auth.HttpRequestData();​
    httpRequestData.setEndpoint(endpoint);​
    httpRequestData.addQueryParam("list-type", "2");​
    httpRequestData.setService('s3');​
    httpRequestData.setHttpMethod('get');​
    httpRequestData.setDirective("query");​
    httpRequestData.setExpiry(300);

    gs.info("Signature expires in: " + httpRequestData.getExpiry());

Saída:

    Signature expires in: 300

## HttpRequestData -- getHeader(Chave de cadeia de caracteres) {#ariaid-title13}

Retorna o valor associado ao cabeçalho HTTP fornecido.
{#HttpRD-getHeader_S__table_hg4_gtx_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| chave | Cadeia de caracteres | Nome do cabeçalho HTTP. |
[Tabela 22. Parâmetros]

{#HttpRD-getHeader_S__table_hg4_gtx_sjb} {#HttpRD-getHeader_S__table_ig4_gtx_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Valor do cabeçalho HTTP fornecido. |
[Tabela 23. Retorna]

{#HttpRD-getHeader_S__table_ig4_gtx_sjb}  

    var endpoint= "https://third-party-endpoint";
    var httpRequestData = new sn_auth.HttpRequestData();
    httpRequestData.setEndpoint(endpoint);
    httpRequestData.setService('s3');
    httpRequestData.setRegion('us-east-1');
    httpRequestData.setHttpMethod('put');
    var content = "Action=SendMessage&MessageBody=This is a test message";
    httpRequestData.setContent(content);
    httpRequestData.addHeader('x-amz-acl', 'public-read' );
    ​

    gs.info( "Header value is: " + httpRequestData.getHeader('x-amz-acl') );

Saída:

    Header value is: public-read

## HttpRequestData -- getHeaderMap() {#ariaid-title14}

Retorna um objeto que contém os cabeçalhos incluídos na solicitação.
{#HttpRD-getHeaderMap__table_shk_3tx_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 24. Parâmetros]

{#HttpRD-getHeaderMap__table_shk_3tx_sjb} {#HttpRD-getHeaderMap__table_thk_3tx_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Pares de chave-valor que definem todos os cabeçalhos associados à solicitação. Cada par de chave-valor inclui estas partes: * Chave: cadeia de caracteres. Nome do cabeçalho. * Valor: cadeia de caracteres. Valor do cabeçalho. {#HttpRD-getHeaderMap__ul_adn_4qh_5jb} |
[Tabela 25. Retorna]

{#HttpRD-getHeaderMap__table_thk_3tx_sjb}  

    var endpoint= "https://third-party-endpoint";
    var httpRequestData = new sn_auth.HttpRequestData();
    httpRequestData.setEndpoint(endpoint);
    httpRequestData.setService('s3');
    httpRequestData.setRegion('us-east-1');
    httpRequestData.setHttpMethod('put');
    var content = "Action=SendMessage&MessageBody=This is a test message";
    httpRequestData.setContent(content);
    httpRequestData.addHeader('x-amz-acl', 'public-read' );
    httpRequestData.addHeader('content-type', 'application/json' );

    var map = httpRequestData.getHeaderMap();

    for(var x in map) {
        var y = map[x]

        gs.info(x, y);
    }

Saída:

    *** Script: x-amz-acl
    *** Script: content-type

## HttpRequestData -- getHost() {#ariaid-title15}

Retorna o host usado na solicitação.
{#HttpRD-getHost__table_i4j_ktx_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 26. Parâmetros]

{#HttpRD-getHost__table_i4j_ktx_sjb} {#HttpRD-getHost__table_j4j_ktx_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Host usado na solicitação. |
[Tabela 27. Retorna]

{#HttpRD-getHost__table_j4j_ktx_sjb}  

    var endpoint= "https://third-party-endpoint";
    var httpRequestData = new sn_auth.HttpRequestData();
    httpRequestData.setEndpoint(endpoint);
    httpRequestData.setHost('myHost')
    httpRequestData.setService('s3');
    httpRequestData.setRegion('us-east-1');
    httpRequestData.setHttpMethod('put');
    var content = "Action=SendMessage&MessageBody=This is a test message";
    httpRequestData.setContent(content);
    httpRequestData.addHeader('x-amz-acl' , 'public-read' );

    gs.info("Host is: " + httpRequestData.getHost());

Saída:

    Host is: myHost

## HttpRequestData -- getHttpMethod() {#ariaid-title16}

Retorna o método HTTP usado na solicitação.
{#HttpRD-getHttpMethod__table_xyl_mtx_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 28. Parâmetros]

{#HttpRD-getHttpMethod__table_xyl_mtx_sjb} {#HttpRD-getHttpMethod__table_yyl_mtx_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Método HTTP usado na solicitação. |
[Tabela 29. Retorna]

{#HttpRD-getHttpMethod__table_yyl_mtx_sjb}  

    var endpoint= "https://third-party-endpoint";
    var httpRequestData = new sn_auth.HttpRequestData();
    httpRequestData.setEndpoint(endpoint);
    httpRequestData.setService('s3');
    httpRequestData.setRegion('us-east-1');
    httpRequestData.setHttpMethod('put');
    var content = "Action=SendMessage&MessageBody=This is a test message";
    httpRequestData.setContent(content);
    httpRequestData.addHeader('x-amz-acl', 'public-read' );
    ​

    gs.info("HTTP method is: " + httpRequestData.getHttpMethod());

Saída:

    HTTP method is: PUT

## HttpRequestData -- getQueryParam(cadeia de caracteres chave) {#ariaid-title17}

Retorna o valor do parâmetro de consulta especificado.
{#HttpRD-getQueryParam_S__table_lhh_ptx_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| chave | Cadeia de caracteres | Nome do parâmetro de consulta do qual o valor será obtido. |
[Tabela 30. Parâmetros]

{#HttpRD-getQueryParam_S__table_lhh_ptx_sjb} {#HttpRD-getQueryParam_S__table_mhh_ptx_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Valor do parâmetro de consulta. |
[Tabela 31. Retorna]

{#HttpRD-getQueryParam_S__table_mhh_ptx_sjb}  

    var endpoint= "https://third-party-endpoint";
    var httpRequestData = new sn_auth.HttpRequestData();
    httpRequestData.setEndpoint(endpoint);
    httpRequestData.setService('s3');
    httpRequestData.setRegion('us-east-1');
    httpRequestData.setHttpMethod('put');
    var content = "Action=SendMessage&MessageBody=This is a test message";
    httpRequestData.setContent(content);
    httpRequestData.addQueryParam('api_version', 'v2' );

    gs.info("API version is: " + httpRequestData.getQueryParam('api_version'));

Saída:

    API version is: v2

## HttpRequestData -- getQueryParamMap() {#ariaid-title18}

Retorna um objeto que contém os parâmetros de consulta incluídos na solicitação.
{#HttpRD-getQueryParamMap__table_pk3_rtx_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 32. Parâmetros]

{#HttpRD-getQueryParamMap__table_pk3_rtx_sjb} {#HttpRD-getQueryParamMap__table_qk3_rtx_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Pares de chave-valor que definem os parâmetros de consulta associados à solicitação. Cada par de chave-valor inclui estas partes: * Chave: cadeia de caracteres. Nome do parâmetro de consulta. * Valor: cadeia de caracteres. Valor do parâmetro de consulta. {#HttpRD-getQueryParamMap__ul_adn_4qh_5jb} |
[Tabela 33. Retorna]

{#HttpRD-getQueryParamMap__table_qk3_rtx_sjb}  

    var endpoint= "https://third-party-endpoint";
    var httpRequestData = new sn_auth.HttpRequestData();
    httpRequestData.setEndpoint(endpoint);
    httpRequestData.setService('s3');
    httpRequestData.setRegion('us-east-1');
    httpRequestData.setHttpMethod('put');
    var content = "Action=SendMessage&MessageBody=This is a test message";
    httpRequestData.setContent(content);
    httpRequestData.addQueryParam('api_version', 'v2' );
    httpRequestData.addQueryParam('limit', '1000' );
    httpRequestData.addQueryParam('offset', '1' );


    var map = httpRequestData.getQueryParamMap();
    gs.info("api_version is: " + map['api_version']);

Saída:

    api_version is: v2

## HttpRequestData -- getRegion() {#ariaid-title19}

Retorna a região da solicitação que será usada na assinatura.
{#HttpRD-getRegion__table_djf_g5x_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 34. Parâmetros]

{#HttpRD-getRegion__table_djf_g5x_sjb} {#HttpRD-getRegion__table_ejf_g5x_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Nome da região. |
[Tabela 35. Retorna]

{#HttpRD-getRegion__table_ejf_g5x_sjb}  

    var endpoint= "https://third-party-endpoint";
    var httpRequestData = new sn_auth.HttpRequestData();
    httpRequestData.setEndpoint(endpoint);
    httpRequestData.setService('s3');
    httpRequestData.setRegion('us-east-1');
    httpRequestData.setHttpMethod('put');
    var content = "Action=SendMessage&MessageBody=This is a test message";
    httpRequestData.setContent(content);

    gs.info("Region is: " + httpRequestData.getRegion());

Saída:

    Region is: us-east-1

## HttpRequestData -- getService() {#ariaid-title20}

Retorna o serviço definido na solicitação.
{#HttpRD-getService__table_iqr_h5x_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 36. Parâmetros]

{#HttpRD-getService__table_iqr_h5x_sjb} {#HttpRD-getService__table_jqr_h5x_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Serviço definido na solicitação. |
[Tabela 37. Retorna]

{#HttpRD-getService__table_jqr_h5x_sjb}  

    var endpoint= "https://s3.amazonaws.com";
    var httpRequestData = new sn_auth.HttpRequestData();
    httpRequestData.setEndpoint(endpoint);
    httpRequestData.setService('s3');

    gs.info("Service is: " + httpRequestData.getService());

Saída:

    Service is: s3

## HttpRequestData - setContent(conteúdo de cadeia de caracteres) {#ariaid-title21}

Define o conteúdo a ser enviado na solicitação.
Nota:  
Este método não é compatível com inclusões de script ou scripts do MID Server.
{#HttpRD-setContent_S__table_u5g_j5x_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| conteúdo | Cadeia de caracteres | Conteúdo a ser enviado na solicitação. |
[Tabela 38. Parâmetros]

{#HttpRD-setContent_S__table_u5g_j5x_sjb} {#HttpRD-setContent_S__table_v5g_j5x_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 39. Retorna]

{#HttpRD-setContent_S__table_v5g_j5x_sjb}  

    var endpoint= "https://s3.amazonaws.com";
    var httpRequestData = new sn_auth.HttpRequestData();
    httpRequestData.setEndpoint(endpoint);
    httpRequestData.setService('s3');
    httpRequestData.setRegion('us-east-1');
    httpRequestData.setHttpMethod('put');
    var content = "This is a test message";
    httpRequestData.setContent(content);

## HttpRequestData - setDate(Number date) {#ariaid-title22}

Define a data da solicitação usada para assinatura.
Use este método somente ao testar se a assinatura foi criada corretamente com base em um carimbo de data/hora. Na produção, a solicitação de assinatura usa a hora em que você gerou a assinatura; definir manualmente este valor pode fazer com que a solicitação de assinatura falhe.
{#HttpRD-setDate_N__table_xzg_pcy_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| data | Número | A diferença entre 1º de janeiro de 1970 UTC e a data usada para assinar a solicitação. Unidade: Milissegundos |
[Tabela 40. Parâmetros]

{#HttpRD-setDate_N__table_xzg_pcy_sjb} {#HttpRD-setDate_N__table_yzg_pcy_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 41. Retorna]

{#HttpRD-setDate_N__table_yzg_pcy_sjb}  

    var endpoint= "https://s3.amazonaws.com";​
    var httpRequestData = new sn_auth.HttpRequestData();​
    httpRequestData.setEndpoint(endpoint);​
    httpRequestData.addQueryParam("list-type", "2");​
    httpRequestData.setService('s3');​
    httpRequestData.setHttpMethod('get');
    httpRequestData.setDate(1349333576093);

## HttpRequestData - setDirective(diretiva de cadeia de caracteres) {#ariaid-title23}

Define se a assinatura deve ser aplicada à solicitação em um cabeçalho ou como um parâmetro de consulta.
{#HttpRD-setDirective_S__table_nxn_rcy_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| diretiva | Cadeia de caracteres | Se a assinatura deve ser aplicada ao cabeçalho ou como um parâmetro de consulta. Os valores incluem: * `consulta`: aplica a assinatura como um parâmetro de consulta. * `cabeçalho`: aplica assinatura ao cabeçalho da solicitação. {#HttpRD-setDirective_S__ul_w2m_lzb_5jb} Padrão: cabeçalho |
[Tabela 42. Parâmetros]

{#HttpRD-setDirective_S__table_nxn_rcy_sjb} {#HttpRD-setDirective_S__table_oxn_rcy_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 43. Retorna]

{#HttpRD-setDirective_S__table_oxn_rcy_sjb}  

    var endpoint= "https://s3.amazonaws.com";​
    var httpRequestData = new sn_auth.HttpRequestData();​
    httpRequestData.setEndpoint(endpoint);​
    httpRequestData.addQueryParam("list-type", "2");​
    httpRequestData.setService('s3');​
    httpRequestData.setHttpMethod('get');​
    httpRequestData.setDirective("query");​

## HttpRequestData - setEndpoint(endpoint de cadeia de caracteres) {#ariaid-title24}

Define o endpoint para o qual a solicitação será enviada.
{#HttpRD-setEndpoint_S__table_rcx_scy_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| endpoint | Cadeia de caracteres | Endpoint para o qual a solicitação será enviada. O endpoint pode incluir parâmetros de consulta, caminho e versão. |
[Tabela 44. Parâmetros]

{#HttpRD-setEndpoint_S__table_rcx_scy_sjb} {#HttpRD-setEndpoint_S__table_scx_scy_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 45. Retorna]

{#HttpRD-setEndpoint_S__table_scx_scy_sjb}  

    var endpoint="https://third-party-endpoint/path-parameters/version";

    var httpRequestData = new sn_auth.HttpRequestData();
    httpRequestData.setEndpoint(endpoint);

## HttpRequestData - setExpiry (expiração do número) {#ariaid-title25}

Define a quantidade de tempo antes que a assinatura expire, começando quando a solicitação é assinada usando o método generateAuth() na classe RequestAuthAPI.
A expiração é normalmente definida pelo serviço de terceiros para o qual você está enviando a solicitação, que substitui qualquer valor definido pelo método setExpiry(). Por exemplo, se a expiração for definida como 900 segundos pelo serviço de terceiros e você usar o método setExpiry() para definir a expiração para 300 segundos, o método getExpiry() retornará 900 segundos.
{#HttpRD-setExpiry_N__table_wbj_5cy_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Expiração | Número | Quantidade de tempo antes que a assinatura expire. Unidade: segundos |
[Tabela 46. Parâmetros]

{#HttpRD-setExpiry_N__table_wbj_5cy_sjb} {#HttpRD-setExpiry_N__table_xbj_5cy_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 47. Retorna]

{#HttpRD-setExpiry_N__table_xbj_5cy_sjb}  

    var endpoint= "https://s3.amazonaws.com";​
    var httpRequestData = new sn_auth.HttpRequestData();​
    httpRequestData.setEndpoint(endpoint);​
    httpRequestData.addQueryParam("list-type", "2");​
    httpRequestData.setService('s3');​
    httpRequestData.setHttpMethod('get');​
    httpRequestData.setExpiry(300);​

## HttpRequestData -- setHost(cadeia de caracteres host) {#ariaid-title26}

Define o host usado na solicitação.
{#HttpRD-setHost_S__table_yzh_wcy_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Host | Cadeia de caracteres | Nome do host da solicitação HTTP. |
[Tabela 48. Parâmetros]

{#HttpRD-setHost_S__table_yzh_wcy_sjb} {#HttpRD-setHost_S__table_zzh_wcy_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 49. Retorna]

{#HttpRD-setHost_S__table_zzh_wcy_sjb}  

    var endpoint= "https:third-party-endpoint";
    var httpRequestData = new sn_auth.HttpRequestData();
    httpRequestData.setEndpoint(endpoint);
    httpRequestData.setHost('myHost')
    httpRequestData.setService('s3');
    httpRequestData.setRegion('us-east-1');
    httpRequestData.setHttpMethod('put');
    var content = "Action=SendMessage&MessageBody=This is a test message";
    httpRequestData.setContent(content);
    httpRequestData.addHeader('x-amz-acl', 'public-read' );

## HttpRequestData -- setHttpMethod(cadeia de caracteres httpMethod) {#ariaid-title27}

Define o método HTTP a ser usado na solicitação.
{#HttpRD-setHttpMethod_S__table_kwx_ycy_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| httpMétodo | Cadeia de caracteres | Método HTTP a ser usado na solicitação. |
[Tabela 50. Parâmetros]

{#HttpRD-setHttpMethod_S__table_kwx_ycy_sjb} {#HttpRD-setHttpMethod_S__table_lwx_ycy_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 51. Retorna]

{#HttpRD-setHttpMethod_S__table_lwx_ycy_sjb}  

    var endpoint= "https://third-party-endpoint";
    var httpRequestData = new sn_auth.HttpRequestData();
    httpRequestData.setEndpoint(endpoint);
    httpRequestData.setService('s3');
    httpRequestData.setRegion('us-east-1');
    httpRequestData.setHttpMethod('put');

## HttpRequestData - setRegion(cadeia de caracteres região) {#ariaid-title28}

Define a região a ser usada para a solicitação na assinatura.
{#HttpRD-setRegion_S__table_wby_1dy_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| região | Cadeia de caracteres | A região a ser usada para assinar a solicitação. Os valores disponíveis são determinados pelos requisitos da API de terceiros. |
[Tabela 52. Parâmetros]

{#HttpRD-setRegion_S__table_wby_1dy_sjb} {#HttpRD-setRegion_S__table_xby_1dy_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 53. Retorna]

{#HttpRD-setRegion_S__table_xby_1dy_sjb}  

    var endpoint= "https:third-party-endpoint";
    var httpRequestData = new sn_auth.HttpRequestData();
    httpRequestData.setEndpoint(endpoint);
    httpRequestData.setService('s3');
    httpRequestData.setRegion('us-east-1');
    httpRequestData.setHttpMethod('put');
    var content = "Action=SendMessage&MessageBody=This is a test message";
    httpRequestData.setContent(content);

## HttpRequestData - setService(cadeia de caracteres serviço) {#ariaid-title29}

Define o serviço para a solicitação.
{#HttpRD-setService_S__table_yvs_2dy_sjb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| serviço | Cadeia de caracteres | O serviço para a solicitação. |
[Tabela 54. Parâmetros]

{#HttpRD-setService_S__table_yvs_2dy_sjb} {#HttpRD-setService_S__table_zvs_2dy_sjb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 55. Retorna]

{#HttpRD-setService_S__table_zvs_2dy_sjb}  

    var endpoint= "https://s3.amazonaws.com";
    var httpRequestData = new sn_auth.HttpRequestData();
    httpRequestData.setEndpoint(endpoint);
    httpRequestData.setService('s3');