API de l’élément de base d’installation

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 152 minutes de lecture

    • L’API d’élément de base d’installation fournit des points de terminaison pour accéder aux enregistrements d’éléments de base d’installation et les gérer au sein d’une ServiceNow instance.

    Un élément de base d’installation représente une instance d’un produit qui a été configuré pour un client. Les éléments de base d’installation vous permettent de suivre tous les achats effectués par un client.

    Vous pouvez également effectuer des opérations CRUD sur la liste connexe Parties connexes de la base d’installation à l’aide de cette API. En outre, vous pouvez lire les enregistrements dans d’autres listes connexes des éléments de base d’installation, tels que les tickets, les contrats, les autorisations, les plans de maintenance, les produits vendus et les commandes de travaux.

    Pour accéder à cette API, vous devez disposer du rôle sn_install_base.ib_api_write ou sn_install_base.ib_api_read, selon le type d’action CRUD que vous essayez d’effectuer.

    Pour accéder aux différents points de terminaison de cette API, les modules d’extension suivants doivent être installés :
    • Customer Service Install Base Management (com.snc.install_base)
    • Gestion du travail planifié (sn_fsm_planned_wm) si vous souhaitez récupérer les données relatives au plan de maintenance et aux commandes de travaux.

    Cette API s’exécute dans l’espace de noms sn_install_base .

    Remarque :
    Cette API renvoie uniquement des champs non vides dans les réponses de point de terminaison. De plus, aucun des champs au niveau du système (ceux précédés de la mention « sys_ ») n’est renvoyé, à l’exception du champ sys_id.

    Pour plus d’informations sur les éléments de base d’installation, reportez-vous à la section Create an install base item.

    Élément de base d’installation : DELETE /sn_install_base/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id}

    Dissocie un enregistrement de parties liées spécifié à partir d’un enregistrement d’élément de base d’installation spécifié.

    Format d'URL

    URL versionnée : /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id}

    URL par défaut : /api/sn_install_base/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id}

    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
    id Sys_id de l’enregistrement de l’élément de base d’installation. Situé dans la table Élément de base d’installation [sn_install_base_item].

    Type de données : chaîne
    related_party_sys_id Sys_id de l’enregistrement de partie connexe. Par défaut, il se trouve dans la table Partie connexe de la base d’installation [sn_install_base_related_party].

    Type de données : chaîne
    Tableau 2. Paramètres de requête
    Nom Description
    Aucun
    Tableau 3. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Aucun

    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.
    403 Interdit. L’utilisateur ne possède pas les droits d’accès à l’enregistrement spécifié.
    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 du corps de réponse (JSON ou XML)

    Nom Description
    erreur Détails sur l’erreur qui s’est produite lors de la tentative de traitement de la demande.

    Type de données : objet

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Détails supplémentaires sur l’erreur associée.

    Type de données : chaîne
    message.erreur Message d’erreur qui décrit le problème qui s’est produit lors de la tentative d’exécution de la demande.

    Type de données : chaîne
    résultat Description des résultats du point de terminaison.

    Type de données : objet
    Résultat.État État de la demande de point de terminaison.

    Valeurs possibles :

    • SUCCÈS
    • ÉCHEC

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991/relatedparties/2a42dfae872521100b6afc86dabb356b" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'

    Résultats renvoyés :

    {
  "result": {
    "status": "SUCCESS"
  }
}

    Élément de base d’installation : GET /sn_install_base/integrations/installbaseitems

    Renvoie tous les éléments de base d’installation. Vous pouvez passer des paramètres dans l’appel pour filtrer les résultats renvoyés.

    Format d'URL

    URL versionnée : /api/sn_install_base/{api_version}/integrations/installbaseitems

    URL par défaut : /api/sn_install_base/integrations/installbaseitems

    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
    Tableau 8. Paramètres de requête
    Nom Description
    Paires nom-valeur de champ Paires champ-valeur à utiliser pour filtrer les enregistrements d’éléments de base d’installation. Situé dans la table Élément de base d’installation [sn_istall_base_item]. Si vous spécifiez une autre table dans sys_class_name, spécifiez les champs de cette table.

    Vous pouvez transmettre une ou plusieurs paires champ-valeur pour filtrer les résultats renvoyés.

    Par exemple, pour renvoyer uniquement les enregistrements dont le champ d’état est défini sur « in_use » et le champ d’état est défini sur « remplacement », transmettez ce qui suit : &state=in_use&status=replacement.

    Type de données : chaîne

    Par défaut : Tous les champs
    related_party Sys_id d’un enregistrement de partie connexe. Situé dans la table Partie connexe de la base d’installation [sn_install_base_related_party].

    Filtre les enregistrements d’éléments de base d’installation en fonction de la partie associée spécifiée. Une partie liée peut être liée à un élément de base d’installation ou à un produit vendu.

    Valeurs valides :
    • sys_id de compte : situé dans la table Compte [customer_account].
    • sys_id du consommateur : situé dans la table Consommateur [csm_consumer].
    • sys_id de contact : situé dans la table Contact [customer-contact].
    • sys_id de l’organisation de services : située dans la table Organisation de services [sn_customer_service_organization].
    • sys_id d’utilisateur : situé dans la table Utilisateur [sys-user].

    Type de données : chaîne
    responsabilité Sys_id de l’enregistrement de responsabilité associé. Cet enregistrement définit le niveau d’accès aux informations de base d’installation.

    Ce paramètre n’est valide que si le related_party champ est également spécifié. S’il est spécifié, il renvoie uniquement les éléments de base d’installation related_party qui correspondent aux paramètres and responsibility .

    Pour en savoir plus, consultez Configure related parties for items received.

    Type de données : chaîne
    sys_class_name Si les enregistrements souhaités se trouvent dans une table qui étend la table Éléments de base d’installation [sn_install_base_item], nom de la table étendue à interroger.

    Type de données : chaîne
    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.

    Cette limite est appliquée avant l'évaluation de l'ACL. Si aucun enregistrement n'est renvoyé (notamment ceux auxquels vous avez accès), réorganisez l'ordre des enregistrements pour que ceux auxquels vous avez accès soient renvoyés en premier.

    Remarque :
    Des valeurs sysparm_limit anormalement élevées peuvent avoir un impact sur les performances du système.

    Type de données : nombre

    Par défaut : 10 000
    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 sysparm_offset paramètre.

    Type de données : nombre

    Par défaut : 0
    Tableau 9. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Aucun

    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 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 la 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.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    403 Interdit. L’utilisateur ne possède pas les droits d’accès à l’enregistrement spécifié.
    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 réponse (JSON ou XML)

    Les résultats de retour suivants décrivent uniquement les valeurs de retour des enregistrements retournés à partir de la table Éléments de base d’installation [sn_install_base_items].

    Nom Description
    erreur Détails sur l’erreur qui s’est produite lors de la tentative de traitement de la demande.

    Type de données : objet

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Détails supplémentaires sur l’erreur associée.

    Type de données : chaîne
    message.erreur Message d’erreur qui décrit le problème qui s’est produit lors de la tentative d’exécution de la demande.

    Type de données : chaîne
    has_more Marqueur indiquant s’il existe d’autres enregistrements dans la table à renvoyer.
    Valeurs possibles :
    • true : plus d’enregistrements à renvoyer.
    • false : plus aucun enregistrement à renvoyer.

    Type de données : chaîne booléenne
    Éléments Liste des éléments de base d’installation qui correspondaient aux résultats de filtre spécifiés.

    Type de données : tableau d’objets

    "items":[
  {
    "account": {Object},
    "active": "String",
    "asset": {Object},
    "configuration_item": {Object},
    "consumer": {Object},
    "consumer_profile": {Object},
    "contact": {Object},
    "health_status": {Object},
    "health_status_last_updated": "String",
    "household": {Object},
    "install_date": {Object},
    "location": {Object},
    "name": "String",
    "number": "String",
    "parent": {Object},
    "product": {Object},
    "service_context": {Object},
    "service_organization" {Object},
    "sys_class_name": "String",
    "sys_id": "String",
    "sys_mod_count": "String",
    "state": {Object},
    "status": {Object},
    "uninstall_date": "String"
  }
]
    Articles.Compte Détails sur le compte client associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    items.account.display_value Nom de texte du compte client associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du compte client dans l’interface utilisateur.

    Type de données : chaîne
    items.account.sys_id Sys_id de l’enregistrement de compte client associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    éléments.actif Marqueur indiquant si l’élément de base d’installation est actif.
    Valeurs possibles :
    • vrai : l’élément de base d’installation est actif.
    • faux : l’élément de base d’installation est inactif.

    Type de données : chaîne booléenne
    Éléments.Actif Détails sur l’actif associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "asset": {
  "display_value": "String",
  "sys_id": "String"
}
    items.asset.display_value Nom de texte de l’actif associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom de la ressource dans l’interface utilisateur.

    Type de données : chaîne
    items.asset.sys_id Sys_id de l’enregistrement d’actif associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    items.configuration_item Détails sur l’élément de configuration associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "configuration_item": {
  "display_value": "String",
  "sys_id": "String"
}
    items.configuration_item.display_value Nom de texte de l’élément de configuration associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom de l’élément de configuration dans l’interface utilisateur.

    Type de données : chaîne
    items.configuration_item.sys_id Sys_id de l’enregistrement d’élément de configuration associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    Articles.Consommateur Détails sur le consommateur associé à l’enregistrement d’élément de base d’installation.
    Remarque :
    Le champ consommateur n’est disponible que si le module d’extension B2B2C est installé.

    Type de données : objet

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    items.consumer.display_value Nom de texte du consommateur associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du consommateur dans l’interface utilisateur.

    Type de données : chaîne
    items.consumer.sys_id Sys_id de l’enregistrement de consommateur associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    items.consumer_profile Détails sur le profil de consommateur associé à l’enregistrement d’élément de base d’installation.
    Remarque :
    Le champ Profil du consommateur n’est disponible que si le module d’extension B2B2C est installé.

    Type de données : objet

    "consumer_profile": {
  "display_value": "String",
  "sys_id": "String"
}
    items.consumer_profile.display_value Nom de texte du profil de consommateur associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du profil du consommateur dans l’interface utilisateur.

    Type de données : chaîne
    items.consumer_profile.sys_id Sys_id de l’enregistrement de profil de consommateur associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    articles.contact Détails sur le contact de compte responsable de l’enregistrement de l’élément de base d’installation.

    Type de données : objet

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    items.contact.display_value Nom de texte du contact du compte associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du contact du compte dans l’interface utilisateur.

    Type de données : chaîne
    items.contact.sys_id Sys_id de l’enregistrement de contact de compte associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    items.health_status Détails sur l’état d’intégrité actuel de l’élément de base d’installation. Uniquement renvoyé si le module d’extension Proactive Customer Service Operations (com.snc.proactive_cs_itom) est installé.

    Type de données : objet

    "health_status": {
  "display_value": "String",
  "value": "String"
}
    items.health_status.display_value Chaîne de texte de l’état d’intégrité actuel de l’élément de base d’installation. Utilisez cette valeur pour afficher l’état d’intégrité dans l’interface utilisateur.

    Type de données : chaîne
    items.health_status.valeur Valeur interne de l’état d’intégrité de l’élément de base d’installation.

    Type de données : chaîne
    items.health_status_last_updated Date et heure auxquelles l’état d’intégrité a été mis à jour pour la dernière fois pour l’élément de base d’installation.

    Type de données : chaîne
    Articles.Ménage Détails sur le ménage associé à l’enregistrement d’élément de base d’installation. Renvoyé uniquement si le module d’extension Service clientèle Household (com.snc.household) est installé.

    Type de données : objet

    "household": {
  "display_value": "String",
  "sys_id": "String"
}
    items.household.display_value Nom de texte du ménage associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du ménage dans l’interface utilisateur.

    Type de données : chaîne
    items.household.sys_id Sys_id du ménage associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    items.install_date Détails sur la date à laquelle l’élément de base d’installation est devenu actif.

    Type de données : objet

    "install_date": {
  "display_value": "String",
  "value": "String"
}
    items.install_date.display_value Date d’installation du texte. Utilisez cette valeur pour afficher la date d’installation dans l’interface utilisateur.

    Type de données : chaîne
    items.install_date.valeur Valeur interne de la date d’installation.

    Type de données : chaîne
    Éléments.Emplacement Détails sur l’emplacement de l’élément de base d’installation.

    Type de données : objet

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    items.location.display_value Nom de texte de l’emplacement de l’élément de base d’installation. Utilisez cette valeur pour afficher le nom de l’emplacement dans l’interface utilisateur.

    Type de données : chaîne
    items.location.sys_id Sys_id de l’enregistrement d’emplacement associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    items.name Nom de l'élément de base d'installation.

    Type de données : chaîne
    nombre d’éléments.nombre ID unique de l'élément de base d'installation.

    Type de données : chaîne
    articles.parent Détails sur l’enregistrement parent de l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "parent": {
  "display_value": "String",
  "sys_id": "String"
}
    items.parent.display_value Nom de texte de l’enregistrement parent associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom parent dans l’interface utilisateur.

    Type de données : chaîne
    items.parent.sys_id Sys_id de l’enregistrement parent associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    articles.produit Détails sur le modèle de produit associé à l’enregistrement de l’élément de base d’installation. Utilisez ces informations pour identifier les services associés à n’importe quel modèle de produit.

    Type de données : objet

    "product": {
  "display_value": "String",
  "sys_id": "String"
}
    items.product.display_value Nom de texte du modèle de produit associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du produit dans l’interface utilisateur.

    Type de données : chaîne
    items.product.sys_id Sys_id de l’enregistrement de modèle de produit associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    items.service_context Détails sur le contexte de service associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    items.service_context.display_value Nom de texte du contexte de service associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du contexte de service dans l’interface utilisateur.

    Type de données : chaîne
    items.service_context.sys_id Sys_id de l’enregistrement de contexte de service associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    items.service_organization Détails sur l’organisation de services associée à l’enregistrement d’élément de base d’installation. Renvoyé uniquement si le module d’extension Organisation de services (com.snc.service_organization) est installé.

    Type de données : objet

    "service_organization": {
  "display_value": "String",
  "sys_id": "String"
}
    items.service_organization.display_value Nom de texte de l’organisation de services associée à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom de l’organisation de service dans l’interface utilisateur.

    Type de données : chaîne
    items.service_organization.sys_id Sys_id de l’enregistrement de l’organisation de services associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    items.sys_nom_de_classe Table contenant l’enregistrement de l’élément de base d’installation.

    Type de données : chaîne
    items.sys_id Sys_id de l’enregistrement de l’élément de base d’installation. Situé dans la table spécifiée dans le sys_class_name paramètre.

    Type de données : chaîne
    items.sys_mod_count Nombre de fois où l’enregistrement d’élément de base d’installation associé a été modifié.

    Type de données : chaîne
    Éléments.État Détails sur l’état actuel de l’élément de base d’installation.

    Type de données : objet

    "state": {
  "display_value": "String",
  "value": "String"
}
    items.state.display_value Chaîne de texte de l’état actuel de l’élément de base d’installation. Utilisez cette valeur pour afficher l’état dans l’interface utilisateur.

    Type de données : chaîne
    éléments.état.valeur Valeur interne de l’état de l’élément de base d’installation.

    Type de données : chaîne
    Éléments.Statut Détails sur l’état de l’élément de base d’installation.

    Type de données : objet

    "status": {
  "display_value": "String",
  "value": "String"
}
    items.status.display_value Chaîne de texte de l’état de l’élément de base d’installation. Utilisez cette valeur pour afficher l’état dans l’interface utilisateur.

    Type de données : chaîne
    éléments.état.valeur Valeur interne de l’état de l’élément de base d’installation.

    Type de données : chaîne
    items.uninstall_date Détails sur la date à laquelle l’élément de base d’installation est devenu inactif.

    Type de données : objet

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    items.uninstall_date.display_value Date de désinstallation du texte. Utilisez cette valeur pour afficher la date de désinstallation dans l’interface utilisateur.

    Type de données : chaîne
    items.uninstall_date.valeur Valeur interne de la date de désinstallation.

    Type de données : chaîne
    statut État de l’appel de point de terminaison.

    Type de données : chaîne
    sysparm_depth Nombre de niveaux de profondeur de l’élément de base d’installation enfant renvoyé dans la hiérarchie.

    Type de données : entier
    sysparm_limit Nombre d’enregistrements qui ont été renvoyés. Si cette valeur n’est pas spécifiée dans la demande d’origine, elle utilise la valeur par défaut.

    Type de données : nombre
    sysparm_offset Décalage (point de départ) dans la table associée à partir de laquelle les enregistrements ont été évalués et récupérés.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre un appel simple qui ne renvoie qu’un seul enregistrement à partir du décalage 5.

    curl "https://instance.servicenow.com/api/sn_install_base/v1/integrations/installbaseitems?sysparm_limit=1&sysparm_offset=5" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Résultats renvoyés :

    {
  "result": {
    "sysparm_offset": "5",
    "sysparm_limit": 1,
    "has_more": true,
    "items": [
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001100",
        "sys_id": "181df7ff530a1110539dddeeff7b12f4",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "sys_mod_count": "2",
        "active": "true",
        "configuration_item": {
          "sys_id": "62446ae8535e5510539dddeeff7b12db",
          "display_value": "boxeoproderp"
        },
        "name": "boxeoproderp",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Demande cURL

    L’exemple de code suivant montre comment rechercher les champs state = « in_use » et status = « remplacement » dans la table Élément de base d’installation.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems?state=in_use&status=replacement" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Résultats renvoyés :

    {
  "result": {
    "sysparm_offset": "0",
    "sysparm_limit": "10",
    "has_more": false,
    "items": [
      {
        "parent": {
          "sys_id": "ffd023f453de9910539dddeeff7b1264",
          "display_value": "Point of Sale System"
        },
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001140",
        "sys_id": "a1a123745312d910539dddeeff7b127b",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "install_date": {
          "value": "2018-12-14 07:00:00",
          "display_value": "2018-12-13 23:00:00"
        },
        "product": {
          "sys_id": "2dd1e7b753421110539dddeeff7b12d1",
          "display_value": "Stand"
        },
        "active": "true",
        "name": "Stand",
        "service_organization": {
          "sys_id": "42b51f5ab3401010700b4d43c6a8dc5a",
          "display_value": "LA City Center - West"
        },
        "status": {
          "value": "replacement",
          "display_value": "Replacement"
        }
      },
      {
        "parent": {
          "sys_id": "ffd023f453de9910539dddeeff7b1264",
          "display_value": "Point of Sale System"
        },
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001139",
        "sys_id": "d0916bb05312d910539dddeeff7b1232",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "install_date": {
          "value": "2018-12-14 07:00:00",
          "display_value": "2018-12-13 23:00:00"
        },
        "product": {
          "sys_id": "dfc127b753421110539dddeeff7b12ac",
          "display_value": "Register"
        },
        "active": "true",
        "name": "Register",
        "service_organization": {
          "sys_id": "42b51f5ab3401010700b4d43c6a8dc5a",
          "display_value": "LA City Center - West"
        },
        "status": {
          "value": "replacement",
          "display_value": "Replacement"
        }
      },
      {
        "parent": {
          "sys_id": "ffd023f453de9910539dddeeff7b1264",
          "display_value": "Point of Sale System"
        },
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001141",
        "sys_id": "ffb123745312d910539dddeeff7b12cb",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "install_date": {
          "value": "2018-12-14 07:00:00",
          "display_value": "2018-12-13 23:00:00"
        },
        "product": {
          "sys_id": "59e1e7b753421110539dddeeff7b12cc",
          "display_value": "Terminal"
        },
        "active": "true",
        "name": "Terminal",
        "service_organization": {
          "sys_id": "42b51f5ab3401010700b4d43c6a8dc5a",
          "display_value": "LA City Center - West"
        },
        "status": {
          "value": "replacement",
          "display_value": "Replacement"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Demande cURL

    L’exemple de code suivant montre comment filtrer les résultats renvoyés à l’aide des paramètres de related_party requête and responsibility .

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems?related_party=dc0185d94f341200025ba3618110c77c&responsibility=c009bbedb3730010700b4d43c6a8dce" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Résultats renvoyés :

    {
  "result": {
    "sysparm_offset": "0",
    "sysparm_limit": "10",
    "has_more": false,
    "items": [
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001004",
        "sys_id": "3ea014a778de1110f877d304c76fdd0d",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "consumer": {
          "sys_id": "feb5139ab3401010700b4d43c6a8dc43",
          "display_value": "Kenny Smith"
        },
        "product": {
          "sys_id": "63c8bc9778921110f877d304c76fdd34",
          "display_value": "X4 Sport Utility 4D"
        },
        "active": "true",
        "name": "X4 Sport Utility 4D",
        "status": {
          "value": "original",
          "display_value": "Original"
        }
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001003",
        "sys_id": "6e94e3c853500010df5dddeeff7b1234",
        "contact": {
          "sys_id": "4d147a386f0331003b3c498f5d3ee437",
          "display_value": "Julie Lewis"
        },
        "active": "true",
        "configuration_item": {
          "sys_id": "a96a570453500010df5dddeeff7b1206",
          "display_value": "boxeosandbox"
        },
        "name": "Boxeo - Sandbox",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001010",
        "sys_id": "83332fde87e5a1105d0055373cbb3567",
        "contact": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "install_date": {
          "value": "2023-02-26 18:59:52",
          "display_value": "2023-02-26 10:59:52"
        },
        "health_status": {
          "value": "not_available",
          "display_value": "Not Available"
        },
        "product": {
          "sys_id": "a9a2d0c3c6112276010db16c5ddd3461",
          "display_value": "Lenovo ThinkStation S20"
        },
        "active": "true",
        "configuration_item": {
          "sys_id": "affd3c8437201000deeabfc8bcbe5dc3",
          "display_value": "*BETH-IBM"
        },
        "name": "IB B2B",
        "location": {
          "sys_id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "display_value": "100 South Charles Street, Baltimore,MD"
        },
        "asset": {
          "sys_id": "bfc1fa8837f3100044e0bfc8bcbe5ddf",
          "display_value": "P1000228 - Lenovo ThinkStation S20"
        },
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        },
        "status": {
          "value": "original",
          "display_value": "Original"
        }
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001011",
        "sys_id": "9d766f168729a1105d0055373cbb3597",
        "health_status": {
          "value": "not_available",
          "display_value": "Not Available"
        },
        "product": {
          "sys_id": "8583ce8237732000158bbfc8bcbe5dd9",
          "display_value": "Fujitsu 1TB Hybrid Solid State Drive"
        },
        "active": "true",
        "name": "IBA",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001013",
        "sys_id": "bd955a2687ada1100b6afc86dabb35fb",
        "health_status": {
          "value": "not_available",
          "display_value": "Not Available"
        },
        "consumer": {
          "sys_id": "59e788fbdb1b1200b6075200cf9619d2",
          "display_value": "Gilly Parker"
        },
        "product": {
          "sys_id": "1a13974053500010df5dddeeff7b122c",
          "display_value": "12000XHD Digital Press"
        },
        "active": "true",
        "name": "IBConsumer"
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0000901",
        "sys_id": "f77c7542b7343300ece839a6ee11a991",
        "product": {
          "sys_id": "8583ce8237732000158bbfc8bcbe5dd9",
          "display_value": "Fujitsu 1TB Hybrid Solid State Drive"
        },
        "active": "true",
        "name": "KX Series - KX5001",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Élément de base d’installation : GET /sn_install_base/integrations/installbaseitem/{id}

    Renvoie un enregistrement d’élément de base d’installation spécifié et sa hiérarchie enfant.

    Format d'URL

    URL versionnée : /api/sn_install_base/{api_version}/integrations/installbaseitem/{id}

    URL par défaut : /api/sn_install_base/integrations/installbaseitem/{id}

    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
    id Sys_id de l’enregistrement de l’élément de base d’installation. Situé dans la table Élément de base d’installation [sn_install_base_item].

    Type de données : chaîne
    Tableau 14. Paramètres de requête
    Nom Description
    sys_class_name Si l’enregistrement souhaité se trouve dans une table qui étend la table Éléments de base d’installation [sn_install_base_item], nom de la table étendue à interroger. Cette table doit étendre la table sn_install_base_item.

    Type de données : chaîne
    sysparm_depth Profondeur maximale de la hiérarchie de l’élément de base d’installation enfant à renvoyer.

    Type de données : entier

    Par défaut : 7

    Maximum : 10
    sysparm_limit Nombre maximal d’enregistrements à renvoyer dans chaque hiérarchie enfant.

    Type de données : entier

    Par défaut : 10

    Maximum : 100
    Tableau 15. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Aucun

    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 16. 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 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 la 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
    200 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    403 Interdit. L’utilisateur ne possède pas les droits d’accès à l’enregistrement spécifié.
    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 du corps de réponse (JSON ou XML)

    Nom Description
    base d’installation enfant Liste des enregistrements d’éléments de base d’installation enfants associés à l’élément de base d’installation spécifié.

    Type de données : objet

    "childinstallbase": {
  "items": [Array],
  "sysparm_depth": Integer
}
    childinstallbase.items Éléments de base d’installation enfants associés à l’élément de base d’installation spécifié.

    Les valeurs de ce tableau sont définies sous le items[] tableau plus bas dans cette section.
    childinstallbase.sysparm_depth Niveau enfant de l’élément de base d’installation.

    Type de données : entier
    erreur Détails sur l’erreur qui s’est produite lors de la tentative de traitement de la demande.

    Type de données : objet

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Détails supplémentaires sur l’erreur associée.

    Type de données : chaîne
    message.erreur Message d’erreur qui décrit le problème qui s’est produit lors de la tentative d’exécution de la demande.

    Type de données : chaîne
    has_children Marqueur indiquant si l’enregistrement d’élément de base d’installation demandé a des enregistrements d’éléments de base d’installation enfants.
    • true : contient des enregistrements d’éléments de base d’installation enfants.
    • false : n’a pas d’enregistrements d’éléments de base d’installation enfants.

    Type de données : booléennes
    élément Élément de base d’installation qui correspondait aux résultats de filtre spécifiés.

    Type de données : tableau d’objets

    "item": {
  "account": {Object},
  "active": "String",
  "asset": {Object},
  "configuration_item": {Object},
  "consumer": {Object},
  "consumer_profile": {Object},
  "contact": {Object},
  "health_status": "Object",
  "health_status_last_updated": "String",
  "household": {Object},
  "install_date": {Object},
  "location": {Object},
  "name": "String",
  "number": "String",
  "parent": {Object},
  "product": {Object},
  "service_context": {Object},
  "service_organization" {Object},
  "sys_class_name": "String",
  "sys_id": "String",
  "state": {Object},
  "status": {Object},
  "uninstall_date": "String"
}
    compte.élément Détails sur le compte client associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    item.account.display_value Nom de texte du compte client associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du compte client dans l’interface utilisateur.

    Type de données : chaîne
    item.account.sys_id Sys_id de l’enregistrement de compte client associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    élément.actif Marqueur indiquant si l’élément de base d’installation est actif.
    Valeurs possibles :
    • vrai : l’élément de base d’installation est actif.
    • faux : l’élément de base d’installation est inactif.

    Type de données : chaîne booléenne
    élément.actif Détails sur l’actif associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "asset": {
  "display_value": "String",
  "sys_id": "String"
}
    item.asset.display_value Nom de texte de l’actif associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom de la ressource dans l’interface utilisateur.

    Type de données : chaîne
    item.asset.sys_id Sys_id de l’enregistrement d’actif associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.configuration_item Détails sur l’élément de configuration associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "configuration_item": {
  "display_value": "String",
  "sys_id": "String"
}
    item.configuration_item.display_value Nom de texte de l’élément de configuration associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom de l’élément de configuration dans l’interface utilisateur.

    Type de données : chaîne
    item.configuration_item.sys_id Sys_id de l’enregistrement d’élément de configuration associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    Consommateur.Article Détails sur le consommateur associé à l’enregistrement d’élément de base d’installation.
    Remarque :
    Le champ consommateur n’est disponible que si le module d’extension B2B2C est installé.

    Type de données : objet

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    item.consumer.display_value Nom de texte du consommateur associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du consommateur dans l’interface utilisateur.

    Type de données : chaîne
    item.consumer.sys_id Sys_id de l’enregistrement de consommateur associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.consumer_profile Détails sur le profil de consommateur associé à l’enregistrement d’élément de base d’installation.
    Remarque :
    Le champ Profil du consommateur n’est disponible que si le module d’extension B2B2C est installé.

    Type de données : objet

    "consumer_profile": {
  "display_value": "String",
  "sys_id": "String"
}
    item.consumer_profile.display_value Nom de texte du profil de consommateur associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du profil du consommateur dans l’interface utilisateur.

    Type de données : chaîne
    item.consumer_profile.sys_id Sys_id de l’enregistrement de profil de consommateur associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    article.contact Détails sur le contact de compte responsable de l’enregistrement de l’élément de base d’installation.

    Type de données : objet

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    item.contact.display_value Nom de texte du contact du compte associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du contact du compte dans l’interface utilisateur.

    Type de données : chaîne
    item.contact.sys_id Sys_id de l’enregistrement de contact de compte associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.health_status Détails sur l’état d’intégrité actuel de l’élément de base d’installation. Uniquement renvoyé si le module d’extension Proactive Customer Service Operations (com.snc.proactive_cs_itom) est installé.

    Type de données : objet

    "health_status": {
  "display_value": "String",
  "value": "String"
}
    item.health_status.display_value Chaîne de texte de l’état d’intégrité actuel de l’élément de base d’installation. Utilisez cette valeur pour afficher l’état d’intégrité dans l’interface utilisateur.

    Type de données : chaîne
    item.health_status.valeur Valeur interne de l’état d’intégrité de l’élément de base d’installation.

    Type de données : chaîne
    item.health_status_last_updated Date et heure auxquelles l’état d’intégrité a été mis à jour pour la dernière fois pour l’élément de base d’installation.

    Type de données : chaîne
    Article.Ménage Détails sur le ménage associé à l’enregistrement d’élément de base d’installation. Renvoyé uniquement si le module d’extension Service clientèle Household (com.snc.household) est installé.

    Type de données : objet

    "household": {
  "display_value": "String",
  "sys_id": "String"
}
    item.household.display_value Nom de texte du ménage associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du ménage dans l’interface utilisateur.

    Type de données : chaîne
    item.household.sys_id Sys_id du ménage associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.install_date Détails sur la date à laquelle l’élément de base d’installation est devenu actif.

    Type de données : objet

    "install_date": {
  "display_value": "String",
  "value": "String"
}
    item.install_date.display_value Date d’installation du texte. Utilisez cette valeur pour afficher la date d’installation dans l’interface utilisateur.

    Type de données : chaîne
    item.install_date.valeur Valeur interne de la date d’installation.

    Type de données : chaîne
    élément.emplacement Détails sur l’emplacement de l’élément de base d’installation.

    Type de données : objet

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    item.location.display_value Nom de texte de l’emplacement de l’élément de base d’installation. Utilisez cette valeur pour afficher le nom de l’emplacement dans l’interface utilisateur.

    Type de données : chaîne
    item.location.sys_id Sys_id de l’enregistrement d’emplacement associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.name Nom de l'élément de base d'installation.

    Type de données : chaîne
    numéro.élément ID unique de l'élément de base d'installation.

    Type de données : chaîne
    élément.parent Détails sur l’enregistrement parent de l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "parent": {
  "display_value": "String",
  "sys_id": "String"
}
    item.parent.display_value Nom de texte de l’enregistrement parent associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom parent dans l’interface utilisateur.

    Type de données : chaîne
    item.parent.sys_id Sys_id de l’enregistrement parent associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    produit.article Détails sur le modèle de produit associé à l’enregistrement de l’élément de base d’installation. Utilisez ces informations pour identifier les services associés à n’importe quel modèle de produit.

    Type de données : objet

    "product": {
  "display_value": "String",
  "sys_id": "String"
}
    item.product.display_value Nom de texte du modèle de produit associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du produit dans l’interface utilisateur.

    Type de données : chaîne
    item.product.sys_id Sys_id de l’enregistrement de modèle de produit associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.service_context Détails sur le contexte de service associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_context.display_value Détails sur le contexte de service associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_context.sys_id Sys_id de l’enregistrement de contexte de service associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.service_organization Détails sur l’organisation de services associée à l’enregistrement d’élément de base d’installation. Renvoyé uniquement si le module d’extension Organisation de services (com.snc.service_organization) est installé.

    Type de données : objet

    "service_organization": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_organization.display_value Nom de texte de l’organisation de services associée à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom de l’organisation de service dans l’interface utilisateur.

    Type de données : chaîne
    item.service_organization.sys_id Sys_id de l’enregistrement de l’organisation de services associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.sys_nom_classe Table contenant l’enregistrement de l’élément de base d’installation.

    Type de données : chaîne
    item.sys_id Sys_id de l’enregistrement de l’élément de base d’installation. Situé dans la table spécifiée dans le sys_class_name paramètre.

    Type de données : chaîne
    item.sys_mod_count Nombre de fois où l’enregistrement d’élément de base d’installation associé a été modifié.

    Type de données : chaîne
    élément.état Détails sur l’état actuel de l’élément de base d’installation.

    Type de données : objet

    "state": {
  "display_value": "String",
  "value": "String"
}
    item.state.display_value Chaîne de texte de l’état actuel de l’élément de base d’installation. Utilisez cette valeur pour afficher l’état dans l’interface utilisateur.

    Type de données : chaîne
    élément.état.valeur Valeur interne de l’état de l’élément de base d’installation.

    Type de données : chaîne
    élément.état Détails sur l’état de l’élément de base d’installation.

    Type de données : objet

    "status": {
  "display_value": "String",
  "value": "String"
}
    item.status.display_value Chaîne de texte de l’état de l’élément de base d’installation. Utilisez cette valeur pour afficher l’état dans l’interface utilisateur.

    Type de données : chaîne
    élément.état.valeur Valeur interne de l’état de l’élément de base d’installation.

    Type de données : chaîne
    item.uninstall_date Détails sur la date à laquelle l’élément de base d’installation est devenu inactif.

    Type de données : objet

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    item.uninstall_date.display_value Date de désinstallation du texte. Utilisez cette valeur pour afficher la date de désinstallation dans l’interface utilisateur.

    Type de données : chaîne
    item.uninstall_date.valeur Valeur interne de la date de désinstallation.

    Type de données : chaîne
    statut État de l’appel de point de terminaison.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison. L’élément de base d’installation associé n’a pas d’enfants.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitem/f77c7542b7343300ece839a6ee11a991" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Résultats renvoyés :

    {
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": "sn_install_base_item",
      "number": "IBITM0000901",
      "sys_id": "f77c7542b7343300ece839a6ee11a991",
      "product": {
        "sys_id": "8583ce8237732000158bbfc8bcbe5dd9",
        "display_value": "Fujitsu 1TB Hybrid Solid State Drive"
      },
      "active": "true",
      "name": "KX Series - KX5001",
      "account": {
        "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    },
    "hasChildren": "false"
  }
}

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison en spécifiant une profondeur maximale de quatre niveaux enfants.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/e0a80e4b87b521100b6afc86dabb3565?depth=4" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Résultats renvoyés :

    {
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": "sn_install_base_item",
      "number": "IBITM0001073",
      "sys_id": "e0a80e4b87b521100b6afc86dabb3565",
      "health_status": {
        "value": "not_available",
        "display_value": "Not Available"
      },
      "active": "true",
      "name": "parent",
      "account": {
        "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    },
    "hasChildren": "true",
    "childinstallbase": {
      "sysparm_depth": 2,
      "items": [
        {
          "parent": {
            "sys_id": "e0a80e4b87b521100b6afc86dabb3565",
            "display_value": "parent"
          },
          "sys_class_name": "sn_install_base_item",
          "number": "IBITM0001074",
          "sys_id": "6db80e4b87b521100b6afc86dabb356b",
          "state": {
            "value": "in_use",
            "display_value": "In Use"
          },
          "health_status": {
            "value": "not_available",
            "display_value": "Not Available"
          },
          "active": "true",
          "name": "child1",
          "account": {
            "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
            "display_value": "Boxeo"
          },
          "hasChildren": "true",
          "items": {
            "sysparm_depth": 3,
            "items": [
              {
                "parent": {
                  "sys_id": "6db80e4b87b521100b6afc86dabb356b",
                  "display_value": "child1"
                },
                "sys_class_name": "sn_install_base_item",
                "number": "IBITM0001075",
                "sys_id": "36ecce4b87b521100b6afc86dabb3503",
                "health_status": {
                  "value": "not_available",
                  "display_value": "Not Available"
                },
                "active": "true",
                "name": "childL2",
                "account": {
                  "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
                  "display_value": "Boxeo"
                },
                "hasChildren": "false"
              }
            ]
          }
        }
      ]
    }
  }
}

    Élément de base d’installation : GET /sn_install_base/integrations/installbaseitems/{id}/cases

    Renvoie les tickets associés à un enregistrement d’élément de base d’installation spécifié.

    Format d'URL

    URL versionnée : /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/cases

    URL par défaut : /api/sn_install_base/integrations/installbaseitems/{id}/cases

    Paramètres de demande pris en charge

    Tableau 19. 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 de l’élément de base d’installation. Situé dans la table Élément de base d’installation [sn_install_base_item].

    Type de données : chaîne
    Tableau 20. Paramètres de requête
    Nom Description
    Paires nom-valeur de champ Paires champ-valeur à utiliser pour filtrer les enregistrements de ticket. Par défaut, cela fait référence aux champs de la table Ticket [sn_customerservice_case]. Si vous spécifiez une autre table dans sys_class_name, spécifiez les champs de cette table.

    Vous pouvez transmettre une ou plusieurs paires champ-valeur pour filtrer les résultats renvoyés.

    Par exemple, pour renvoyer uniquement les enregistrements dans lesquels le champ d’approbation est défini sur « rejeté » et le champ de catégorie est défini sur « 2 », transmettez ce qui suit : &approval=rejected&category=2.

    Type de données : chaîne

    Par défaut : Tous les champs
    sys_class_name Si vous utilisez une table de ticket étendue (pas sn_customerservice_case), le nom de la table étendue à interroger.

    Type de données : chaîne

    Par défaut : sn_customerservice_case
    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.

    Cette limite est appliquée avant l'évaluation de l'ACL. Si aucun enregistrement n'est renvoyé (notamment ceux auxquels vous avez accès), réorganisez l'ordre des enregistrements pour que ceux auxquels vous avez accès soient renvoyés en premier.

    Remarque :
    Des valeurs sysparm_limit anormalement élevées peuvent avoir un impact sur les performances du système.

    Type de données : nombre

    Par défaut : 10 000
    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 sysparm_offset paramètre.

    Type de données : nombre

    Par défaut : 0
    Tableau 21. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Aucun

    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 22. 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 23. 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 24. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    403 Interdit. L’utilisateur ne possède pas les droits d’accès à l’enregistrement spécifié.
    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 du corps de réponse (JSON ou XML)

    Élément Description
    tickets Liste des tickets associés à l’enregistrement d’élément de base d’installation spécifié.

    Type de données : tableau d’objets

    "cases": [
  {
    "account": "String",
    "active": Boolean,
    "active_account_escalation": "String",
    "active_escalation": "String",
    "activity_due": "String",
    "additional_assignee_list": "String",
    "approval": "String",
    "approval_history": "String",
    "approval_set": "String",
    "asset": "String",
    "assigned_on": "String",
    "assigned_to": "String",
    "assignment_group": "String",
    "auto_close": Boolean,
    "business_duration": "String",
    "business_impact": "String",
    "business_service": "String",
    "calendar_duration": "String",
    "case": "String",
    "case_report": "String",
    "category": Number,
    "cause": "String",
    "caused_by": "String",
    "change": "String",
    "child_case_creation_progress": Boolean,
    "closed_at": "String",
    "closed_by": "String",
    "close_notes: "String",
    "cmdb_ci": "String",
    "comments": "String",
    "comments_and_work_notes": "String",
    "company": "String",
    "consumer": "String",
    "contact": "String",
    "contact_local_time: "String",
    "contact_time_zone": "String",
    "contact_type": "String",
    "contract": "String",
    "contributor_groups": "String",
    "contributor_users": "String",
    "correlation_display": "String",
    "correlation_id": "String",
    "delivery_plan": "String",
    "delivery_task": "String",
    "description": "string",
    "due_date": "String",
    "entitlement": "String",
    "escalation": Number,
    "expected_start": "String",
    "first_response_time": "String",
    "follow_the_sun": Boolean,
    "follow_up": "String",
    "group_list": [Array],
    "impact": Number,
    "internal_user": "String",
    "initiated_as_request": Boolean,
    "knowledge": Boolean,
    "location": "String",
    "made_sla": Boolean,
    "major_case_state": "String",
    "needs_attention": Boolean,
    "notes_to_comments": Boolean,
    "notify": Number,
    "number": "String",
    "opened_at": "String",
    "opened_by": "String",
    "order": Number,
    "parent": "String",
    "partner": "String",
    "partner_contact": "String",
    "priority": Number,
    "proactive": Boolean,
    "probable_cause": "String",
    "problem": "String",
    "product": "String",
    "reassignment_count": Number,
    "recipient_list": "String",
    "rejection_goto": "String",
    "resolution_code": "String",
    "resolved_at": "String",
    "resolved_by": "String",
    "route_reason": "String",
    "service_offering": "String",
    "short_description": "String",
    "skills": "String",
    "sla_due": "String",
    "sn_app_cs_social_social_profile": "String",
    "sold_product": "String",
    "stage": "String",
    "state": Number,
    "subcategory": Number,
    "support_manager" "String",
    "sync_driver": Boolean,
    "sys_class_name": "String",
    "sys_domain": "String",
    "sys_domain_path": "String",
    "sys_id": "String",
    "task_effective_number": "String",
    "time_worked": "String",
    "universal_request": "String",
    "upon_approval": "String",
    "upon_reject": "String",
    "urgency": Number,
    "user_input": "String",
    "variables":  "String",
    "watch_list": [Array],
    "wf_activity": "String",
    "work_end": "String",
    "work_notes": "String",
    "work_notes_list": [Array],
    "work_start": "String"
    Tickets.Compte Sys_id de l’enregistrement de compte associé au ticket. Situé dans la table Compte [customer_account].

    Type de données : chaîne
    Tickets.Actifs Marqueur indiquant si le ticket est ouvert et actif.

    Valeurs possibles :

    • true : le ticket est actif
    • false : le ticket est fermé

    Type de données : booléennes

    Valeur par défaut : true
    cases.active_account_escalation Sys_id de l’enregistrement d’escalade de compte actif associé au ticket. Situé dans la table Escalade [sn_customerservice_escalation].

    Type de données : chaîne
    cases.active_escalation Sys_id de l’enregistrement d’escalade actif associé au ticket. Situé dans la table Escalade [sn_customerservice_escalation].

    Type de données : chaîne
    cases.activity_due Date à laquelle le ticket associé est censé être terminé.

    Type de données : chaîne
    cases.additional_assignee_list Liste des sys_ids des personnes supplémentaires (autres que le délégataire principal) qui ont été affectées au compte. Situé dans la table Utilisateur [sys_user].

    Type de données : tableau

    Maximum : 4 000
    Tickets.Approbation Chaîne décrivant le type d’approbation requis.

    Valeurs possibles :

    • approuvé
    • annulé
    • dupliquer
    • not_required
    • non demandé
    • rejeté
    • Demandé

    Type de données : chaîne

    Nombre maximal de caractères : 40

    Par défaut : non demandé
    cases.approval_history Liste de toutes les approbations associées au ticket.

    Type de données : chaîne

    Nombre maximal de caractères : 4 000
    cases.approval_set Date et heure d’approbation de l’action associée.

    Type de données : chaîne
    Tickets.Actif Sys_id de l’enregistrement d’actif associé au ticket. Situé dans la table Actif [alm_asset].

    Type de données : chaîne
    cases.assigned_on Date et heure auxquelles le ticket a été affecté à la personne identifiée dans le assigned_to paramètre.

    Type de données : chaîne (date)

    Longueur maximale : 40
    cases.assigned_to Sys_id de la personne affectée au ticket. Situé dans la table Utilisateur [sys_user].

    Type de données : chaîne
    cases.assignment_group Sys_id du groupe d’agents du service clientèle affecté au ticket. Situé dans la table Groupe [sys_user_group].

    Type de données : chaîne
    cases.auto_close Marqueur indiquant si le ticket a été fermé automatiquement.

    Valeurs possibles :

    • true : le ticket a été fermé automatiquement
    • false : le ticket n’a pas été fermé automatiquement

    Type de données : booléennes

    Valeur par défaut : false
    cases.business_duration Durée en heures de travail, en jours de travail et en semaines de travail du calendrier nécessaire pour terminer le ticket.

    Type de données : chaîne
    cases.business_impact Impact du problème sur le client associé.

    Type de données : chaîne

    Nombre maximal de caractères : 4 000
    cases.business_service Sys_id de l’enregistrement de service associé au ticket. Situé dans la table Service [cmdb_ci_service].

    Type de données : chaîne
    cases.calendar_duration Durée en heures, en jours et en semaines calendaires nécessaire pour terminer le ticket.

    Type de données : chaîne (durée)

    Longueur maximale : 40
    Ticket.Ticket Description brève et numéro de ticket du ticket.

    Type de données : chaîne

    Longueur maximale : 300
    cases.case_report Sys_id du rapport de ticket associé. Situé dans la table Rapport de ticket [sn_customerservice_case_report].

    Type de données : chaîne
    Tickets.catégorie Catégorie de ticket.

    Valeurs possibles :

    • 0 : Question
    • 1 : Problème
    • 2 : Caractéristique

    Type de données : nombre (entier)

    Valeur par défaut : 1
    Tickets.Cause Détails sur la cause du problème.

    Type de données : chaîne

    Longueur maximale : 4 000
    cases.caused_by Sys_id de la demande de changement à l’origine de la création du ticket. Situé dans la table Demande de changement [change_request].

    Type de données : chaîne
    tickets.changement Sys_id de la demande de changement à l’origine de la création du ticket. Situé dans la table Demande de changement [change_request].

    Type de données : chaîne
    cases.child_case_creation_progress Marqueur indiquant s’il s’agit d’un ticket enfant créé à partir d’un ticket principal.

    Valeurs possibles :

    • true : ticket enfant créé à partir d’un ticket principal
    • false : ce n’est pas un ticket enfant

    Type de données : booléennes
    cases.closed_at Date et heure de fermeture du ticket.

    Type de données : chaîne
    cases.closed_by Sys_id de l’utilisateur qui a fermé le ticket. Situé dans la table Utilisateur [sys_user].

    Type de données : chaîne
    cases.close_notes Notes prises lors de la clôture du ticket.

    Type de données : chaîne

    Longueur maximale : 4 000
    cases.cmdb_ci Sys_id de l’élément de configuration associé au ticket. Situé dans la table Élément de configuration [cmdb_ci].

    Type de données : chaîne
    Tickets.Commentaires Commentaires supplémentaires sur le ticket.

    Type de données : chaîne

    Longueur maximale : 4 000
    cases.comments_and_work_notes Commentaires et notes de travail saisis pour le ticket.

    Type de données : chaîne

    Longueur maximale : 4 000
    Ticket.Société Sys_id de la société associée au ticket. Situé dans la table Société [core_company].

    Type de données : chaîne
    Tickets.Consommateur Tickets de l’entreprise au consommateur uniquement. Sys_id de la personne à contacter dans le cadre de ce dossier. Situé dans la table Consommateur [csm_consumer].

    Type de données : chaîne
    Tickets.Contact Tickets interentreprises uniquement. Sys_id de la personne à contacter concernant ce ticket. Situé dans la table Contact [customer_contact].

    Type de données : chaîne
    cases.contact_local_time Heure locale du contact.

    Type de données : chaîne

    Longueur maximale : 70
    cases.contact_time_zone Fuseau horaire du contact associé au ticket.

    Type de données : chaîne

    Longueur maximale : 40
    cases.contact_type Méthode par laquelle le ticket a été initialement signalé.
    Valeurs possibles :
    • messagerie instantanée
    • E-mail
    • Téléphone
    • social
    • Web

    Type de données : chaîne

    Longueur maximale : 40
    Tickets.Contrat Sys_id du contrat associé au ticket. Situé dans la table Contrat [ast_contract]. Ce contrat contient des informations sur le type de prise en charge fournie à la société associée au ticket. Un contrat peut inclure une société et un contact, ainsi que les actifs spécifiques couverts. Un contrat peut également inclure plusieurs autorisations de service et SLA.

    Type de données : chaîne
    cases.contributor_groups Liste des sys_ids des groupes d’utilisateurs qui ont contribué au ticket. Situé dans la table Groupe [sys_user_group].

    Type de données : chaîne
    cases.contributor_users Liste des sys_ids des utilisateurs qui ont contribué au ticket. Situé dans la table Utilisateur [sys_user].

    Type de données : chaîne
    cases.correlation_display Affichage de corrélation.

    Type de données : chaîne

    Longueur maximale : 100
    cases.correlation_id Identificateur de corrélation.

    Type de données : chaîne

    Longueur maximale : 100
    cases.delivery_plan Sys_id du plan d’exécution parent pour ce ticket. Situé dans la table Plan d’exécution [sc_cat_item_delivery_plan].

    Type de données : chaîne
    cases.delivery_task Sys_id de la tâche de plan d’exécution. Situé dans la table Tâche de plan d’exécution [sc_cat_item_delivery_task].

    Type de données : chaîne
    Tickets.Description Description détaillée du problème associé au ticket.

    Type de données : chaîne

    Longueur maximale : 4 000
    cases.due_date Date à laquelle le ticket doit être fermé.

    Type de données : chaîne
    Tickets.Autorisation Sys_id de l’enregistrement d’autorisation associé au ticket. Situé dans la table Autorisation [service_entitlement]. Les autorisations définissent le type de prise en charge qu’un client reçoit, ainsi que les canaux de communication pris en charge. Une autorisation peut être associée à un produit, un actif, un compte ou un contrat.

    Type de données : chaîne
    Ticket.Escalade Niveau d'escalade actuel.

    Valeurs possibles :

    • 0 : normal
    • 1 : Modéré
    • 2 : Élevé
    • 3 : En retard

    Type de données : nombre (entier)

    Par défaut : 0
    cases.expected_start Date et heure planifiées pour le début du travail sur le ticket.

    Type de données : chaîne
    cases.first_response_time Date et heure auxquelles la première action a été effectuée sur le ticket.

    Type de données : chaîne
    cases.follow_the_sun Marqueur indiquant si le ticket doit être transféré pour un suivi global.

    Si un client entre des commentaires supplémentaires sur un ticket de priorité 1 - critique ou de priorité 2 - élevée, ou si le ticket est escaladé, le marqueur est automatiquement défini sur vrai.

    Valeurs possibles :

    • true : le ticket doit être transféré pour un suivi global
    • false : le ticket ne doit pas être transféré pour un suivi global

    Type de données : booléennes

    Valeur par défaut : false
    cases.follow_up Date et heure de la prochaine action de suivi.

    Type de données : chaîne
    cases.group_list Liste des sys_ids des enregistrements de groupe associés au ticket. Situé dans la table Groupe [sys_user_group].

    Type de données : tableau
    Tickets.Impact Impact sur le client.

    Valeurs possibles :

    • 1 : Élevé
    • 2 : Moyen
    • 3 : Faible

    Type de données : nombre (entier)

    Par défaut : 3
    cases.internal_user Sys_id de l’utilisateur interne pour ce ticket. Situé dans la table Utilisateur [sys_user].

    Type de données : chaîne
    cases.initiated_as_request Marqueur indiquant si cette demande a été initiée en tant que requête par le client.

    Valeurs possibles :

    • true : demande initiée par le client.
    • faux : la demande n’a pas été initiée par le client.

    Type de données : booléennes

    Valeur par défaut : false
    Tickets.Connaissances Marqueur indiquant si un article de la base de connaissances est disponible pour le problème spécifié.

    Valeurs possibles :

    • vrai : un article de la base de connaissances est disponible pour ce problème
    • faux : l’article de la base de connaissances n’est pas disponible pour ce problème

    Type de données : booléennes

    Valeur par défaut : false
    Tickets.Emplacement Sys_id de l’enregistrement décrivant l’emplacement de la société. Situé dans la table Emplacement [cmn_location].

    Type de données : chaîne
    cases.made_sla Marqueur indiquant si le ticket a été résolu conformément à l’accord sur les niveaux de service associé.

    Valeurs possibles :

    • vrai : le ticket a été résolu conformément au SLA
    • false : le ticket n’a pas été résolu conformément au SLA

    Type de données : booléennes

    Valeur par défaut : true
    cases.major_case_state État actuel du ticket principal.

    Valeurs possibles :

    • accepté : état initial lorsqu’un gestionnaire crée un ticket principal ou lorsqu’un gestionnaire promeut un ticket candidat.
    • annulé : le ticket est annulé.
    • proposé : état initial lorsqu’un agent ou un gestionnaire crée ou propose un ticket candidat.
    • rejeté : le gestionnaire a rejeté le ticket du candidat.

    Type de données : chaîne

    Longueur maximale : 40
    needs_attention Marqueur indiquant si le ticket requiert une attention.

    Valeurs possibles :

    • true : le ticket nécessite une attention supplémentaire
    • false : le ticket ne nécessite pas d’attention supplémentaire

    Type de données : booléennes

    Valeur par défaut : false
    cases.notes_to_comments Marqueur indiquant s’il faut ajouter les notes de résolution aux commentaires.

    Valeurs possibles :

    • true : les notes de résolution, lorsqu’elles sont ajoutées, sont également ajoutées aux commentaires
    • faux : les notes de résolution dans les commentaires ne sont pas requises

    Type de données : booléennes
    Tickets.Notification Méthode à utiliser pour notifier le contact/consommateur.

    Valeurs possibles :

    • 1 : Ne pas notifier
    • 2 : Envoyer un e-mail
    • 3 : Téléphone

    Type de données : nombre (entier)

    Valeur par défaut : 1
    numéro.tickets Numéro du ticket.

    Type de données : chaîne

    Longueur maximale : 40
    cases.opened_at Date et heure d’ouverture du ticket.

    Type de données : chaîne
    cases.opened_by Sys_id de la personne qui a initialement ouvert le ticket. Situé dans la table Utilisateur [sys_user].

    Type de données : chaîne
    Tickets.Ordre Ordre de l’affaire.

    Type de données : nombre (entier)
    Tickets.Parent Sys_id du ticket parent auquel ce ticket (enfant) est associé. Situé dans la table Tâche [task].

    Type de données : chaîne
    Dossiers.Partenaire Sys_id du partenaire associé au ticket. Situé dans la table Compte [customer_account].

    Type de données : chaîne
    cases.partner_contact Sys_id du contact du partenaire associé au ticket. Situé dans la table Contact [customer_contact].

    Type de données : chaîne
    Tickets.Priorité Priorité du ticket.
    Valeurs possibles :
    • 1 : critique
    • 2 : Élevé
    • 3 : Modéré
    • 4 : Faible

    Type de données : nombre (entier)

    Par défaut : 4
    tickets.proactifs Marqueur indiquant si la demande fait l’objet d’une surveillance proactive.

    Valeurs possibles :

    • true : être surveillé de manière proactive.
    • false : non surveillé.

    Type de données : booléennes

    Par défaut : faux
    cases.probable_cause Cause possible du problème associé au ticket.

    Type de données : chaîne

    Longueur maximale : 4 000
    tickets.problème Sys_id du problème rencontré par le client. Situé dans la table Problème [problem].

    Type de données : chaîne
    Tickets.Produit Sys_id du modèle de produit de la ressource associée au ticket. Situé dans la table Modèle de produit [cmdb_model]. Un modèle est une version ou une configuration spécifique d'un actif (par exemple, Apple Mac Book Pro).

    Type de données : chaîne
    cases.reassignment_count Nombre de fois où le ticket a été réaffecté à une personne chargée de faire avancer le ticket.

    Type de données : nombre (entier)

    Par défaut : 0
    cases.recipient_list Sys_id de l’enregistrement qui contient la liste des destinataires des communications relatives à ce ticket. Situé dans la table Liste des destinataires [sn_publications_recipients_list].

    Type de données : chaîne
    cases.rejection_goto Sys_id de la tâche à exécuter si le ticket est rejeté. Situé dans la table Tâche [task].

    Type de données : chaîne
    cases.resolution_code État de résolution du ticket, tel que « Résolu : corrigé par le support/les conseils fournis ».

    Type de données : chaîne

    Longueur maximale : 40
    cases.resolved_at Date et heure auxquelles le ticket a été résolu.

    Type de données : chaîne
    cases.resolved_by Sys_id de la personne qui a résolu le ticket. Situé dans la table Utilisateur [sys_user].

    Type de données : chaîne
    cases.route_reason Motif pour lequel le ticket a été acheminé vers un autre délégataire.

    Type de données : nombre (entier)

    Longueur maximale : 40
    cases.service_offering Sys_id de l’offre de service associée à la demande de paiement. Les offres de service définissent uniquement le niveau de service en termes de disponibilité, de portée, de tarification et d’options de package. Situé dans la table Offre de service [service_offering].

    Type de données : chaîne
    cases.short_description Description succincte du ticket.

    Type de données : chaîne

    Longueur maximale : 160
    Tickets.Compétences Liste des identifiants uniques (sys_id) des compétences nécessaires pour terminer le ticket. Situé dans la table Compétence [cmn_skill].

    Type de données : chaîne
    cases.sla_due Date/heure à laquelle le ticket doit être fermé en fonction de l’accord sur les niveaux de service associé.

    Type de données : chaîne
    cases.sn_app_cs_social_social_profile Sys_id du profil de réseau social associé au ticket. Situé dans la table Profil social [sn_app_cs_social_social_profile].

    Type de données : chaîne
    cases.sold_product Sys_id du produit associé. Situé dans la table Produit vendu [sn_install_base_sold_product].

    Type de données : chaîne
    Tickets.Étape Étape de la demande, telle que Fermé terminé, Fermé rejeté, Vérification des documents, Autorisation, etc.

    Type de données : chaîne

    Longueur maximale : 40
    Tickets.État État actuel du ticket.

    Valeurs possibles :

    • 1 : Nouveau
    • 3 : Fermé
    • 6 : Résolu
    • 10 : Ouvert
    • 18 : En attente d’infos

    Type de données : nombre (entier)

    Valeur par défaut : 1
    Tickets.Sous-catégorie Sous-catégorie du ticket.

    Valeurs possibles :

    0 : Question

    Type de données : nombre (entier)

    Par défaut : 0
    cases.support_manager Sys_id du gestionnaire CSM affecté au ticket. Situé dans la table Utilisateur [sys_user].

    Type de données : chaîne
    cases.sync_driver Marqueur indiquant s’il y a synchronisation du pilote.

    Valeurs possibles :

    • true : le pilote est synchronisé
    • false : le pilote n’est pas synchronisé

    Type de données : booléennes
    cases.sys_nom_classe Table contenant l’enregistrement du ticket.

    Type de données : chaîne

    Longueur maximale : 80
    cases.sys_domaine Domaine associé au ticket.

    Type de données : chaîne

    Longueur maximale : 32

    Par défaut : global
    cases.sys_domain_path Chemin de domaine.

    Type de données : chaîne

    Longueur maximale : 255

    Faire défaut:/
    cases.sys_id Identificateur unique du ticket.

    Type de données : chaîne

    Longueur maximale : 32
    cases.task_effective_number Numéro d’identification.

    Si une demande universelle est associée à la tâche, il s’agit du numéro UR. Sinon, il s’agit du numéro de la tâche actuelle.

    Type de données : chaîne

    Longueur maximale : 40
    cases.time_worked Durée totale de travail sur le ticket.

    Type de données : chaîne
    cases.universal_request Sys_id d’une tâche universelle dont cette enquête fait partie. Situé dans la table Tâche [task].

    Type de données : chaîne
    cases.upon_approval Action à exécuter si le ticket est approuvé.

    Valeurs possibles :

    • do_nothing
    • procéder

    Type de données : chaîne

    Longueur maximale : 40

    Par défaut : poursuivre
    cases.upon_reject Action à prendre si le ticket est rejeté.

    Valeurs possibles :

    • annuler
    • goto

    Type de données : chaîne

    Longueur maximale : 40

    Par défaut : annuler
    Tickets.Urgence Urgence de l’affaire.

    Valeurs possibles :

    • 1 : Élevé
    • 2 : Moyen
    • 3 : Faible

    Type de données : nombre (entier)

    Par défaut : 3
    cases.user_input Entrée utilisateur supplémentaire.

    Type de données : chaîne

    Longueur maximale : 4 000
    Tickets.Variables Paires nom-valeur de variables associées au ticket.

    Type de données : chaîne

    Longueur maximale : 40
    cases.watch_list Liste des sys_ids des utilisateurs qui reçoivent des notifications concernant ce ticket lorsque des commentaires supplémentaires sont ajoutés ou si l’état d’un ticket est défini sur Résolu ou Fermé. Situé dans la table Utilisateur [sys_user].

    Type de données : tableau
    cases.wf_activity Sys_id de l’enregistrement d’activité de workflow associé au ticket. Situé dans la table Activité du workflow [wf_activity].

    Type de données : chaîne
    cases.work_end Date et heure de fin du travail sur le ticket.

    Type de données : chaîne
    cases.work_notes Informations sur la façon de résoudre le ticket ou les mesures prises pour le résoudre.

    Type de données : chaîne

    Longueur maximale : 4 000
    cases.work_notes_list Liste des sys_ids des utilisateurs internes qui reçoivent des notifications sur ce ticket lorsque des notes de travail sont ajoutées. Situé dans la table Utilisateur [sys_user].

    Type de données : tableau
    cases.work_start Date et heure auxquelles le travail sur le ticket a commencé.

    Type de données : chaîne
    has_more Marqueur indiquant s’il existe d’autres enregistrements dans la table à renvoyer.
    Valeurs possibles :
    • true : plus d’enregistrements à renvoyer.
    • false : plus aucun enregistrement à renvoyer.

    Type de données : chaîne booléenne
    statut État de l’appel de point de terminaison.

    Type de données : chaîne
    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

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/1474a3c853500010df5dddeeff7b12ec/cases" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Résultats renvoyés :

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "cases": [
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "CS0001034",
        "initiated_as_request": "0",
        "state": "1",
        "case": "Performance is impacted with latest update​CS0001034",
        "knowledge": "0",
        "impact": "3",
        "contract": {
          "sys_id": "495e16b96f0731003b3c498f5d3ee4af",
          "display_value": "CNTR0000603"
        },
        "active": "1",
        "auto_created_case": "0",
        "priority": "4",
        "sys_domain_path": "/",
        "child_case_creation_progress": "0",
        "sync_driver": "0",
        "needs_attention": "0",
        "short_description": "Performance is impacted with latest update",
        "notify": "1",
        "sys_class_name": "sn_customerservice_case",
        "reassignment_count": "0",
        "notes_to_comments": "0",
        "hierarchical_variables": "variable_pool",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "made_sla": "1",
        "task_effective_number": "CS0001034",
        "opened_by": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "contact": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "follow_the_sun": "0",
        "entitlement": {
          "sys_id": "1eb7893a6f1b31003b3c498f5d3ee4dd",
          "display_value": "24x7 Customer Support"
        },
        "opened_at": {
          "value": "2023-03-20 14:53:51",
          "display_value": "2023-03-20 07:53:51"
        },
        "case_report": {
          "sys_id": "85e8604c87f521100b6afc86dabb35b9",
          "display_value": "CSR0010014"
        },
        "subcategory": "0",
        "install_base": {
          "sys_id": "1474a3c853500010df5dddeeff7b12ec",
          "display_value": "Boxeo - Development"
        },
        "proactive": "0",
        "auto_close": "0",
        "sys_id": "92c8684087b521105d0055373cbb357e",
        "contact_type": {
          "value": "web",
          "display_value": "Web"
        },
        "urgency": "3",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "category": "1",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      },
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "CS0001008",
        "initiated_as_request": "0",
        "state": "1",
        "case": "Test Alert​CS0001008",
        "knowledge": "0",
        "impact": "3",
        "active": "1",
        "auto_created_case": "0",
        "priority": "1",
        "sys_domain_path": "/",
        "child_case_creation_progress": "0",
        "sync_driver": "0",
        "needs_attention": "1",
        "short_description": "Test Alert",
        "notify": "1",
        "sys_class_name": "sn_customerservice_case",
        "reassignment_count": "0",
        "notes_to_comments": "0",
        "hierarchical_variables": "variable_pool",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "made_sla": "1",
        "task_effective_number": "CS0001008",
        "opened_by": {
          "sys_id": "08c83021acbe7300964fca436af2bb97",
          "display_value": "noc_operator "
        },
        "follow_the_sun": "0",
        "opened_at": {
          "value": "2023-03-15 08:02:58",
          "display_value": "2023-03-15 01:02:58"
        },
        "case_report": {
          "sys_id": "a4fa9d9a872d61105d0055373cbb356e",
          "display_value": "CSR0010005"
        },
        "subcategory": "0",
        "proactive": "1",
        "auto_close": "0",
        "sys_id": "60ea199a872d61105d0055373cbb35c9",
        "contact_type": {
          "value": "proactive",
          "display_value": "Alert"
        },
        "alert": {
          "sys_id": "506a559a872d61105d0055373cbb3581",
          "display_value": "Alert0010008"
        },
        "urgency": "3",
        "action_status": "4",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "category": "1"
      },
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "CS0001033",
        "initiated_as_request": "0",
        "state": "1",
        "case": "System is down​CS0001033",
        "knowledge": "0",
        "impact": "3",
        "contract": {
          "sys_id": "495e16b96f0731003b3c498f5d3ee4af",
          "display_value": "CNTR0000603"
        },
        "active": "1",
        "auto_created_case": "0",
        "priority": "4",
        "sys_domain_path": "/",
        "child_case_creation_progress": "0",
        "sync_driver": "0",
        "needs_attention": "0",
        "short_description": "System is down",
        "notify": "1",
        "sys_class_name": "sn_customerservice_case",
        "reassignment_count": "0",
        "notes_to_comments": "0",
        "hierarchical_variables": "variable_pool",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "made_sla": "1",
        "task_effective_number": "CS0001033",
        "opened_by": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "contact": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "follow_the_sun": "0",
        "entitlement": {
          "sys_id": "1eb7893a6f1b31003b3c498f5d3ee4dd",
          "display_value": "24x7 Customer Support"
        },
        "opened_at": {
          "value": "2023-03-20 14:52:48",
          "display_value": "2023-03-20 07:52:48"
        },
        "case_report": {
          "sys_id": "64b86c0c87f521100b6afc86dabb35fc",
          "display_value": "CSR0010013"
        },
        "subcategory": "0",
        "install_base": {
          "sys_id": "1474a3c853500010df5dddeeff7b12ec",
          "display_value": "Boxeo - Development"
        },
        "proactive": "0",
        "auto_close": "0",
        "sys_id": "7c98a04087b521105d0055373cbb352e",
        "contact_type": {
          "value": "web",
          "display_value": "Web"
        },
        "urgency": "3",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "category": "1",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      },
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "CS0001048",
        "initiated_as_request": "0",
        "state": "1",
        "case": "AIB with Single account​CS0001048",
        "knowledge": "0",
        "impact": "3",
        "active": "1",
        "auto_created_case": "0",
        "priority": "4",
        "sys_domain_path": "/",
        "child_case_creation_progress": "0",
        "sync_driver": "0",
        "needs_attention": "1",
        "short_description": "AIB with Single account",
        "notify": "1",
        "sys_class_name": "sn_customerservice_case",
        "reassignment_count": "0",
        "notes_to_comments": "0",
        "hierarchical_variables": "variable_pool",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "made_sla": "1",
        "task_effective_number": "CS0001048",
        "opened_by": {
          "sys_id": "08c83021acbe7300964fca436af2bb97",
          "display_value": "noc_operator "
        },
        "contact": {
          "sys_id": "4d147a386f0331003b3c498f5d3ee437",
          "display_value": "Julie Lewis"
        },
        "follow_the_sun": "0",
        "opened_at": {
          "value": "2023-03-24 03:28:58",
          "display_value": "2023-03-23 20:28:58"
        },
        "case_report": {
          "sys_id": "4082be81877161100b6afc86dabb35fe",
          "display_value": "CSR0010023"
        },
        "subcategory": "0",
        "proactive": "1",
        "auto_close": "0",
        "sys_id": "6a723e81877161100b6afc86dabb35cf",
        "contact_type": {
          "value": "proactive",
          "display_value": "Alert"
        },
        "alert": {
          "sys_id": "6b227681877161100b6afc86dabb35d5",
          "display_value": "Alert0010094"
        },
        "urgency": "3",
        "action_status": "4",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "category": "1",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Élément de base d’installation : GET /sn_install_base/integrations/installbaseitems/{id}/childinstallbaseitems

    Renvoie les éléments de base d’installation enfants associés à un enregistrement d’élément de base d’installation spécifié.

    Format d'URL

    URL versionnée : /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/childinstallbaseitems

    URL par défaut : /api/sn_install_base/integrations/installbaseitems/{id}/childinstallbaseitems

    Paramètres de demande pris en charge

    Tableau 25. 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 de l’élément de base d’installation. Situé dans la table Élément de base d’installation [sn_install_base_item].

    Type de données : chaîne
    Tableau 26. Paramètres de requête
    Nom Description
    Paires nom-valeur de champ Paires champ-valeur à utiliser pour filtrer les enregistrements d’éléments de base d’installation enfants. Situé dans la table Élément de base d’installation [sn_install_base_item]. Si vous spécifiez une autre table dans sys_class_name, spécifiez les champs de cette table.

    Vous pouvez transmettre une ou plusieurs paires champ-valeur pour filtrer les résultats renvoyés.

    Par exemple, pour renvoyer uniquement les enregistrements dont le champ d’état est défini sur « in_use » et le champ d’état est défini sur « remplacement », transmettez ce qui suit : &state=in_use&status=replacement.

    Type de données : chaîne

    Par défaut : Tous les champs
    sys_class_name En cas d’utilisation d’une table d’éléments de base d’installation étendue (et non sn_install_base_item), nom de la table étendue à interroger.

    Type de données : chaîne

    Par défaut : sn_install_base_item
    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.

    Cette limite est appliquée avant l'évaluation de l'ACL. Si aucun enregistrement n'est renvoyé (notamment ceux auxquels vous avez accès), réorganisez l'ordre des enregistrements pour que ceux auxquels vous avez accès soient renvoyés en premier.

    Remarque :
    Des valeurs sysparm_limit anormalement élevées peuvent avoir un impact sur les performances du système.

    Type de données : nombre

    Par défaut : 10 000
    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 sysparm_offset paramètre.

    Type de données : nombre

    Par défaut : 0
    Tableau 27. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Aucun

    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 28. 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 29. 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 30. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    403 Interdit. L’utilisateur ne possède pas les droits d’accès à l’enregistrement spécifié.
    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 du corps de réponse (JSON ou XML)

    Nom Description
    erreur Détails sur l’erreur qui s’est produite lors de la tentative de traitement de la demande.

    Type de données : objet

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Détails supplémentaires sur l’erreur associée.

    Type de données : chaîne
    message.erreur Message d’erreur qui décrit le problème qui s’est produit lors de la tentative d’exécution de la demande.

    Type de données : chaîne
    has_more Marqueur indiquant s’il existe d’autres enregistrements dans la table à renvoyer.
    Valeurs possibles :
    • true : plus d’enregistrements à renvoyer.
    • false : plus aucun enregistrement à renvoyer.

    Type de données : chaîne booléenne
    Éléments Liste des éléments de base d’installation qui correspondaient aux résultats de filtre spécifiés.

    Type de données : tableau d’objets

    "items":[
  {
    "account": {Object},
    "active": "String",
    "asset": {Object},
    "configuration_item": {Object},
    "consumer": {Object},
    "consumer_profile": {Object},
    "contact": {Object},
    "health_status": {Object},
    "health_status_last_updated": "String",
    "household": {Object},
    "install_date": {Object},
    "location": {Object},
    "name": "String",
    "number": "String",
    "parent": {Object},
    "product": {Object},
    "service_context": {Object},
    "service_organization" {Object},
    "sys_class_name": "String",
    "sys_id": "String",
    "sys_mod_count": "String",
    "state": {Object},
    "status": {Object},
    "uninstall_date": "String"
  }
]
    Articles.Compte Détails sur le compte client associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    items.account.display_value Nom de texte du compte client associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du compte client dans l’interface utilisateur.

    Type de données : chaîne
    items.account.sys_id Sys_id de l’enregistrement de compte client associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    éléments.actif Marqueur indiquant si l’élément de base d’installation est actif.
    Valeurs possibles :
    • vrai : l’élément de base d’installation est actif.
    • faux : l’élément de base d’installation est inactif.

    Type de données : chaîne booléenne
    Éléments.Actif Détails sur l’actif associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "asset": {
  "display_value": "String",
  "sys_id": "String"
}
    items.asset.display_value Nom de texte de l’actif associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom de la ressource dans l’interface utilisateur.

    Type de données : chaîne
    items.asset.sys_id Sys_id de l’enregistrement d’actif associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    items.configuration_item Détails sur l’élément de configuration associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "configuration_item": {
  "display_value": "String",
  "sys_id": "String"
}
    items.configuration_item.display_value Nom de texte de l’élément de configuration associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom de l’élément de configuration dans l’interface utilisateur.

    Type de données : chaîne
    items.configuration_item.sys_id Sys_id de l’enregistrement d’élément de configuration associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    Articles.Consommateur Détails sur le consommateur associé à l’enregistrement d’élément de base d’installation.
    Remarque :
    Le champ consommateur n’est disponible que si le module d’extension B2B2C est installé.

    Type de données : objet

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    items.consumer.display_value Nom de texte du consommateur associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du consommateur dans l’interface utilisateur.

    Type de données : chaîne
    items.consumer.sys_id Sys_id de l’enregistrement de consommateur associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    items.consumer_profile Détails sur le profil de consommateur associé à l’enregistrement d’élément de base d’installation.
    Remarque :
    Le champ Profil du consommateur n’est disponible que si le module d’extension B2B2C est installé.

    Type de données : objet

    "consumer_profile": {
  "display_value": "String",
  "sys_id": "String"
}
    items.consumer_profile.display_value Nom de texte du profil de consommateur associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du profil du consommateur dans l’interface utilisateur.

    Type de données : chaîne
    items.consumer_profile.sys_id Sys_id de l’enregistrement de profil de consommateur associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    articles.contact Détails sur le contact de compte responsable de l’enregistrement de l’élément de base d’installation.

    Type de données : objet

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    items.contact.display_value Nom de texte du contact du compte associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du contact du compte dans l’interface utilisateur.

    Type de données : chaîne
    items.contact.sys_id Sys_id de l’enregistrement de contact de compte associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    items.health_status Détails sur l’état d’intégrité actuel de l’élément de base d’installation. Uniquement renvoyé si le module d’extension Proactive Customer Service Operations (com.snc.proactive_cs_itom) est installé.

    Type de données : objet

    "health_status": {
  "display_value": "String",
  "value": "String"
}
    items.health_status.display_value Chaîne de texte de l’état d’intégrité actuel de l’élément de base d’installation. Utilisez cette valeur pour afficher l’état d’intégrité dans l’interface utilisateur.

    Type de données : chaîne
    items.health_status.valeur Valeur interne de l’état d’intégrité de l’élément de base d’installation.

    Type de données : chaîne
    items.health_status_last_updated Date et heure auxquelles l’état d’intégrité a été mis à jour pour la dernière fois pour l’élément de base d’installation.

    Type de données : chaîne
    Articles.Ménage Détails sur le ménage associé à l’enregistrement d’élément de base d’installation. Renvoyé uniquement si le module d’extension Service clientèle Household (com.snc.household) est installé.

    Type de données : objet

    "household": {
  "display_value": "String",
  "sys_id": "String"
}
    items.household.display_value Nom de texte du ménage associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du ménage dans l’interface utilisateur.

    Type de données : chaîne
    items.household.sys_id Sys_id du ménage associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    items.install_date Détails sur la date à laquelle l’élément de base d’installation est devenu actif.

    Type de données : objet

    "install_date": {
  "display_value": "String",
  "value": "String"
}
    items.install_date.display_value Date d’installation du texte. Utilisez cette valeur pour afficher la date d’installation dans l’interface utilisateur.

    Type de données : chaîne
    items.install_date.valeur Valeur interne de la date d’installation.

    Type de données : chaîne
    Éléments.Emplacement Détails sur l’emplacement de l’élément de base d’installation.

    Type de données : objet

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    items.location.display_value Nom de texte de l’emplacement de l’élément de base d’installation. Utilisez cette valeur pour afficher le nom de l’emplacement dans l’interface utilisateur.

    Type de données : chaîne
    items.location.sys_id Sys_id de l’enregistrement d’emplacement associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    items.name Nom de l'élément de base d'installation.

    Type de données : chaîne
    nombre d’éléments.nombre ID unique de l'élément de base d'installation.

    Type de données : chaîne
    articles.parent Détails sur l’enregistrement parent de l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "parent": {
  "display_value": "String",
  "sys_id": "String"
}
    items.parent.display_value Nom de texte de l’enregistrement parent associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom parent dans l’interface utilisateur.

    Type de données : chaîne
    items.parent.sys_id Sys_id de l’enregistrement parent associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    articles.produit Détails sur le modèle de produit associé à l’enregistrement de l’élément de base d’installation. Utilisez ces informations pour identifier les services associés à n’importe quel modèle de produit.

    Type de données : objet

    "product": {
  "display_value": "String",
  "sys_id": "String"
}
    items.product.display_value Nom de texte du modèle de produit associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du produit dans l’interface utilisateur.

    Type de données : chaîne
    items.product.sys_id Sys_id de l’enregistrement de modèle de produit associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    items.service_context Détails sur le contexte de service associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    items.service_context.display_value Nom de texte du contexte de service associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du contexte de service dans l’interface utilisateur.

    Type de données : chaîne
    items.service_context.sys_id Sys_id de l’enregistrement de contexte de service associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    items.service_organization Détails sur l’organisation de services associée à l’enregistrement d’élément de base d’installation. Renvoyé uniquement si le module d’extension Organisation de services (com.snc.service_organization) est installé.

    Type de données : objet

    "service_organization": {
  "display_value": "String",
  "sys_id": "String"
}
    items.service_organization.display_value Nom de texte de l’organisation de services associée à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom de l’organisation de service dans l’interface utilisateur.

    Type de données : chaîne
    items.service_organization.sys_id Sys_id de l’enregistrement de l’organisation de services associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    items.sys_nom_de_classe Table contenant l’enregistrement de l’élément de base d’installation.

    Type de données : chaîne
    items.sys_id Sys_id de l’enregistrement de l’élément de base d’installation. Situé dans la table spécifiée dans le sys_class_name paramètre.

    Type de données : chaîne
    items.sys_mod_count Nombre de fois où l’enregistrement d’élément de base d’installation associé a été modifié.

    Type de données : chaîne
    Éléments.État Détails sur l’état actuel de l’élément de base d’installation.

    Type de données : objet

    "state": {
  "display_value": "String",
  "value": "String"
}
    items.state.display_value Chaîne de texte de l’état actuel de l’élément de base d’installation. Utilisez cette valeur pour afficher l’état dans l’interface utilisateur.

    Type de données : chaîne
    éléments.état.valeur Valeur interne de l’état de l’élément de base d’installation.

    Type de données : chaîne
    Éléments.Statut Détails sur l’état de l’élément de base d’installation.

    Type de données : objet

    "status": {
  "display_value": "String",
  "value": "String"
}
    items.status.display_value Chaîne de texte de l’état de l’élément de base d’installation. Utilisez cette valeur pour afficher l’état dans l’interface utilisateur.

    Type de données : chaîne
    éléments.état.valeur Valeur interne de l’état de l’élément de base d’installation.

    Type de données : chaîne
    items.uninstall_date Détails sur la date à laquelle l’élément de base d’installation est devenu inactif.

    Type de données : objet

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    items.uninstall_date.display_value Date de désinstallation du texte. Utilisez cette valeur pour afficher la date de désinstallation dans l’interface utilisateur.

    Type de données : chaîne
    items.uninstall_date.valeur Valeur interne de la date de désinstallation.

    Type de données : chaîne
    statut État de l’appel de point de terminaison.

    Type de données : chaîne
    sysparm_depth Nombre de niveaux de profondeur de l’élément de base d’installation enfant renvoyé dans la hiérarchie.

    Type de données : entier
    sysparm_limit Nombre d’enregistrements qui ont été renvoyés. Si cette valeur n’est pas spécifiée dans la demande d’origine, elle utilise la valeur par défaut.

    Type de données : nombre
    sysparm_offset Décalage (point de départ) dans la table associée à partir de laquelle les enregistrements ont été évalués et récupérés.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/767f34d378d21110f877d304c76fdd2a/childinstallbaseitems?sysparm_limit=1" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Résultats renvoyés :

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 1,
    "has_more": true,
    "items": [
      {
        "parent": {
          "sys_id": "767f34d378d21110f877d304c76fdd2a",
          "display_value": "X5 Sport Utility 4D"
        },
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001005",
        "sys_id": "0704dfcc39265110f87734024cfbc222",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "consumer": {
          "sys_id": "bab5139ab3401010700b4d43c6a8dc41",
          "display_value": "Charles Barkley"
        },
        "product": {
          "sys_id": "56c84f0439265110f87734024cfbc233",
          "display_value": "Electric Power-Assist Speed-Sensing Steering"
        },
        "active": "true",
        "name": "Electric Power-Assist Speed-Sensing Steering",
        "status": {
          "value": "original",
          "display_value": "Original"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Élément de base d’installation : GET /sn_install_base/integrations/installbaseitems/{id}/contracts

    Renvoie les contrats associés à un enregistrement d’élément de base d’installation spécifié.

    Format d'URL

    URL versionnée : /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/contracts

    URL par défaut : /api/sn_install_base/integrations/installbaseitems/{id}/contracts

    Paramètres de demande pris en charge

    Tableau 31. 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 de l’élément de base d’installation. Situé dans la table Élément de base d’installation [sn_install_base_item].

    Type de données : chaîne
    Tableau 32. Paramètres de requête
    Nom Description
    Paires nom-valeur de champ Paires champ-valeur à utiliser pour filtrer les enregistrements de contrat. Par défaut, il s’agit des champs de la table Contrat [ast_contract]. Si vous spécifiez une autre table dans sys_class_name, spécifiez les champs de cette table.

    Vous pouvez transmettre une ou plusieurs paires champ-valeur pour filtrer les résultats renvoyés.

    Par exemple, pour renvoyer uniquement les enregistrements dans lesquels le champ renouvelable est défini sur « vrai », transmettez ce qui suit : &renewable=true.

    Type de données : chaîne

    Par défaut : Tous les champs
    sys_class_name Si vous utilisez une table de contrats étendus (et non ast_contract), nom de la table étendue à interroger.

    Type de données : chaîne

    Par défaut : ast_contract
    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.

    Cette limite est appliquée avant l'évaluation de l'ACL. Si aucun enregistrement n'est renvoyé (notamment ceux auxquels vous avez accès), réorganisez l'ordre des enregistrements pour que ceux auxquels vous avez accès soient renvoyés en premier.

    Remarque :
    Des valeurs sysparm_limit anormalement élevées peuvent avoir un impact sur les performances du système.

    Type de données : nombre

    Par défaut : 10 000
    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 sysparm_offset paramètre.

    Type de données : nombre

    Par défaut : 0
    Tableau 33. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Aucun

    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 34. 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 35. 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 36. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    403 Interdit. L’utilisateur ne possède pas les droits d’accès à l’enregistrement spécifié.
    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 du corps de réponse (JSON ou XML)

    Nom Description
    contrats Liste des contrats associés à l’enregistrement spécifié de l’élément de base d’installation.

    Type de données : tableau d’objets

    "contracts": [
  {
    "active": "String", 
    "approver": {Object},
    "commitment": "String",
    "consumer": {Object},
    "cost_adjustment": "String",
    "cost_adjustment_percentage": "String",
    "cost_per_unit": "String",
    "contract_composite": "String",
    "ends": "String",
    "expiration": {Object},
    "lifetime_cost": "String",
    "monthly_cost": "String",
    "number": "String",
    "payment_amount": "String",
    "payment_schedule": {Object},
    "ratecard": "String",
    "renewable": "String",
    "sales_tax": "String",
    "short_description": "String",
    "starts": "String",
    "state": {Object},
    "sub_total_cost": "String",
    "sys_class_name": "String",
    "sys_domain_path": "String",
    "sys_id": "String",
    "tax_cost": "String",
    "tax_exempt": "String",
    "tax_rate": "String",
    "total_cost": "String",
    "vendor_contract": "String",
    "yearly_cost": "String"
  }
]
    contrats.actifs Marqueur indiquant si le contrat est actif.
    Valeurs possibles :
    • true : le contrat est actif.
    • faux : le contrat est inactif.

    Type de données : chaîne booléenne
    contrats.approbateur Détails sur la personne autorisée à approuver le contrat.

    Type de données : objet

    "approver": {
  "display_value": "String",
  "sys_id": "String"
}
    contracts.approver.display_value Nom de texte de l’approbateur associé à l’enregistrement de contrats. Utilisez cette valeur pour afficher le nom de l’approbateur dans l’interface utilisateur.

    Type de données : chaîne
    contracts.approver.sys_id Sys_id de l’enregistrement de l’approbateur associé à l’enregistrement des contrats.

    Type de données : chaîne
    contrats.consommateur Détails sur le consommateur associé à l’enregistrement de contrats.
    Remarque :
    Le champ consommateur n’est disponible que si le module d’extension B2B2C est installé.

    Type de données : objet

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    contracts.consumer.display_value Nom de texte du consommateur associé à l’enregistrement de contrats. Utilisez cette valeur pour afficher le nom du consommateur dans l’interface utilisateur.

    Type de données : chaîne
    contracts.consumer.sys_id Sys_id de l’enregistrement de consommateur associé à l’enregistrement de contrats.

    Type de données : chaîne
    contracts.cost_adjustment Type d'ajustement des coûts appliqué au contrat.

    Valeurs possibles :

    • Fixe
    • Manuel
    • IPC (indice des prix à la consommation)

    Type de données : chaîne
    contracts.cost_adjustment_percentage Pourcentage d'augmentation ou de diminution du prix du contrat. Pour indiquer une baisse de prix, saisissez un pourcentage négatif. Vous pouvez également spécifier un Ajustement des coûts ou un Pourcentage d'ajustement des coûts, mais pas les deux.

    Type de données : chaîne
    contracts.cost_per_unit Coût unitaire du fournisseur du produit.

    Type de données : chaîne
    contrats.fins Date de résiliation du contrat.

    Type de données : chaîne
    contrats.expiration Détails sur l’état d’expiration du contrat associé.

    Type de données : objet

    "expiration": {
  "display_value": "String",
  "sys_id": "String"
}
    contracts.expiration.display_value État d’expiration du contrat associé. Utilisez cette valeur pour afficher l’état d’expiration dans l’interface utilisateur.

    Type de données : chaîne
    contracts.expiration.sys_id Sys_id de l’enregistrement d’expiration associé à l’enregistrement de contrats.

    Type de données : chaîne
    contracts.lifetime_cost Coût de cycle de vie du contrat.

    Type de données : chaîne
    contracts.monthly_cost Coût mensuel du contrat.

    Type de données : chaîne
    numéro.contrats Numéro de contrat.

    Type de données : chaîne
    contracts.payment_amount Montant d’argent qui a été versé directement à la partie destinataire de ce contrat.

    Type de données : chaîne
    contracts.payment_schedule Détails sur l’échéancier de paiement associé au contrat.

    Type de données : objet

    "payment_schedule": {
  "display_value": "String",
  "sys_id": "String"
}
    contracts.payment_schedule.display_value Échéancier de paiement pour le contrat associé. Utilisez cette valeur pour afficher l’échéancier de paiement dans l’interface utilisateur.

    Type de données : chaîne
    contracts.payment_schedule.valeur Valeur interne de l’échéancier de paiement pour ce contrat, par exemple quotidien, hebdomadaire ou mensuel.

    Type de données : chaîne
    contrats.carte d’évaluation Marqueur indiquant s’il existe une grille tarifaire associée à ce contrat. Situé dans la table Rate Care [fm_contract_rate_card].
    Valeurs possibles :
    • true : carte d’évaluation.
    • false : aucune grille tarifaire.

    Type de données : chaîne booléenne
    contrats.renouvelables Marqueur indiquant si le contrat est renouvelable.
    Valeurs possibles :
    • true : le contrat est renouvelable.
    • faux : le contrat n’est pas renouvelable.

    Type de données : chaîne booléenne
    contracts.sales_tax Marqueur indiquant si une taxe sur la vente est facturée pour les articles référencés par ce contrat.
    Valeurs possibles :
    • true : Une taxe sur la vente est facturée.
    • faux : Aucune taxe de vente n’est facturée.

    Type de données : chaîne booléenne
    contracts.short_description Brève description du contrat.

    Type de données : chaîne
    contrats.débuts Date de début du contrat.

    Type de données : chaîne
    contrats.état Détails sur l’état actuel du contrat.

    Type de données : objet

    "state": {
  "display_value": "String",
  "value": "String"
}
    contracts.state.display_value Chaîne de texte de l’état actuel du contrat. Utilisez cette valeur pour afficher l’état dans l’interface utilisateur.

    Type de données : chaîne
    contrats.état.valeur La valeur interne ou l’état du contrat.

    Type de données : chaîne
    contracts.sub_total_cost Sous-total du coût du contrat.

    Type de données : chaîne
    contracts.sys_nom_de_classe Table contenant l’enregistrement du contrat.

    Type de données : chaîne
    contracts.sys_domain_path Chemin d’accès au domaine dans lequel ce contrat est disponible.

    Type de données : chaîne

    Par défaut : « / » = Domaine global
    contracts.sys_id Sys_id de l’enregistrement de contrat associé.

    Type de données : chaîne
    contracts.tax_cost Taxe totale figurant sur le contrat.

    Ce champ n’est visible que si le champ Taxes applicables est sélectionné comme Ventes.

    Type de données : chaîne
    contracts.tax_exempt Marqueur indiquant si les éléments associés à ce contrat sont exonérés de taxes.
    Valeurs possibles :
    • true : les articles sont exonérés de taxes.
    • false : les articles ne sont pas exonérés de taxes.

    Type de données : chaîne booléenne
    contracts.tax_rate Taux d’imposition facturé pour les éléments taxables associés au contrat.

    Type de données : chaîne
    contracts.total_cost Coût final du contrat après application des ajustements. Si un contrat dispose d'une ou de plusieurs cartes d'évaluation, ce champ affiche la valeur combinée de toutes les cartes d'évaluation.

    Type de données : chaîne
    contracts.vendor_contract Numéro de contrat du fournisseur.

    Type de données : chaîne
    contracts.yearly_cost Coût annuel du contrat.

    Type de données : chaîne
    erreur Détails sur l’erreur qui s’est produite lors de la tentative de traitement de la demande.

    Type de données : objet

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Détails supplémentaires sur l’erreur associée.

    Type de données : chaîne
    message.erreur Message d’erreur qui décrit le problème qui s’est produit lors de la tentative d’exécution de la demande.

    Type de données : chaîne
    has_more Marqueur indiquant s’il existe d’autres enregistrements dans la table à renvoyer.
    Valeurs possibles :
    • true : plus d’enregistrements à renvoyer.
    • false : plus aucun enregistrement à renvoyer.

    Type de données : chaîne booléenne
    statut État de l’appel de point de terminaison.

    Type de données : chaîne
    sysparm_limit Nombre d’enregistrements qui ont été renvoyés. Si cette valeur n’est pas spécifiée dans la demande d’origine, elle utilise la valeur par défaut.

    Type de données : nombre
    sysparm_offset Décalage (point de départ) dans la table associée à partir de laquelle les enregistrements ont été évalués et récupérés.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/167e96f053961910539dddeeff7b1298/contracts" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Résultats renvoyés :

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "contracts": [
      {
        "cost_adjustment_percentage": "0",
        "total_cost": "0",
        "cost_adjustment": "0",
        "tax_rate": "7.75",
        "number": "CNTR0000701",
        "tax_cost": "0",
        "sub_total_cost": "0",
        "state": {
          "value": "expired",
          "display_value": "Expired"
        },
        "starts": "2016-07-01",
        "contract_composite": "CoolMate KL300 1 year Limited Warranty\n\t\t​CNTR0000701",
        "tax_exempt": "false",
        "yearly_cost": "0",
        "active": "true",
        "payment_amount": "0",
        "commitment": "0",
        "sys_domain_path": "/",
        "payment_schedule": {
          "value": "Monthly",
          "display_value": "Monthly"
        },
        "renewable": "true",
        "expiration": {
          "sys_id": "c752e78ec3103000c111113e5bba8f3a",
          "display_value": "Expired"
        },
        "short_description": "CoolMate KL300 1 year Limited Warranty\n\t\t",
        "ratecard": "false",
        "sys_class_name": "ast_contract",
        "sys_id": "3f9db778c3302200e7c7d44d81d3ae0a",
        "ends": "2017-06-30",
        "consumer": {
          "sys_id": "59e788fbdb1b1200b6075200cf9619d2",
          "display_value": "Gilly Parker"
        },
        "approver": {
          "sys_id": "f2c0b27247702000cdd1706eecde27c8",
          "display_value": "Software Manager"
        },
        "monthly_cost": "0",
        "vendor_contract": "CNTR0000701",
        "lifetime_cost": "0",
        "sales_tax": "true",
        "cost_per_unit": "0"
      }
    ],
    "status": "SUCCESS"
  }
}

    Élément de base d’installation : GET /sn_install_base/integrations/installbaseitems/{id}/entitlements

    Renvoie les autorisations associées à un enregistrement d’élément de base d’installation spécifié.

    Format d'URL

    URL versionnée : /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/entitlements

    URL par défaut : /api/sn_install_base/integrations/installbaseitems/{id}/entitlements

    Paramètres de demande pris en charge

    Tableau 37. 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 de l’élément de base d’installation. Situé dans la table Élément de base d’installation [sn_install_base_item].

    Type de données : chaîne
    Tableau 38. Paramètres de requête
    Nom Description
    Paires nom-valeur de champ Paires champ-valeur à utiliser pour filtrer les enregistrements d’autorisations. Par défaut, il s’agit des champs de la table Autorisation [service_entitlement]. Si vous spécifiez une autre table dans sys_class_name, spécifiez les champs de cette table.

    Vous pouvez transmettre une ou plusieurs paires champ-valeur pour filtrer les résultats renvoyés.

    Par exemple, pour renvoyer uniquement les enregistrements actifs, transmettez ce qui suit : &active=true.

    Type de données : chaîne

    Par défaut : Tous les champs
    sys_class_name Si vous utilisez une table d’autorisations étendues (et non service_entitlement), nom de la table étendue à interroger.

    Type de données : chaîne

    Par défaut : service_entitlement
    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.

    Cette limite est appliquée avant l'évaluation de l'ACL. Si aucun enregistrement n'est renvoyé (notamment ceux auxquels vous avez accès), réorganisez l'ordre des enregistrements pour que ceux auxquels vous avez accès soient renvoyés en premier.

    Remarque :
    Des valeurs sysparm_limit anormalement élevées peuvent avoir un impact sur les performances du système.

    Type de données : nombre

    Par défaut : 10 000
    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 sysparm_offset paramètre.

    Type de données : nombre

    Par défaut : 0
    Tableau 39. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Aucun

    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 40. 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 41. 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 42. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    403 Interdit. L’utilisateur ne possède pas les droits d’accès à l’enregistrement spécifié.
    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 du corps de réponse (JSON ou XML)

    Nom Description
    autorisations liées aux services Liste des autorisations associées à l’enregistrement d’élément de base d’installation spécifié.

    Type de données : objet

    "entitlements": {
  "account": {Object},
  "active": "String",
  "business_hour": {Object},
  "contract": {Object},
  "end_date": "String",
  "entitlement_name": "String",
  "install_base_item": {Object},
  "per_unit": "String",
  "start_date": "String",
  "sys_id": "String",
  "total_units": "String",
  "remaining_units": "String",
  "unit": {Object}
  }
    autorisations.compte Détails sur le compte associé à l’enregistrement d’autorisations.

    Type de données : objet

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    entitlements.account.display_value Nom de texte du compte associé à l’enregistrement des autorisations. Utilisez cette valeur pour afficher le nom du compte dans l’interface utilisateur.

    Type de données : chaîne
    entitlements.account.sys_id Sys_id de l’enregistrement de compte associé à l’enregistrement des autorisations.

    Type de données : chaîne
    autorisations.actives Marqueur indiquant si l’autorisation est active.
    Valeurs possibles :
    • 0 : l’autorisation n’est pas active.
    • 1 : l’autorisation est active.

    Type de données : chaîne

    Valeur par défaut : 1
    entitlements.business_hour Détails sur les heures ouvrables pour l’enregistrement des autorisations.

    Type de données : objet

    "business_hour": {
  "display_value": "String",
  "sys_id": "String"
}
    entitlements.business_hour.display_value Nom de texte de l’enregistrement des heures ouvrables associé à l’enregistrement des autorisations. Utilisez cette valeur pour afficher les heures ouvrables dans l’interface utilisateur.

    Type de données : chaîne
    entitlements.business_hour.sys_id Sys_id de l’enregistrement des heures ouvrables associé à l’enregistrement des autorisations.

    Type de données : chaîne
    autorisations.contrat Détails sur le contrat associé à l’enregistrement d’autorisation.

    Type de données : objet

    "contract": {
  "display_value": "String",
  "sys_id": "String"
}
    entitlements.contract.display_value Nom de texte du contrat associé à l’enregistrement d’autorisation. Utilisez cette valeur pour afficher le nom du contrat dans l’interface utilisateur.

    Type de données : chaîne
    entitlements.contract.sys_id Sys_id de l’enregistrement de contrat associé à l’enregistrement d’autorisation.

    Type de données : chaîne
    entitlements.end_date Date de fin de l’autorisation.

    Type de données : chaîne
    entitlements.entitlement_name Nom de l’autorisation.

    Type de données : chaîne
    entitlements.install_base_item Détails sur l’élément de base d’installation associé à l’enregistrement des autorisations.

    Type de données : objet

    "install_base_item": {
  "display_value": "String",
  "sys_id": "String"
}
    entitlements.install_base_item.display_value Nom de texte de l’élément de base d’installation associé à l’enregistrement d’autorisations. Utilisez cette valeur pour afficher le nom de l’élément de base d’installation dans l’interface utilisateur.

    Type de données : chaîne
    entitlements.install_base_item.sys_id Sys_id de l’enregistrement de l’élément de base d’installation associé à l’enregistrement des autorisations.

    Type de données : chaîne
    entitlements.per_unit Nombre de produits dans une unité. Par exemple, si Est le unitcas, cette valeur sera 12 s’il y a 12 éléments par ticket.

    Type de données : chaîne
    entitlements.start_date Date de début de l’autorisation.

    Type de données : chaîne
    entitlements.sys_id Sys_id de l’enregistrement des autorisations associées.

    Type de données : chaîne
    entitlements.total_units Nombre d’unités qui étaient disponibles à l’origine.

    Type de données : chaîne
    entitlements.remaining_units Nombre d’unités restantes.

    Type de données : chaîne
    autorisations.unité Détails sur l’unité de l’élément associé à l’enregistrement des autorisations.

    Type de données : objet

    "unit": {
  "display_value": "String",
  "value": "String"
}
    entitlements.unit.display_value Nom de texte de l’unité de l’élément associé à l’enregistrement des autorisations. Utilisez cette valeur pour afficher le nom de l’unité dans l’interface utilisateur.

    Type de données : chaîne
    autorisations.unité.valeur Nom interne de l’unité de l’élément associé à l’enregistrement des autorisations.

    Type de données : chaîne
    erreur Détails sur l’erreur qui s’est produite lors de la tentative de traitement de la demande.

    Type de données : objet

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Détails supplémentaires sur l’erreur associée.

    Type de données : chaîne
    message.erreur Message d’erreur qui décrit le problème qui s’est produit lors de la tentative d’exécution de la demande.

    Type de données : chaîne
    has_more Marqueur indiquant s’il existe d’autres enregistrements dans la table à renvoyer.
    Valeurs possibles :
    • true : plus d’enregistrements à renvoyer.
    • false : plus aucun enregistrement à renvoyer.

    Type de données : chaîne booléenne
    statut État de l’appel de point de terminaison.

    Type de données : chaîne
    sysparm_limit Nombre d’enregistrements qui ont été renvoyés. Si cette valeur n’est pas spécifiée dans la demande d’origine, elle utilise la valeur par défaut.

    Type de données : nombre
    sysparm_offset Décalage (point de départ) dans la table associée à partir de laquelle les enregistrements ont été évalués et récupérés.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/42746a3b876121100b6afc86dabb3597/entitlements" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Résultats renvoyés :

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "entitlements": [
      {
        "end_date": "2023-04-28",
        "remaining_units": "4978",
        "business_hour": {
          "sys_id": "08fcd0830a0a0b2600079f56b1adb9ae",
          "display_value": "8-5 weekdays"
        },
        "entitlement_name": "Entitlement",
        "sys_id": "7206095d87f121105d0055373cbb3504",
        "total_units": "5000",
        "start_date": "2023-03-27",
        "contract": {
          "sys_id": "495e16b96f0731003b3c498f5d3ee4af",
          "display_value": "CNTR0000603"
        },
        "active": "1",
        "install_base_item": {
          "sys_id": "42746a3b876121100b6afc86dabb3597",
          "display_value": "KX Series - KX5000"
        },
        "unit": {
          "value": "cases",
          "display_value": "Cases"
        },
        "per_unit": "0",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Élément de base d’installation : GET /sn_install_base/integrations/installbaseitems/{id}/maintenanceplans

    Renvoie les plans de maintenance associés à un enregistrement d’élément de base d’installation spécifié.

    Format d'URL

    URL versionnée : /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/maintenanceplans

    URL par défaut : /api/sn_install_base/integrations/installbaseitems/{id}/maintenanceplans

    Paramètres de demande pris en charge

    Tableau 43. 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 de l’élément de base d’installation. Situé dans la table Élément de base d’installation [sn_install_base_item].

    Type de données : chaîne
    Tableau 44. Paramètres de requête
    Nom Description
    Paires nom-valeur de champ Paires champ-valeur à utiliser pour filtrer les enregistrements du plan de maintenance. Par défaut, il s’agit des champs de la table Plan de maintenance [sm_maint_plan]. Si vous spécifiez une autre table dans sys_class_name, spécifiez les champs de cette table.

    Vous pouvez transmettre une ou plusieurs paires champ-valeur pour filtrer les résultats renvoyés.

    Par exemple, pour renvoyer uniquement les enregistrements actifs, transmettez la commande suivante : &active=true.

    Type de données : chaîne

    Par défaut : Tous les champs
    sys_class_name En cas d’utilisation d’une table de plans de maintenance étendus (et non de plans de maintenance), nom de la table étendue à interroger.

    Type de données : chaîne

    Par défaut : maintenanceplans
    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.

    Cette limite est appliquée avant l'évaluation de l'ACL. Si aucun enregistrement n'est renvoyé (notamment ceux auxquels vous avez accès), réorganisez l'ordre des enregistrements pour que ceux auxquels vous avez accès soient renvoyés en premier.

    Remarque :
    Des valeurs sysparm_limit anormalement élevées peuvent avoir un impact sur les performances du système.

    Type de données : nombre

    Par défaut : 10 000
    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 sysparm_offset paramètre.

    Type de données : nombre

    Par défaut : 0
    Tableau 45. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Aucun

    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 46. 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 47. 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 48. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    403 Interdit. L’utilisateur ne possède pas les droits d’accès à l’enregistrement spécifié.
    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 du corps de réponse (JSON ou XML)

    Nom Description
    erreur Détails sur l’erreur qui s’est produite lors de la tentative de traitement de la demande.

    Type de données : objet

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Détails supplémentaires sur l’erreur associée.

    Type de données : chaîne
    message.erreur Message d’erreur qui décrit le problème qui s’est produit lors de la tentative d’exécution de la demande.

    Type de données : chaîne
    has_more Marqueur indiquant s’il existe d’autres enregistrements dans la table à renvoyer.
    Valeurs possibles :
    • true : plus d’enregistrements à renvoyer.
    • false : plus aucun enregistrement à renvoyer.

    Type de données : chaîne booléenne
    Plans de maintenance Liste des plans de maintenance associés à l’enregistrement spécifié d’élément de base d’installation.

    Type de données : tableau d’objets

    "maintenanceplans": [
  {
    "active": "String",
    "apply_to_new": "String",
    "allow_future_wo": "String",
    "maintenance_override_policy": {Object},
    "model": "String",
    "name": "String",
    "number": "String",
    "propagation_flag": "String",
    "sys_class_name": "String",
    "sys_id": "String",
    "table": "String",
    "type": {Object}
  }
]
    plans d’entretien.actif Marqueur indiquant si le plan de maintenance est actif.
    Valeurs possibles :
    • true : le plan de maintenance est actif.
    • faux : le plan de maintenance est inactif.

    Type de données : chaîne
    plans d’entretien.apply_to_new Marqueur indiquant si les calendriers définis pour ce plan de maintenance sont appliqués à tous les enregistrements qui ont été ajoutés à la table spécifiée depuis la dernière exécution du plan et s’ils répondent aux conditions saisies dans la condition de filtre.
    Valeurs possibles :
    • true : appliqué à tout nouvel enregistrement.
    • faux : non appliqué à tous les nouveaux enregistrements.

    Type de données : chaîne
    plans d’entretien.allow_future_wo Marqueur indiquant si les commandes de travaux peuvent être associées au plan de maintenance.
    Valeurs possibles :
    • true : de nouvelles commandes de travaux peuvent être associées.
    • faux : aucune nouvelle commande de travaux ne peut être associée.

    Type de données : chaîne
    plans d’entretien.maintenance_override_policy Détails sur la politique de remplacement de maintenance pour le plan de maintenance.

    Type de données : objet

    "maintenance_override_policy": {
  "display_value": "String",
  "value": "String"
}
    plans d’entretien.maintenance_override_policy.display_value Chaîne de texte décrivant la politique de remplacement. Utilisez cette valeur pour afficher la politique de remplacement dans l’interface utilisateur.

    Type de données : chaîne
    plans d’entretien.maintenance_override_policy.valeur Valeur interne de la politique de remplacement.

    Type de données : chaîne
    plans d’entretien.modèle Sys_id de l’enregistrement de modèle associé au plan de maintenance.

    Type de données : chaîne
    plans d’entretien.nombre Numéro du plan de maintenance.

    Type de données : chaîne
    plans d’entretien.propagation_flag Marqueur indiquant si le plan de maintenance peut être propagé.
    Valeurs possibles :
    • vrai : le plan de maintenance peut être propagé.
    • faux : le plan de maintenance ne peut pas être propagé.

    Type de données : chaîne
    plans d’entretien.sys_class_name Table contenant l’enregistrement du plan de maintenance.

    Type de données : chaîne
    plans d’entretien.sys_id Sys_id du plan de maintenance associé.

    Type de données : chaîne
    plans d’entretien.table Table contenant l’enregistrement de temps de base d’installation associé.

    Type de données : chaîne
    plans d’entretien.type Détails sur le type de plan de maintenance.

    Type de données : objet

    "type": {
  "display_value": "String",
  "value": "String"
}
    plans d’entretien.type.display_value Chaîne de texte décrivant le type de plan de maintenance. Utilisez cette valeur pour afficher le type dans l’interface utilisateur.

    Type de données : chaîne
    plans d’entretien.type.valeur Valeur interne du type de plan de maintenance.

    Type de données : chaîne
    statut État de l’appel de point de terminaison.

    Type de données : chaîne
    sysparm_limit Nombre d’enregistrements qui ont été renvoyés. Si cette valeur n’est pas spécifiée dans la demande d’origine, elle utilise la valeur par défaut.

    Type de données : nombre
    sysparm_offset Décalage (point de départ) dans la table associée à partir de laquelle les enregistrements ont été évalués et récupérés.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/167e96f053961910539dddeeff7b1298/maintenanceplans" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Résultats renvoyés :

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 1,
    "has_more": true,
    "maintenanceplans": [
      {
        "propagation_flag": "false",
        "active": "true",
        "type": {
          "value": "install_base",
          "display_value": "Install base"
        },
        "maintenance_override_policy": {
          "value": "do_nothing",
          "display_value": "Leave alone"
        },
        "sys_class_name": "wm_planned_work_plan",
        "allow_future_wo": "true",
        "sys_id": "0b809d70877561105d0055373cbb357f",
        "number": "WP0001026",
        "name": "Plan 10",
        "model": "8583ce8237732000158bbfc8bcbe5dd9",
        "apply_to_new": "true",
        "table": "sn_install_base_item"
      }
    ],
    "status": "SUCCESS"
  }
}

    Élément de base d’installation : GET /sn_install_base/integrations/installbaseitems/{id}/relatedparties

    Renvoie les parties connexes associées à un enregistrement d’élément de base d’installation spécifié.

    Format d'URL

    URL versionnée : /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/relatedparties

    URL par défaut : /api/sn_install_base/integrations/installbaseitems/{id}/relatedparties

    Paramètres de demande pris en charge

    Tableau 49. 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 de l’élément de base d’installation. Situé dans la table Élément de base d’installation [sn_install_base_item].

    Type de données : chaîne
    Tableau 50. Paramètres de requête
    Nom Description
    Paires nom-valeur de champ Paires champ-valeur à utiliser pour filtrer les enregistrements des parties connexes. Par défaut, cela fait référence aux champs de la table Parties connexes [sn_install_base_related_party]. Si vous spécifiez une autre table dans sys_class_name, spécifiez les champs de cette table.

    Vous pouvez transmettre une ou plusieurs paires champ-valeur pour filtrer les résultats renvoyés.

    Par exemple, si vous souhaitez filtrer sur un compte et une partie responsable spécifiques, transmettez le sys_ids des deux enregistrements : &account=86837a386f0331003b3c498f5d3ee4ca&responsibility=c009bbedb3730010700b4d43c6a8dcef.

    Type de données : chaîne

    Par défaut : Tous les champs
    sys_class_name Si vous utilisez une table de parties liées étendues (et non sn_install_base_related_party), le nom de la table étendue à interroger.

    Type de données : chaîne

    Par défaut : sn_install_base_related_party
    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.

    Cette limite est appliquée avant l'évaluation de l'ACL. Si aucun enregistrement n'est renvoyé (notamment ceux auxquels vous avez accès), réorganisez l'ordre des enregistrements pour que ceux auxquels vous avez accès soient renvoyés en premier.

    Remarque :
    Des valeurs sysparm_limit anormalement élevées peuvent avoir un impact sur les performances du système.

    Type de données : nombre

    Par défaut : 10 000
    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 sysparm_offset paramètre.

    Type de données : nombre

    Par défaut : 0
    Tableau 51. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Aucun

    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 52. 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 53. 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 54. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    403 Interdit. L’utilisateur ne possède pas les droits d’accès à l’enregistrement spécifié.
    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 du corps de réponse (JSON ou XML)

    Nom Description
    erreur Détails sur l’erreur qui s’est produite lors de la tentative de traitement de la demande.

    Type de données : objet

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Détails supplémentaires sur l’erreur associée.

    Type de données : chaîne
    message.erreur Message d’erreur qui décrit le problème qui s’est produit lors de la tentative d’exécution de la demande.

    Type de données : chaîne
    has_more Marqueur indiquant s’il existe d’autres enregistrements dans la table à renvoyer.
    Valeurs possibles :
    • true : plus d’enregistrements à renvoyer.
    • false : plus aucun enregistrement à renvoyer.

    Type de données : chaîne booléenne
    Parties connexes Liste des parties connexes associées à l’enregistrement d’élément de base d’installation spécifié.

    Type de données : tableau d’objets

    "relatedparties": [
  {
    "account": {Object},
    "consumer": {Object},
    "contact": {Object},
    "install_base_item": {Object},
    "responsibility": {Object},
    "service_organization": {Object},
    "sys_class_name": "String",
    "sys_id": "String",
    "type": {Object},
    "user": {Object}
  }
]
    Partiesassociées.Compte Détails sur le compte associé à l’enregistrement des parties connexes.

    Type de données : objet

    account": {
  "display_value": "String",
  "sys_id": "String"
}
    relatedparties.account.display_value Nom de texte du compte associé à l’enregistrement des parties connexes. Utilisez cette valeur pour afficher le nom du compte dans l’interface utilisateur.

    Type de données : chaîne
    relatedparties.account.sys_id Sys_id de l’enregistrement de compte associé à l’enregistrement des parties connexes.

    Type de données : chaîne
    Parties connexes.Consommateur Détails sur le consommateur associé à l’enregistrement des parties connexes.

    Type de données : objet

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    relatedparties.consumer.display_value Nom de texte du consommateur associé à l’enregistrement des parties connexes. Utilisez cette valeur pour afficher le nom du consommateur dans l’interface utilisateur.

    Type de données : chaîne
    relatedparties.consumer.sys_id Sys_id de l’enregistrement de consommateur associé à l’enregistrement des parties connexes.

    Type de données : chaîne
    RelatedParties.Contact Détails sur le contact de compte responsable de l’enregistrement des parties connexes.

    Type de données : objet

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    relatedparties.contact.display_value Nom de texte du contact associé à l’enregistrement des parties connexes. Utilisez cette valeur pour afficher le nom du contact dans l’interface utilisateur.

    Type de données : chaîne
    relatedparties.contact.sys_id Sys_id de l’enregistrement de contact associé à l’enregistrement des parties connexes. Situé dans la table Contact [customer_contact].

    Type de données : chaîne
    relatedparties.install_base_item Détails sur l’élément de base d’installation associé à l’enregistrement des parties connexes.

    Type de données : objet

    "install_base_item": {
  "display_value": "String",
  "sys_id": "String"
}
    relatedparties.install_base_item.display_value Nom de texte de l’élément de base d’installation associé à l’enregistrement des parties connexes. Utilisez cette valeur pour afficher le nom de l’élément de base d’installation dans l’interface utilisateur.

    Type de données : chaîne
    relatedparties.install_base_item.sys_id Sys_id de l’enregistrement de l’élément de base d’installation associé à l’enregistrement des parties connexes.

    Type de données : chaîne
    RelatedParties.Responsabilité Détails sur le niveau d’accès des informations de base d’installation.

    Type de données : objet

    "responsibility": {
  "display_value": "String",
  "sys_id": "String"
}
    relatedparties.responsibility.display_value Valeur d’affichage de texte pour le niveau d’accès aux informations de base d’installation.

    Type de données : chaîne
    relatedparties.responsibility.sys_id Sys_id de l’enregistrement de responsabilité associé. Cet enregistrement définit le niveau d’accès aux informations de base d’installation. Situé dans la table de définition de responsabilité [sn_customerservice_responsibility_def].

    Ce paramètre n’est valide que si le related_party champ est également spécifié. S’il est spécifié, il renvoie uniquement les éléments de base d’installation related_party qui correspondent aux paramètres and responsibility .

    Pour plus d’informations, voir Configure related parties for items received

    Type de données : chaîne
    relatedparties.service_organization Détails sur l’organisation de services associée à l’enregistrement des parties connexes.

    Type de données : objet

    "service_organization": {
  "display_value": "String",
  "sys_id": "String"
}
    relatedparties.service_organization.display_value Nom de texte de l’organisation de services associée à l’enregistrement des parties connexes. Utilisez cette valeur pour afficher le nom de l’organisation de service dans l’interface utilisateur.

    Type de données : chaîne
    relatedparties.service_organization.sys_id Sys_id de l’enregistrement de l’organisation de services associé à l’enregistrement des parties connexes. Situé dans la table Organisation de services [sn_customer_service_organization].

    Type de données : chaîne
    relatedparties.sys_nom_de_classe Table contenant l’enregistrement des parties connexes.

    Type de données : chaîne

    Par défaut : sn_install_base_related_party
    relatedparties.sys_id Sys_id de l’enregistrement des parties connexes associées.

    Type de données : chaîne
    relatedParties.Type Détails sur le type de contact associé à l’enregistrement des parties connexes.

    Type de données : objet

    "type": {
  "display_value": "String",
  "sys_id": "String"
}
    relatedparties.type.display_value Nom de texte du type de contact associé à l’enregistrement des parties connexes. Utilisez cette valeur pour afficher le type de contact dans l’interface utilisateur. Pour en savoir plus, consultez Add related party configurations to cases, sold products, install bases, or service organizations.
    Types possibles :
    • Compte autorisé
    • Consommateur autorisé
    • Contact autorisé
    • Contributeur autorisé
    • Membre autorisé
    • Organisation de services autorisés
    • Compte répertorié
    • Consommateur répertorié
    • Contact répertorié
    • Contributeur répertorié
    • Membre répertorié
    • Organisation de services répertoriée

    Type de données : chaîne
    relatedparties.type.sys_id Sys_id de type enregistrement associé à l’enregistrement des parties connexes.

    Type de données : chaîne
    relatedparties.user Détails sur l’utilisateur associé à l’enregistrement des parties connexes.

    Type de données : objet

    "user": {
  "display_value": "String",
  "sys_id": "String"
}
    relatedparties.user.display_value Nom de texte de l’utilisateur associé à l’enregistrement des parties connexes. Utilisez cette valeur pour afficher le nom d’utilisateur dans l’interface utilisateur.

    Type de données : chaîne
    relatedparties.user.sys_id
    Sys_id de l’enregistrement utilisateur associé à l’enregistrement des parties connexes. Situé dans la table Utilisateur [sys_user].

    Type de données : chaîne
    statut État de l’appel de point de terminaison.

    Type de données : chaîne
    sysparm_limit Nombre d’enregistrements qui ont été renvoyés. Si cette valeur n’est pas spécifiée dans la demande d’origine, elle utilise la valeur par défaut.

    Type de données : nombre
    sysparm_offset Décalage (point de départ) dans la table associée à partir de laquelle les enregistrements ont été évalués et récupérés.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/42746a3b876121100b6afc86dabb3597/relatedparties" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Résultats renvoyés :

    
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "relatedparties": [
      {
        "type": {
          "sys_id": "68ec8b2965e99110f87764df53db779f",
          "display_value": "Authorized Contact"
        },
        "install_base_item": {
          "sys_id": "42746a3b876121100b6afc86dabb3597",
          "display_value": "KX Series - KX5000"
        },
        "sys_class_name": "sn_install_base_related_party",
        "sys_id": "8547774087f561100b6afc86dabb351a",
        "responsibility": {
          "sys_id": "c009bbedb3730010700b4d43c6a8dcef",
          "display_value": "Authorized Representative"
        },
        "contact": {
          "sys_id": "dc0185d94f341200025ba3618110c77c",
          "display_value": "Cindy Contact"
        },
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Élément de base d’installation : GET /sn_install_base/integrations/installbaseitems/{id}/soldproducts

    Renvoie les enregistrements de produits vendus associés à un enregistrement d’élément de base d’installation spécifié.

    Format d'URL

    URL versionnée : /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/soldproducts

    URL par défaut : /api/sn_install_base/integrations/installbaseitems/{id}/soldproducts

    Paramètres de demande pris en charge

    Tableau 55. 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 de l’élément de base d’installation. Situé dans la table Élément de base d’installation [sn_install_base_item].

    Type de données : chaîne
    Tableau 56. Paramètres de requête
    Nom Description
    Paires nom-valeur de champ Paires champ-valeur à utiliser pour filtrer les enregistrements des parties connexes. Par défaut, il s’agit des champs de la table Produits vendus [sn_install_base_sold_product]. Si vous spécifiez une autre table dans sys_class_name, spécifiez les champs de cette table.

    Vous pouvez transmettre une ou plusieurs paires champ-valeur pour filtrer les résultats renvoyés.

    Par exemple, si vous souhaitez filtrer les produits vendus à un compte spécifique, transmettez quelque chose de similaire à ce qui suit, où la valeur réussie est la sys_id du compte : &account=86837a386f0331003b3c498f5d3ee4ca.

    Type de données : chaîne

    Par défaut : Tous les champs
    sys_class_name Si vous utilisez une table étendue de produits vendus (et non sn_install_base_sold_product), nom de la table étendue à interroger.

    Type de données : chaîne

    Par défaut : sn_install_base_sold_product
    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.

    Cette limite est appliquée avant l'évaluation de l'ACL. Si aucun enregistrement n'est renvoyé (notamment ceux auxquels vous avez accès), réorganisez l'ordre des enregistrements pour que ceux auxquels vous avez accès soient renvoyés en premier.

    Remarque :
    Des valeurs sysparm_limit anormalement élevées peuvent avoir un impact sur les performances du système.

    Type de données : nombre

    Par défaut : 10 000
    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 sysparm_offset paramètre.

    Type de données : nombre

    Par défaut : 0
    Tableau 57. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Aucun

    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 58. 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 59. 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 60. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    403 Interdit. L’utilisateur ne possède pas les droits d’accès à l’enregistrement spécifié.
    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 du corps de réponse (JSON ou XML)

    Nom Description
    erreur Détails sur l’erreur qui s’est produite lors de la tentative de traitement de la demande.

    Type de données : objet

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Détails supplémentaires sur l’erreur associée.

    Type de données : chaîne
    message.erreur Message d’erreur qui décrit le problème qui s’est produit lors de la tentative d’exécution de la demande.

    Type de données : chaîne
    has_more Marqueur indiquant s’il existe d’autres enregistrements dans la table à renvoyer.
    Valeurs possibles :
    • true : plus d’enregistrements à renvoyer.
    • false : plus aucun enregistrement à renvoyer.

    Type de données : chaîne booléenne
    produits vendus Liste des produits vendus associés à l’enregistrement d’élément de base d’installation spécifié.

    Type de données : tableau d’objets

    "soldproducts":[
  {
    "account": {Object},
    "contact": {Object},
    "name": "String",
    "number": "String",
    "product": {Object},
    "sys_class_name": "String",
    "sys_id": "String",
    "state": {Object}
  }
]
    soldproducts.account Détails sur le compte associé à l’enregistrement de produit.

    Type de données : objet

    account": {
  "display_value": "String",
  "sys_id": "String"
}
    soldproducts.account.display_value Nom de texte du compte associé à l’enregistrement de produit. Utilisez cette valeur pour afficher le nom du compte dans l’interface utilisateur.

    Type de données : chaîne
    soldproducts.account.sys_id Sys_id de l’enregistrement de compte associé à l’enregistrement de produit.

    Type de données : chaîne
    soldproducts.contact Détails sur le contact de compte responsable du produit.

    Type de données : objet

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    soldproducts.contact.display_value Texte du nom du contact associé au produit. Utilisez cette valeur pour afficher le nom du contact dans l’interface utilisateur.

    Type de données : chaîne
    soldproducts.contact.sys_id Sys_id de l’enregistrement de contact associé à l’enregistrement de produit.

    Type de données : chaîne
    soldproducts.name Nom du produit.

    Type de données : chaîne
    soldproducts.number Numéro de produit.

    Type de données : chaîne
    soldproducts.sys_nom_de_classe Table contenant l’enregistrement du produit.

    Type de données : chaîne
    soldproducts.sys_id Sys_id du produit associé.

    Type de données : chaîne
    soldproducts.state Détails sur l’état actuel du produit.

    Type de données : objet

    "state": {
  "display_value": "String",
  "value": "String"
}
    soldproducts.state.display_value Chaîne de texte de l’état actuel du produit. Utilisez cette valeur pour afficher l’état dans l’interface utilisateur.

    Type de données : chaîne
    soldproducts.state.value Valeur interne de l’état du produit.

    Type de données : chaîne
    statut État de l’appel de point de terminaison.

    Type de données : chaîne
    sysparm_limit Nombre d’enregistrements qui ont été renvoyés. Si cette valeur n’est pas spécifiée dans la demande d’origine, elle utilise la valeur par défaut.

    Type de données : nombre
    sysparm_offset Décalage (point de départ) dans la table associée à partir de laquelle les enregistrements ont été évalués et récupérés.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991/soldproducts?sysparm_limit=1" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Résultats renvoyés :

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 1,
    "has_more": true,
    "soldproducts": [
      {
        "product": {
          "sys_id": "a9a2d0c3c6112276010db16c5ddd3461",
          "display_value": "Lenovo ThinkStation S20"
        },
        "sys_class_name": "sn_install_base_sold_product",
        "number": "SLPRD0001008",
        "sys_id": "17a3a7128729a1105d0055373cbb35fb",
        "contact": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "name": "SP B2B",
        "state": {
          "value": "active",
          "display_value": "Active"
        },
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Élément de base d’installation : GET /sn_install_base/integrations/installbaseitems/{id}/workorders

    Renvoie les commandes de travaux associées à un enregistrement d’élément de base d’installation spécifié.

    Format d'URL

    URL versionnée : /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/workorders

    URL par défaut : /api/sn_install_base/integrations/installbaseitems/{id}/workorders

    Paramètres de demande pris en charge

    Tableau 61. 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 de l’élément de base d’installation. Situé dans la table Élément de base d’installation [sn_install_base_item].

    Type de données : chaîne
    Tableau 62. Paramètres de requête
    Nom Description
    Paires nom-valeur de champ Paires champ-valeur à utiliser pour filtrer les enregistrements des parties connexes. Par défaut, il s’agit des champs de la table Produits vendus [sn_install_base_sold_product]. Si vous spécifiez une autre table dans sys_class_name, spécifiez les champs de cette table.

    Vous pouvez transmettre une ou plusieurs paires champ-valeur pour filtrer les résultats renvoyés.

    Par exemple, si vous souhaitez filtrer les produits vendus à un compte spécifique, transmettez quelque chose de similaire à ce qui suit où la valeur réussie est la sys_id du compte : &account=86837a386f0331003b3c498f5d3ee4ca.

    Type de données : chaîne

    Par défaut : Tous les champs
    sys_class_name Si vous utilisez une table étendue de produits vendus (et non sn_install_base_sold_product), nom de la table étendue à interroger.

    Type de données : chaîne

    Par défaut : sn_install_base_sold_product
    sysparm_limit Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la récupération de l’enregistrement sysparm_offset .
    Remarque :
    Des valeurs sysparm_limit anormalement élevées peuvent avoir un impact sur les performances du système.

    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 sysparm_offset paramètre.

    Type de données : nombre

    Par défaut : 0
    Tableau 63. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Aucun

    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 64. 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 65. 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 66. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    403 Interdit. L’utilisateur ne possède pas les droits d’accès à l’enregistrement spécifié.
    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 du corps de réponse (JSON ou XML)

    Nom Description
    erreur Détails sur l’erreur qui s’est produite lors de la tentative de traitement de la demande.

    Type de données : objet

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Détails supplémentaires sur l’erreur associée.

    Type de données : chaîne
    message.erreur Message d’erreur qui décrit le problème qui s’est produit lors de la tentative d’exécution de la demande.

    Type de données : chaîne
    has_more Marqueur indiquant s’il existe d’autres enregistrements dans la table à renvoyer.
    Valeurs possibles :
    • true : plus d’enregistrements à renvoyer.
    • false : plus aucun enregistrement à renvoyer.

    Type de données : chaîne booléenne
    statut État de l’appel de point de terminaison.

    Type de données : chaîne
    sysparm_limit Nombre d’enregistrements qui ont été renvoyés. Si cette valeur n’est pas spécifiée dans la demande d’origine, elle utilise la valeur par défaut.

    Type de données : nombre
    sysparm_offset Décalage (point de départ) dans la table associée à partir de laquelle les enregistrements ont été évalués et récupérés.

    Type de données : chaîne
    ordres de travail Liste des commandes de travaux associées à l’enregistrement spécifié d’élément de base d’installation.

    Type de données : tableau d’objets

    "workorders":[
  {
    "active": "String",
    "approval": {Object},
    "billable": "String",
    "escalation": "String",
    "has_appointment": "String",
    "hierarchical_variables": "String",
    "impact": "String",
    "install_base_item": {Object},
    "is_catalog": "String",
    "knowledge": "String",
    "location": {Object},
    "made_sla": "String",
    "needs_attention": "String",
    "number": "String",
    "opened_at": {Object},
    "opened_by": {Object},
    "opened_for": {Object},
    "priority": "String",
    "reassignment_count": "String",
    "reschedule_maintenance_if_canceled": "String",
    "short_description": "String",
    "sla_suspended": "String",
    "state": "String",
    "sys_class_name": "String",
    "sys_domain_path": "String"
    "sys_id": "String",
    "task_created": "String",
    "task_effective_number": "String",
    "template_workflow_invoked": "String",
    "upon_approval": {Object},
    "upon_reject": {Object},
    "urgency": "String"
  }
]
    commandestravaux.actif Marqueur indiquant si la commande de travaux est active.
    Valeurs possibles :
    • vrai : la commande de travaux est active.
    • faux : la commande de travaux est inactive.

    Type de données : chaîne booléenne
    ordres de travail.approbation Détails sur le processus d’approbation actuel de la commande de travaux.

    Type de données : objet

    "approval": {
  "display_value": "String",
  "value": "String"
}
    ordres de travail.approval.display_value Chaîne de texte de l’état actuel du processus d’approbation. Utilisez cette valeur pour afficher l’état d’approbation dans l’interface utilisateur.

    Type de données : chaîne
    ordres de travail.Valeur.Approbation Valeur interne de l’état du processus d’approbation.

    Type de données : chaîne
    ordres de travail.Facturable Marqueur indiquant si la commande de travaux est facturable.
    Valeurs possibles :
    • vrai : l’ordre de travail est facturable.
    • false : la commande de travaux n’est pas facturable

    Type de données : chaîne booléenne
    ordres de travail.escalade Niveau d’escalade de la commande de travaux.

    Type de données : chaîne
    ordres de travail.has_appointment Marqueur indiquant si la commande de travaux a un rendez-vous planifié.
    Valeurs possibles :
    • vrai : l’ordre de travail a un rendez-vous.
    • faux : l’ordre de travail n’a pas de rendez-vous.

    Type de données : chaîne booléenne
    ordres de travail.install_base_item Détails sur l’élément de base d’installation associé à l’enregistrement de commande de travaux.

    Type de données : objet

    "install_base_item": {
  "display_value": "String",
  "sys_id": "String"
}
    ordres de travail.install_base_item.display_value Nom de texte de l’élément de base d’installation associé à l’enregistrement de commande de travaux. Utilisez cette valeur pour afficher le nom de l’élément de base d’installation dans l’interface utilisateur.

    Type de données : chaîne
    ordres de travail.install_base_item.sys_id Sys_id de l’enregistrement de l’élément de base d’installation associé à l’enregistrement de commande de travaux.

    Type de données : chaîne
    ordres de travail.is_catalog Marqueur indiquant s’il fait partie d’un catalogue.
    Valeurs possibles :
    • true : la commande de travaux fait partie d’un catalogue.
    • false : la commande de travaux ne fait pas partie d’un catalogue.

    Type de données : chaîne booléenne
    commandestravaux.connaissances Marqueur indiquant si un article de la base de connaissances est disponible pour le problème de commande de travaux spécifié.

    Valeurs possibles :

    • vrai : un article de la base de connaissances est disponible pour ce problème.
    • faux : l’article de la base de connaissances n’est pas disponible pour ce problème.

    Type de données : chaîne booléenne
    commandestravaux.emplacement Détails sur l’emplacement de l’élément sur lequel vous devez travailler.

    Type de données : objet

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    ordres de travail.emplacement.display_value Nom de texte de l’emplacement de l’élément sur lequel travailler. Utilisez cette valeur pour afficher l’emplacement dans l’interface utilisateur.

    Type de données : chaîne
    ordres de travail.emplacement.sys_id Sys_id de l’enregistrement d’emplacement associé à l’enregistrement de commande de travaux.

    Type de données : chaîne
    ordres de travail.made_sla Marqueur indiquant si le travail associé à la commande de travaux respecte l’accord sur les niveaux de service (SLA) associé.
    Valeurs possibles :
    • true : SLA a été respecté.
    • faux : le SLA n’a pas été respecté.

    Type de données : chaîne booléenne
    ordres de travail.needs_attention Marqueur indiquant si cette commande de travaux requiert une attention particulière.
    Valeurs possibles :
    • true : l’ordre de travail requiert une attention.
    • faux : l’ordre de travail ne nécessite pas d’attention.

    Type de données : chaîne booléenne
    ordres de travail.nombre Numéro unique utilisé pour identifier la commande de travaux.

    Type de données : chaîne
    ordres de travail.opened_at Détails sur la date d’ouverture de la commande de travaux.

    Type de données : objet

    "opened_at": {
  "display_value": "String",
  "value": "String"
}
    ordres de travail.opened_at.display_value Date et heure d’ouverture de la commande de travaux. Utilisez cette valeur pour afficher la valeur dans l’interface utilisateur.

    Type de données : chaîne
    ordres de travail.opened_at.valeur Date et heure d’ouverture de la commande de travaux.

    Type de données : chaîne
    ordres de travail.opened_by Détails sur la personne qui a ouvert la commande de travaux.

    Type de données : objet

    "opened_by": {
  "display_value": "String",
  "sys_id": "String"
}
    ordres de travail.opened_by.display_value Nom de texte de la personne qui a ouvert la commande de travaux. Utilisez cette valeur pour afficher ce nom dans l’interface utilisateur.

    Type de données : chaîne
    ordres de travail.opened_by.sys_id Sys_id de l’enregistrement utilisateur de la personne qui a ouvert la commande de travaux.

    Type de données : chaîne
    workorders.opened_for Détails sur la personne pour laquelle la commande de travaux a été ouverte si elle est différente de la opened_by personne.

    Type de données : objet

    "opened_for": {
  "display_value": "String",
  "sys_id": "String"
}
    ordres de travail.opened_for.display_value Nom de texte de la personne pour laquelle la commande de travaux a été ouverte. Utilisez cette valeur pour afficher ce nom dans l’interface utilisateur.

    Type de données : chaîne
    ordres de travail.opened_for.sys_id Sys_id de l’enregistrement utilisateur de la personne pour laquelle la commande de travaux a été ouverte.

    Type de données : chaîne
    commandes de travaux.priorité Priorité de la commande de travaux.

    Type de données : chaîne
    ordres de travail.reassignment_count Nombre de fois où la commande de travaux a été réaffectée à une personne chargée de faire avancer la commande de travaux.

    Type de données : chaîne
    ordres de travail.reschedule_maintenance_if_canceled Marqueur qui indique si le travail doit être replanifié si la commande de travaux associée est annulée.
    Valeurs possibles :
    • true : replanifiez le travail.
    • faux : vérifier avant de replanifier le travail.

    Type de données : chaîne booléenne
    ordres de travail.short_description Texte bref décrivant le travail associé à la commande de travaux.

    Type de données : chaîne
    ordres de travail.sla_suspended Marqueur indiquant si le SLA associé à la commande de travaux a été suspendu.
    Valeurs valides :
    • true : SLA a été suspendu.
    • faux : le SLA n’a pas été suspendu.

    Type de données : chaîne booléenne
    ordres de travail.état État actuel de la commande de travaux.

    Type de données : chaîne
    ordres de travail.sys_class_name Table contenant l’enregistrement de commande de travaux.

    Type de données : chaîne
    ordres de travail.sys_domain_path Chemin de domaine.

    Type de données : chaîne
    workorders.sys_id Sys_id de l’enregistrement de commande de travaux associé.

    Type de données : chaîne
    ordres de travail.task_created Marqueur indiquant si une tâche a été créée pour cette commande de travaux.
    Valeurs possibles :
    • vrai : une tâche a été créée pour cette commande de travaux.
    • faux : la tâche n’a pas été créée pour cette commande de travaux.

    Type de données : chaîne booléenne
    ordres de travail.task_effective_number Numéro unique utilisé pour identifier la commande de travaux.

    Type de données : chaîne
    ordres de travail.template_workflow_invoked Marqueur indiquant si le workflow associé a été invoqué pour cette commande de travaux.
    Valeurs possibles :
    • true : le workflow a été invoqué.
    • false : Worflow n’a pas été invoqué.

    Type de données : chaîne booléenne
    ordres de travail.upon_approval Détails sur la prochaine action à effectuer si la commande de travaux est approuvée.

    Type de données : objet

    "upon_approval": {
  "display_value": "String",
  "value": "String"
}
    ordres de travail.upon_approval.display_value Chaîne de texte de l’action à effectuer si la commande de travaux est approuvée. Utilisez cette valeur pour afficher ces informations dans l’interface utilisateur.

    Type de données : chaîne
    ordres de travail.upon_approval.valeur Action à exécuter si la commande de travaux est approuvée.

    Valeurs possibles :

    • do_nothing
    • procéder

    Type de données : chaîne
    ordres de travail.upon_reject Détails sur la prochaine action à effectuer si la commande de travaux est rejetée.

    Type de données : objet

    "upon_reject": {
  "display_value": "String",
  "value": "String"
}
    ordres de travail.upon_reject.display_value Chaîne de texte de l’action à effectuer si la commande de travaux est rejetée. Utilisez cette valeur pour afficher ces informations dans l’interface utilisateur.

    Type de données : chaîne
    ordres de travail.upon_reject.valeur Action à exécuter si la commande de travaux est rejetée.

    Valeurs possibles :

    • annuler
    • goto

    Type de données : chaîne
    commandestravaux.urgence Urgence de la commande de travaux.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991/workorders?sysparm_limit=1" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Résultats renvoyés :

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "workorders": [
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "WO0010372",
        "state": "1",
        "template_workflow_invoked": "false",
        "knowledge": "false",
        "impact": "3",
        "active": "true",
        "priority": "4",
        "sys_domain_path": "/",
        "sla_suspended": "false",
        "needs_attention": "false",
        "short_description": "Test WO1",
        "sys_class_name": "wm_order",
        "reschedule_maintenance_if_canceled": "true",
        "reassignment_count": "0",
        "hierarchical_variables": "variable_pool",
        "opened_for": {
          "sys_id": "85453c616fc331003b3c498f5d3ee4fa",
          "display_value": "Jodi Seals"
        },
        "install_base_item": {
          "sys_id": "42746a3b876121100b6afc86dabb3597",
          "display_value": "KX Series - KX5000"
        },
        "has_appointment": "false",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "spam": "false",
        "made_sla": "true",
        "is_catalog": "false",
        "task_effective_number": "WO0010372",
        "opened_by": {
          "sys_id": "85453c616fc331003b3c498f5d3ee4fa",
          "display_value": "Jodi Seals"
        },
        "opened_at": {
          "value": "2023-03-20 13:33:22",
          "display_value": "2023-03-20 06:33:22"
        },
        "task_created": "false",
        "sys_id": "19761cc087b521100b6afc86dabb352f",
        "urgency": "3",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "billable": "false",
        "location": {
          "sys_id": "1cd145bc23070110766713d1d7bf654f",
          "display_value": "2866 Stevens Creek Blvd,Santa Clara,CA"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Élément de base d’installation : PATCH /sn_install_base/integrations/installbaseitems/{id}

    Met à jour un enregistrement d’élément de base d’installation spécifié avec des valeurs de champ spécifiées.

    Format d'URL

    URL versionnée : /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}

    URL par défaut : /api/sn_install_base/integrations/installbaseitems/{id}

    Paramètres de demande pris en charge

    Tableau 67. 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 68. Paramètres de requête
    Nom Description
    Aucun
    Tableau 69. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    compte Requis lors de la création d’un élément de base d’installation pour un compte.

    Sys_id du compte à associer à l’élément de base d’installation. Situé dans la table Compte [customer_account].

    Remarque :
    Si vous transmettez le account paramètre, vous ne pouvez pas également transmettre le consumer paramètre.

    Type de données : chaîne
    Actif Marqueur indiquant si l’élément de base d’installation est actif.
    Valeurs valides :
    • vrai, « vrai » ou « 0 » : l’élément est actif.
    • faux, « faux » ou « 1 » : l’élément n’est pas actif.

    Type de données : booléennes

    Valeur par défaut : true
    asset Sys_id de l’actif associé à l’enregistrement d’élément de base d’installation. Situé dans la table Actif [alm_asset].

    Type de données : chaîne
    child_install_base_items Liste des éléments de base d’installation enfants associés à cet élément de base d’installation.
    Remarque :
    Les champs d’élément de base d’installation enfant suivants ne peuvent pas être différents de leur parent :
    • compte
    • consommateur
    • contact
    • Organisation de services

    Type de données : tableau d’objets

    "child_install_base_items": [
  {
    "name": "String",
    "product": "String"
  }
]
    child_install_base_items.name Nom de l’élément de base d’installation enfant.

    Type de données : chaîne
    child_install_base_items.produit Sys_id de l’enregistrement de l’élément de base enfant associé. Situé dans la table Élément de base d’installation [sn_install_base_item].

    Type de données : chaîne
    configuration_item Sys_id de l’élément de configuration associé à l’enregistrement d’élément de base d’installation. Situé dans la table Élément de configuration [cmdb_ci].

    Type de données : chaîne
    consommateur Requis lors de la création d’un élément de base d’installation pour un consommateur.
    Sys_id du consommateur associé à l’enregistrement d’élément de base d’installation. Situé dans la table Consommateur [csm_consumer].
    Remarque :
    Si vous transmettez le consumer paramètre, vous ne pouvez pas également transmettre le account paramètre. En outre, vous ne pouvez associer un consommateur à un élément de base d’installation que si le module d’extension B2B2C est installé sur votre instance.

    Type de données : chaîne
    consumer_profile Sys_id du profil de consommateur associé à l’enregistrement d’élément de base d’installation. Situé dans la table Profil de consommateur [sn_csm_consumer_profile].

    Type de données : chaîne
    contact
    Sys_id de l’enregistrement de contact de compte qui est principalement responsable de l’élément de base d’installation. Situé dans la table Contact [customer_contact].
    Remarque :
    Les contacts ne peuvent être spécifiés que pour les éléments de base d’installation du compte.

    Type de données : chaîne
    household​ Sys_id du ménage associé à l’enregistrement d’élément de base d’installation. Situé dans la table Ménage [csm_household].
    Remarque :
    Ce champ n’est valide que lorsque le module d’extension Service clientèle Household (com.snc.household) est installé.

    Type de données : chaîne
    install_date Date à laquelle l’élément de base d’installation devient actif.

    Type de données : chaîne

    Format : aaaa-MM-jj HH :mm :ss
    emplacement Sys_id de l’emplacement du produit associé. Situé dans la table Emplacement [cmn_location].

    Type de données : chaîne
    nom Nom de l'élément de base d'installation.

    Type de données : chaîne
    Numéro Identificateur unique de l’élément de base d’installation.

    Type de données : chaîne

    Par défaut : généré automatiquement par le point de terminaison.
    parent Sys_id de l’enregistrement parent pour cet enregistrement d’élément de base d’installation. Situé dans la table Élément de base d’installation [sn_install_base_item].

    Type de données : chaîne
    product_model Sys_id du modèle de produit associé à l’enregistrement de l’élément de base d’installation. Situé dans la table Modèle de produit [cmdb_model].

    Type de données : chaîne
    quantité Nombre d’éléments installés.

    Type de données : entier
    service_context Sys_id du service qui est associé au CI sous-jacent pour calculer la sévérité de l’impact de Gestion des événements. Pour plus d'informations, consultez Service health status for install base.
    Remarque :
    Ce champ n’est valide que si le module d’extension Opérations du service clientèle proactif avec Gestion des événements est installé.

    Type de données : chaîne
    service_organization Requis lors de la création d’un élément de base d’installation pour une organisation de services.

    Sys_id de l’enregistrement de l’organisation de service impliquée dans la fourniture du service au client. Situé dans la table Organisation de services [sn_customer_service_organization].

    Remarque :
    Si vous transmettez ce paramètre, vous ne devez pas également transmettre les paramètres compte, contact ou consommateur. Le service_organization paramètre n’est disponible que lorsque le module d’extension Organisation de services (com.snc.service_organization) est installé sur votre instance.

    Type de données : chaîne
    État État actuel de l’élément de base d’installation.
    Valeurs valides :
    • in_use
    • inactif

    Type de données : chaîne
    statut État du produit.
    Valeurs valides :
    • d'origine
    • remplacement

    Type de données : chaîne
    sys_class_name Nom de la table de base d’installation étendue dans laquelle mettre à jour l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    uninstall_date Date à laquelle la base d’installation devient inactive.

    Type de données : chaîne

    Format : aaaa-MM-jj HH :mm :ss

    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 70. 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
    Content-Type Format de données du corps de la demande. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 71. 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 72. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    403 Interdit. L’utilisateur ne possède pas les droits d’accès à l’enregistrement spécifié.
    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 du corps de réponse (JSON ou XML)

    Nom Description
    erreur Détails sur l’erreur qui s’est produite lors de la tentative de traitement de la demande.

    Type de données : objet

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Détails supplémentaires sur l’erreur associée.

    Type de données : chaîne
    message.erreur Message d’erreur qui décrit le problème qui s’est produit lors de la tentative d’exécution de la demande.

    Type de données : chaîne
    élément Détails sur l’élément de base d’installation qui a été mis à jour.

    Type de données : objet

    "item": {
  "account": {Object},
  "active": Boolean,
  "name": "String",
  "number": "String",
  "state": {Object},
  "sys_class_name": {Object},
  "sys_id": "String"
}
    compte.élément Détails sur le compte client associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    item.account.display_value Nom de texte du compte client associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du compte client dans l’interface utilisateur.

    Type de données : chaîne
    item.account.sys_id Sys_id de l’enregistrement de compte client associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    élément.actif Marqueur indiquant si l’élément de base d’installation est actif.
    Valeurs possibles :
    • vrai : l’élément de base d’installation est actif.
    • faux : l’élément de base d’installation est inactif.

    Type de données : chaîne booléenne
    item.name Nom de l'élément de base d'installation.

    Type de données : chaîne
    numéro.élément ID unique de l'élément de base d'installation.

    Type de données : chaîne
    élément.état Détails sur l’état actuel de l’élément de base d’installation.

    Type de données : objet

    "state": {
  "display_value": "String",
  "value": "String"
}
    item.state.display_value Chaîne de texte de l’état actuel de l’élément de base d’installation. Utilisez cette valeur pour afficher l’état dans l’interface utilisateur.

    Type de données : chaîne
    élément.état.valeur Valeur interne de l’état de l’élément de base d’installation.

    Type de données : chaîne
    item.sys_nom_classe Détails sur la table qui contient l’élément de base d’installation.

    Type de données : objet

    "sys_class_name": {
  "display_value": "String",
  "value": "String"
}
    item.sys_nom_classe.display_value Chaîne de texte du nom de la table qui contient l’élément de base d’installation. Utilisez cette valeur pour afficher le nom de la table dans l’interface utilisateur.

    Type de données : chaîne
    item.sys_nom_classe.valeur Valeur interne de la table qui contient l’élément de base d’installation

    Type de données : chaîne
    item.sys_id Sys_id de l’enregistrement de l’élément de base d’installation. Situé dans la table spécifiée dans le sys_class_name paramètre.

    Type de données : chaîne
    statut État de l’appel de point de terminaison.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment mettre à jour le nom et les champs actif dans l’enregistrement de l’élément de base d’installation.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\": \"KX Series - KX5001\",
  \"active\":true
}" \
--user 'username':'password'

    Résultats renvoyés :

    {
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": {
        "value": "sn_install_base_item",
        "display_value": "Install Base Item"
      },
      "number": "IBITM0001001",
      "sys_id": "bc610d38cb76211050501ebfe8076d8b",
      "state": {
        "value": "inactive",
        "display_value": "Inactive"
      },
      "active": "false",
      "name": "NewTestIB",
      "account": {
        "sys_id": "8637a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    }
  }
}
      
}

    Élément de base d’installation : PATCH /sn_install_base/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id}

    Met à jour l’enregistrement de partie associée spécifié, associé à un élément de base d’installation spécifié, avec les valeurs du corps de la demande.

    Si vous devez modifier le type de partie associée associée à un élément de base d’installation, vous devez supprimer les champs spécifiques au type pour le type de partie associée actuel et les remplacer par les champs spécifiques au type du nouveau type de partie associée. Par exemple, pour passer d’un type de compte autorisé à un type de consommateur autorisé, transmettez ce qui suit :

    • type = « Consommateur autorisé »
    • account = ""
    • consumer = « <sys_id de l’enregistrement du consommateur> »
    • responsibility = « <sys_id de responsabilité du consommateur> »

    Format d'URL

    URL versionnée : /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id}

    URL par défaut : /api/sn_install_base/integrations/installbaseitems/{id}/relatedparties/{related_party_sys_id}

    Paramètres de demande pris en charge

    Tableau 73. 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 de l’élément de base d’installation. Situé dans la table Élément de base d’installation [sn_install_base_item].

    Type de données : chaîne
    related_party_sys_id Sys_id de l’enregistrement de partie connexe. Par défaut, il se trouve dans la table Partie connexe de la base d’installation [sn_install_base_related_party].

    Type de données : chaîne
    Tableau 74. Paramètres de requête
    Nom Description
    Aucun
    Tableau 75. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    compte Requis si le type paramètre est l’un des suivants :
    • Compte autorisé
    • Contact autorisé
    • Compte répertorié
    • Contact répertorié

    Sys_id du compte à associer à l’élément de base d’installation. Situé dans la table Compte [customer_account].

    Remarque :
    Si vous transmettez le account paramètre, vous ne pouvez pas également transmettre le consumer paramètre.

    Type de données : chaîne
    consommateur Requis si le type paramètre est Consommateur autorisé ou Consommateur répertorié.
    Sys_id du consommateur associé à l’enregistrement d’élément de base d’installation. Situé dans la table Consommateur [csm_consumer].
    Remarque :
    Si vous transmettez le consumer paramètre, vous ne pouvez pas également transmettre le account paramètre. En outre, vous ne pouvez associer un consommateur à un élément de base d’installation que si le module d’extension B2B2C est installé sur votre instance.

    Type de données : chaîne
    contact Sys_id de l’enregistrement de contact associé à l’enregistrement des parties connexes. Situé dans la table Contact [customer_contact].

    Type de données : chaîne
    responsabilité Sys_id de l’enregistrement de responsabilité associé. Cet enregistrement définit le niveau d’accès aux informations de base d’installation. Situé dans la table de définition de responsabilité [sn_customerservice_responsibility_def].

    Ce paramètre n’est valide que si le related_party champ est également spécifié. S’il est spécifié, il renvoie uniquement les éléments de base d’installation related_party qui correspondent aux paramètres and responsibility .

    Pour plus d’informations, voir Configure related parties for items received

    Type de données : chaîne
    service_organization Requis si le type paramètre est l’un des suivants :
    • Membre autorisé
    • Organisation de services autorisés
    • Membre répertorié
    • Organisation de services répertoriée

    Sys_id de l’enregistrement de l’organisation de service impliquée dans la fourniture du service au client. Situé dans la table Organisation de services [sn_customer_service_organization].

    Remarque :
    Si vous transmettez ce paramètre, vous ne devez pas également transmettre les paramètres compte, contact ou consommateur. Le service_organization paramètre n’est disponible que lorsque le module d’extension Organisation de services (com.snc.service_organization) est installé sur votre instance.

    Type de données : chaîne
    sys_class_name Table contenant l’enregistrement des parties connexes.

    Type de données : chaîne

    Par défaut : sn_install_base_related_party
    type Requis. Sys_id du type de partie liée à créer. Situé dans la table Configuration des parties associées [sn_customerservice_related_party_configuration].
    Types possibles :
    • Compte autorisé
    • Consommateur autorisé
    • Contact autorisé
    • Contributeur autorisé
    • Membre autorisé
    • Organisation de services autorisés
    • Compte répertorié
    • Consommateur répertorié
    • Contact répertorié
    • Contributeur répertorié
    • Membre répertorié
    • Organisation de services répertoriée

    Type de données : chaîne
    utilisateur Requis si le type paramètre est l’un des types de parties associés suivants :
    • Contributeur autorisé
    • Membre autorisé
    • Contributeur répertorié
    • Membre répertorié
    Sys_id de l’enregistrement utilisateur associé à l’enregistrement des parties connexes. Situé dans la table Utilisateur [sys_user].

    Type de données : chaîne

    Pour les membres autorisés et les membres répertoriés, cet utilisateur doit être associé à l’enregistrement spécifié service_organization .

    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 76. 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
    Content-Type Format de données du corps de la demande. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 77. 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 78. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    403 Interdit. L’utilisateur ne possède pas les droits d’accès à l’enregistrement spécifié.
    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 du corps de réponse (JSON ou XML)

    Nom Description
    erreur Détails sur l’erreur qui s’est produite lors de la tentative de traitement de la demande.

    Type de données : objet

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Détails supplémentaires sur l’erreur associée.

    Type de données : chaîne
    message.erreur Message d’erreur qui décrit le problème qui s’est produit lors de la tentative d’exécution de la demande.

    Type de données : chaîne
    élément Détails sur l’enregistrement des parties connexes.

    Type de données : tableau

    "item": {
  "account": {Object},
  "consumer": {Object},
  "contact": {Object},
  "install_base_item": {Object},
  "responsibility": {Object},
  "service_organization": {Object},
  "sys_class_name": "String",
  "sys_id": "String",
  "type": {Object},
  "user": {Object}
}
    compte.élément Détails sur le compte associé à l’enregistrement des parties connexes.

    Type de données : objet

    account": {
  "display_value": "String",
  "sys_id": "String"
}
    item.account.display_value Nom de texte du compte associé à l’enregistrement des parties connexes. Utilisez cette valeur pour afficher le nom du compte dans l’interface utilisateur.

    Type de données : chaîne
    item.account.sys_id Sys_id de l’enregistrement de compte associé à l’enregistrement des parties connexes.

    Type de données : chaîne
    Consommateur.Article Détails sur le consommateur associé à l’enregistrement des parties connexes.

    Type de données : objet

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    item.consumer.display_value Nom de texte du consommateur associé à l’enregistrement des parties connexes. Utilisez cette valeur pour afficher le nom du consommateur dans l’interface utilisateur.

    Type de données : chaîne
    item.consumer.sys_id Sys_id de l’enregistrement de consommateur associé à l’enregistrement des parties connexes.

    Type de données : chaîne
    article.contact Détails sur le contact de compte responsable de l’enregistrement des parties connexes.

    Type de données : objet

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    item.contact.display_value Nom de texte du contact associé à l’enregistrement des parties connexes. Utilisez cette valeur pour afficher le nom du contact dans l’interface utilisateur.

    Type de données : chaîne
    item.contact.sys_id Sys_id de l’enregistrement de contact associé à l’enregistrement des parties connexes. Situé dans la table Contact [customer_contact].

    Type de données : chaîne
    item.install_base_item Détails sur l’élément de base d’installation associé à l’enregistrement des parties connexes.

    Type de données : objet

    "install_base_item": {
  "display_value": "String",
  "sys_id": "String"
}
    item.install_base_item.display_value Nom de texte de l’élément de base d’installation associé à l’enregistrement des parties connexes. Utilisez cette valeur pour afficher le nom de l’élément de base d’installation dans l’interface utilisateur.

    Type de données : chaîne
    item.install_base_item.sys_id Sys_id de l’enregistrement de l’élément de base d’installation associé à l’enregistrement des parties connexes.

    Type de données : chaîne
    Responsabilité.Élément Détails sur le niveau d’accès des informations de base d’installation.

    Type de données : objet

    "responsibility": {
  "display_value": "String",
  "sys_id": "String"
}
    item.responsibility.display_value Valeur d’affichage de texte pour le niveau d’accès aux informations de base d’installation.

    Type de données : chaîne
    item.responsibility.sys_id Sys_id de l’enregistrement de responsabilité associé. Cet enregistrement définit le niveau d’accès aux informations de base d’installation. Situé dans la table de définition de responsabilité [sn_customerservice_responsibility_def].

    Ce paramètre n’est valide que si le related_party champ est également spécifié. S’il est spécifié, il renvoie uniquement les éléments de base d’installation related_party qui correspondent aux paramètres and responsibility .

    Pour plus d’informations, voir Configure related parties for items received

    Type de données : chaîne
    item.sys_nom_classe Table contenant l’enregistrement des parties connexes.

    Type de données : chaîne

    Par défaut : sn_install_base_related_party
    item.sys_id Sys_id de l’enregistrement des parties connexes associées.

    Type de données : chaîne
    type.élément Détails sur le type de contact associé à l’enregistrement des parties connexes.

    Type de données : objet

    "type": {
  "display_value": "String",
  "sys_id": "String"
}
    item.type.display_value Nom de texte du type de contact associé à l’enregistrement des parties connexes. Utilisez cette valeur pour afficher le type de contact dans l’interface utilisateur. Pour en savoir plus, consultez Add related party configurations to cases, sold products, install bases, or service organizations.
    Types possibles :
    • Compte autorisé
    • Consommateur autorisé
    • Contact autorisé
    • Contributeur autorisé
    • Membre autorisé
    • Organisation de services autorisés
    • Compte répertorié
    • Consommateur répertorié
    • Contact répertorié
    • Contributeur répertorié
    • Membre répertorié
    • Organisation de services répertoriée

    Type de données : chaîne
    item.type.sys_id Sys_id de type enregistrement associé à l’enregistrement des parties connexes.

    Type de données : chaîne
    élément.utilisateur Détails sur l’utilisateur associé à l’enregistrement des parties connexes.

    Type de données : objet

    "user": {
  "display_value": "String",
  "sys_id": "String"
}
    item.user.display_value Nom de texte de l’utilisateur associé à l’enregistrement des parties connexes. Utilisez cette valeur pour afficher le nom d’utilisateur dans l’interface utilisateur.

    Type de données : chaîne
    item.user.sys_id
    Sys_id de l’enregistrement utilisateur associé à l’enregistrement des parties connexes. Situé dans la table Utilisateur [sys_user].

    Type de données : chaîne
    statut État de l’appel de point de terminaison.

    Type de données : chaîne
    sysparm_limit Nombre d’enregistrements qui ont été renvoyés. Si cette valeur n’est pas spécifiée dans la demande d’origine, elle utilise la valeur par défaut.

    Type de données : nombre
    sysparm_offset Décalage (point de départ) dans la table associée à partir de laquelle les enregistrements ont été évalués et récupérés.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison pour mettre à jour l’enregistrement de contact associé à la partie connexe.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/relatedparties/f77c7542b7343300ece839a6ee11a991" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"contact\": \"dc0185d94f341200025ba3618110c77c\"
}" \
--user 'username':'password'

    Résultats renvoyés :

    {
"result":
  {
    "type": {
      "display_value":"Authorized Contact",
      "sys_id":"68ec8b2965e99110f87764df53db779f"
    },
    "install_base_item": {
      "display_value":"KX Series - KX5000",
      "sys_id":"f77c7542b7343300ece839a6ee11a991"
    },
    "sys_class_name":"sn_install_base_related_party",
    "sys_id":"4659539814ac6910f877ae314c1fb43a",
    "responsibility": {
      "display_value":"Authorized Representative",
      "sys_id":"c009bbedb3730010700b4d43c6a8dcef"
    },
    "contact": {
      "display_value":"Cindy Contact",
      "sys_id":"dc0185d94f341200025ba3618110c77c"
    },
    "account": {
      "display_value":"Boxeo",
      "value":"86837a386f0331003b3c498f5d3ee4ca"
    },
    "status":"SUCCESS",
  }
}

    Élément de base d’installation : PATCH /sn_install_base/integrations/installbaseitems/{id}/uninstall

    Désinstalle l’élément de base d’installation spécifié.

    Une désinstallation consiste à définir le active champ sur false et à définir le unistall_date champ sur une date spécifiée. Vide si aucune valeur de date n’est fournie.

    Format d'URL

    URL versionnée : /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/uninstall

    URL par défaut : /api/sn_install_base/integrations/installbaseitems/{id}/uninstall

    Paramètres de demande pris en charge

    Tableau 79. 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 de l’élément de base d’installation. Situé dans la table Élément de base d’installation [sn_install_base_item].

    Type de données : chaîne
    Tableau 80. Paramètres de requête
    Nom Description
    Aucun
    Tableau 81. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    uninstall_date Date à laquelle désinstaller l’élément de base d’installation spécifié. S’il n’est pas spécifié, il est désinstallé immédiatement.

    Type de données : chaîne

    Format : aaaa-mm-jj hh :mm :ss

    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 82. 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
    Content-Type Format de données du corps de la demande. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 83. 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 84. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    403 Interdit. L’utilisateur ne possède pas les droits d’accès à l’enregistrement spécifié.
    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 du corps de réponse (JSON ou XML)

    Nom Description
    erreur Détails sur l’erreur qui s’est produite lors de la tentative de traitement de la demande.

    Type de données : objet

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Détails supplémentaires sur l’erreur associée.

    Type de données : chaîne
    message.erreur Message d’erreur qui décrit le problème qui s’est produit lors de la tentative d’exécution de la demande.

    Type de données : chaîne
    élément Description de l’élément désinstallé.

    Type de données : objet

    "item": {
  "account": {Object},
  "active": "String",
  "asset": {Object},
  "configuration_item": {Object},
  "consumer": {Object},
  "consumer_profile": {Object},
  "contact": {Object},
  "health_status": {Object},
  "health_status_last_updated": "String",
  "household": {Object},
  "install_date": {Object},
  "location": {Object},
  "name": "String",
  "number": "String",
  "parent": {Object},
  "product": {Object},
  "service_context": {Object},
  "service_organization" {Object},
  "sys_class_name": "String",
  "sys_id": "String",
  "state": {Object},
  "status": {Object},
  "uninstall_date": "String"
}
    compte.élément Détails sur le compte client associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    item.account.display_value Nom de texte du compte client associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du compte client dans l’interface utilisateur.

    Type de données : chaîne
    item.account.sys_id Sys_id de l’enregistrement de compte client associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    élément.actif Marqueur indiquant si l’élément de base d’installation est actif.
    Valeurs possibles :
    • vrai : l’élément de base d’installation est actif.
    • faux : l’élément de base d’installation est inactif.

    Type de données : chaîne booléenne
    élément.actif Détails sur l’actif associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "asset": {
  "display_value": "String",
  "sys_id": "String"
}
    item.asset.display_value Nom de texte de l’actif associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom de la ressource dans l’interface utilisateur.

    Type de données : chaîne
    item.asset.sys_id Sys_id de l’enregistrement d’actif associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.child_install_base_items Liste des éléments de base d’installation enfants associés à cet élément de base d’installation.
    Remarque :
    Les champs d’élément de base d’installation enfant suivants ne peuvent pas être différents de leur parent :
    • compte
    • consommateur
    • contact
    • Organisation de services

    Type de données : tableau d’objets

    "child_install_base_items": [
  {
    "name": "String",
    "product": "String"
  }
]
    item.child_install_base_items.name Nom de l’élément de base d’installation enfant.

    Type de données : chaîne
    item.child_install_base_items.produit Sys_id de l’enregistrement de l’élément de base enfant associé. Situé dans la table Élément de base d’installation [sn_install_base_item].

    Type de données : chaîne
    item.configuration_item Détails sur l’élément de configuration associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "configuration_item": {
  "display_value": "String",
  "sys_id": "String"
}
    item.configuration_display_value Nom de texte de l’élément de configuration associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom de l’élément de configuration dans l’interface utilisateur.

    Type de données : chaîne
    item.configuration_sys_id Sys_id de l’enregistrement d’élément de configuration associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    Consommateur.Article Détails sur le consommateur associé à l’enregistrement d’élément de base d’installation.
    Remarque :
    Le champ consommateur n’est disponible que si le module d’extension B2B2C est installé.

    Type de données : objet

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    item.consumer.display_value Nom de texte du consommateur associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du consommateur dans l’interface utilisateur.

    Type de données : chaîne
    item.consumer.sys_id Sys_id de l’enregistrement de consommateur associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.consumer_profile Détails sur le profil de consommateur associé à l’enregistrement d’élément de base d’installation.
    Remarque :
    Le champ Profil du consommateur n’est disponible que si le module d’extension B2B2C est installé.

    Type de données : objet

    "consumer_profile": {
  "display_value": "String",
  "sys_id": "String"
}
    item.consumer_profile.display_value Nom de texte du profil de consommateur associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du profil du consommateur dans l’interface utilisateur.

    Type de données : chaîne
    item.consumer_profile.sys_id Sys_id de l’enregistrement de profil de consommateur associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    article.contact Détails sur le contact de compte responsable de l’enregistrement de l’élément de base d’installation.

    Type de données : objet

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    item.contact.display_value Nom de texte du contact du compte associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du contact du compte dans l’interface utilisateur.

    Type de données : chaîne
    item.contact.sys_id Sys_id de l’enregistrement de contact de compte associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.health_status Détails sur l’état d’intégrité actuel de l’élément de base d’installation. Uniquement renvoyé si le module d’extension Proactive Customer Service Operations (com.snc.proactive_cs_itom) est installé.

    Type de données : objet

    "health_status": {
  "display_value": "String",
  "value": "String"
}
    item.health_status.display_value Chaîne de texte de l’état d’intégrité actuel de l’élément de base d’installation. Utilisez cette valeur pour afficher l’état d’intégrité dans l’interface utilisateur.

    Type de données : chaîne
    item.health_status.valeur Valeur interne de l’état d’intégrité de l’élément de base d’installation.

    Type de données : chaîne
    item.health_status_last_updated Date et heure auxquelles l’état d’intégrité a été mis à jour pour la dernière fois pour l’élément de base d’installation.

    Type de données : chaîne
    Article.Ménage Détails sur le ménage associé à l’enregistrement d’élément de base d’installation. Renvoyé uniquement si le module d’extension Service clientèle Household (com.snc.household) est installé.

    Type de données : objet

    "household": {
  "display_value": "String",
  "sys_id": "String"
}
    item.household.display_value Nom de texte du ménage associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du ménage dans l’interface utilisateur.

    Type de données : chaîne
    item.household.sys_id Sys_id du ménage associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.install_date Détails sur la date à laquelle l’élément de base d’installation est devenu actif.

    Type de données : objet

    "install_date": {
  "display_value": "String",
  "value": "String"
}
    item.install_date.display_value Date d’installation du texte. Utilisez cette valeur pour afficher la date d’installation dans l’interface utilisateur.

    Type de données : chaîne
    item.install_date.valeur Valeur interne de la date d’installation.

    Type de données : chaîne
    élément.emplacement Détails sur l’emplacement de l’élément de base d’installation.

    Type de données : objet

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    item.location.display_value Nom de texte de l’emplacement de l’élément de base d’installation. Utilisez cette valeur pour afficher le nom de l’emplacement dans l’interface utilisateur.

    Type de données : chaîne
    item.location.sys_id Sys_id de l’enregistrement d’emplacement associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.name Nom de l'élément de base d'installation.

    Type de données : chaîne
    numéro.élément ID unique de l'élément de base d'installation.

    Type de données : chaîne
    élément.parent Détails sur l’enregistrement parent de l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "parent": {
  "display_value": "String",
  "sys_id": "String"
}
    item.parent.display_value Nom de texte de l’enregistrement parent associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom parent dans l’interface utilisateur.

    Type de données : chaîne
    item.parent.sys_id Sys_id de l’enregistrement parent associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    produit.article Détails sur le modèle de produit associé à l’enregistrement de l’élément de base d’installation. Utilisez ces informations pour identifier les services associés à n’importe quel modèle de produit.

    Type de données : objet

    "product": {
  "display_value": "String",
  "sys_id": "String"
}
    item.product.display_value Nom de texte du modèle de produit associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du produit dans l’interface utilisateur.

    Type de données : chaîne
    item.product.sys_id Sys_id de l’enregistrement de modèle de produit associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.quantity Nombre d’éléments installés.

    Type de données : entier
    item.service_context Détails sur le contexte de service associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_context.display_value Détails sur le contexte de service associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_context.sys_id Sys_id de l’enregistrement de contexte de service associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.service_organization Détails sur l’organisation de services associée à l’enregistrement d’élément de base d’installation. Renvoyé uniquement si le module d’extension Organisation de services (com.snc.service_organization) est installé.

    Type de données : objet

    "service_organization": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_organization.display_value Nom de texte de l’organisation de services associée à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom de l’organisation de service dans l’interface utilisateur.

    Type de données : chaîne
    item.service_organization.sys_id Sys_id de l’enregistrement de l’organisation de services associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.sys_nom_classe Table contenant l’enregistrement de l’élément de base d’installation.

    Type de données : chaîne
    item.sys_id Sys_id de l’enregistrement de l’élément de base d’installation. Situé dans la table spécifiée dans le sys_class_name paramètre.

    Type de données : chaîne
    élément.état Détails sur l’état actuel de l’élément de base d’installation.

    Type de données : objet

    "state": {
  "display_value": "String",
  "value": "String"
}
    item.state.display_value Chaîne de texte de l’état actuel de l’élément de base d’installation. Utilisez cette valeur pour afficher l’état dans l’interface utilisateur.

    Type de données : chaîne
    élément.état.valeur Valeur interne de l’état de l’élément de base d’installation.

    Type de données : chaîne
    élément.état Détails sur l’état de l’élément de base d’installation.

    Type de données : objet

    "status": {
  "display_value": "String",
  "value": "String"
}
    item.status.display_value Chaîne de texte de l’état de l’élément de base d’installation. Utilisez cette valeur pour afficher l’état dans l’interface utilisateur.

    Type de données : chaîne
    élément.état.valeur Valeur interne de l’état de l’élément de base d’installation.

    Type de données : chaîne
    item.uninstall_date Détails sur la date à laquelle l’élément de base d’installation est devenu inactif.

    Type de données : objet

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    item.uninstall_date.display_value Date de désinstallation du texte. Utilisez cette valeur pour afficher la date de désinstallation dans l’interface utilisateur.

    Type de données : chaîne
    item.uninstall_date.valeur Valeur interne de la date de désinstallation.

    Type de données : chaîne
    statut État de l’appel de point de terminaison.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/42746a3b876121100b6afc86dabb3597/uninstall" \
--request PATCH \
--header "Accept:application/json" \
--user 'username':'password'

    Résultats renvoyés :

    {
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": {
        "value": "sn_install_base_item",
        "display_value": "Install Base Item"
      },
      "number": "IBITM0000901",
      "sys_id": "f77c7542b7343300ece839a6ee11a991",
      "contact": {
        "sys_id": "4d147a386f0331003b3c498f5d3ee437",
        "display_value": "Julie Lewis"
      },
      "state": {
        "value": "inactive",
        "display_value": "Inactive"
      },
      "active": "false",
      "configuration_item": {
        "sys_id": "e5a28e07c30202001efd5cb981d3aedb",
        "display_value": "KX Series - KX5000"
      },
      "name": "KX Series - KX5000",
      "account": {
        "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    }
  }
}

    Élément de base d’installation : POST /sn_install_base/integrations/installbaseitems

    Crée un ou plusieurs enregistrements d’éléments de base d’installation dans la table Élément de base d’installation par défaut, ou dans sa table étendue si spécifiée, et les remplit avec les valeurs de champ spécifiées.

    Lors de la création d’un seul enregistrement d’élément de base d’installation, transmettez un objet dans le corps de la demande qui contient tous les champs à inclure dans le corps de la demande. Lorsque vous créez plusieurs enregistrements d’éléments de base d’installation en un seul appel, vous transmettez un tableau d’objets dans le corps de la demande qui contient tous les enregistrements à créer. Le point de terminaison traite et génère des rapports sur chacun des objets de création d’enregistrement individuellement. Si un ou plusieurs enregistrements ne parviennent pas à être créés, cela n’affecte pas la création d’autres enregistrements.

    Format d'URL

    URL versionnée : /api/sn_install_base/{api_version}/integrations/installbaseitems

    URL par défaut : /api/sn_install_base/integrations/installbaseitems

    Paramètres de demande pris en charge

    Tableau 85. 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 86. Paramètres de requête
    Nom Description
    Aucun
    Tableau 87. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    compte Requis lors de la création d’un élément de base d’installation pour un compte.

    Sys_id du compte à associer à l’élément de base d’installation. Situé dans la table Compte [customer_account].

    Remarque :
    Si vous transmettez le account paramètre, vous ne pouvez pas également transmettre le consumer paramètre.

    Type de données : chaîne
    Actif Marqueur indiquant si l’élément de base d’installation est actif.
    Valeurs valides :
    • vrai, « vrai » ou « 0 » : l’élément est actif.
    • faux, « faux » ou « 1 » : l’élément n’est pas actif.

    Type de données : booléennes

    Valeur par défaut : true
    asset Sys_id de l’actif associé à l’enregistrement d’élément de base d’installation. Situé dans la table Actif [alm_asset].

    Type de données : chaîne
    child_install_base_items Liste des éléments de base d’installation enfants associés à cet élément de base d’installation.
    Remarque :
    Les champs d’élément de base d’installation enfant suivants ne peuvent pas être différents de leur parent :
    • compte
    • consommateur
    • contact
    • Organisation de services

    Type de données : tableau d’objets

    "child_install_base_items": [
  {
    "name": "String",
    "product": "String"
  }
]
    child_install_base_items.name Nom de l’élément de base d’installation enfant.

    Type de données : chaîne
    child_install_base_items.produit Sys_id de l’enregistrement de l’élément de base enfant associé. Situé dans la table Élément de base d’installation [sn_install_base_item].

    Type de données : chaîne
    configuration_item Sys_id de l’élément de configuration associé à l’enregistrement d’élément de base d’installation. Situé dans la table Élément de configuration [cmdb_ci].

    Type de données : chaîne
    consommateur Requis lors de la création d’un élément de base d’installation pour un consommateur.
    Sys_id du consommateur associé à l’enregistrement d’élément de base d’installation. Situé dans la table Consommateur [csm_consumer].
    Remarque :
    Si vous transmettez le consumer paramètre, vous ne pouvez pas également transmettre le account paramètre. En outre, vous ne pouvez associer un consommateur à un élément de base d’installation que si le module d’extension B2B2C est installé sur votre instance.

    Type de données : chaîne
    consumer_profile Sys_id du profil de consommateur associé à l’enregistrement d’élément de base d’installation. Situé dans la table Profil de consommateur [sn_csm_consumer_profile].

    Type de données : chaîne
    contact
    Sys_id de l’enregistrement de contact de compte qui est principalement responsable de l’élément de base d’installation. Situé dans la table Contact [customer_contact].
    Remarque :
    Les contacts ne peuvent être spécifiés que pour les éléments de base d’installation du compte.

    Type de données : chaîne
    household​ Sys_id du ménage associé à l’enregistrement d’élément de base d’installation. Situé dans la table Ménage [csm_household].
    Remarque :
    Ce champ n’est valide que lorsque le module d’extension Service clientèle Household (com.snc.household) est installé.

    Type de données : chaîne
    install_date Date à laquelle l’élément de base d’installation devient actif.

    Type de données : chaîne

    Format : aaaa-MM-jj HH :mm :ss
    emplacement Sys_id de l’emplacement du produit associé. Situé dans la table Emplacement [cmn_location].

    Type de données : chaîne
    nom Nom de l'élément de base d'installation.

    Type de données : chaîne
    Numéro Identificateur unique de l’élément de base d’installation.

    Type de données : chaîne

    Par défaut : généré automatiquement par le point de terminaison.
    parent Sys_id de l’enregistrement parent pour cet enregistrement d’élément de base d’installation. Situé dans la table Élément de base d’installation [sn_install_base_item].

    Type de données : chaîne
    product_model Sys_id du modèle de produit associé à l’enregistrement de l’élément de base d’installation. Situé dans la table Modèle de produit [cmdb_model].

    Type de données : chaîne
    quantité Nombre d’éléments installés.

    Type de données : entier
    service_context Sys_id du service qui est associé au CI sous-jacent pour calculer la sévérité de l’impact de Gestion des événements. Pour plus d'informations, consultez Service health status for install base.
    Remarque :
    Ce champ n’est valide que si le module d’extension Opérations du service clientèle proactif avec Gestion des événements est installé.

    Type de données : chaîne
    service_organization Requis lors de la création d’un élément de base d’installation pour une organisation de services.

    Sys_id de l’enregistrement de l’organisation de service impliquée dans la fourniture du service au client. Situé dans la table Organisation de services [sn_customer_service_organization].

    Remarque :
    Si vous transmettez ce paramètre, vous ne devez pas également transmettre les paramètres compte, contact ou consommateur. Le service_organization paramètre n’est disponible que lorsque le module d’extension Organisation de services (com.snc.service_organization) est installé sur votre instance.

    Type de données : chaîne
    État État actuel de l’élément de base d’installation.
    Valeurs valides :
    • in_use
    • inactif

    Type de données : chaîne
    statut État du produit.
    Valeurs valides :
    • d'origine
    • remplacement

    Type de données : chaîne
    sys_class_name Nom de la table de base d’installation étendue dans laquelle créer l’enregistrement d’élément de base d’installation.

    Type de données : chaîne

    Par défaut : table Élément de base d’installation [sn_install_base_item]
    uninstall_date Date à laquelle la base d’installation devient inactive.

    Type de données : chaîne

    Format : aaaa-MM-jj HH :mm :ss

    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 88. 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
    Content-Type Format de données du corps de la demande. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 89. 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 90. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    403 Interdit. L’utilisateur ne possède pas les droits d’accès à l’enregistrement spécifié.
    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 réponse (JSON ou XML)

    Nom Description
    erreur Détails sur l’erreur qui s’est produite lors de la tentative de traitement de la demande.

    Type de données : objet

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Détails supplémentaires sur l’erreur associée.

    Type de données : chaîne
    message.erreur Message d’erreur qui décrit le problème qui s’est produit lors de la tentative d’exécution de la demande.

    Type de données : chaîne
    élément Élément de base d’installation qui correspondait aux résultats de filtre spécifiés. Seuls les champs non vides sont renvoyés.

    Type de données : tableau d’objets

    "item": {
  "account": {Object},
  "active": "String",
  "asset": {Object},
  "child_install_base_items": {Object},
  "condition": "String",
  "configuration_item": {Object},
  "consumer": {Object},
  "consumer_profile": {Object},
  "contact": {Object},
  "health_status": {Object},
  "health_status_last_updated": "String",
  "household": {Object},
  "install_date": {Object},
  "location": {Object},
  "name": "String",
  "number": "String",
  "parent": {Object},
  "product": {Object},
  "quantity": Integer,
  "service_context": {Object},
  "service_organization" {Object},
  "sys_id": "String",
  "state": {Object},
  "status": {Object},
  "uninstall_date": "String"
}
    compte.élément Détails sur le compte client associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    item.account.display_value Nom de texte du compte client associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du compte client dans l’interface utilisateur.

    Type de données : chaîne
    item.account.sys_id Sys_id de l’enregistrement de compte client associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    élément.actif Marqueur indiquant si l’élément de base d’installation est actif.
    Valeurs possibles :
    • vrai : l’élément de base d’installation est actif.
    • faux : l’élément de base d’installation est inactif.

    Type de données : chaîne booléenne
    élément.actif Détails sur l’actif associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "asset": {
  "display_value": "String",
  "sys_id": "String"
}
    item.asset.display_value Nom de texte de l’actif associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom de la ressource dans l’interface utilisateur.

    Type de données : chaîne
    item.asset.sys_id Sys_id de l’enregistrement d’actif associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.child_install_base_items Liste des éléments de base d’installation enfants associés à cet élément de base d’installation.
    Remarque :
    Les champs d’élément de base d’installation enfant suivants ne peuvent pas être différents de leur parent :
    • compte
    • consommateur
    • contact
    • Organisation de services

    Type de données : tableau d’objets

    "child_install_base_items": [
  {
    "name": "String",
    "product": "String"
  }
]
    item.child_install_base_items.name Nom de l’élément de base d’installation enfant.

    Type de données : chaîne
    item.child_install_base_items.produit Sys_id de l’enregistrement de l’élément de base enfant associé. Situé dans la table Élément de base d’installation [sn_install_base_item].

    Type de données : chaîne
    item.configuration_item Détails sur l’élément de configuration associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "configuration_item": {
  "display_value": "String",
  "sys_id": "String"
}
    item.configuration_item.display_value Nom de texte de l’élément de configuration associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom de l’élément de configuration dans l’interface utilisateur.

    Type de données : chaîne
    item.configuration_item.sys_id Sys_id de l’enregistrement d’élément de configuration associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    Consommateur.Article Détails sur le consommateur associé à l’enregistrement d’élément de base d’installation.
    Remarque :
    Le champ consommateur n’est disponible que si le module d’extension B2B2C est installé.

    Type de données : objet

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    item.consumer.display_value Nom de texte du consommateur associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du consommateur dans l’interface utilisateur.

    Type de données : chaîne
    item.consumer.sys_id Sys_id de l’enregistrement de consommateur associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.consumer_profile Détails sur le profil de consommateur associé à l’enregistrement d’élément de base d’installation.
    Remarque :
    Le champ Profil du consommateur n’est disponible que si le module d’extension B2B2C est installé.

    Type de données : objet

    "consumer_profile": {
  "display_value": "String",
  "sys_id": "String"
}
    item.consumer_profile.display_value Nom de texte du profil de consommateur associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du profil du consommateur dans l’interface utilisateur.

    Type de données : chaîne
    item.consumer_profile.sys_id Sys_id de l’enregistrement de profil de consommateur associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    article.contact Détails sur le contact de compte responsable de l’enregistrement de l’élément de base d’installation.

    Type de données : objet

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    item.contact.display_value Nom de texte du contact du compte associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du contact du compte dans l’interface utilisateur.

    Type de données : chaîne
    item.contact.sys_id Sys_id de l’enregistrement de contact de compte associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.health_status Détails sur l’état d’intégrité actuel de l’élément de base d’installation. Uniquement renvoyé si le module d’extension Proactive Customer Service Operations (com.snc.proactive_cs_itom) est installé.

    Type de données : objet

    "health_status": {
  "display_value": "String",
  "value": "String"
}
    item.health_status.display_value Chaîne de texte de l’état d’intégrité actuel de l’élément de base d’installation. Utilisez cette valeur pour afficher l’état d’intégrité dans l’interface utilisateur.

    Type de données : chaîne
    item.health_status.valeur Valeur interne de l’état d’intégrité de l’élément de base d’installation.

    Type de données : chaîne
    item.health_status_last_updated Date et heure auxquelles l’état d’intégrité a été mis à jour pour la dernière fois pour l’élément de base d’installation.

    Type de données : chaîne
    Article.Ménage Détails sur le ménage associé à l’enregistrement d’élément de base d’installation. Renvoyé uniquement si le module d’extension Service clientèle Household (com.snc.household) est installé.

    Type de données : objet

    "household": {
  "display_value": "String",
  "sys_id": "String"
}
    item.household.display_value Nom de texte du ménage associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du ménage dans l’interface utilisateur.

    Type de données : chaîne
    item.household.sys_id Sys_id du ménage associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.install_date Détails sur la date à laquelle l’élément de base d’installation est devenu actif.

    Type de données : objet

    "install_date": {
  "display_value": "String",
  "value": "String"
}
    item.install_date.display_value Date d’installation du texte. Utilisez cette valeur pour afficher la date d’installation dans l’interface utilisateur.

    Type de données : chaîne
    item.install_date.valeur Valeur interne de la date d’installation.

    Type de données : chaîne
    élément.emplacement Détails sur l’emplacement de l’élément de base d’installation.

    Type de données : objet

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    item.location.display_value Nom de texte de l’emplacement de l’élément de base d’installation. Utilisez cette valeur pour afficher le nom de l’emplacement dans l’interface utilisateur.

    Type de données : chaîne
    item.location.sys_id Sys_id de l’enregistrement d’emplacement associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.name Nom de l'élément de base d'installation.

    Type de données : chaîne
    numéro.élément ID unique de l'élément de base d'installation.

    Type de données : chaîne
    élément.parent Détails sur l’enregistrement parent de l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "parent": {
  "display_value": "String",
  "sys_id": "String"
}
    item.parent.display_value Nom de texte de l’enregistrement parent associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom parent dans l’interface utilisateur.

    Type de données : chaîne
    item.parent.sys_id Sys_id de l’enregistrement parent associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    produit.article Détails sur le modèle de produit associé à l’enregistrement de l’élément de base d’installation. Utilisez ces informations pour identifier les services associés à n’importe quel modèle de produit.

    Type de données : objet

    "product": {
  "display_value": "String",
  "sys_id": "String"
}
    item.product.display_value Nom de texte du modèle de produit associé à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom du produit dans l’interface utilisateur.

    Type de données : chaîne
    item.product.sys_id Sys_id de l’enregistrement de modèle de produit associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.quantity Nombre d’éléments installés.

    Type de données : entier
    item.service_context Détails sur le contexte de service associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_context.display_value Détails sur le contexte de service associé à l’enregistrement d’élément de base d’installation.

    Type de données : objet

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_context.sys_id Sys_id de l’enregistrement de contexte de service associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.service_organization Détails sur l’organisation de services associée à l’enregistrement d’élément de base d’installation. Renvoyé uniquement si le module d’extension Organisation de services (com.snc.service_organization) est installé.

    Type de données : objet

    "service_organization": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_organization.display_value Nom de texte de l’organisation de services associée à l’enregistrement d’élément de base d’installation. Utilisez cette valeur pour afficher le nom de l’organisation de service dans l’interface utilisateur.

    Type de données : chaîne
    item.service_organization.sys_id Sys_id de l’enregistrement de l’organisation de services associé à l’enregistrement d’élément de base d’installation.

    Type de données : chaîne
    item.sys_nom_classe Table contenant l’enregistrement de l’élément de base d’installation.

    Type de données : chaîne
    item.sys_id Sys_id de l’enregistrement de l’élément de base d’installation. Situé dans la table spécifiée dans le sys_class_name paramètre.

    Type de données : chaîne
    élément.état Détails sur l’état actuel de l’élément de base d’installation.

    Type de données : objet

    "state": {
  "display_value": "String",
  "value": "String"
}
    item.state.display_value Chaîne de texte de l’état actuel de l’élément de base d’installation. Utilisez cette valeur pour afficher l’état dans l’interface utilisateur.

    Type de données : chaîne
    élément.état.valeur Valeur interne de l’état de l’élément de base d’installation.

    Type de données : chaîne
    élément.état Détails sur l’état de l’élément de base d’installation.

    Type de données : objet

    "status": {
  "display_value": "String",
  "value": "String"
}
    item.status.display_value Chaîne de texte de l’état de l’élément de base d’installation. Utilisez cette valeur pour afficher l’état dans l’interface utilisateur.

    Type de données : chaîne
    élément.état.valeur Valeur interne de l’état de l’élément de base d’installation.

    Type de données : chaîne
    item.uninstall_date Détails sur la date à laquelle l’élément de base d’installation est devenu inactif.

    Type de données : objet

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    item.uninstall_date.display_value Date de désinstallation du texte. Utilisez cette valeur pour afficher la date de désinstallation dans l’interface utilisateur.

    Type de données : chaîne
    item.uninstall_date.valeur Valeur interne de la date de désinstallation.

    Type de données : chaîne
    statut État de l’appel de point de terminaison.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment créer un seul enregistrement d’élément de base d’installation.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\":\"Base Monitor\",
  \"quantity\": 4,
  \"account\":\"86837a386f0331003b3c498f5d3ee4ca\",
  \"contact\": \"dc0185d94f341200025ba3618110c77c\",
  \"configuration_item\":\"0c43baaac61122750182c132ee74bcf0\",
  \"state\":\"in_use\"
}" \
--user 'username':'password'

    Résultats renvoyés : seuls les champs non vides sont renvoyés.

    {
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": "sn_install_base_item",
      "number": "IBITM0001003",
      "sys_id": "27cb093114c66910f877324710112fd6",
      "contact": {
        "sys_id": "dc0185d94f341200025ba3618110c77c",
        "display_value": "Cindy Contact"
      },
      "state": {
        "value": "in_use",
        "display_value": "In Use"
      },
      "quantity": "4",
      "active": "true",
      "configuration_item": {
        "sys_id": "0c43baaac61122750182c132ee74bcf0",
        "display_value": "3D Pinball"
      },
      "name": "Base Monitor",
      "account": {
        "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    }
  }
}

    Demande cURL

    L’exemple de code suivant montre comment créer plusieurs enregistrements d’éléments de base d’installation.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "[
  {
    \"name\":\"AST4 Laptop\",
    \"consumer\":\"b119803fdb1b1200b6075200cf961917\",
    \"status\":\"replacement\",
    \"install_date\":\"2023-05-18 12:00:00\",
    \"uninstall_date\":\"2023-09-28 12:00:00\"
  },
{
    \"name\":\"Base Monitor\",
    \"quantity\": 4,
    \"account\":\"86837a386f0331003b3c498f5d3ee4ca\",
    \"contact\": \"dc0185d94f341200025ba3618110c77c\",
    \"configuration_item\":\"0c43baaac61122750182c132ee74bcf0\",
    \"state\":\"in_use\"
  }
]" \
--user 'username':'password'

    Résultats renvoyés : seuls les champs non vides sont renvoyés.

    {
  "result": {
    "status": "SUCCESS",
    "items": [
      {
        "status": "SUCCESS",
        "item": {
          "sys_class_name": "sn_install_base_item",
          "number": "IBITM0001018",
          "sys_id": "16fe91b1140a6910f877324710112f40",
          "uninstall_date": {
            "value": "2023-09-28 12:00:00",
            "display_value": "2023-09-28 05:00:00"
          },
          "install_date": {
            "value": "2023-05-18 12:00:00",
            "display_value": "2023-05-18 05:00:00"
          },
          "consumer": {
            "sys_id": "b119803fdb1b1200b6075200cf961917",
            "display_value": "Silvester Erik"
          },
          "active": "true",
          "name": "AST4 Laptop",
          "status": {
            "value": "replacement",
            "display_value": "Replacement"
          }
        }
      },
      {
        "status": "SUCCESS",
        "item": {
          "sys_class_name": "sn_install_base_item",
          "number": "IBITM0001019",
          "sys_id": "5efe91b1140a6910f877324710112f40",
          "contact": {
            "sys_id": "dc0185d94f341200025ba3618110c77c",
            "display_value": "Cindy Contact"
          },
          "state": {
            "value": "in_use",
            "display_value": "In Use"
          },
          "quantity": "4",
          "active": "true",
          "configuration_item": {
            "sys_id": "0c43baaac61122750182c132ee74bcf0",
            "display_value": "3D Pinball"
          },
          "name": "Base Monitor",
          "account": {
            "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
            "display_value": "Boxeo"
          }
        }
      }
    ]
  }
}

    Élément de base d’installation : POST /sn_install_base/integrations/installbaseitems/{id}/relatedparties

    Crée un enregistrement de partie connexe et l’associe à un enregistrement d’élément de base d’installation spécifié. Les valeurs spécifiées dans les paramètres de demande sont stockées dans l’enregistrement de partie connexe nouvellement créé.

    Format d'URL

    URL versionnée : /api/sn_install_base/{api_version}/integrations/installbaseitems/{id}/relatedparties

    URL par défaut : /api/sn_install_base/integrations/installbaseitems/{id}/relatedparties

    Paramètres de demande pris en charge

    Tableau 91. 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 de l’élément de base d’installation. Situé dans la table Élément de base d’installation [sn_install_base_item].

    Type de données : chaîne
    Tableau 92. Paramètres de requête
    Nom Description
    Aucun
    Tableau 93. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    compte Requis si le type paramètre est l’un des suivants :
    • Compte autorisé
    • Contact autorisé
    • Compte répertorié
    • Contact répertorié

    Sys_id du compte à associer à l’élément de base d’installation. Situé dans la table Compte [customer_account].

    Remarque :
    Si vous transmettez le account paramètre, vous ne pouvez pas également transmettre le consumer paramètre.

    Type de données : chaîne
    consommateur Requis si le type paramètre est Consommateur autorisé ou Consommateur répertorié.
    Sys_id du consommateur associé à l’enregistrement d’élément de base d’installation. Situé dans la table Consommateur [csm_consumer].
    Remarque :
    Si vous transmettez le consumer paramètre, vous ne pouvez pas également transmettre le account paramètre. En outre, vous ne pouvez associer un consommateur à un élément de base d’installation que si le module d’extension B2B2C est installé sur votre instance.

    Type de données : chaîne
    contact Sys_id de l’enregistrement de contact associé à l’enregistrement des parties connexes. Situé dans la table Contact [customer_contact].

    Type de données : chaîne
    install_base_item Sys_id de l’enregistrement de l’élément de base d’installation associé à l’enregistrement des parties connexes.

    Type de données : chaîne
    responsabilité Sys_id de l’enregistrement de responsabilité associé. Cet enregistrement définit le niveau d’accès aux informations de base d’installation. Situé dans la table de définition de responsabilité [sn_customerservice_responsibility_def].

    Ce paramètre n’est valide que si le related_party champ est également spécifié. S’il est spécifié, il renvoie uniquement les éléments de base d’installation related_party qui correspondent aux paramètres and responsibility .

    Pour plus d’informations, voir Configure related parties for items received

    Type de données : chaîne
    service_organization Requis si le type paramètre est l’un des suivants :
    • Membre autorisé
    • Organisation de services autorisés
    • Membre répertorié
    • Organisation de services répertoriée

    Sys_id de l’enregistrement de l’organisation de service impliquée dans la fourniture du service au client. Situé dans la table Organisation de services [sn_customer_service_organization].

    Remarque :
    Si vous transmettez ce paramètre, vous ne devez pas également transmettre les paramètres compte, contact ou consommateur. Le service_organization paramètre n’est disponible que lorsque le module d’extension Organisation de services (com.snc.service_organization) est installé sur votre instance.

    Type de données : chaîne
    sys_class_name Table contenant l’enregistrement des parties connexes.

    Type de données : chaîne

    Par défaut : sn_install_base_related_party
    type Requis. Sys_id du type de partie liée à créer. Situé dans la table Configuration des parties associées [sn_customerservice_related_party_configuration].
    Types possibles :
    • Compte autorisé
    • Consommateur autorisé
    • Contact autorisé
    • Contributeur autorisé
    • Membre autorisé
    • Organisation de services autorisés
    • Compte répertorié
    • Consommateur répertorié
    • Contact répertorié
    • Contributeur répertorié
    • Membre répertorié
    • Organisation de services répertoriée

    Type de données : chaîne
    utilisateur Requis si le type paramètre est l’un des types de parties associés suivants :
    • Contributeur autorisé
    • Membre autorisé
    • Contributeur répertorié
    • Membre répertorié

    Pour les membres autorisés et les membres répertoriés, cet utilisateur doit être associé à l’enregistrement spécifié service_organization .

    Sys_id de l’enregistrement utilisateur associé à l’enregistrement des parties connexes. Situé dans la table Utilisateur [sys_user].

    Type de données : chaîne

    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 94. 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
    Content-Type Format de données du corps de la demande. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 95. 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 96. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    403 Interdit. L’utilisateur ne possède pas les droits d’accès à l’enregistrement spécifié.
    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 du corps de réponse (JSON ou XML)

    Nom Description
    compte Détails sur le compte associé à l’enregistrement des parties connexes.

    Type de données : objet

    account": {
  "display_value": "String",
  "sys_id": "String"
}
    account.display_value Nom de texte du compte associé à l’enregistrement des parties connexes. Utilisez cette valeur pour afficher le nom du compte dans l’interface utilisateur.

    Type de données : chaîne
    account.sys_id Sys_id de l’enregistrement de compte associé à l’enregistrement des parties connexes.

    Type de données : chaîne
    consommateur Détails sur le consommateur associé à l’enregistrement des parties connexes.

    Type de données : objet

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    consumer.display_value Nom de texte du consommateur associé à l’enregistrement des parties connexes. Utilisez cette valeur pour afficher le nom du consommateur dans l’interface utilisateur.

    Type de données : chaîne
    consumer.sys_id Sys_id de l’enregistrement de consommateur associé à l’enregistrement des parties connexes.

    Type de données : chaîne
    contact Détails sur le contact de compte responsable de l’enregistrement des parties connexes.

    Type de données : objet

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    contact.display_value Nom de texte du contact associé à l’enregistrement des parties connexes. Utilisez cette valeur pour afficher le nom du contact dans l’interface utilisateur.

    Type de données : chaîne
    contact.sys_id Sys_id de l’enregistrement de contact associé à l’enregistrement des parties connexes. Situé dans la table Contact [customer_contact].

    Type de données : chaîne
    erreur Détails sur l’erreur qui s’est produite lors de la tentative de traitement de la demande.

    Type de données : objet

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Détails supplémentaires sur l’erreur associée.

    Type de données : chaîne
    message.erreur Message d’erreur qui décrit le problème qui s’est produit lors de la tentative d’exécution de la demande.

    Type de données : chaîne
    install_base_item Détails sur l’élément de base d’installation associé à l’enregistrement des parties connexes.

    Type de données : objet

    "install_base_item": {
  "display_value": "String",
  "sys_id": "String"
}
    install_base_item.display_value Nom de texte de l’élément de base d’installation associé à l’enregistrement des parties connexes. Utilisez cette valeur pour afficher le nom de l’élément de base d’installation dans l’interface utilisateur.

    Type de données : chaîne
    install_base_item.sys_id Sys_id de l’enregistrement de l’élément de base d’installation associé à l’enregistrement des parties connexes.

    Type de données : chaîne
    responsabilité Détails sur le niveau d’accès des informations de base d’installation.

    Type de données : objet

    "responsibility": {
  "display_value": "String",
  "sys_id": "String"
}
    responsibility.display_value Valeur d’affichage de texte pour le niveau d’accès aux informations de base d’installation.

    Type de données : chaîne
    responsibility.sys_id Sys_id de l’enregistrement de responsabilité associé. Cet enregistrement définit le niveau d’accès aux informations de base d’installation. Situé dans la table de définition de responsabilité [sn_customerservice_responsibility_def].

    Ce paramètre n’est valide que si le related_party champ est également spécifié. S’il est spécifié, il renvoie uniquement les éléments de base d’installation related_party qui correspondent aux paramètres and responsibility .

    Pour plus d’informations, voir Configure related parties for items received

    Type de données : chaîne
    statut État de l’appel de point de terminaison.

    Type de données : chaîne
    sys_class_name Table contenant l’enregistrement des parties connexes.

    Type de données : chaîne

    Par défaut : sn_install_base_related_party
    sys_id Sys_id de l’enregistrement des parties connexes associées.

    Type de données : chaîne
    sysparm_limit Nombre d’enregistrements qui ont été renvoyés. Si cette valeur n’est pas spécifiée dans la demande d’origine, elle utilise la valeur par défaut.

    Type de données : nombre
    sysparm_offset Décalage (point de départ) dans la table associée à partir de laquelle les enregistrements ont été évalués et récupérés.

    Type de données : chaîne
    type Détails sur le type de contact associé à l’enregistrement des parties connexes.

    Type de données : objet

    "type": {
  "display_value": "String",
  "sys_id": "String"
}
    type.display_value Nom de texte du type de contact associé à l’enregistrement des parties connexes. Utilisez cette valeur pour afficher le type de contact dans l’interface utilisateur. Pour en savoir plus, consultez Add related party configurations to cases, sold products, install bases, or service organizations.
    Types possibles :
    • Compte autorisé
    • Consommateur autorisé
    • Contact autorisé
    • Contributeur autorisé
    • Membre autorisé
    • Organisation de services autorisés
    • Compte répertorié
    • Consommateur répertorié
    • Contact répertorié
    • Contributeur répertorié
    • Membre répertorié
    • Organisation de services répertoriée

    Type de données : chaîne
    type.sys_id Sys_id de type enregistrement associé à l’enregistrement des parties connexes.

    Type de données : chaîne
    utilisateur Détails sur l’utilisateur associé à l’enregistrement des parties connexes.

    Type de données : objet

    "user": {
  "display_value": "String",
  "sys_id": "String"
}
    user.display_value Nom de texte de l’utilisateur associé à l’enregistrement des parties connexes. Utilisez cette valeur pour afficher le nom d’utilisateur dans l’interface utilisateur.

    Type de données : chaîne
    user.sys_id
    Sys_id de l’enregistrement utilisateur associé à l’enregistrement des parties connexes. Situé dans la table Utilisateur [sys_user].

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison pour créer un enregistrement connexe Compte autorisé et l’associer à un élément de base d’installation.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/relatedparties/f77c7542b7343300ece839a6ee11a991" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  "contact":"0a232a0013691200042ab3173244b075",
  "type":"68ec8b2965e99110f87764df53db779f",
  "account":"86837a386f0331003b3c498f5d3ee4ca",
  "install_base_item":"f77c7542b7343300ece839a6ee11a991",
  "responsibility":"c009bbedb3730010700b4d43c6a8dcef",
  "sys_class_name":"sn_install_base_related_party"
}" \
--user 'username':'password'

    Résultats renvoyés :

    {
"result":
  {
    "type": {
      "display_value":"Authorized Contact",
      "sys_id":"68ec8b2965e99110f87764df53db779f"
    },
    "install_base_item": {
      "display_value":"KX Series - KX5000",
      "sys_id":"f77c7542b7343300ece839a6ee11a991"
    },
    "sys_class_name":"sn_install_base_related_party",
    "sys_id":"4659539814ac6910f877ae314c1fb43a",
    "responsibility": {
      "display_value":"Authorized Representative",
      "sys_id":"c009bbedb3730010700b4d43c6a8dcef"
    },
    "contact": {
      "display_value":"Cindy Contact",
      "sys_id":"dc0185d94f341200025ba3618110c77c"
    },
    "account": {
      "display_value":"Boxeo",
      "value":"86837a386f0331003b3c498f5d3ee4ca"
    },
    "status":"SUCCESS",
  }
}