API du consommateur

Référence API de Washington DC

Release

washingtondc

ft:locale

fr-FR

ft:publication_title

Référence API de Washington DC

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

API du consommateur

Rversion finale: Washingtondc

Mis à jour 1 févr. 2024

17 minutes de lecture

L’API consommateur vous permet de récupérer et de mettre à jour Gestion du service clientèle (CSM) les enregistrements de consommateurs.

En outre, 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 requiert le module d’extension Customer Service (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

Récupère un ensemble spécifié d’enregistrements de Gestion du service clientèle (CSM) consommateurs.

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

Tableau 1. Paramètres de chemin d'accès
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 2. Paramètres de requête
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é. 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 classe les résultats par ordre croissant, par numéro d’abord, puis par ordre décroissant de 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 3. Paramètres de corps de demande (XML ou JSON)
Élément	Description
Néant

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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 4. En-têtes de demandes
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 5. En-têtes de réponses
En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 6. Codes d'état
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.

Paramètres de 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 d’éléments définie 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 à votre définition de table spécifique [Définition du système > Tables].


Élément	Description
Actif	Marqueur indiquant si le consommateur est actif. Valeurs possibles : true : consommateur actif false : consommateur désactivé 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 Type de données : chaîne Longueur maximale : 40 Valeur 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	Genre 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é Type de données : nombre 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 principale 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
Principal	Marqueur indiquant s’il s’agit du consommateur principal. Valeurs possibles : true : consommateur primaire false : non consommateur principal 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, par exemple 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 de consommateur associées ont été modifiées. Type de données : nombre entier
sys_tags	Balises système. Type de données : chaîne
sys_updated_by	Utilisateur ayant mis à jour les informations de consommateur pour la dernière fois. Type de données : chaîne Longueur maximale : 40
sys_updated_on	Date et heure de dernière mise à jour des informations de consommateur. Type de données : chaîne
time_format	Format d’affichage de 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) Type de données : chaîne Longueur maximale : 40 Valeur par défaut : vide (format d’heure du système)
time_zone	Fuseau horaire du consommateur, par exemple Canada/Centre ou US/Est. Type de données : chaîne Longueur maximale : 40
Titre	Titre de l’entreprise du consommateur, tel que Gestionnaire, Développeur de logiciels ou Sous-traitant. 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}

Récupère l’enregistrement de consommateur spécifié Gestion du service clientèle (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

Tableau 7. Paramètres de chemin d'accès
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 8. Paramètres de requête
Nom	Description
Néant

Tableau 9. Paramètres de corps de demande (XML ou JSON)
Nom	Description
Néant

En-têtes

Tableau 10. En-têtes de demandes
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 11. En-têtes de réponses
En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 12. Codes d'état
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.
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.

Paramètres de corps de réponse (JSON ou XML)


Élément	Description
Actif	Marqueur indiquant si le consommateur est actif. Valeurs possibles : true : consommateur actif false : consommateur désactivé 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 Type de données : chaîne Longueur maximale : 40 Valeur 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	Genre 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é Type de données : nombre 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 principale 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
Principal	Marqueur indiquant s’il s’agit du consommateur principal. Valeurs possibles : true : consommateur primaire false : non consommateur principal 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, par exemple 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 de consommateur associées ont été modifiées. Type de données : nombre entier
sys_updated_by	Utilisateur ayant mis à jour les informations de consommateur pour la dernière fois. Type de données : chaîne Longueur maximale : 40
sys_updated_on	Date et heure de dernière mise à jour des informations de consommateur. Type de données : chaîne
time_format	Format d’affichage de 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) Type de données : chaîne Longueur maximale : 40 Valeur par défaut : vide (format d’heure du système)
time_zone	Fuseau horaire du consommateur, par exemple Canada/Centre ou US/Est. Type de données : chaîne Longueur maximale : 40
Titre	Titre de l’entreprise du consommateur, tel que Gestionnaire, Développeur de logiciels ou Sous-traitant. 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

Crée un nouveau Gestion du service clientèle (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

Avertissement :

Ce point de terminaison n’effectue pas la validation des paramètres, car cela peut entraîner 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

Tableau 13. Paramètres de chemin d'accès
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 14. Paramètres de requête
Nom	Description
Néant

Tableau 15. Paramètres de corps de demande (XML ou JSON)
Élément	Description
Actif	Marqueur indiquant si le consommateur est actif. Valeurs possibles : true : consommateur actif false : consommateur désactivé 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 Type de données : chaîne Longueur maximale : 40 Valeur 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	Genre 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é Type de données : nombre entier Longueur maximale : 40 Valeur par défaut : 2
Photo	Photo du consommateur. Type de données : image
preferred_language	Langue principale 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
Principal	Marqueur indiquant s’il s’agit du consommateur principal. Valeurs possibles : true : consommateur primaire false : non consommateur principal 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	Nom d’utilisateur sur le canal de médias sociaux. Type de données : chaîne
social_handle_url	URL vers le handle 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, par exemple Jr., Sr. ou II. Type de données : chaîne
time_format	Format d’affichage de 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) Type de données : chaîne Longueur maximale : 40 Valeur par défaut : vide (format d’heure du système)
time_zone	Fuseau horaire du consommateur, par exemple Canada/Centre ou US/Est. Type de données : chaîne Longueur maximale : 40
Titre	Titre de l’entreprise du consommateur, tel que Gestionnaire, Développeur de logiciels ou Sous-traitant. 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

En-têtes

Tableau 16. En-têtes de demandes
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 17. En-têtes de réponses
En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 18. Codes d'état
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 logique sur le code côté serveur s’est produite.

Paramètres de corps de réponse (JSON ou XML)


É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"
}