CdmSharedLibraryApi

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 30 minutes de lecture
  • CdmSharedLibraryApi fournit des points de terminaison qui vous permettent de créer et de gérer des bibliothèques partagées et des composants partagés. Il dispose également de points de terminaison qui vous permettent de charger et d’exporter les données de configuration d’un composant partagé.

    Cette API nécessite que le module d’extension Gestion des données de configuration (CDM) soit activé pour que ces API soient disponibles dans l’instance. En outre, vous devez avoir l’un des rôles suivants pour accéder à cette API :
    • Rôle d’éditeur CDM
    • Rôle administrateur CDM

    Pour plus d’informations sur les bibliothèques partagées et les composants partagés, consultez Partage de composants entre applications — Bibliothèques de composants.

    CdmSharedLibraryApi : SUPPRIMER /sn_cdm/shared_libraries

    Supprime la bibliothèque partagée avec le nom spécifié.

    Le rôle administrateur CDM est requis pour accéder à ce point de terminaison.

    Format d'URL

    URL versionnée : /api/sn_cdm/{api_version}/shared_libraries

    URL par défaut : /api/sn_cdm/shared_libraries

    Paramètres de demande pris en charge

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

    Type de données : chaîne

    Tableau 2. Paramètres de requête
    Nom Description
    Aucun
    Tableau 3. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    nom Requis. Nom de la bibliothèque partagée à supprimer. Situé dans la table [sn_cdm_application] de l’application CDM.

    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 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
    • application/xml
    • text/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. 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 (JSON ou XML)

    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"
    }
    error.detail Informations supplémentaires sur l’erreur.

    Type de données : chaîne

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

    Type de données : chaîne

    statut État de l’erreur de la demande.

    Valeurs possibles : échec

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment supprimer la bibliothèque partagée « javalib ».

    curl "http://instance.servicenow.com/sn_cdm/shared_libraries?name='javalib'\ 
    --request DELETE\ 
    --header "Accept:application/json" \ 
    --user 'username':'password'

    Réponse :

    ""

    CdmSharedLibraryApi : SUPPRIMER /sn_cdm/shared_libraries/composants

    Supprime le composant partagé spécifié de la bibliothèque spécifiée.

    Le rôle d’éditeur CDM est requis pour accéder à ce point de terminaison.

    Remarque :
    Vous ne pouvez supprimer un composant que s’il n’est pas en cours d’utilisation. En outre, vous ne pouvez pas supprimer un composant si la bibliothèque partagée associée n’est pas active.

    Format d'URL

    URL versionnée : /api/sn_cdm/{api_version}/shared_libraries/components

    URL par défaut : /api/sn_cdm/shared_libraries/components

    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
    changesetNumber Requis. Numéro de l’ensemble de changements associé au composant. Situé dans la table de l’ensemble de changements CDM [sn_cdm_changeset]

    Type de données : chaîne

    nom Requis. Nom du composant partagé à supprimer. Situé dans la table Composant partagé CDM [sn_cdm_shared_component].

    Type de données : chaîne

    sharedLibraryName Requis. Nom de la bibliothèque partagée où se trouve le composant à supprimer. Situé dans la table [sn_cdm_application] de l’application CDM.

    Type de données : chaîne

    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
    • application/xml
    • text/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.
    Problèmes possibles :
    • La bibliothèque partagée n’existe pas.
    • La bibliothèque partagée n’est pas active.
    • Le composant partagé est en cours d’utilisation. Impossible de le supprimer.
    • L’utilisateur ne peut pas supprimer le composant partagé.
    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"
    }
    error.detail Informations supplémentaires sur l’erreur.

    Type de données : chaîne

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

    Type de données : chaîne

    statut État de l’erreur de la demande.

    Valeurs possibles : échec

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment supprimer le composant « TestComponent » sous la bibliothèque partagée « javalib ».

    curl "http://instance.servicenow.com/sn_cdm/shared_libraries/components?sharedLibraryName='javalib&changesetNumber='chset-8'&name='TestComponent'\ 
    --request DELETE\ 
    --header "Accept:application/json" \ 
    --user 'username':'password' 

    Réponse :

    ""

    CdmSharedLibraryApi : GET /sn_cdm/shared_libraries/upload-status/{upload-id}

    Renvoie l’état actuel de la demande de chargement de la bibliothèque partagée spécifiée.

    Format d'URL

    URL versionnée : /api/sn_cdm/{api_version}/shared_libraries/upload-status/{upload-id}

    URL par défaut : /api/sn_cdm/shared_libraries/upload-status/{upload-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 de chargement Sys_id de la demande de chargement dont l’état doit être renvoyé. Cette valeur est renvoyée par divers points de terminaison de demande de chargement CdmSharedLibrary.

    Type de données : chaîne

    Tableau 14. Paramètres de requête
    Nom Description
    Aucun
    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.

    Types pris en charge :

    • application/json
    • application/xml
    • text/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é.
    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
    erreurs Description de la ou des erreurs rencontrées lors du chargement.

    Type de données : chaîne

    sortie Description des données chargées ou, si une erreur s’est produite pendant le chargement, message d’erreur décrivant l’erreur rencontrée.

    Type de données : tableau de chaînes

    "output": {
      "auto_validate": "String",
      "cdm_application": "String",
      "committed_at": "String",
      "committed_by": "String",
      "description": "String",
      "last_conflict_detection_time": "String",
      "number": "String",
      "publish_option": "String",
      "sharedLibraryName": "String",
      "snapshot_description": "String",
      "snapshot_name": "String",
      "state": "String",
      "sys_created_by": "String",
      "sys_id": "String",
      "title": "String"
    }
    output.auto_validate Indique s’il faut invoquer la validation après la validation.

    Type de données : chaîne

    output.cdm_application Nom de l’application sous laquelle le chargement a été effectué.

    Type de données : chaîne

    output.committed_at Date et heure de validation du contenu chargé.

    Type de données : chaîne

    output.committed_by Sys_id de l’enregistrement de l’entité qui a effectué la validation.

    Type de données : chaîne

    Sortie.description Non utilisé actuellement.

    Type de données : chaîne

    output.last_conflict_detection_time Invocation de détection de conflit de date et d’heure.

    Type de données : chaîne

    output.number Valeur unique d’identification de l’ensemble de changements, telle que Chset-124.

    Type de données : chaîne

    output.publish_option Valeur de l’option de publication transmise dans l’appel de chargement associé.

    Pour plus d’informations sur la publication d’instantanés, consultez Publier ou annuler la publication d’un instantané.

    Type de données : chaîne

    output.sharedLibraryName Nom de la bibliothèque partagée tel que transmis lors de l’appel de chargement d’origine.

    Type de données : chaîne

    output.snapshot_description Description de l’instantané associé.

    Type de données : chaîne

    output.snapshot_name Nom de l’instantané associé.

    Type de données : chaîne

    sortie.état État du chargement.
    Valeurs possibles :
    • COMPLETED : le chargement est terminé.
    • EXPIREDERROR : erreur lors du traitement de la demande de chargement. La tâche s’est exécutée pendant plus de 15 minutes et a été arrêtée par le système.
    • IN_PROGRESS : le chargement est en cours de traitement.
    • NOUVEAU : le traitement n’a pas encore commencé.
    • PRÊT : la demande a été mise en file d’attente.

    Type de données : chaîne

    output.sys_created_by Sys_id de l’entité qui a créé l’enregistrement.

    Type de données : chaîne

    output.sys_id Sys_id de l’enregistrement contenant l’ensemble de changements.

    Type de données : chaîne

    sortie.titre Titre de l’ensemble de changements créé dans le cadre du chargement.

    Type de données : chaîne

    processing_state État de traitement actuel de la demande de chargement.

    Valeurs possibles : TRAITÉ

    Type de données : chaîne

    État État actuel de la demande de chargement.
    Valeurs possibles :
    • terminé
    • erreur
    type Type de demande de chargement.

    Valeurs possibles : upload_and_commit

    Type de données : chaîne

    upload_id Sys_id de l’enregistrement contenant la charge utile de configuration chargée.

    Type de données : chaîne

    Demande cURL

    Cet exemple de code montre comment demander l’état de l’upload-id 0d91d9891b2b19109524cae0604bcbe6.

    curl "http://instance.servicenow.com/api/sn_cdm/shared_libraries/upload-status/0d91d9891b2b19109524cae0604bcbe6" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username':'password'

    Réponse :

    // Successful response
    {
      "result": {
        "type": "upload_and_commit",
        "state": "completed",
        "output": {
          "sys_id": "0002ea107768a1109ac0cf0bbb5a9963",
          "number": "Chset-457",
          "title": "admin8802ea107768a1109ac0cf0bbb5a9962",
          "description": null,
          "committed_at": "",
          "committed_by": null,
          "sys_created_by": "admin",
          "state": "open",
          "publish_option": "publish_none",
          "auto_validate": false,
          "snapshot_name": null,
          "snapshot_description": null,
          "cdm_application": "OracleG-Library-15",
          "last_conflict_detection_time": null
        },
        "processing_state": "PROCESSED",
        "upload_id": "00b226547768a1109ac0cf0bbb5a99f2"
      }
    }
    
    // Error response
    {
      "result": {
        "type": "upload_and_commit",
        "state": "error",
        "output": "Error: Application with sys_id 87fb1ecb1be3111050fc21b0604bcb95 is in State Deleted. No data can be modified on deleted applications",
        "processing_state": "PROCESSED",
        "upload_id": "fcdfaf7f1b88211050fc21b0604bcb79"
      }
    }

    CdmSharedLibraryApi : POST /sn_cdm/shared_libraries

    Crée une nouvelle bibliothèque partagée avec le nom spécifié.

    Le rôle administrateur CDM est requis pour accéder à ce point de terminaison.

    Format d'URL

    URL versionnée : /api/sn_cdm/{api_version}/shared_libraries

    URL par défaut : /api/sn_cdm/shared_libraries

    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

    Tableau 20. Paramètres de requête
    Nom Description
    description Description de la bibliothèque partagée.

    Type de données : chaîne

    Par défaut : vide

    nom Requis. Nom de la bibliothèque partagée à créer. Ce nom doit être unique dans toutes les applications et bibliothèques CDM.

    Type de données : chaîne

    returnFields Liste de champs séparés par des virgules à renvoyer dans le cadre de la réponse. Situé dans la table [sn_cdm_application] de l’application CDM.

    Type de données : chaîne

    Par défaut : tous les champs non-système sont renvoyés.

    userGroupIds Liste séparée par des virgules des sys_ids des groupes d’utilisateurs qui peuvent modifier la bibliothèque partagée associée. Tous les utilisateurs disposant des rôles appropriés peuvent afficher la bibliothèque partagée. Situé dans la table Groupe [sys_user_group].

    Type de données : chaîne

    Par défaut : tous les utilisateurs ayant le rôle d’éditeur CDM peuvent modifier les données de la bibliothèque partagée.

    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
    • application/xml
    • text/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é.
    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
    <champs> Champs demandés à partir de la table [sn_cdm_application] de l’application CDM.

    Type de données : variable

    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"
    }
    error.detail Informations supplémentaires sur l’erreur.

    Type de données : chaîne

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

    Type de données : chaîne

    statut État de l’erreur de la demande.

    Valeurs possibles : échec

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison pour créer la bibliothèque partagée Java11Lib avec tous les groupes d’utilisateurs pouvant accéder à la bibliothèque.

    curl "http://instance.servicenow.com/api/sn_cdm/shared_libraries?name=Java11Lib&description=The%20new%20java%20library" \ 
    --request POST \ 
    --header "Accept:application/json" \ 
    --user 'userName':'password

    Réponse :

    {
      "result": {
        "sdlc_component": null,
        "cdi_count": "0",
        "available": false,
        "description": "Description of LibraryA",
        "managed_by_group": null,
        "sys_updated_on": "2023-01-18 11:34:43",
        "type": "shared_library",
        "node": {
          "value": "d852b15877a4a1109ac0cf0bbb5a99aa",
          "link": "http://instance.servicenow.com/api/now/table/sn_cdm_node/d852b15877a4a1109ac0cf0bbb5a99aa"
        },
        "sys_id": "185235dc77a4a1109ac0cf0bbb5a994e",
        "sys_updated_by": "admin",
        "node_main": {
          "value": "1852b15877a4a1109ac0cf0bbb5a99aa",
          "link": "http://instance.servicenow.com/api/now/table/sn_cdm_node_main/1852b15877a4a1109ac0cf0bbb5a99aa"
        },
        "sys_created_on": "2023-01-18 11:34:43",
        "cdi_usage": "0",
        "name": "LibraryA",
        "last_committed_changeset": {
          "value": "9052b15877a4a1109ac0cf0bbb5a99aa",
          "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/9052b15877a4a1109ac0cf0bbb5a99aa"
        },
        "state": "active",
        "sys_created_by": "admin"
      }
    }

    CdmSharedLibraryApi : POST /sn_cdm/shared_libraries/composants

    Crée le composant partagé spécifié dans la bibliothèque spécifiée.

    Le rôle d’éditeur CDM est requis pour accéder à ce point de terminaison.

    Format d'URL

    URL versionnée : /api/sn_cdm/{api_version}/shared_libraries/components

    URL par défaut : /api/sn_cdm/shared_libraries/components

    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

    Tableau 26. Paramètres de requête
    Nom Description
    changesetNumber Requis.
    Identificateur unique de l’ensemble de changements associé, tel que « Chset-10 ». Situé dans la table de l’ensemble de changements CDM [sn_cdm_changeset].

    Type de données : chaîne

    description Description du composant partagé.

    Type de données : chaîne

    nom Requis. Nom du composant partagé à créer dans la bibliothèque partagée. Ce nom doit être unique.

    Type de données : chaîne

    returnFields Liste de champs séparés par des virgules dans la table Nœud CDM [sn_cdm_node] à renvoyer dans le cadre de la réponse.

    Type de données : chaîne

    Par défaut : tous les champs non internes sont renvoyés.

    sharedLibraryName Requis. Nom de la bibliothèque partagée sous laquelle créer le composant. Cette bibliothèque doit déjà exister et être à l’état actif.

    Type de données : chaîne

    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.

    Types pris en charge :

    • application/json
    • application/xml
    • text/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é.
    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
    <champs demandés> Champs demandés à partir de la table Nœud CDM [sn_cdm_node].
    erreur Renvoyé uniquement si une erreur s’est produite pendant le traitement.

    Type de données : objet

    "error": {
      "detail": "String",
      "message": "String"
    }
    error.detail Détails sur l’erreur qui s’est produite.

    Type de données : chaîne

    message.erreur Message qui donne une vue d’ensemble de l’erreur.

    Type de données : chaîne

    statut État de l’erreur de la demande.

    Valeurs possibles : échec

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant stocke le composant nommé « SharedComponent » sous la bibliothèque partagée « javalib ».

    curl "http://instance.servicenow.com/sn_cdm/shared_libraries/components/?sharedLibraryName=javalib&changeSetNumber='Chset-9'&name='SharedComponent'\  
    --request POST\  
    --header "Accept:application/json" \  
    --user 'username':'password'

    Réponse :

    {
      "result": {
        "changeset_id": {
          "value": "ca7e6a501b202110636e0fe0604bcb71",
          "link": "https://instance.servicenow.com/api/now/table/sn_cdm_changeset/ca7e6a501b202110636e0fe0604bcb71"
        },
        "node_path": "!2!3!:",
        "description": null,
        "sys_updated_on": "2023-01-18 16:04:52",
        "type": "sn_cdm_node_shared_component",
        "sys_class_name": "sn_cdm_node",
        "sys_id": "6d2072901b602110636e0fe0604bcbec",
        "sys_updated_by": "admin",
        "previous_version": null,
        "sys_created_on": "2023-01-18 16:04:52",
        "value": null,
        "effective_from": null,
        "linked_to": null,
        "sys_created_by": "admin",
        "restricted_to": null,
        "linked_to_version": null,
        "level": "2",
        "conflict_type": null,
        "main_id": "19",
        "effective_to": null,
        "secure_value": null,
        "node_classifier": "/shared_library/shared_components",
        "main_id_encoded": ":",
        "name": "testSharedComponent",
        "position": null,
        "reason_for_conflict": null,
        "system_folder": false,
        "status": "new",
        "conflict": false
      }
    }

    CdmSharedLibraryApi : POST /sn_cdm/shared_libraries/uploads/components

    Permet de créer et de gérer des bibliothèques partagées et des composants partagés. Ce point de terminaison crée un nœud de composant partagé dans la table Nœud CDM [sn_cdm_node] et un enregistrement de composant partagé dans la table Composant partagé CDM [sn_cdm_shared_component].

    Le rôle d’éditeur CDM est requis pour accéder à ce point de terminaison.

    Remarque :
    Par défaut, la taille maximale de chargement de contenu est de 2 Mo. Vous pouvez modifier cette valeur par défaut en mettant à jour la propriété sn_cdm.max_allowed_upload_file_size.
    Remarque :
    Cette méthode de chargement ne peut pas être utilisée pour modifier des nœuds. Utilisez la méthode alternative CdmSharedLibraryApi : POST /sn_cdm/shared_libraries/uploads/components/file pour modifier les nœuds.

    Format d'URL

    URL versionnée : /api/sn_cdm/{api_version}/shared_libraries/uploads/components

    URL par défaut : /api/sn_cdm/shared_libraries/uploads/components

    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

    Tableau 32. Paramètres de requête
    Nom Description
    Validation automatique Marqueur indiquant si l’ensemble de changements identifié dans le changesetNumber paramètre est validé dans le modèle de données après le chargement.
    Valeurs valides :
    • vrai : l’ensemble de changements est validé après le chargement.
    • false : l’ensemble de changements n’est pas validé après le chargement.

    Type de données : booléennes

    Valeur par défaut : false

    autoDelete Marqueur indiquant si les nœuds existants, qui ne font pas partie du contenu téléchargé, sont supprimés une fois le traitement terminé.
    Valeurs valides :
    • true : supprime automatiquement les nœuds existants.
    • false : ne supprime pas automatiquement les nœuds existants.

    Type de données : booléennes

    Valeur par défaut : false

    changesetNumber Requis. Chaîne qui identifie de manière unique l’ensemble de changements associé à l’application, telle que Chset-102. Situé dans la table de l’ensemble de changements CDM [sn_cdm_changeset]. Cet ensemble de changements doit être dans l’état « Ouvert ».

    Type de données : chaîne

    dataFormat (Format de données) Requis. Format des données de configuration.
    Valeurs valides :
    • csv
    • ini
    • JSON
    • Propriétés de
    • brut
    • xml
    • yaml

    Type de données : chaîne

    deleteRedundantOverrides Marqueur indiquant s’il faut créer un remplacement lorsque des valeurs redondantes sont présentes.
    Valeurs valides :
    • true : si des valeurs redondantes sont présentes, un remplacement n’est pas créé.
    • false : si des valeurs redondantes sont présentes, procède au remplacement.

    Valeur par défaut : true

    identifierKeys Liste de noms qui indiquent la clé d’un enfant de tableau à utiliser pour identifier le même nœud.

    Par exemple, si vous chargez :

    [
      {"name" : "Allan, "city" : "Paris"}, 
      {"name" : "Karen, "city" : "Sydney"}
    ]

    dans le modèle existant suivant :

    [
      {"name" : "Karen, "city" : "Manila"},
      {"name" : "Allan, "city" : "Brussels"}
    ]

    et que vous définissez identifierKeys sur name, cela produit la sortie suivante :

    [
      {"name" : "Karen, "city" : "Sydney"},
      {"name" : "Allan, "city" : "Paris"}
    ]

    Sinon, il produit la sortie suivante :

    [
      {"name" : "Karen, "city" : "Manila"},
      {"name" : "Allan, "city" : "Brussels"},
      {"name" : "Allan, "city" : "Paris"},
      {"name" : "Karen, "city" : "Sydney"}
    ]

    Type de données : tableau de chaînes

    ignoreAttributes (en anglais seulement) Marqueur indiquant si le format de données donné prend en charge les attributs (actuellement uniquement XML).
    Valeurs valides :
    • vrai : si le format de données donné prend en charge les attributs, tous les attributs des données d’entrée sont ignorés pendant le chargement.
    • false : si le format de données donné prend en charge les attributs, tous les attributs des données d’entrée sont inclus dans le chargement.

    Type de données : booléennes

    Valeur par défaut : false

    namePath Chemin d’accès du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d’accès est relatif aux composants, à la collection ou au dossier déployable (selon le point de terminaison appelé).
    Vous pouvez transmettre le chemin d’accès au nom dans l’un des formats suivants. Par exemple, pour définir le chemin d’accès du nom du nœud testApp/deployables/Development1/cdi1 :
    • Format de barre oblique inverse : testApp/deployables/Development1/cdi1
      Remarque :
      Si le nom de votre nœud contient une barre oblique inverse (« / »), vous ne pouvez pas utiliser ce format.
    • Chemin d’accès au nom du back-end avec caractères de remplacement : testApp déployables Développement1 cdi1
    • Tableau : ['testApp','deployables','Development1','cdi1']
    Remarque :
    Si le composant spécifié n’existe pas sur le chemin d’accès spécifié, le système crée automatiquement le composant sur le chemin d’accès spécifié, puis charge les données.

    Type de données : chaîne

    publishOption (en anglais seulement)
    Option Publier pour les instantanés configurés associés.
    Valeurs valides :
    • publish_new_and_unpublish_old : publiez le nouvel instantané créé après la validation et annulez la publication de l’instantané existant.
    • publish_none : ne publiez pas d’instantanés.

    Pour plus d’informations sur la publication d’instantanés, consultez Publier ou annuler la publication d’un instantané.

    Type de données : chaîne

    Par défaut : publish_none

    sharedLibraryName Requis. Nom de la bibliothèque partagée à créer ou gérer. Situé dans la table [sn_cdm_application] de l’application CDM.

    Type de données : chaîne

    Tableau 33. Paramètres du corps de la demande
    Nom Description
    Données de chargement de variable Données de configuration à charger. Il peut s’agir de n’importe quelle donnée au format défini par le dataFormat paramètre des paramètres de requête.

    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. Prend uniquement en charge application/json.
    Type de contenu Format de données du corps de la demande. Types pris en charge : text/plain et application/x-www-form-urlencoded.

    Valeur par défaut : text/plain

    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. La demande de chargement a été rejetée.
    Problèmes possibles :
    • La taille de la charge utile de la configuration est supérieure à la valeur maximale autorisée (2 Mo par défaut).
    • Les paramètres requis sont manquants dans l’appel.
    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"
    }
    error.detail Informations supplémentaires sur l’erreur.

    Type de données : chaîne

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

    Type de données : chaîne

    upload_id Sys_id de la demande de chargement. Utilisez cet ID pour appeler le point de terminaison afin d’obtenir l’état du chargement.

    Type de données : chaîne

    statut État de l’erreur de la demande.

    Valeurs possibles : échec

    Type de données : chaîne

    Demande cURL

    L’exemple suivant montre comment charger la bibliothèque partagée appelée Demo_App1631126164773 avec les données de configuration en texte brut.

    curl "http://instance.servicenow.com/api/sn_cdm/sharedlibrary/component/upload?namePath=%2FSettings%2FdbSettings&dataFormat=json&appName=Demo_App1631126164773&changesetNumber=Chset-8&autoCommit=false&publishOption=publish_none&autoDelete=true" \ 
    --request POST \  
    --header "Accept:application/json" \  
    --header "Content-Type:text/plain" \  
    --data "{  
      \"dbIPAddress\": \"10.10.10.110\",  
    \"dbPort\": \"8080\",  
    \"dbConnectionString\": \"admin:admin server1.xyz.com:8080 dbName_payments\",  
    \"dbConnectionStringBackup\": \"admin:admin server2.xyz.com dbName_payments_backup\ "}" \  
    --user 'username':'password' 

    Les résultats de retour suivants montrent à la fois une réponse réussie et une réponse d’erreur à cette demande.

    // Successful response 
    {  
    "result": {  
        "upload_id": "ec1f71f45322301096edddeeff7b12b3"  
      }  
    }
     
    // Error response 
    
    {  
    "error": {  
       "message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)",  
       "detail": ""  
    },  
    "status": "failure" 
    } 

    CdmSharedLibraryApi : POST /sn_cdm/shared_libraries/uploads/components/file

    Télécharge les fichiers dans le cadre du modèle de données de configuration (CDM) dans le dossier des composants d’une bibliothèque partagée.

    Format d'URL

    URL versionnée : /api/sn_cdm/{api_version}shared_libraries/uploads/components/file

    URL par défaut : /api/sn_cdm/shared_libraries/uploads/components/file

    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

    Tableau 38. Paramètres de requête
    Validation automatique Marqueur indiquant si l’ensemble de changements identifié dans le changesetNumber paramètre est validé dans le modèle de données après le chargement.
    Valeurs valides :
    • vrai : l’ensemble de changements est validé après le chargement.
    • false : l’ensemble de changements n’est pas validé après le chargement.

    Type de données : booléennes

    Valeur par défaut : false

    Valider automatiquement Marqueur indiquant si les instantanés créés lors de la validation sont validés.
    Valeurs valides :
    • true : validez les instantanés.
    • false : ne validez pas les instantanés.
    Remarque :
    Cette option n’est disponible que si le autoCommit paramètre est défini sur vrai.

    Type de données : booléennes

    Valeur par défaut : false

    changesetNumber Chaîne qui identifie de manière unique l’ensemble de changements associé à l’application, telle que Chset-102. Cet ensemble de changements doit être dans l’état « Ouvert ». Situé dans la table de l’ensemble de changements CDM [sn_cdm_changeset].

    Type de données : chaîne

    Par défaut : crée un ensemble de changements à utiliser. Les détails de l’ensemble de changements sont renvoyés dans le CdmApplicationsApi : GET /sn_cdm/applications/upload-status/{upload_id} cadre des résultats.

    fileName Nom du fichier à charger. Ce nom peut différer du nom de fichier réel et contenir l’extension du fichier. Par exemple, .txt/.scv/.jar. La valeur fileName est appliquée lors du téléchargement du fichier.

    Type de données : chaîne

    fileNodeName Nom du nœud de fichier. Ce nom de fichier est utilisé dans les données de configuration lors de l’exportation. Ce nom ne nécessite pas d’extension de fichier et n’affecte pas le téléchargement.

    Type de données : chaîne

    namePath Chemin d’accès du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d’accès est relatif aux composants, à la collection ou au dossier déployable (selon le point de terminaison appelé).
    Vous pouvez transmettre le chemin d’accès au nom dans l’un des formats suivants. Par exemple, pour définir le chemin d’accès du nom du nœud testApp/deployables/Development1/cdi1 :
    • Format de barre oblique inverse : testApp/deployables/Development1/cdi1
      Remarque :
      Si le nom de votre nœud contient une barre oblique inverse (« / »), vous ne pouvez pas utiliser ce format.
    • Chemin d’accès au nom du back-end avec caractères de remplacement : testApp déployables Développement1 cdi1
    • Tableau : ['testApp','deployables','Development1','cdi1']
    Remarque :
    Si le composant spécifié n’existe pas sur le chemin d’accès spécifié, le système crée automatiquement le composant sur le chemin d’accès spécifié, puis charge les données.

    Type de données : chaîne

    sharedLibraryName Requis. Nom de la bibliothèque partagée où se trouve le composant à supprimer. Situé dans la table [sn_cdm_application] de l’application CDM.

    Type de données : chaîne

    Tableau 39. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Données de chargement de variable Données de configuration à charger. Par défaut, les téléchargements de taille de fichier sont limités à 5 Mo. Pour plus d’informations sur le réglage de la taille et du type de vos fichiers de chargement, consultez ceci Now Support article.

    Type de données : Chaîne/flux

    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

    Type de contenu Type de contenu du fichier à télécharger. Exemples : application/zip, text/plain, 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.

    La demande de chargement a été rejetée.

    Problèmes possibles :
    • La taille de la charge utile de la configuration est supérieure à la limite autorisée : 2 Mo par défaut.
    • Les paramètres requis sont manquants dans l’appel.
    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 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"
    }
    error.detail Informations supplémentaires sur l’erreur.

    Type de données : chaîne

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

    Type de données : chaîne

    statut État de l’erreur de la demande.

    Valeurs possibles : échec

    Type de données : chaîne

    upload_id Sys_id de la demande de chargement. Utilisez cet ID pour appeler le CdmApplicationsApi : GET /sn_cdm/applications/upload-status/{upload_id} point de terminaison afin d’obtenir l’état du chargement.

    Type de données : chaîne

    Demande cURL

    L’appel suivant montre comment charger un fichier texte brut dans le dossier des composants de la bibliothèque partagée.

    curl "http://instance.servicenow.com/api/sn_cdm/shared_libraries/uploads/components/file?autoValidate=true&sharedLibraryName=sharedLibA &namePath=testComponent%2FfilesFolder&fileName=testFileNodeName.txt&publishOption=publish_valid&changesetNumber=Chset-108&autoCommit=true&fileNodeName=testFile.txt" \ 
    --request POST \ 
    --header "Accept:application/json" \ 
    --header "Content-Type:text/plain" \ 
    --data "This is sample content that will be uploaded to a plain text file."\ 
    --user 'username':'password' 

    Les résultats de retour suivants montrent à la fois une réponse réussie et une réponse d’erreur à cette demande.

    // Successful completion of the upload request
    { 
      "result": { 
        "upload_id": "ec1f71f45322301096edddeeff7b12b3" 
      } 
    } 
    
    // Error response. Payload is too large.
    { 
      "error": { 
        "message": "Could not find active application with name: ‘testApp’ of type application", 
        "detail": "" 
      },
      "status": "failure"
    }

    CdmSharedLibraryApi : PUT /sn_cdm/shared_libraries

    Met à jour les informations de la bibliothèque partagée. Utilisez ce point de terminaison pour mettre à jour le nom, la description, l’état d’une bibliothèque partagée et les groupes d’utilisateurs qui peuvent y accéder.

    Le rôle administrateur CDM est requis pour accéder à ce point de terminaison.

    Format d'URL

    URL versionnée : /api/sn_cdm/{api_version}/shared_libraries

    URL par défaut : /api/sn_cdm/shared_libraries

    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

    Tableau 44. Paramètres de requête
    Nom Description
    nom Requis. Nom de la bibliothèque partagée à mettre à jour. Situé dans la table [sn_cdm_application] de l’application CDM.

    Type de données : chaîne

    newAvailableState Marqueur qui indique l’état de la bibliothèque partagée.
    Valeurs valides :
    • true : la bibliothèque partagée est active.
    • false : la bibliothèque partagée est inactive. Aucun utilisateur n’est autorisé à accéder à cette bibliothèque.

    Valeur par défaut : true

    nouvelleDescription Description mise à jour de la bibliothèque partagée.

    Type de données : chaîne

    nouveauNom Nouveau nom de la bibliothèque partagée.

    Type de données : chaîne

    nouveauUserGroupIds Liste séparée par des virgules des sys_ids des groupes d’utilisateurs qui peuvent accéder à la bibliothèque partagée associée. Situé dans la table Groupe [sys_user_group].

    Type de données : chaîne

    returnFields Liste de champs séparés par des virgules dans la table de l’application CDM [sn_cdm_application] à renvoyer dans le cadre de la réponse.

    Type de données : chaîne

    Par défaut : tous les champs non-système sont renvoyés.

    Tableau 45. 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 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
    • application/xml
    • text/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é.
    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
    <champs> Champs demandés à partir de la table [sn_cdm_application] de l’application CDM.

    Type de données : variable

    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"
    }
    error.detail Informations supplémentaires sur l’erreur.

    Type de données : chaîne

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

    Type de données : chaîne

    statut État de l’erreur de la demande.

    Valeurs possibles : échec

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison pour la bibliothèque partagée Java11Lib et mettre à jour le nom et la description de la bibliothèque.

    curl "http://instance.servicenow.com/sn_cdm/shared_libraries?name=' javalib'&newName=’NewLibraryName’&newDescription=’new%20description%20of%20library’\ 
    --request PUT\ 
    --header "Accept:application/json" \ 
    --user 'username':'password'  

    Réponse :

    {
      "result": {
        "sdlc_component": null,
        "cdi_count": "0",
        "available": true,
        "description": "Set new description",
        "managed_by_group": null,
        "sys_updated_on": "2023-01-18 11:51:14",
        "type": "shared_library",
        "node": {
          "value": "021635dc77a4a1109ac0cf0bbb5a9952",
          "link": "http://192.168.0.129:8080/api/now/table/sn_cdm_node/021635dc77a4a1109ac0cf0bbb5a9952"
        },
        "sys_id": "185235dc77a4a1109ac0cf0bbb5a994e",
        "sys_updated_by": "admin",
        "node_main": {
          "value": "1852b15877a4a1109ac0cf0bbb5a99aa",
          "link": "http://192.168.0.129:8080/api/now/table/sn_cdm_node_main/1852b15877a4a1109ac0cf0bbb5a99aa"
        },
        "sys_created_on": "2023-01-18 11:34:43",
        "cdi_usage": "0",
        "name": "LibraryA",
        "last_committed_changeset": {
          "value": "4a1635dc77a4a1109ac0cf0bbb5a9951",
          "link": "http://192.168.0.129:8080/api/now/table/sn_cdm_changeset/4a1635dc77a4a1109ac0cf0bbb5a9951"
        },
        "state": "active",
        "sys_created_by": "admin"
      }
    }

    CdmSharedLibraryApi : PUT /sn_cdm/shared_libraries/components

    Met à jour le nom et la description du composant partagé spécifié.

    Le rôle d’éditeur CDM est requis pour accéder à ce point de terminaison.

    Remarque :
    Le changement de nom n’est autorisé que si un composant n’a jamais été utilisé, c’est-à-dire lorsque l’instantané du composant n’a jamais été importé. Le scénario de renommage vise principalement à corriger les fautes de frappe lors de la création de nouveaux composants.

    Format d'URL

    URL versionnée : /api/sn_cdm/{api_version}/shared_libraries/components

    URL par défaut : /api/sn_cdm/shared_libraries/components

    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

    Tableau 50. Paramètres de requête
    Nom Description
    changesetNumber Requis. Nom de l’ensemble de changements associé. Situé dans la table de l’ensemble de changements CDM [sn_cdm_changeset].

    Type de données : chaîne

    nom Requis. Nom du composant partagé à mettre à jour. Situé dans la table Composant partagé CDM [sn_cdm_shared_component].

    Type de données : chaîne

    nouveauNom Requis. Nom mis à jour du composant partagé.

    Type de données : chaîne

    nouvelleDescription Description mise à jour du composant partagé.

    Type de données : chaîne

    Par défaut : vide

    returnFields Liste de champs séparés par des virgules dans la table Composant partagé CDM [sn_cdm_shared_component] à renvoyer dans le cadre de la réponse.

    Type de données : chaîne

    Par défaut : tous les champs non-système sont renvoyés.

    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
    • application/xml
    • text/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é.
    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
    <champs> Champs demandés à partir de la table Composant partagé CDM [sn_cdm_shared_component].

    Type de données : variable

    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"
    }
    error.detail Informations supplémentaires sur l’erreur.

    Type de données : chaîne

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

    Type de données : chaîne

    statut État de l’erreur de la demande.

    Valeurs possibles : échec

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment mettre à jour la description du composant SharedComponentTest.

    curl "http://instance.servicenow.com/sn_cdm/shared_libraries/components/?sharedLibraryName=javalib&changeSetNumber='chset-9'&name='SharedComponentTest'&newDescription='The shared component description'\  
    --request POST\  
    --header "Accept:application/json" \  
    --user 'username':'password

    Réponse :

    {
      "result": {
        "changeset_id": {
          "value": "5c33311077e4a1109ac0cf0bbb5a9902",
          "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/5c33311077e4a1109ac0cf0bbb5a9902"
        },
        "node_path": "!(1!(2!(3",
        "description": "Changing the description only",
        "sys_updated_on": "2023-01-18 12:09:05",
        "type": "sn_cdm_node_shared_component",
        "sys_class_name": "sn_cdm_node",
        "sys_id": "9953f99077a4a1109ac0cf0bbb5a99ec",
        "sys_updated_by": "admin",
        "previous_version": null,
        "sys_created_on": "2023-01-18 11:39:09",
        "value": null,
        "effective_from": null,
        "linked_to": null,
        "sys_created_by": "admin",
        "restricted_to": null,
        "linked_to_version": null,
        "level": "2",
        "conflict_type": null,
        "main_id": "183",
        "effective_to": null,
        "secure_value": null,
        "node_classifier": "/shared_library/shared_components",
        "main_id_encoded": "(3",
        "name": "sharedComponentName",
        "position": null,
        "reason_for_conflict": null,
        "system_folder": false,
        "status": "new",
        "conflict": false
      }
    }