API de compte

Référence de l’API Yokohama

Release

yokohama

ft:locale

fr-FR

ft:publication_title

Référence de l’API Yokohama

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

API de compte

Rversion finale: Yokohama

Mis à jour 30 janv. 2025

14 minutes de lecture

L’API de compte fournit des points de terminaison pour récupérer Gestion du service client (CSM) les enregistrements de compte.

Cette API nécessite 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 un accès complet à l’API.

Compte : GET /now/account

Récupère un ensemble spécifié de Gestion du service client (CSM) comptes.

Format d'URL

URL versionnée : /api/now/{api_version}/account

URL par défaut : /api/now/account

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. Par 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é. Elle indique s’il existe d’autres enregistrements à renvoyer qui répondent aux critères de filtre. Type de données : nombre Valeur 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=vrai` 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 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 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 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.

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 la 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.
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 du corps de la réponse (JSON ou XML)


Paramètre	Description
account_code	Combinaison unique de valeurs qu’une application utilise pour identifier les prévisions budgétaires et les plans budgétaires. Type de données : chaîne Longueur maximale : 255
account_parent	Sys_id du compte parent de ce compte. Situé dans la table Compte [customer_account]. Type de données : chaîne
account_path	Chemin d’accès du compte parent au compte enfant dans la hiérarchie des comptes. Type de données : chaîne Longueur maximale : 255
active_escalation	Sys_id de l’escalade active associée au compte. Type de données : chaîne Table : Escalade [sn_customerservice_escalation]
apple_icon	Icône utilisée pour les signets de la page d’accueil iPhone. Type de données : image
banner_image	Image de bannière qui s’affiche sur le portail client. Type de données : image
banner_image_light	Petite image de bannière. Type de données : image
banner_text	Texte de la bannière qui s’affiche sur le portail client. Type de données : chaîne Longueur maximale : 4 000
city	Ville dans laquelle réside la société associée à ce compte. Type de données : chaîne Longueur maximale : 50
contact	Sys_id d’un enregistrement de contact associé à ce compte. Type de données : chaîne Table : Utilisateur [sys_user]
pays	Pays dans lequel réside la société associée à ce compte. Type de données : chaîne Longueur maximale : 40 Par défaut : États-Unis
customer	Marqueur indiquant si le compte est un compte client, par opposition à un compte partenaire. Valeurs possibles : true : compte client false : compte de partenaire Type de données : booléennes Valeur par défaut : false
rabais	Remise accordée au compte sur les achats. Type de données : nombre Longueur maximale : 15
fax_phone	Numéro de fax primaire de la société associée à ce compte. Type de données : chaîne Longueur maximale : 40
fiscal_year	Exercice fiscal de la société associée au compte. Type de données : chaîne
lat_long_error	Différence entre l’emplacement réel et les informations de latitude et de longitude. Type de données : chaîne Longueur maximale : 1 000
latitude	Latitude de la société associée à ce compte. Type de données : Nombre (nombre à virgule flottante) Longueur maximale : 40
longitude	Longitude de la société associée à ce compte. Type de données : Nombre (nombre à virgule flottante) Longueur maximale : 40
fabricant	Marqueur indiquant si la société associée à ce compte fabrique des biens. Valeurs possibles : true : fabrique des biens faux : ne fabrique pas de marchandises Type de données : booléennes Valeur par défaut : false
market_cap	Valeur marchande des actions cotées en bourse de la société associée. Type de données : nombre (devise) Longueur maximale : 20
nom	Nom de la société associée à ce compte. Type de données : chaîne Longueur maximale : 80
notes	Informations supplémentaires sur la société. Type de données : chaîne Longueur maximale : 4 000
num_employees	Nombre de personnes employées par l’entreprise. Type de données : nombre (entier) Longueur maximale : 40
Numéro	Numéro qui identifie ce compte. Type de données : chaîne Longueur maximale : 40
parent	Sys_id du compte parent de ce compte. Type de données : chaîne Table : Société [core_company]
partenaire	Marqueur indiquant si le compte est un compte partenaire ou un compte client. Valeurs possibles : true : compte de partenaire false : compte client Type de données : booléennes Valeur par défaut : false
Téléphone	Numéro de téléphone primaire pour la société. Type de données : chaîne
primaire	Marqueur indiquant s’il s’agit d’un compte primaire. Valeurs possibles : true : compte primaire false : compte secondaire Type de données : booléennes Valeur par défaut : false
primary_contact	Sys_id du contact principal pour le compte. Type de données : chaîne Table : Contact [customer_contact]
Bénéfices	Informations sur les bénéfices saisies pour ce compte. Type de données : nombre (devise) Longueur maximale : 40
publicly_traded	Marqueur indiquant si la société associée à ce compte est cotée en bourse. Valeurs possibles : true : coté en bourse faux : Société privée Type de données : booléennes
rank_tier	Type de compte. Valeurs possibles : Liste noire autre stratégique tactique Évalués Type de données : chaîne Longueur maximale : 40
registration_code	Code unique que les clients utilisent lorsqu’ils demandent une connexion sur le portail des clients. Ce code fournit une méthode de validation du client sur la société avant d’accorder l’accès. Type de données : chaîne Longueur maximale : 40
revenue_per_year	Chiffre d’affaires produit par la société associée à ce compte. Type de données : nombre (devise) Longueur maximale : 20
État	État dans lequel la société réside. Type de données : chaîne Longueur maximale : 40
stock_price	Prix de l’action de la société. Type de données : chaîne Longueur maximale : 40
stock_symbol	Code mnémonique de la société. Type de données : chaîne Longueur maximale : 40
rue	Rue de la société. Type de données : chaîne Longueur maximale : 255
sys_class_name	Table contenant l’enregistrement de compte associé. Type de données : chaîne
sys_created_by	Utilisateur qui a créé le compte à l’origine. Type de données : chaîne Longueur maximale : 40
sys_created_on	Date et heure de création initiale du compte. Type de données : chaîne
sys_id	Sys_id pour l’enregistrement du compte. Type de données : chaîne
sys_mod_count	Nombre de fois que les informations de compte ont été mises à jour. Type de données : nombre (entier)
sys_updated_by	Utilisateur ayant modifié les informations du compte 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 du compte. Type de données : chaîne
thème	Sys_id du thème du portail client utilisé par ce compte. Type de données : chaîne Tableau : Thème [sys_ui_theme]
vendor	Marqueur indiquant si la société associée à ce compte est un fournisseur. Valeurs possibles : true : fournisseur false : n’est pas un fournisseur Type de données : booléennes Valeur par défaut : false
vendor_manager	Liste des sys_ids des gestionnaires de fournisseurs pour le compte. Type de données : chaîne Table : Utilisateur [sys_user]
vendor_type	Liste des sys_ids du type de fournisseur, par exemple, applications, matériel, services ou logiciels. Type de données : chaîne Table : Type de fournisseur [vendor_type]
site internet	URL du site web de la société. Type de données : chaîne Longueur maximale : 1 024
code postal	Code postal de la société. Type de données : chaîne Longueur maximale : 40

Demande cURL

curl "https://instance.servicenow.com/api/now/account?sysparm_limit=2&sysparm_offset=2>;rel="next" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

{
"result": [
  {
   "banner_image_light": "",
   "country": "USA",
   "parent": "",
   "notes": "",
   "stock_symbol": "",
   "discount": "",
   "active_escalation": "",
   "sys_updated_on": "2019-01-03 19:37:55",
   "apple_icon": "",
   "number": "ACCT0000003",
    "sys_updated_by": "admin",
    "fiscal_year": "",
    "sys_created_on": "2018-12-23 05:25:17",
    "contact": "",
    "stock_price": "",
    "state": "",
    "banner_image": "",
    "sys_created_by": "admin",
    "longitude": "",
    "zip": "BR1 3QR",
    "profits": "0",
    "phone": "+44 20 8466 9992",
    "fax_phone": "",
    "name": "Boxeo EMEA",
    "banner_text": "",
    "account_code": "~~~~3",
    "primary": "false",
    "city": "Bromley",
    "latitude": "",
    "sys_class_name": "customer_account",
    "manufacturer": "false",
    "account_parent": "86837a386f0331003b3c498f5d3ee4ca",
    "sys_id": "3eedd08413651200042ab3173244b088",
    "market_cap": "0",
    "num_employees": "",
    "rank_tier": "",
    "street": "18 London Rd",
    "vendor": "false",
    "lat_long_error": "",
    "theme": "",
    "vendor_type": "",
    "website": "",
    "revenue_per_year": "0",
    "publicly_traded": "false",
    "sys_mod_count": "5",
    "sys_tags": "",
    "partner": "false",
    "registration_code": "BOXEO-EMEA",
    "vendor_manager": "",
    "account_path": "~~~~1/~~~~3",
    "primary_contact": "ff66c1254fb81200025ba3618110c76e",
    "customer": "true"
  },
  {
    "banner_image_light": "",
    "country": "USA",
    "parent": "",
    "notes": "",
    "stock_symbol": "",
    "discount": "",
    "active_escalation": "",
    "sys_updated_on": "2019-01-03 19:38:04",
    "apple_icon": "",
    "number": "ACCT0000004",
    "sys_updated_by": "admin",
    "fiscal_year": "",
    "sys_created_on": "2018-12-23 05:19:24",
    "contact": "",
    "stock_price": "",
    "state": "",
    "banner_image": "",
    "sys_created_by": "admin",
    "longitude": "",
    "zip": "V5L 2G4",
    "profits": "0",
    "phone": "+1 604-255-9797",
    "fax_phone": "",
    "name": "Boxeo Canada",
    "banner_text": "",
    "account_code": "~~~~4",
    "primary": "false",
    "city": "Vancouver",
    "latitude": "",
    "sys_class_name": "customer_account",
    "manufacturer": "false",
    "account_parent": "86837a386f0331003b3c498f5d3ee4ca",
    "sys_id": "609cd80413651200042ab3173244b03e",
    "market_cap": "0",
    "num_employees": "",
    "rank_tier": "",
    "street": "1362 Venables St,, BC V5L 2G4, Canada",
    "vendor": "false",
    "lat_long_error": "",
    "theme": "",
    "vendor_type": "",
    "website": "",
    "revenue_per_year": "0",
    "publicly_traded": "false",
    "sys_mod_count": "5",
    "sys_tags": "",
    "partner": "false",
    "registration_code": "BOXEO-CANADA",
    "vendor_manager": "",
    "account_path": "~~~~1/~~~~4",
    "primary_contact": "c07424a54f781200025ba3618110c746",
    "customer": "true"
  }
 ]
}

Compte : GET /now/account/{id}

Récupère le compte spécifié Gestion du service client (CSM) .