CdmSharedLibraryApi
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é.
- Rôle d’éditeur CDM
- Rôle administrateur CDM
Pour plus d’informations sur les bibliothèques partagées et les composants partagés, reportez-vous à la section 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.
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| nom | Requis. Nom de la bibliothèque partagée à supprimer. Situé dans la table Application CDM [sn_cdm_application]. 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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Types pris en charge :
Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| 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 de corps de réponse (JSON ou XML)
| Nom | Description |
|---|---|
| erreur | Si une erreur s’est produite pendant le traitement, les détails sur l’erreur. Type de données : objet |
| erreur.détail | Informations supplémentaires sur l’erreur. Type de données : chaîne |
| message d’erreur | Message d’erreur généré lors de l’essai 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/components
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.
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
| Nom | Description |
|---|---|
| api_version | Type de données : chaîne |
| Nom | Description |
|---|---|
| changesetNumber | Requis. Numéro de l’ensemble de changements associé au composant. Situé dans la table Ensembles 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 Application CDM [sn_cdm_application]. Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Types pris en charge :
Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Problèmes possibles : |
| 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 sur l’erreur. Type de données : objet |
| erreur.détail | Informations supplémentaires sur l’erreur. Type de données : chaîne |
| message d’erreur | Message d’erreur généré lors de l’essai 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
| Nom | Description |
|---|---|
| api_version | 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 |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Types pris en charge :
Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| 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 de 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, un message d’erreur décrivant l’erreur rencontrée. Type de données : tableau de chaîne |
| 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 |
| sortie.number | Valeur d’identification unique 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 :
Type de données : chaîne |
| output.sys_créée_par | 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 :
|
| 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 pour 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
| Nom | Description |
|---|---|
| api_version | Type de données : chaîne |
| Nom | Description |
|---|---|
| description | Description de la bibliothèque partagée. Type de données : chaîne Valeur 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 Application CDM [sn_cdm_application]. Type de données : chaîne Par défaut : tous les champs non liés au 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 disposant du rôle d’éditeur CDM peuvent modifier les données de la bibliothèque partagée. |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Types pris en charge :
Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| 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 Application [sn_cdm_application] CDM. Type de données : variable |
| erreur | Si une erreur s’est produite pendant le traitement, les détails sur l’erreur. Type de données : objet |
| erreur.détail | Informations supplémentaires sur l’erreur. Type de données : chaîne |
| message d’erreur | Message d’erreur généré lors de l’essai 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':'passwordRé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/components
Crée le composant partagé spécifié sous 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
| Nom | Description |
|---|---|
| api_version | Type de données : chaîne |
| Nom | Description |
|---|---|
| changesetNumber | Requis. |
| 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 [sn_cdm_node] CDM à 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 |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Types pris en charge :
Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| 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 [sn_cdm_node]. |
| erreur | Renvoyé uniquement si une erreur s’est produite pendant le traitement. Type de données : objet |
| erreur.détail | Détails sur l’erreur qui s’est produite. Type de données : chaîne |
| message d’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
Vous 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.
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
| Nom | Description |
|---|---|
| api_version | Type de données : chaîne |
| Nom | Description |
|---|---|
| Autocommit | 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 :
Type de données : booléennes Valeur par défaut : false |
| autoDelete | Marqueur qui indique si les nœuds existants, qui ne font pas partie du contenu de chargement, sont supprimés une fois le traitement terminé. Valeurs valides :
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, tel que Chset-102. Situé dans la table Ensemble de changements CDM [sn_cdm_changeset]. Cet ensemble de changements doit être dans l’état « Ouvert ». Type de données : chaîne |
| Format de données | Requis. Format des données de configuration. Valeurs valides :
Type de données : chaîne |
| deleteRedundantOverrides | Marqueur indiquant s’il faut créer un remplacement en présence de valeurs redondantes. Valeurs valides :
Valeur par défaut : true |
| Clés d’identificateur | Liste de noms qui indiquent quelle clé d’un enfant de tableau utiliser pour identifier le même nœud. Par exemple, si vous chargez : dans le modèle existant suivant : et que vous définissez identifierKeys sur name, il produit la sortie suivante : Sinon, il produit la sortie suivante : Type de données : tableau de chaînes |
| ignorer les attributs | Marqueur indiquant si le format de données donné prend en charge les attributs (actuellement uniquement XML). Valeurs valides : 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é). 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 (publication)Option | Option Publier pour les instantanés configurés associés. Valeurs valides :
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 Valeur par défaut : publish_none |
| sharedLibraryName | Requis. Nom de la bibliothèque partagée à créer ou à gérer. Situé dans la table Application CDM [sn_cdm_application]. Type de données : chaîne |
| 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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| 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 |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| 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 :
|
| 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 sur l’erreur. Type de données : objet |
| erreur.détail | Informations supplémentaires sur l’erreur. Type de données : chaîne |
| message d’erreur | Message d’erreur généré lors de l’essai 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
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.
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Type de données : chaîne |
| Autocommit | 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 :
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 :
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, tel que Chset-102. Cet ensemble de changements doit être dans l’état « Ouvert ». Situé dans la table 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é). 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 Application CDM [sn_cdm_application]. 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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Valeur par défaut : application/json |
| Type de contenu | Type de contenu du fichier à charger. Exemples : application/zip, text/plain, application/json. |
| En-tête | Description |
|---|---|
| Aucun |
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 accéder à la bibliothèque.
Le rôle administrateur CDM est requis pour accéder à ce point de terminaison.
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Type de données : chaîne |
| Nom | Description |
|---|---|
| nom | Requis. Nom de la bibliothèque partagée à mettre à jour. Situé dans la table Application CDM [sn_cdm_application]. Type de données : chaîne |
| nouveauÉtat disponible | Marqueur qui indique l’état de la bibliothèque partagée. Valeurs valides :
Valeur par défaut : true |
| nouvelleDescription | Description mise à jour de la bibliothèque partagée. Type de données : chaîne |
| Newname | 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 Application [sn_cdm_application] CDM à renvoyer dans le cadre de la réponse. Type de données : chaîne Par défaut : tous les champs non liés au système sont renvoyés. |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Types pris en charge :
Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| 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 Application [sn_cdm_application] CDM. Type de données : variable |
| erreur | Si une erreur s’est produite pendant le traitement, les détails sur l’erreur. Type de données : objet |
| erreur.détail | Informations supplémentaires sur l’erreur. Type de données : chaîne |
| message d’erreur | Message d’erreur généré lors de l’essai 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.
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Type de données : chaîne |
| Nom | Description |
|---|---|
| changesetNumber | Requis. Nom de l’ensemble de changements associé. Situé dans la table 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 |
| Newname | Requis. Nom du composant partagé mis à jour. Type de données : chaîne |
| nouvelleDescription | Description mise à jour du composant partagé. Type de données : chaîne Valeur par défaut : vide |
| returnFields | Liste de champs séparés par des virgules dans la table Composant partagé [sn_cdm_shared_component] CDM à renvoyer dans le cadre de la réponse. Type de données : chaîne Par défaut : tous les champs non liés au système sont renvoyés. |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Types pris en charge :
Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| 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 de la table Composant partagé [sn_cdm_shared_component] CDM. Type de données : variable |
| erreur | Si une erreur s’est produite pendant le traitement, les détails sur l’erreur. Type de données : objet |
| erreur.détail | Informations supplémentaires sur l’erreur. Type de données : chaîne |
| message d’erreur | Message d’erreur généré lors de l’essai 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':'passwordRé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
}
}