CdmPoliciesApi

  • Rversion finale: Zurich
  • Mis à jour 31 juil. 2025
  • 17 minutes de lecture
  • CdmPoliciesApi fournit des points de terminaison qui vous permettent de gérer les mappages de politiques des déployables dans Gestion des données de configuration (CDM). Les politiques correctement mappées à un élément déployable sont exécutées lorsqu’un instantané de l’élément déployable est validé.

    Vous devez disposer de l’un des rôles suivants pour accéder aux points de terminaison de cette API :
    • REST scripté ACL de vue CDM
    • REST scripté ACL de l’administrateur CDM

    En outre, le module d’extension Gestion des données de configuration (CDM) doit être activé pour que cette API soit disponible dans une instance.

    Pour plus d’informations sur les mappages de stratégies, consultez Mapper les stratégies à un élément déployable.

    CdmPoliciesApi : SUPPRIMER /sn_cdm/policies/mappings

    Supprime le mappage d’une stratégie spécifiée à un élément déployable.

    L’appelant de ce point de terminaison doit avoir le rôle d’administrateur CDM.

    Format d'URL

    URL versionnée : /api/sn_cdm/{api_version}/policies/mappings

    URL par défaut : /api/sn_cdm/policies/mappings

    Remarque :
    Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

    Paramètres de demande pris en charge

    Tableau 1. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne

    Tableau 2. Paramètres de requête
    Nom Description
    appName Requis. Nom de l’application Gestion des données de configuration (CDM) dont le mappage à la politique doit être supprimé.

    Type de données : chaîne

    Table : Application CDM [sn_cdm_application]

    deployableName Requis. Nom de l’élément déployable CDM pour lequel le mappage doit être supprimé à la politique.

    Type de données : chaîne

    Table : déployable CDM [sn_cdm_deployable]

    policyName Requis. Nom de la politique associée.

    Type de données : chaîne

    Tableau : Politique [sn_pace_policy]

    Tableau 3. Paramètres du corps de la demande
    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.
    400 Demande incorrecte. Le policyName paramètre transmis n’est pas valide.
    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

    Nom Description
    erreur Si une erreur s’est produite pendant le traitement, les détails de l’erreur.

    Type de données : objet

    "error": {
      "detail": "String",
      "message": "String"
    }
    erreur.détail Informations supplémentaires sur l’erreur.

    Type de données : chaîne

    message.erreur Message d’erreur généré lors de la tentative de traitement de la demande.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment supprimer un mappage de stratégies.

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings?deployableName=Development_1&policyName=testALPolicy1&appName=testApp" \ 
    --request DELETE \ 
    --header "Accept:application/json" \ 
    --user 'username':'password'

    Pour une suppression réussie du mappage, aucune réponse autre que le code d’état HTTP n’est renvoyée.

    None - results defined by the HTTP status code

    CdmPoliciesApi : obtenir /sn_cdm/policies/mappings/inputs/resolved

    Renvoie les entrées résolues pour un mappage de stratégie spécifié d’un élément déployable.

    Pour plus d’informations sur les mappages de stratégies, consultez Mapper les stratégies à un déployable et Validation et correction des données de configuration.

    L’appelant de ce point de terminaison doit avoir le rôle de visionneur CDM.

    Format d'URL

    URL versionnée : /api/sn_cdm/{api_version}/policies/mappings/inputs/resolved

    URL par défaut : /api/sn_cdm/policies/mappings/inputs/resolved

    Remarque :
    Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

    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. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne

    Tableau 8. Paramètres de requête
    Nom Description
    appName Requis. Nom de l’application Gestion des données de configuration (CDM) associée au déployable pour laquelle renvoyer les entrées de politique résolues.

    Type de données : chaîne

    Table : Application CDM [sn_cdm_application]

    deployableName Requis. Nom du déployable CDM pour lequel renvoyer la politique résolue.

    Type de données : chaîne

    Table : déployable CDM [sn_cdm_deployable]

    policyName Requis. Nom de la politique associée.

    Type de données : chaîne

    Tableau : Politique [sn_pace_policy]

    Tableau 9. Paramètres du corps de la demande
    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. Le policyName paramètre transmis n’est pas valide.
    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

    Nom Description
    résultat Paire nom-valeur Liste de toutes les entrées résolues pour le mappage de stratégie spécifié.

    Par exemple : {"input_name » : « user_1 », « input_password » : «  » }

    Type de données : objet

    Demande cURL

    L’exemple suivant montre comment utiliser ce point de terminaison pour obtenir les entrées de politique résolues.

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings/inputs/resolved?policyName=testALPolicy1&deployableName=Development_1&appName=testApp" \ 
    --request GET \ 
    --header "Accept:application/json" \ 
    --user 'username':'password'

    Renvoyer le résultat :

    { 
      "result": { 
        "key1": "someVal", 
        "additionalDeployablesInput": "[{\"id\":\"e7e34a531b501110636e0fe0604bcba9\",\"label\":\"testApp-Development_2\"}]" 
      } 
    }

    CdmPoliciesApi : POST /sn_cdm/policies/mappings

    Mappe une stratégie spécifiée à un élément déployable.

    L’appelant de ce point de terminaison doit avoir le rôle d’administrateur CDM.

    Format d'URL

    URL versionnée : /api/sn_cdm/{api_version}/policies/mappings

    URL par défaut : /api/sn_cdm/policies/mappings

    Remarque :
    Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

    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. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne

    Tableau 14. Paramètres de requête
    Nom Description
    appName Requis. Nom de l’application Gestion des données de configuration (CDM) pour laquelle mapper la politique.

    Type de données : chaîne

    Table : Application CDM [sn_cdm_application]

    deployableName Requis. Nom de l’élément déployable CDM pour lequel mapper la politique.

    Type de données : chaîne

    Table : déployable CDM [sn_cdm_deployable]

    policyName Requis. Nom de la politique associée.

    Type de données : chaîne

    Tableau : Politique [sn_pace_policy]

    returnFields Liste des champs à renvoyer dans le cadre de la réponse. Transmettez les noms de colonnes d’enregistrement tels que sys_id, sys_updated_by ou état.

    Type de données : tableau

    Par défaut : tous les champs tels que déterminés par le point de terminaison

    Tableau 15. Paramètres du corps de la demande
    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. Prend uniquement en charge application/json.
    Content-Type Format de données du corps de la demande. Prend uniquement en charge application/json.
    Tableau 17. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir 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é.
    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

    Nom Description
    description Description du mappage.

    Type de données : chaîne

    document Sys_id du document.

    Type de données : chaîne

    document_ref Détails de l’enregistrement document_ref associé au nœud.

    Type de données : objet

    "document_ref": {
      "link": "String",
      "value": "String"
    }
    document_ref.lien Syntaxe d’appel pour interroger l’enregistrement déployable mappé à la politique à l’aide de l’API REST de table .

    PaCE Utilise ce champ pour stocker la référence à l’élément déployable mappé à une politique.

    Type de données : chaîne

    document_ref.sys_id Sys_id de l’enregistrement déployable mappé à la politique.

    Type de données : chaîne

    erreur Si une erreur s’est produite pendant le traitement, les détails de l’erreur.

    Type de données : objet

    "error": {
      "detail": "String",
      "message": "String"
    }
    erreur.détail Informations supplémentaires sur l’erreur.

    Type de données : chaîne

    message.erreur Message d’erreur généré lors de la tentative de traitement de la demande.

    Type de données : chaîne

    exception S’il existe une exception lors de la tentative de mappage, le lien renvoie à l’enregistrement d’exception.

    Type de données : chaîne

    exception_allowed Marqueur indiquant si des exceptions sont autorisées pour la politique.
    Valeurs possibles :
    • true : des exceptions sont autorisées.
    • faux : les exceptions ne sont pas autorisées.

    Type de données : booléennes

    input_status État des entrées.
    Valeurs possibles :
    • non valide
    • valide

    Type de données : chaîne

    last_updated_by Détails de l’utilisateur qui a mis à jour le mappage de stratégie pour la dernière fois.

    Type de données : objet

    "last_updated_by": {
      "link": "String",
      "value": "String"
    }
    last_updated_by.lien Syntaxe d’appel pour interroger l’enregistrement utilisateur à l’aide de l’API REST de table .

    Type de données : chaîne

    last_updated_by.sys_id Sys_id de l'enregistrement de l'utilisateur.

    Type de données : chaîne

    Table : Utilisateur [sys_user]

    Numéro Numéro unique qui identifie le mappage. Cette valeur fournit un identificateur lisible par l’homme pour le mappage.

    Type de données : chaîne

    policy Détails de l’enregistrement de politique associé au mappage.

    Type de données : objet

    "policy": {
      "link": "String",
      "value": "String"
    }
    policy.link Syntaxe d’appel pour interroger l’enregistrement de politique mappé à la politique à l’aide de l’API REST de table .

    Type de données : chaîne

    policy.sys_id Sys_id de l’enregistrement de la politique.

    Type de données : chaîne

    Tableau : Politique [sn_pace_policy]

    motif Description de la raison de l’état actuel.

    Type de données : chaîne

    État État actuel du mappage.
    Valeurs possibles :
    • actif
    • inactif

    Type de données : chaîne

    sys_class_name Nom de table du mappage de stratégies.

    Type de données : chaîne

    sys_created_by Nom de l’utilisateur qui a créé le mappage.

    Type de données : chaîne

    sys_created_on Date et heure auxquelles le mappage a été créé.

    Type de données : chaîne

    Format : aaaa-mm-jj hh :mm :ss

    sys_id Sys_id du mappage.

    Type de données : chaîne

    Table : Mappage de stratégie [sn_pace_policy_mapping]

    sys_updated_by Nom de l’utilisateur qui a mis à jour le mappage.

    Type de données : chaîne

    sys_updated_on Date et heure auxquelles le mappage a été mis à jour pour la dernière fois.

    Type de données : chaîne

    Format : aaaa-mm-jj hh :mm :ss

    Demande cURL

    Cet exemple de code montre comment mapper une stratégie spécifique à un élément déployable.

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings?appName=testApp&deployableName=Development_1&policyName=testALPolicy1" \ 
    --request POST \ 
    --header "Accept:application/json" \ 
    --user 'username':'password'

    Renvoyer les résultats :

    { 
      "result": { 
        "exception": null, 
        "reason": null, 
        "exception_allowed": "--", 
        "document": "0be34a531b501110636e0fe0604bcb21", 
        "input_status": "valid", 
        "description": null, 
        "sys_updated_on": "2022-06-30 14:07:37", 
        "sys_class_name": "sn_cdm_pace_policy_mapping", 
        "sys_id": "ea24469f1b101110636e0fe0604bcbed", 
        "number": "MAP0001001", 
        "last_updated_by": { 
          "value": "48630e131b501110636e0fe0604bcb53", 
          "link": "https://instance.servicenow.com/api/now/table/sys_user/48630e131b501110636e0fe0604bcb53" 
        }, 
        "sys_updated_by": "admin", 
        "sys_created_on": "2022-06-30 14:07:37", 
        "document_ref": { 
          "value": "0be34a531b501110636e0fe0604bcb21", 
          "link": "https://instance.servicenow.com/api/now/table/sn_cdm_deployable/0be34a531b501110636e0fe0604bcb21" 
        }, 
        "state": "active", 
        "sys_created_by": "admin", 
        "policy": { 
          "value": "12a3c2531b501110636e0fe0604bcb9b", 
          "link": "https://instance.servicenow.com/api/now/table/sn_pace_policy/12a3c2531b501110636e0fe0604bcb9b" 
        } 
      } 
    }

    CdmPoliciesApi : PUT /sn_cdm/policies/mappings/inputs/additional-deployables

    Met à jour la variable d’entrée additionalDeployablesInput d’un Gestion des données de configuration mappage de stratégie (CDM).

    La variable d’entrée additionalDeployablesInput contient les déployables supplémentaires que vous pouvez affecter à un mappage de stratégie existant. Elles sont similaires aux entrées de mappage, mais elles ont une structure de tableau spécifique.

    Pour plus d’informations sur les mappages de stratégies, consultez Mapper les stratégies à un élément déployable.

    L’appelant de ce point de terminaison doit avoir le rôle d’administrateur CDM.

    Format d'URL

    URL versionnée : /api/sn_cdm/{api_version}/policies/mappings/inputs/additional-deployables

    URL par défaut : /api/sn_cdm/policies/mappings/inputs/additional-deployables

    Remarque :
    Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

    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. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne

    Tableau 20. Paramètres de requête
    Nom Description
    additionalDeployables Requis. Liste des déployables à ajouter à la variable d’entrée additionalDeployablesInput.

    Type de données : tableau d’objets

    "additionalDeployables": [
      {
        "appName": "String", 
        "deployableName": "String"
      }
    ]
    additionalDeployables.appName Requis. Nom de l’application CDM à laquelle le déployable est associé.

    Type de données : chaîne

    Table : Application CDM [sn_cdm_application]

    additionalDeployables.deployableName Requis. Nom du déployable CDM à ajouter à la variable d’entrée additionalDeployablesInput.

    Type de données : chaîne

    Table : déployable CDM [sn_cdm_deployable]

    appName Requis. Nom de l’application CDM pour laquelle mettre à jour la variable d’entrée additionalDeployablesInput.

    Type de données : chaîne

    Table : Application CDM [sn_cdm_application]

    deployableName Requis. Nom du déployable CDM pour lequel mettre à jour la variable d’entrée additionalDeployablesInput.

    Type de données : chaîne

    Table : déployable CDM [sn_cdm_deployable]

    policyName Requis. Nom de la politique associée.

    Type de données : chaîne

    Tableau : Politique [sn_pace_policy]

    returnFields Liste des champs à renvoyer dans le cadre de la réponse. Transmettez les noms de colonnes d’enregistrement tels que sys_id, sys_updated_by ou état.

    Type de données : tableau

    Par défaut : tous les champs tels que déterminés par le point de terminaison

    Tableau 21. Paramètres du corps de la demande
    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. Prend uniquement en charge application/json.
    Content-Type Format de données du corps de la demande. Prend uniquement en charge 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. Le policyName paramètre transmis n’est pas valide.
    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

    Nom Description
    io_definition Détails sur l’enregistrement de définition d’E/S associé PaCE .

    Pour plus d’informations sur , reportez-vous à PaCEPolicy as Code Engine (PaCE).

    Type de données : objet

    "io_definition": {
      "link": "String",
      "value": "String"
    }
    io_definition.lien Syntaxe d’appel pour interroger cet PaCE enregistrement de définition E/S à l’aide de l’API REST de table .

    Type de données : chaîne

    io_definition.valeur Sys_id de l’enregistrement de définition de l’E PaCE /S.

    Type de données : chaîne

    Table : Mappage des E/S [sn_pace_io_mapping]

    is_unused Marqueur indiquant si la variable d’entrée de mappage est inutilisée.
    Valeurs possibles :
    • vrai : la variable d’entrée de mappage associée n’est pas utilisée actuellement.
    • false : la variable d’entrée de mappage associée est actuellement utilisée.

    Type de données : booléennes

    mapped_value Valeur actuelle de la variable d’entrée de mappage.

    Type de données : tableau d’objets ou chaîne

    policy_mapping Détails sur l’enregistrement de mappage PaCE de stratégie.

    Pour plus d’informations sur , reportez-vous à PaCEPolicy as Code Engine (PaCE).

    Type de données : objet

    "policy_mapping": {
      "link": "String",
      "value": "String"
    }
    policy_mapping.lien Syntaxe d’appel pour interroger l’enregistrement de mappage de stratégie à l’aide de l’API REST de table .

    Type de données : chaîne

    policy_mapping.valeur Sys_id de l’enregistrement de mappage PaCE de stratégie.

    Type de données : chaîne

    Table : Mappage de stratégie [sn_pace_policy_mapping]

    sys_created_by Nom de l’utilisateur qui a créé la variable d’entrée de mappage.

    Type de données : chaîne

    sys_created_on Date et heure auxquelles la variable d’entrée de mappage a été créée.

    Type de données : chaîne

    Format : aaaa-mm-jj hh :mm :ss

    sys_id Sys_id de l’enregistrement de mappage associé.

    Type de données : chaîne

    Table : Mappage des E/S [sn_pace_io_mapping]

    sys_updated_by Nom de l’utilisateur qui a mis à jour la variable d’entrée de mappage.

    Type de données : chaîne

    sys_updated_on Date et heure auxquelles la variable d’entrée de mappage a été mise à jour pour la dernière fois.

    Type de données : chaîne

    Format : aaaa-mm-jj hh :mm :ss

    Demande cURL

    L’exemple suivant montre comment ajouter des déployables à une variable d’entrée additionalDeployablesInput.

    curl "https://instance.servicenow.com/api/sn_cdm/policies/mappings/inputs/additional-deployables?additionalDeployables=%5B%7B%22appName%22%3A%20%22testApp%22%2C%20%22deployableName%22%3A%22Development_2%22%7D%5D&policyName=testALPolicy1&deployableName=Development_1&appName=testApp" \ 
    --request PUT \ 
    --header "Accept:application/json" \ 
    --user 'admin':'admin

    Renvoyer le résultat :

    { 
      "result": { 
        "sys_id": "6bb746171b501110636e0fe0604bcb1c", 
        "policy_mapping": { 
          "value": "6bb746171b501110636e0fe0604bcb1b", 
          "link": "https://instance.servicenow.com/api/now/table/sn_cdm_pace_policy_mapping/6bb746171b501110636e0fe0604bcb1b" 
        }, 
        "sys_updated_by": "ameya", 
        "sys_created_on": "2022-06-30 14:23:15", 
        "io_definition": { 
          "value": "4d0b061b1b501110636e0fe0604bcb2f", 
          "link": "https://instance.servicenow.com/api/now/table/sn_pace_io_definition/4d0b061b1b501110636e0fe0604bcb2f" 
        }, 
        "mapped_value": "[{\"id\":\"e7e34a531b501110636e0fe0604bcba9\",\"label\":\"testApp-Development_2\"}]", 
        "sys_updated_on": "2022-06-30 14:53:21", 
        "sys_created_by": "ameya", 
        "is_unused": false 
      } 
    } 

    CdmPoliciesApi : PUT /sn_cdm/policies/mappings/inputs

    Met à jour une variable d’entrée spécifiée pour un mappage de Gestion des données de configuration politique (CDM).

    Pour plus d’informations sur les mappages de stratégies, consultez Mapper les stratégies à un élément déployable.

    L’appelant de ce point de terminaison doit avoir le rôle d’administrateur CDM.

    Format d'URL

    URL versionnée : /api/sn_cdm/{api_version}/policies/mappings/inputs

    URL par défaut : /api/sn_cdm/policies/mappings/inputs

    Remarque :
    Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

    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. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne

    Tableau 26. Paramètres de requête
    Nom Description
    appName Requis. Nom de l’application CDM pour laquelle les entrées de mappage de politique doivent être mises à jour.

    Type de données : chaîne

    Table : Application CDM [sn_cdm_application]

    deployableName Requis. Nom du déployable CDM pour lequel mettre à jour les entrées de mappage de politique.

    Type de données : chaîne

    Table : déployable CDM [sn_cdm_deployable]

    Nom d’entrée Requis. Nom de la variable d’entrée à mettre à jour.

    Type de données : chaîne

    Table : Mappage des E/S [sn_pace_io_mapping]

    Valeur d’entrée Requis. Valeur à affecter à la variable d’entrée.

    Type de données : dépendant de la variable d’entrée. Vous pouvez trouver le type de données dans la table Mappage des E/S [sn_pace_io_mapping].

    policyName Requis. Nom de la politique associée.

    Type de données : chaîne

    Tableau : Politique [sn_pace_policy]

    returnFields Liste des champs à renvoyer dans le cadre de la réponse. Transmettez les noms de colonnes d’enregistrement tels que sys_id, sys_updated_by ou état.

    Type de données : tableau

    Par défaut : tous les champs tels que déterminés par le point de terminaison

    Tableau 27. Paramètres du corps de la demande
    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. Prend uniquement en charge application/json.
    Content-Type Format de données du corps de la demande. Prend uniquement en charge 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. Le policyName paramètre transmis n’est pas valide.
    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

    Nom Description
    io_definition Détails sur l’enregistrement de définition d’E/S associé PaCE .

    Pour plus d’informations sur , reportez-vous à PaCEPolicy as Code Engine (PaCE).

    Type de données : objet

    "io_definition": {
      "link": "String",
      "value": "String"
    }
    io_definition.lien Syntaxe d’appel pour interroger cet PaCE enregistrement de définition E/S à l’aide de l’API REST de table .

    Type de données : chaîne

    io_definition.valeur Sys_id de l’enregistrement de définition de l’E PaCE /S.

    Type de données : chaîne

    Table : Mappage des E/S [sn_pace_io_mapping]

    is_unused Marqueur indiquant si la variable d’entrée de mappage est inutilisée.
    Valeurs possibles :
    • vrai : la variable d’entrée de mappage associée n’est pas utilisée actuellement.
    • false : la variable d’entrée de mappage associée est actuellement utilisée.

    Type de données : booléennes

    mapped_value Valeur actuelle de la variable d’entrée de mappage.

    Type de données : tableau d’objets ou chaîne

    policy_mapping Détails sur l’enregistrement de mappage PaCE de stratégie.

    Pour plus d’informations sur , reportez-vous à PaCEPolicy as Code Engine (PaCE).

    Type de données : objet

    "policy_mapping": {
      "link": "String",
      "value": "String"
    }
    policy_mapping.lien Syntaxe d’appel pour interroger l’enregistrement de mappage de stratégie à l’aide de l’API REST de table .

    Type de données : chaîne

    policy_mapping.valeur Sys_id de l’enregistrement de mappage PaCE de stratégie.

    Type de données : chaîne

    Table : Mappage de stratégie [sn_pace_policy_mapping]

    sys_created_by Nom de l’utilisateur qui a créé la variable d’entrée de mappage.

    Type de données : chaîne

    sys_created_on Date et heure auxquelles la variable d’entrée de mappage a été créée.

    Type de données : chaîne

    Format : aaaa-mm-jj hh :mm :ss

    sys_id Sys_id de l’enregistrement de mappage associé.

    Type de données : chaîne

    Table : Mappage des E/S [sn_pace_io_mapping]

    sys_updated_by Nom de l’utilisateur qui a mis à jour la variable d’entrée de mappage.

    Type de données : chaîne

    sys_updated_on Date et heure auxquelles la variable d’entrée de mappage a été mise à jour pour la dernière fois.

    Type de données : chaîne

    Format : aaaa-mm-jj hh :mm :ss

    Demande cURL

    L’exemple suivant montre comment mettre à jour la variable d’entrée key1 associée à testALPolicy.

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings/inputs?policyName=testALPolicy1&appName=testApp&inputValue=value1&inputName=key1&deployableName=Development_1" \ 
    --request PUT \ 
    --header "Accept:application/json" \ 
    --user 'username':'password'

    Renvoyer les résultats :

    { 
      "result": { 
        "sys_id": "631b861b1b501110636e0fe0604bcb6f", 
        "policy_mapping": { 
          "value": "6bb746171b501110636e0fe0604bcb1b", 
          "link": "https://instance.servicenow.com/api/now/table/sn_cdm_pace_policy_mapping/6bb746171b501110636e0fe0604bcb1b" 
        }, 
        "sys_updated_by": "admin", 
        "sys_created_on": "2022-06-30 14:38:00", 
        "io_definition": { 
          "value": "fe1b061b1b501110636e0fe0604bcb90", 
          "link": "https://instance.servicenow.comm/api/now/table/sn_pace_io_definition/fe1b061b1b501110636e0fe0604bcb90" 
        }, 
        "mapped_value": "someVal", 
        "sys_updated_on": "2022-06-30 14:39:21", 
        "sys_created_by": "admin", 
        "is_unused": false 
      } 
    }