---
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
---
# API du consommateur
# API du consommateur {#ariaid-title1}
* Rversion finale: Xanadu
*
* Mis à jour 1 août 2024
*
*  17 minutes de lecture
L'API consommateur fournit des points de terminaison pour récupérer et mettre à jour Gestion du service client (CSM) les enregistrements de consommateurs.
De plus, vous pouvez générer de nouveaux enregistrements de profil de médias sociaux lors de la création d'un consommateur.
L'API consommateur nécessite le module d'extension Service clientèle (com.sn_customerservice) et est fournie dans l'espace de noms `Now` .
Les utilisateurs ont besoin du rôle csm_ws_integration pour bénéficier d'un accès complet à l'API.
## Consommateur : GET /now/consumer {#ariaid-title2}
Récupère un ensemble spécifié d'enregistrements de Gestion du service client (CSM) consommateur.
### Format d'URL
URL versionnée : /api/now/{api_version}/consumer
URL par défaut : /api/now/consumer
### Paramètres de demande pris en charge
{#consumer-GET__entry__2}{#consumer-GET__version-RESTAPI}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
[Tableau 1. Paramètres de chemin d'accès]
{#consumer-GET__entry__6}{#consumer-GET__sysparm-limit-entry}{#consumer-GET__sysparm-offset-entry}{#consumer-GET__sysparm-query-entry}
| Nom | Description |
|-|-|
| sysparm_limit | Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d'enregistrements, utilisez le paramètre sysparm_offset pour paginer la récupération d'enregistrements. Dans la réponse, le paramètre hasMore booléen est renvoyé. Il indique s'il existe d'autres enregistrements à renvoyer qui répondent aux critères de filtre. Type de données : nombre Par défaut : 10 |
| sysparm_offset | Index de début des enregistrements pour lequel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit le nombre d'enregistrements, par petits blocs gérables. Par exemple, lors du premier appel de ce point de terminaison, sysparm_offset est défini sur \<\< 0 \>\>. Pour parcourir simplement tous les enregistrements disponibles, utilisez le paramètre `sysparm_offset=sysparm_offset+sysparm_limit`, jusqu'à atteindre la fin de tous les enregistrements. Ne transmettez pas de nombre négatif dans le paramètre sysparm_offset. Type de données : nombre Par défaut : 0 |
| sysparm_query | Requête codée utilisée pour filtrer l'ensemble de résultats. Par exemple : `sysparm_query=caller_id=javascript :gs.getUserID()^active=true` La requête codée prend en charge le tri par. Pour trier les réponses en fonction de certains champs, utilisez les clauses ORDERBY et ORDERBYDESC dans sysparm_query. Par exemple, `sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory` filtre tous les enregistrements actifs et trie les résultats par ordre croissant par numéro d'abord, puis par ordre décroissant par catégorie. Si une partie de la requête n'est pas valide (par exemple, un nom de champ non valide a été spécifié), l'instance ignore la partie non valide. Puis, elle renvoie les lignes en utilisant uniquement la partie valide de la requête. Vous pouvez contrôler ce comportement à l'aide de la propriété glide.invalid_query.returns_no_rows. Définissez cette propriété sur true pour ne renvoyer aucune ligne dans une requête non valide. Remarque : La propriété glide.invalid_query.returns_no_rows contrôle le comportement de toutes les requêtes dans l'instance, par exemple dans les listes, les scripts (GlideRecord.query()) et les API de service Web. Type de données : chaîne |
[Tableau 2. Paramètres de requête]
{#consumer-GET__entry__14}
| Élément | Description |
|-|-|
| Aucun | |
[Tableau 3. Paramètres de corps de demande (XML ou JSON)]
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#consumer-GET__entry__18}{#consumer-GET__accept-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
[Tableau 4. En-têtes de demandes]
{#consumer-GET__entry__22}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 5. En-têtes de réponses]
### Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#consumer-GET__entry__26}{#consumer-GET__entry-200-status-code}{#consumer-GET__entry-401-status-code}{#consumer-GET__entry-404-status-code}{#consumer-GET__entry-500-status-code}
| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 404 | Introuvable. L'élément demandé est introuvable. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
[Tableau 6. Codes d'état]
### Paramètres du corps de réponse (JSON ou XML)
Le point de terminaison peut renvoyer les éléments JSON ou XML suivants dans le corps de la réponse. En plus de la liste des éléments définis ci-dessous (qui définissent les éléments d'un système de base), le point de terminaison renvoie également tous les champs personnalisés ajoutés à la table Consommateur \[csm_consumer\]. Pour plus d'informations sur ces éléments, reportez-vous à la définition de table spécifique \[Définition du systèmeTables\].
{#consumer-GET__csmconsumer_response_parms__entry__2}{#consumer-GET__consumertable-active-entry}{#consumer-GET__consumertable-business_phone-entry}{#consumer-GET__consumertable-city-entry}{#consumer-GET__consumertable-country-entry}{#consumer-GET__consumertable-date_format-entry}{#consumer-GET__consumertable-email-entry}{#consumer-GET__consumertable-fax-entry}{#consumer-GET__consumertable-first_name-entry}{#consumer-GET__consumertable-gender-entry}{#consumer-GET__consumertable-home_phone-entry}{#consumer-GET__consumertable-household-entry}{#consumer-GET__consumertable-last_name-entry}{#consumer-GET__consumertable-middle_name-entry}{#consumer-GET__consumertable-mobile_phone-entry}{#consumer-GET__consumertable-name-entry}{#consumer-GET__consumertable-notes-entry}{#consumer-GET__consumertable-notification-entry}{#consumer-GET__consumertable-number-entry}{#consumer-GET__consumertable-photo-entry}{#consumer-GET__consumertable-preferred_language-entry}{#consumer-GET__consumertable-prefix-entry}{#consumer-GET__consumertable-primary-entry}{#consumer-GET__consumertable-state-entry}{#consumer-GET__consumertable-street-entry}{#consumer-GET__consumertable-suffix-entry}{#consumer-GET__consumertable-sys_created_by-entry}{#consumer-GET__consumertable-sys_created_on-entry}{#consumer-GET__consumertable-sys_domain-entry}{#consumer-GET__consumertable-sys_id-entry}{#consumer-GET__consumertable-sys_mod_count-entry}{#consumer-GET__consumertable-sys_updated_by-entry}{#consumer-GET__consumertable-sys_updated_on-entry}{#consumer-GET__consumertable-time_format-entry}{#consumer-GET__consumertable-time_zone-entry}{#consumer-GET__consumertable-title-entry}{#consumer-GET__consumertable-user-entry}{#consumer-GET__consumertable-zip-entry}
| Élément | Description |
|-|-|
| Actif | Marqueur indiquant si le consommateur est actif. Valeurs possibles : * vrai : consommateur actif * false : consommateur désactivé {#consumer-GET__ul_asy_4b3_2hb} Type de données : booléennes Valeur par défaut : true |
| business_phone | Numéro de téléphone professionnel du consommateur. Type de données : chaîne Longueur maximale : 40 |
| city | Ville dans laquelle réside le consommateur. Type de données : chaîne Longueur maximale : 100 |
| pays | Pays dans lequel réside le consommateur. Type de données : chaîne Longueur maximale : 40 |
| date_format | Format dans lequel afficher les dates. Valeurs valides : * jj-mm-aaaa * jj/mm/aaaa * jj.mm.aaaa * mm-jj-aaaa * aaaa-mm-jj {#consumer-GET__ul_jsj_qwc_2hb} Type de données : chaîne Longueur maximale : 40 Par défaut : vide (format de date système) |
| E-mail | Adresse e-mail du consommateur. Type de données : chaîne Longueur maximale : 100 |
| fax | Numéro de fax du consommateur. Type de données : chaîne Longueur maximale : 40 |
| first_name | Prénom du consommateur. Type de données : chaîne Longueur maximale : 50 |
| sexe | Sexe du consommateur. Type de données : chaîne Longueur maximale : 40 |
| home_phone | Numéro de téléphone du domicile du consommateur. Type de données : chaîne Longueur maximale : 40 |
| household | Sys_id de l'enregistrement qui décrit les caractéristiques du ménage. Situé dans la table Ménage \[csm_household\]. Type de données : chaîne |
| last_name | Nom du consommateur. Type de données : chaîne Longueur maximale : 50 |
| middle_name | Deuxième prénom du consommateur. Type de données : chaîne Longueur maximale : 50 |
| mobile_phone | Numéro de téléphone mobile du consommateur. Type de données : chaîne Longueur maximale : 40 |
| nom | Nom complet du consommateur ; first_name+middle_name+last_name. Type de données : chaîne Longueur maximale : 152 |
| notes | Remarques sur le consommateur. Type de données : chaîne Longueur maximale : 4 000 |
| Notification | Indique si le consommateur doit recevoir des notifications. Valeurs valides : * 1 : désactivé * 2 : Activé {#consumer-GET__ul_o5d_pyh_2hb} Type de données : entier Longueur maximale : 40 Valeur par défaut : 2 |
| Numéro | Numéro unique associé au consommateur. Type de données : chaîne Longueur maximale : 40 |
| photo | Photo du consommateur. Type de données : Image |
| preferred_language | Langue primaire du consommateur. Type de données : chaîne Longueur maximale : 3 |
| préfixe | Préfixe du nom du consommateur, tel que Dr., M., Mme ou Mme. Type de données : chaîne Longueur maximale : 40 |
| primaire | Marqueur indiquant s'il s'agit du consommateur primaire. Valeurs possibles : * true : consommateur primaire * false : consommateur non primaire {#consumer-GET__ul_yns_yb3_2hb} Type de données : booléennes Valeur par défaut : false |
| État | État dans lequel réside le consommateur. Type de données : chaîne Longueur maximale : 100 |
| rue | Adresse postale du consommateur. Type de données : chaîne Longueur maximale : 255 |
| suffixe | Suffixe du nom du consommateur tel que Jr., Sr. ou II. Type de données : chaîne |
| sys_created_by | Utilisateur qui a créé l'enregistrement de consommateur. Type de données : chaîne Longueur maximale : 40 |
| sys_created_on | Date et heure de création de l'enregistrement de consommateur. Type de données : chaîne |
| sys_domain | ServiceNow Domaine dans lequel résident les informations sur le consommateur. Type de données : chaîne |
| sys_id | Identificateur unique pour le consommateur. Type de données : chaîne |
| sys_mod_count | Nombre de fois où les informations consommateur associées ont été modifiées. Type de données : entier |
| sys_tags | Balises système. Type de données : chaîne |
| sys_updated_by | Utilisateur qui a mis à jour les informations sur le consommateur pour la dernière fois. Type de données : chaîne Longueur maximale : 40 |
| sys_updated_on | Date et heure de la dernière mise à jour des informations sur le consommateur. Type de données : chaîne |
| time_format | Format dans lequel afficher l'heure. Valeurs valides : * hh.mm.ss : hh.mm.ss (12 heures) * hh :mm :ss a : hh :mm :ss (12 heures) * HH.mm.ss : hh.mm.ss (24 heures) * HH :mm :ss : hh :mm :ss (24 heures) {#consumer-GET__ul_kvg_gxc_2hb} Type de données : chaîne Longueur maximale : 40 Par défaut : vide (format d'heure système) |
| time_zone | Fuseau horaire du consommateur, tel que Canada/Centre ou États-Unis/Est. Type de données : chaîne Longueur maximale : 40 |
| Titre | Titre de l'entreprise du consommateur, par exemple Gestionnaire, Développeur de logiciels ou Prestataire. Type de données : chaîne Longueur maximale : 60 |
| utilisateur | Sys_id de l'utilisateur consommateur. Situé dans la table Utilisateur consommateur \[csm_consumer_user\]. Type de données : chaîne |
| code postal | Code postal du consommateur. Type de données : chaîne Longueur maximale : 40 |
[ ]
### Demande cURL
curl "https://instance.servicenow.com/api/now/consumer?sysparm_query=account=86837a386f0331003b3c498f5d3ee4ca&sysparm_limit=2&sysparm_offset=2>;rel="next" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
"result": [
{
"country": "USA",
"notes": "",
"gender": "Male",
"city": "Plano",
"prefix": "",
"sys_updated_on": "2016-08-12 00:19:12",
"suffix": "",
"title": "",
"number": "CSMR0000004",
"notification": "2",
"sys_id": "01d8403fdb1b1200b6075200cf961941",
"business_phone": "",
"sys_updated_by": "prithvi",
"mobile_phone": "",
"street": "6900 Dallas Pkwy",
"sys_created_on": "2016-06-16 19:20:13",
"sys_domain": "global",
"state": "TX",
"fax": "",
"first_name": "Harding",
"email": "harding.asher@mailinator.com",
"preferred_language": "",
"sys_created_by": "guest",
"zip": "75024",
"home_phone": "",
"time_format": "",
"sys_mod_count": "8",
"last_name": "Asher",
"photo": "",
"active": "true",
"middle_name": "",
"time_zone": "",
"sys_tags": "",
"name": "Harding Asher",
"household": "",
"date_format": "",
"user": "c3d35d82c37122005871d44d81d3ae91",
"primary": "false"
},
{
"country": "USA",
"notes": "",
"gender": "Male",
"city": "San Francisco",
"prefix": "",
"sys_updated_on": "2016-08-12 00:20:27",
"suffix": "",
"title": "",
"number": "CSMR0000002",
"notification": "2",
"sys_id": "a0488cfbdb1b1200b6075200cf9619db",
"business_phone": "",
"sys_updated_by": "prithvi",
"mobile_phone": "",
"street": "144 2nd St",
"sys_created_on": "2016-06-16 19:17:44",
"sys_domain": "global",
"state": "CA",
"fax": "",
"first_name": "Sam",
"email": "sam.collins@mailinator.com",
"preferred_language": "",
"sys_created_by": "guest",
"zip": "94105",
"home_phone": "",
"time_format": "",
"sys_mod_count": "13",
"last_name": "Collins",
"photo": "",
"active": "true",
"middle_name": "",
"time_zone": "",
"sys_tags": "",
"name": "Sam Collins",
"household": "",
"date_format": "",
"user": "64488cfbdb1b1200b6075200cf9619db",
"primary": "false"
}
]
}
## Consommateur : GET /now/consumer/{id} {#ariaid-title3}
Récupère l'enregistrement de consommateur spécifié Gestion du service client (CSM) .
### Format d'URL
URL versionnée : /api/now/{api_version}/consumer/{id}
URL par défaut : /api/now/consumer/{id}
### Paramètres de demande pris en charge
{#consumer-GET-id__entry__2}{#consumer-GET-id__version-RESTAPI}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
| id | Sys_id de l'enregistrement consommateur à renvoyer. Situé dans la table Consommateur \[csm_consumer\]. Type de données : chaîne |
[Tableau 7. Paramètres de chemin d'accès]
{#consumer-GET-id__entry__8}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 8. Paramètres de requête]
{#consumer-GET-id__entry__12}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 9. Paramètres de corps de demande (XML ou JSON)]
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#consumer-GET-id__entry__16}{#consumer-GET-id__accept-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
[Tableau 10. En-têtes de demandes]
{#consumer-GET-id__entry__20}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 11. En-têtes de réponses]
### Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#consumer-GET-id__entry__24}{#consumer-GET-id__entry-200-status-code}{#consumer-GET-id__entry-401-status-code}{#consumer-GET-id__entry-500-status-code}
| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 404 | Indique que la demande n'est pas valide. Cela peut être dû à l'une des raisons suivantes : * Le ticket demandé n'existe pas. * L'utilisateur n'a pas accès à l'enregistrement du consommateur. {#consumer-GET-id__ul_ubm_1jl_3v} |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
[Tableau 12. Codes d'état]
### Paramètres du corps de réponse (JSON ou XML)
Le point de terminaison peut renvoyer les éléments JSON ou XML suivants dans le corps de la réponse. En plus de la liste des éléments définis ci-dessous (qui définissent les éléments d'un système de base), le point de terminaison renvoie également tous les champs personnalisés ajoutés à la table Consommateur \[csm_consumer\]. Pour plus d'informations sur ces éléments, reportez-vous à la définition de table spécifique \[Définition du systèmeTables\].
{#consumer-GET-id__csmconsumer_response_parms__entry__2}{#consumer-GET-id__consumertable-active-entry}{#consumer-GET-id__consumertable-business_phone-entry}{#consumer-GET-id__consumertable-city-entry}{#consumer-GET-id__consumertable-country-entry}{#consumer-GET-id__consumertable-date_format-entry}{#consumer-GET-id__consumertable-email-entry}{#consumer-GET-id__consumertable-fax-entry}{#consumer-GET-id__consumertable-first_name-entry}{#consumer-GET-id__consumertable-gender-entry}{#consumer-GET-id__consumertable-home_phone-entry}{#consumer-GET-id__consumertable-household-entry}{#consumer-GET-id__consumertable-last_name-entry}{#consumer-GET-id__consumertable-middle_name-entry}{#consumer-GET-id__consumertable-mobile_phone-entry}{#consumer-GET-id__consumertable-name-entry}{#consumer-GET-id__consumertable-notes-entry}{#consumer-GET-id__consumertable-notification-entry}{#consumer-GET-id__consumertable-number-entry}{#consumer-GET-id__consumertable-photo-entry}{#consumer-GET-id__consumertable-preferred_language-entry}{#consumer-GET-id__consumertable-prefix-entry}{#consumer-GET-id__consumertable-primary-entry}{#consumer-GET-id__consumertable-state-entry}{#consumer-GET-id__consumertable-street-entry}{#consumer-GET-id__consumertable-suffix-entry}{#consumer-GET-id__consumertable-sys_created_by-entry}{#consumer-GET-id__consumertable-sys_created_on-entry}{#consumer-GET-id__consumertable-sys_domain-entry}{#consumer-GET-id__consumertable-sys_id-entry}{#consumer-GET-id__consumertable-sys_mod_count-entry}{#consumer-GET-id__consumertable-sys_updated_by-entry}{#consumer-GET-id__consumertable-sys_updated_on-entry}{#consumer-GET-id__consumertable-time_format-entry}{#consumer-GET-id__consumertable-time_zone-entry}{#consumer-GET-id__consumertable-title-entry}{#consumer-GET-id__consumertable-user-entry}{#consumer-GET-id__consumertable-zip-entry}
| Élément | Description |
|-|-|
| Actif | Marqueur indiquant si le consommateur est actif. Valeurs possibles : * vrai : consommateur actif * false : consommateur désactivé {#consumer-GET-id__ul_asy_4b3_2hb} Type de données : booléennes Valeur par défaut : true |
| business_phone | Numéro de téléphone professionnel du consommateur. Type de données : chaîne Longueur maximale : 40 |
| city | Ville dans laquelle réside le consommateur. Type de données : chaîne Longueur maximale : 100 |
| pays | Pays dans lequel réside le consommateur. Type de données : chaîne Longueur maximale : 40 |
| date_format | Format dans lequel afficher les dates. Valeurs valides : * jj-mm-aaaa * jj/mm/aaaa * jj.mm.aaaa * mm-jj-aaaa * aaaa-mm-jj {#consumer-GET-id__ul_jsj_qwc_2hb} Type de données : chaîne Longueur maximale : 40 Par défaut : vide (format de date système) |
| E-mail | Adresse e-mail du consommateur. Type de données : chaîne Longueur maximale : 100 |
| fax | Numéro de fax du consommateur. Type de données : chaîne Longueur maximale : 40 |
| first_name | Prénom du consommateur. Type de données : chaîne Longueur maximale : 50 |
| sexe | Sexe du consommateur. Type de données : chaîne Longueur maximale : 40 |
| home_phone | Numéro de téléphone du domicile du consommateur. Type de données : chaîne Longueur maximale : 40 |
| household | Sys_id de l'enregistrement qui décrit les caractéristiques du ménage. Situé dans la table Ménage \[csm_household\]. Type de données : chaîne |
| last_name | Nom du consommateur. Type de données : chaîne Longueur maximale : 50 |
| middle_name | Deuxième prénom du consommateur. Type de données : chaîne Longueur maximale : 50 |
| mobile_phone | Numéro de téléphone mobile du consommateur. Type de données : chaîne Longueur maximale : 40 |
| nom | Nom complet du consommateur ; first_name+middle_name+last_name. Type de données : chaîne Longueur maximale : 152 |
| notes | Remarques sur le consommateur. Type de données : chaîne Longueur maximale : 4 000 |
| Notification | Indique si le consommateur doit recevoir des notifications. Valeurs valides : * 1 : désactivé * 2 : Activé {#consumer-GET-id__ul_o5d_pyh_2hb} Type de données : entier Longueur maximale : 40 Valeur par défaut : 2 |
| Numéro | Numéro unique associé au consommateur. Type de données : chaîne Longueur maximale : 40 |
| photo | Photo du consommateur. Type de données : Image |
| preferred_language | Langue primaire du consommateur. Type de données : chaîne Longueur maximale : 3 |
| préfixe | Préfixe du nom du consommateur, tel que Dr., M., Mme ou Mme. Type de données : chaîne Longueur maximale : 40 |
| primaire | Marqueur indiquant s'il s'agit du consommateur primaire. Valeurs possibles : * true : consommateur primaire * false : consommateur non primaire {#consumer-GET-id__ul_yns_yb3_2hb} Type de données : booléennes Valeur par défaut : false |
| État | État dans lequel réside le consommateur. Type de données : chaîne Longueur maximale : 100 |
| rue | Adresse postale du consommateur. Type de données : chaîne Longueur maximale : 255 |
| suffixe | Suffixe du nom du consommateur tel que Jr., Sr. ou II. Type de données : chaîne |
| sys_created_by | Utilisateur qui a créé l'enregistrement de consommateur. Type de données : chaîne Longueur maximale : 40 |
| sys_created_on | Date et heure de création de l'enregistrement de consommateur. Type de données : chaîne |
| sys_domain | ServiceNow Domaine dans lequel résident les informations sur le consommateur. Type de données : chaîne |
| sys_id | Identificateur unique pour le consommateur. Type de données : chaîne |
| sys_mod_count | Nombre de fois où les informations consommateur associées ont été modifiées. Type de données : entier |
| sys_updated_by | Utilisateur qui a mis à jour les informations sur le consommateur pour la dernière fois. Type de données : chaîne Longueur maximale : 40 |
| sys_updated_on | Date et heure de la dernière mise à jour des informations sur le consommateur. Type de données : chaîne |
| time_format | Format dans lequel afficher l'heure. Valeurs valides : * hh.mm.ss : hh.mm.ss (12 heures) * hh :mm :ss a : hh :mm :ss (12 heures) * HH.mm.ss : hh.mm.ss (24 heures) * HH :mm :ss : hh :mm :ss (24 heures) {#consumer-GET-id__ul_kvg_gxc_2hb} Type de données : chaîne Longueur maximale : 40 Par défaut : vide (format d'heure système) |
| time_zone | Fuseau horaire du consommateur, tel que Canada/Centre ou États-Unis/Est. Type de données : chaîne Longueur maximale : 40 |
| Titre | Titre de l'entreprise du consommateur, par exemple Gestionnaire, Développeur de logiciels ou Prestataire. Type de données : chaîne Longueur maximale : 60 |
| utilisateur | Sys_id de l'utilisateur consommateur. Situé dans la table Utilisateur consommateur \[csm_consumer_user\]. Type de données : chaîne |
| code postal | Code postal du consommateur. Type de données : chaîne Longueur maximale : 40 |
[ ]
### Demande cURL
curl "https://instance.servicenow.com/api/now/consumer/01d8403fdb1b1200b6075200cf961941 \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
"result": {
"country": "USA",
"notes": "",
"gender": "Male",
"city": "Plano",
"prefix": "",
"sys_updated_on": "2016-08-12 00:19:12",
"suffix": "",
"title": "",
"number": "CSMR0000004",
"notification": "2",
"sys_id": "01d8403fdb1b1200b6075200cf961941",
"business_phone": "",
"sys_updated_by": "prithvi",
"mobile_phone": "",
"street": "6900 Dallas Pkwy",
"sys_created_on": "2016-06-16 19:20:13",
"sys_domain": "global",
"state": "TX",
"fax": "",
"first_name": "Harding",
"email": "harding.asher@mailinator.com",
"preferred_language": "",
"sys_created_by": "guest",
"zip": "75024",
"home_phone": "",
"time_format": "",
"sys_mod_count": "8",
"last_name": "Asher",
"photo": "",
"active": "true",
"middle_name": "",
"time_zone": "",
"sys_tags": "",
"name": "Harding Asher",
"household": "",
"date_format": "",
"user": "c3d35d82c37122005871d44d81d3ae91",
"primary": "false"
}
}
## Consommateur : POST /now/consumer {#ariaid-title4}
Créer un nouveau Gestion du service client (CSM) consommateur.
En outre, vous pouvez créer un profil de réseau social pour le consommateur à l'aide de ce point de terminaison. Pour créer le profil, vous devez spécifier les paramètres suivants dans le corps de la demande :
* social_channel
* social_handle
* social_handle_url
{#consumer-POST__ul_ntx_lg4_pgb}
Avertissement :
Ce point de terminaison n'effectue pas la validation des paramètres, car cela peut créer une surcharge excessive. Si un paramètre de demande est mal orthographié, n'est pas valide ou n'est pas pris en charge par le point de terminaison, il est ignoré sans avertissement.
### Format d'URL
URL versionnée : /api/now/{api_version}/consumer
URL par défaut : /api/now/consumer
### Paramètres de demande pris en charge
{#consumer-POST__entry__2}{#consumer-POST__version-RESTAPI}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
[Tableau 13. Paramètres de chemin d'accès]
{#consumer-POST__entry__6}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 14. Paramètres de requête]
{#consumer-POST__entry__10}{#consumer-POST__consumertable-active-entry}{#consumer-POST__consumertable-business_phone-entry}{#consumer-POST__consumertable-city-entry}{#consumer-POST__consumertable-country-entry}{#consumer-POST__consumertable-date_format-entry}{#consumer-POST__consumertable-email-entry}{#consumer-POST__consumertable-fax-entry}{#consumer-POST__consumertable-first_name-entry}{#consumer-POST__consumertable-gender-entry}{#consumer-POST__consumertable-home_phone-entry}{#consumer-POST__consumertable-household-entry}{#consumer-POST__consumertable-last_name-entry}{#consumer-POST__consumertable-middle_name-entry}{#consumer-POST__consumertable-mobile_phone-entry}{#consumer-POST__consumertable-name-entry}{#consumer-POST__consumertable-notes-entry}{#consumer-POST__consumertable-notification-entry}{#consumer-POST__consumertable-photo-entry}{#consumer-POST__consumertable-preferred_language-entry}{#consumer-POST__consumertable-prefix-entry}{#consumer-POST__consumertable-primary-entry}{#consumer-POST__consumertable-state-entry}{#consumer-POST__consumertable-street-entry}{#consumer-POST__consumertable-suffix-entry}{#consumer-POST__consumertable-time_format-entry}{#consumer-POST__consumertable-time_zone-entry}{#consumer-POST__consumertable-title-entry}{#consumer-POST__consumertable-user-entry}{#consumer-POST__consumertable-zip-entry}
| Élément | Description |
|-|-|
| Actif | Marqueur indiquant si le consommateur est actif. Valeurs possibles : * vrai : consommateur actif * false : consommateur désactivé {#consumer-POST__ul_asy_4b3_2hb} Type de données : booléennes Valeur par défaut : true |
| business_phone | Numéro de téléphone professionnel du consommateur. Type de données : chaîne Longueur maximale : 40 |
| city | Ville dans laquelle réside le consommateur. Type de données : chaîne Longueur maximale : 100 |
| pays | Pays dans lequel réside le consommateur. Type de données : chaîne Longueur maximale : 40 |
| date_format | Format dans lequel afficher les dates. Valeurs valides : * jj-mm-aaaa * jj/mm/aaaa * jj.mm.aaaa * mm-jj-aaaa * aaaa-mm-jj {#consumer-POST__ul_jsj_qwc_2hb} Type de données : chaîne Longueur maximale : 40 Par défaut : vide (format de date système) |
| E-mail | Adresse e-mail du consommateur. Type de données : chaîne Longueur maximale : 100 |
| fax | Numéro de fax du consommateur. Type de données : chaîne Longueur maximale : 40 |
| first_name | Prénom du consommateur. Type de données : chaîne Longueur maximale : 50 |
| sexe | Sexe du consommateur. Type de données : chaîne Longueur maximale : 40 |
| home_phone | Numéro de téléphone du domicile du consommateur. Type de données : chaîne Longueur maximale : 40 |
| household | Sys_id de l'enregistrement qui décrit les caractéristiques du ménage. Situé dans la table Ménage \[csm_household\]. Type de données : chaîne |
| last_name | Nom du consommateur. Type de données : chaîne Longueur maximale : 50 |
| middle_name | Deuxième prénom du consommateur. Type de données : chaîne Longueur maximale : 50 |
| mobile_phone | Numéro de téléphone mobile du consommateur. Type de données : chaîne Longueur maximale : 40 |
| nom | Nom complet du consommateur ; first_name+middle_name+last_name. Type de données : chaîne Longueur maximale : 152 |
| notes | Remarques sur le consommateur. Type de données : chaîne Longueur maximale : 4 000 |
| Notification | Indique si le consommateur doit recevoir des notifications. Valeurs valides : * 1 : désactivé * 2 : Activé {#consumer-POST__ul_o5d_pyh_2hb} Type de données : entier Longueur maximale : 40 Valeur par défaut : 2 |
| photo | Photo du consommateur. Type de données : Image |
| preferred_language | Langue primaire du consommateur. Type de données : chaîne Longueur maximale : 3 |
| préfixe | Préfixe du nom du consommateur, tel que Dr., M., Mme ou Mme. Type de données : chaîne Longueur maximale : 40 |
| primaire | Marqueur indiquant s'il s'agit du consommateur primaire. Valeurs possibles : * true : consommateur primaire * false : consommateur non primaire {#consumer-POST__ul_yns_yb3_2hb} Type de données : booléennes Valeur par défaut : false |
| social_channel | Canal de médias sociaux auquel le consommateur est associé, tel que Twitter, Facebook ou Instagram. Type de données : chaîne |
| social_handle | Descripteur de l'utilisateur sur le canal de médias sociaux. Type de données : chaîne |
| social_handle_url | URL du descripteur du canal social du consommateur. Type de données : chaîne |
| État | État dans lequel réside le consommateur. Type de données : chaîne Longueur maximale : 100 |
| rue | Adresse postale du consommateur. Type de données : chaîne Longueur maximale : 255 |
| suffixe | Suffixe du nom du consommateur tel que Jr., Sr. ou II. Type de données : chaîne |
| time_format | Format dans lequel afficher l'heure. Valeurs valides : * hh.mm.ss : hh.mm.ss (12 heures) * hh :mm :ss a : hh :mm :ss (12 heures) * HH.mm.ss : hh.mm.ss (24 heures) * HH :mm :ss : hh :mm :ss (24 heures) {#consumer-POST__ul_kvg_gxc_2hb} Type de données : chaîne Longueur maximale : 40 Par défaut : vide (format d'heure système) |
| time_zone | Fuseau horaire du consommateur, tel que Canada/Centre ou États-Unis/Est. Type de données : chaîne Longueur maximale : 40 |
| Titre | Titre de l'entreprise du consommateur, par exemple Gestionnaire, Développeur de logiciels ou Prestataire. Type de données : chaîne Longueur maximale : 60 |
| utilisateur | Sys_id de l'utilisateur consommateur. Situé dans la table Utilisateur consommateur \[csm_consumer_user\]. Type de données : chaîne |
| code postal | Code postal du consommateur. Type de données : chaîne Longueur maximale : 40 |
[Tableau 15. Paramètres de corps de demande (XML ou JSON)]
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#consumer-POST__entry__76}{#consumer-POST__accept-JSON-only-entry-RESTAPI}{#consumer-POST__content_type-JSON-only-entry-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
[Tableau 16. En-têtes de demandes]
{#consumer-POST__entry__82}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 17. En-têtes de réponses]
### Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#consumer-POST__entry__86}{#consumer-POST__entry-401-status-code}
| Code d'état | Description |
|-|-|
| 201 | Un nouvel enregistrement de consommateur a été créé avec succès. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 500 | Erreur interne du serveur. Une erreur de logique s'est produite sur le code côté serveur. |
[Tableau 18. Codes d'état]
### Paramètres du corps de réponse (JSON ou XML)
{#consumer-POST__entry__96}
| Élément | Description |
|-|-|
| résultat | Sys_id de l'enregistrement de consommateur nouvellement créé. Type de données : chaîne |
[ ]
### Demande cURL
curl -X POST "https://instance.servicenow.com/api/now/consumer" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d " { \
"country": "USA", \
"notes": "Never comes in before 10am", \
"gender": "Female", \
"city": "San Marcos", \
"prefix": "Ms", \
"title": "Director", \
"notification": "1", \
"business_phone": "(555)555-1234", \
"mobile_phone": "(555)555-1235", \
"street": "123 Sesame St", \
"state": "CA", \
"fax": "(555)555-1236", \
"first_name": "Jane", \
"zip": "92001", \
"home_phone": "(555)555-1234", \
"last_name": "Brown", \
"active": "true", \
"middle_name": "Dell", \
"time_zone": "PST", \
"name": "Jane Brown", \
"household": "4", \
"user": "c3d35d82c37122005871d44d81d3ae91", \
"primary": "false" \
}"
--user "username":"password"
{
"result": "0f5c13addb93230057c3fd441d9619b8"
}