---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# HttpRequestData - inclus dans le périmètre

# HttpRequestData - inclus dans le périmètre {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 11 minutes de lecture

L'API HttpRequestData fournit des méthodes pour créer et manipuler une demande REST avant d'appliquer une signature et de l'envoyer à un point de terminaison.  
Générez des demandes de signature sortantes à l'aide de ces API dans l'ordre suivant :

1. HttpRequestData : générer la demande d'API.
2. AuthCredential : créer un objet d'informations d'identification ou mettre à jour un objet existant. Utilisez les informations d'identification pour signer la demande via la classe RequestAuthAPI .
3. RequestAuthAPI : signer la demande et renvoyer un objet HttpRequestAuthedData.
4. HttpRequestAuthedData : obtenir des informations sur la demande signée.
5. GlideHTTPRequest : envoyer la demande signée.
{#HttpRequestDataAPI__ol_gvv_22t_tjb}

Avant d'utiliser ces API, vous devez [configurer un algorithme d'authentification](https://www.servicenow.com/docs/access?context=configure-authentication-algorithm&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US) pour signer la demande et l'associer aux informations d'identification utilisées pour authentifier la demande.

Utilisez cette API dans les scripts inclus dans le champ d'application avec l'identificateur `d'espace` de noms sn_auth. Vous pouvez instancier cette classe à l'aide du constructeur, ou vous pouvez renvoyer un objet HttpRequestData à partir de la méthode getHttpRequestData() dans la classe RequestAuthAPI .

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

Instancie un objet HttpRequestData.
{#HttpRD-HttpRD__table_qmp_t4x_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 1. Paramètres]

{#HttpRD-HttpRD__table_qmp_t4x_sjb}  

    var httpRequestData = new sn_auth.HttpRequestData();

## HttpRequestData : addHeader(Chaîne, clé, Valeur de chaîne) {#ariaid-title3}

Ajoute un en-tête à l'objet HttpRequestData.
{#HttpRD-addHeader_S_S__table_u2f_lsx_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| key | Chaîne | Nom de l'en-tête HTTP. |
| valide | Chaîne | Valeur de l'en-tête HTTP. |
[Tableau 2. Paramètres]

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

| Type | Description |
|-|-|
| nul |   |
[Tableau 3. Renvoie]

{#HttpRD-addHeader_S_S__table_v2f_lsx_sjb}  
Cet exemple crée une charge utile de demande 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(clé de chaîne, valeur de chaîne) {#ariaid-title4}

Ajoute un paramètre de requête à l'objet HttpRequestData.
{#HttpRD-addQueryParam_S_S__table_u2f_lsx_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| key | Chaîne | Nom du paramètre de requête. |
| valide | Chaîne | Valeur du paramètre de requête. |
[Tableau 4. Paramètres]

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

| Type | Description |
|-|-|
| nul |   |
[Tableau 5. Renvoie]

{#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(clé de chaîne) {#ariaid-title5}

Supprime un en-tête de l'objet HttpRequestData.
{#HttpRD-deleteHeader_S__table_rrt_4sx_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| key | Chaîne | Nom de l'en-tête HTTP à supprimer. |
[Tableau 6. Paramètres]

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

| Type | Description |
|-|-|
| nul |   |
[Tableau 7. Renvoie]

{#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}

Renvoie le sys_id de l'alias de connexion et d'informations d'identification associé à l'étape Hub d'intégration REST.
Vous pouvez transmettre le sys_id à l'API ConnectionInfoProvider pour récupérer des informations sur la connexion.  
Remarque :  
Vous ne pouvez utiliser cette méthode que dans une Hub d'intégration étape REST. Pour plus d'informations, consultez [Étape 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}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 8. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Sys_id de l'enregistrement d'alias de la table Alias de connexion et d'informations d'identification \[sys_alias\] associée à la demande. |
[Tableau 9. Renvoie]

{#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 (nom de chaîne) {#ariaid-title7}

Renvoie la valeur d'un attribut de connexion associé à l'alias de connexion et d'informations d'identification associé à Hub d'intégration l'étape REST.
Remarque :  
Vous ne pouvez utiliser cette méthode que dans une Hub d'intégration étape REST. Pour plus d'informations, consultez [Étape REST](https://www.servicenow.com/docs/access?context=rest-request-action-designer&version=xanadu&pubname=xanadu-build-workflows&ft:locale=en-US).

Pour plus d'informations sur les attributs de connexion, consultez [Créer des attributs de connexion pour le concentrateur d'intégration](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}

| Nom | Type | Description |
|-|-|-|
| nom | Chaîne | Nom de l'attribut de connexion. |
[Tableau 10. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Valeur de l'attribut de connexion. |
[Tableau 11. Renvoie]

{#HttpRD-getConnectionExtendedAttribute_S__table_ljk_tsx_sjb}  
Cet exemple renvoie la valeur d'un ensemble d'attributs de connexion sur l'alias de connexion et d'informations d'identification associé à l'étape REST.

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

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

Renvoie le contenu de la demande dans l'objet HttpRequestData.
{#HttpRD-getContent__table_ivs_xsx_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 12. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Contenu de la demande. |
[Tableau 13. Renvoie]

{#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();

Sortie :

    Action=SendMessage&MessageBody=This is a test message

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

Renvoie la date à laquelle la demande a été signée.
{#HttpRD-getDate__table_jf4_zsx_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 14. Paramètres]

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

| Type | Description |
|-|-|
| Numéro | La différence entre le 1er janvier 1970 UTC et le moment où la demande a été signée. Unité : Millisecondes |
[Tableau 15. Renvoie]

{#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());

Sortie :

    Date: 1349333576093

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

Indique si la signature est appliquée à la demande dans l'en-tête ou en tant que paramètre de requête.
Par défaut, le système applique la signature à l'en-tête. Vous pouvez appliquer la signature en tant que paramètre de requête à l'aide de l'API setDirective().
{#HttpRD-getDirective__table_rjy_btx_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 16. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Indique si la signature est appliquée à l'en-tête ou en tant que paramètre de requête. Les valeurs comprennent : * EN-TÊTE : La signature est appliquée à l'en-tête de la demande. * QUERY : La signature est appliquée en tant que paramètre de requête. {#HttpRD-getDirective__ul_xdw_v5b_5jb} |
[Tableau 17. Renvoie]

{#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() );

Sortie :

    Signature applied to: HEADER

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

Renvoie le point de terminaison défini pour la demande.
{#HttpRD-getEndpoint__table_pwp_dtx_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 18. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Point de terminaison défini pour la demande. |
[Tableau 19. Renvoie]

{#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() );

Sortie :

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

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

Renvoie le délai en secondes avant l'expiration de la signature à partir du moment où la demande a été signée à l'aide de la méthode generateAuth() dans la classe RequestAuthAPI .
L'expiration est généralement définie par le service tiers auquel vous envoyez la demande, qui remplace toute valeur définie par la méthode setExpiry(). Par exemple, si l'expiration est fixée à 900 secondes par le service tiers et que vous utilisez la méthode setExpiry() pour définir l'expiration à 300 secondes, la méthode getExpiry() renvoie 900 secondes.
{#HttpRD-getExpiry__table_vr1_ftx_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 20. Paramètres]

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

| Type | Description |
|-|-|
| Numéro | Temps avant l'expiration de la signature. Unité : Secondes |
[Tableau 21. Renvoie]

{#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());

Sortie :

    Signature expires in: 300

## HttpRequestData : getHeader(clé de chaîne) {#ariaid-title13}

Renvoie la valeur associée à l'en-tête HTTP donné.
{#HttpRD-getHeader_S__table_hg4_gtx_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| key | Chaîne | Nom de l'en-tête HTTP. |
[Tableau 22. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Valeur de l'en-tête HTTP donné. |
[Tableau 23. Renvoie]

{#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') );

Sortie :

    Header value is: public-read

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

Renvoie un objet contenant les en-têtes inclus dans la demande.
{#HttpRD-getHeaderMap__table_shk_3tx_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 24. Paramètres]

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

| Type | Description |
|-|-|
| Objet | Paires clé-valeur qui définissent tous les en-têtes associés à la demande. Chaque paire clé-valeur comprend les éléments suivants : * Clé : Chaîne. Nom de l'en-tête. * Valeur : chaîne. Valeur de l'en-tête. {#HttpRD-getHeaderMap__ul_adn_4qh_5jb} |
[Tableau 25. Renvoie]

{#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);
    }

Sortie :

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

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

Renvoie l'hôte utilisé dans la demande.
{#HttpRD-getHost__table_i4j_ktx_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 26. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Hôte utilisé dans la demande. |
[Tableau 27. Renvoie]

{#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());

Sortie :

    Host is: myHost

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

Retourne la méthode HTTP utilisée dans la requête.
{#HttpRD-getHttpMethod__table_xyl_mtx_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 28. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Méthode HTTP utilisée dans la requête. |
[Tableau 29. Renvoie]

{#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());

Sortie :

    HTTP method is: PUT

## HttpRequestData : getQueryParam(clé de chaîne) {#ariaid-title17}

Renvoie la valeur du paramètre de requête spécifié.
{#HttpRD-getQueryParam_S__table_lhh_ptx_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| key | Chaîne | Nom du paramètre de requête dont obtenir la valeur. |
[Tableau 30. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Valeur du paramètre de requête. |
[Tableau 31. Renvoie]

{#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'));

Sortie :

    API version is: v2

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

Renvoie un objet contenant les paramètres de requête inclus dans la demande.
{#HttpRD-getQueryParamMap__table_pk3_rtx_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 32. Paramètres]

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

| Type | Description |
|-|-|
| Objet | Paires clé-valeur qui définissent les paramètres de requête associés à la demande. Chaque paire clé-valeur comprend les éléments suivants : * Clé : Chaîne. Nom du paramètre de requête. * Valeur : chaîne. Valeur du paramètre de requête. {#HttpRD-getQueryParamMap__ul_adn_4qh_5jb} |
[Tableau 33. Renvoie]

{#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']);

Sortie :

    api_version is: v2

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

Renvoie la région de la demande qui sera utilisée pour la signature.
{#HttpRD-getRegion__table_djf_g5x_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 34. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Nom de la région. |
[Tableau 35. Renvoie]

{#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());

Sortie :

    Region is: us-east-1

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

Renvoie le service défini dans la demande.
{#HttpRD-getService__table_iqr_h5x_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 36. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Service défini dans la demande. |
[Tableau 37. Renvoie]

{#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());

Sortie :

    Service is: s3

## HttpRequestData : setContent(contenu de la chaîne) {#ariaid-title21}

Définit le contenu à envoyer dans la demande.
Remarque :  
Cette méthode n'est pas prise en charge dans les includes de script ou les scripts de serveur MID.
{#HttpRD-setContent_S__table_u5g_j5x_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| contenu | Chaîne | Contenu à envoyer dans la demande. |
[Tableau 38. Paramètres]

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

| Type | Description |
|-|-|
| nul |   |
[Tableau 39. Renvoie]

{#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}

Définit la date de la demande utilisée pour la signature.
Utilisez cette méthode uniquement pour vérifier si la signature est correctement créée sur la base d'un horodatage. En production, la demande de signature utilise l'heure à laquelle vous avez généré la signature ; La définition manuelle de cette valeur peut entraîner l'échec de la demande de signature.
{#HttpRD-setDate_N__table_xzg_pcy_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| date | Numéro | La différence entre le 1er janvier 1970 UTC et la date utilisée pour signer la demande. Unité : Millisecondes |
[Tableau 40. Paramètres]

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

| Type | Description |
|-|-|
| nul |   |
[Tableau 41. Renvoie]

{#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(directive String) {#ariaid-title23}

Définit s'il faut appliquer la signature à la demande dans un en-tête ou en tant que paramètre de requête.
{#HttpRD-setDirective_S__table_nxn_rcy_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| directive | Chaîne | Indique s'il faut appliquer la signature à l'en-tête ou en tant que paramètre de requête. Les valeurs comprennent : * `query` : applique la signature comme paramètre de requête. * `en-tête` : applique une signature à l'en-tête de la demande. {#HttpRD-setDirective_S__ul_w2m_lzb_5jb} Par défaut : en-tête |
[Tableau 42. Paramètres]

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

| Type | Description |
|-|-|
| nul |   |
[Tableau 43. Renvoie]

{#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(String point de terminaison) {#ariaid-title24}

Définit le point de terminaison auquel envoyer la demande.
{#HttpRD-setEndpoint_S__table_rcx_scy_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| endpoint | Chaîne | Point de terminaison auquel envoyer la demande. Le point de terminaison peut inclure les paramètres de requête, le chemin d'accès et la version. |
[Tableau 44. Paramètres]

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

| Type | Description |
|-|-|
| nul |   |
[Tableau 45. Renvoie]

{#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(Expiration du numéro) {#ariaid-title25}

Définit le délai avant l'expiration de la signature à partir du moment où la demande est signée à l'aide de la méthode generateAuth() dans la classe RequestAuthAPI .
L'expiration est généralement définie par le service tiers auquel vous envoyez la demande, qui remplace toute valeur définie par la méthode setExpiry(). Par exemple, si l'expiration est fixée à 900 secondes par le service tiers et que vous utilisez la méthode setExpiry() pour définir l'expiration à 300 secondes, la méthode getExpiry() renvoie 900 secondes.
{#HttpRD-setExpiry_N__table_wbj_5cy_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| expiration | Numéro | Délai avant l'expiration de la signature. Unité : Secondes |
[Tableau 46. Paramètres]

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

| Type | Description |
|-|-|
| nul |   |
[Tableau 47. Renvoie]

{#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(String host) {#ariaid-title26}

Définit l'hôte utilisé dans la demande.
{#HttpRD-setHost_S__table_yzh_wcy_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| hôte | Chaîne | Nom de l'hôte de requête HTTP. |
[Tableau 48. Paramètres]

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

| Type | Description |
|-|-|
| nul |   |
[Tableau 49. Renvoie]

{#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(String httpMethod) {#ariaid-title27}

Définit la méthode HTTP à utiliser dans la requête.
{#HttpRD-setHttpMethod_S__table_kwx_ycy_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Méthode http | Chaîne | Méthode HTTP à utiliser dans la requête. |
[Tableau 50. Paramètres]

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

| Type | Description |
|-|-|
| nul |   |
[Tableau 51. Renvoie]

{#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(région de la chaîne) {#ariaid-title28}

Définit la région à utiliser pour la demande lors de la signature.
{#HttpRD-setRegion_S__table_wby_1dy_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| région | Chaîne | La région à utiliser pour signer la demande. Les valeurs disponibles sont déterminées par les exigences de l'API tierce. |
[Tableau 52. Paramètres]

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

| Type | Description |
|-|-|
| nul |   |
[Tableau 53. Renvoie]

{#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(service de chaîne) {#ariaid-title29}

Définit le service pour la demande.
{#HttpRD-setService_S__table_yvs_2dy_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| service | Chaîne | Le service pour la demande. |
[Tableau 54. Paramètres]

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

| Type | Description |
|-|-|
| nul |   |
[Tableau 55. Renvoie]

{#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');