--- sourceDocument: Référence de l’API Xanadu sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference Release : - xanadu ft:locale : - fr-FR ft:publication_title : - Référence de l’API Xanadu ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # DocumentService : champ d'application, global # DocumentService : champ d'application, global {#ariaid-title1} * Rversion finale: Xanadu * * Mis à jour 1 août 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 minutes de lecture L'API DocumentService fournit des méthodes pour créer, supprimer et mettre à jour un document. Cette API nécessite le module d'extension Document Management (com.snc.platform_document_management) et est fournie dans l'espace de noms `sn_doc_services` . Pour plus d'informations, consultez [Services documentaires](https://www.servicenow.com/docs/access?context=document-services-landing-page&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US). Un document est une collection d'informations sur un enregistrement de document. Les méthodes utilisées pour créer ou mettre à jour un enregistrement modifient les champs à l'aide de l'objet [SystemDocument](https://servicenow-prod.fluidtopics.net/0Q_RcHYN1RnUW4tDfGZdcw#SystemDocumentBothAPI "L’API SystemDocument fournit des méthodes pour définir les champs d’un enregistrement dans la table Documents [ds_document].") . Le contenu d'un document est géré à l'aide des versions. Les API suivantes vous permettent de définir et de gérer les versions de documents : * [SystemDocumentVersion](https://servicenow-prod.fluidtopics.net/UFkDetAXkMJemIoCuI0seg#SystemDocumentVersionBothAPI "L’API SystemDocumentVersion fournit des méthodes pour définir les valeurs de la version source d’un document dans la table Versions [ds_document_version].") : définit une version de document comme source du contenu du document. chaque version est un élément contenant le contenu du document et est fournie à l'aide d'une URL unique ou d'une pièce jointe. Une pièce jointe ne peut être ajoutée que dans l'interface utilisateur de la table Versions de documents \[ds_document_version\] et non avec l'API. * [DocumentVersionService](https://servicenow-prod.fluidtopics.net/fdPq_WHYlYYdg~a1uSua_A#DocumentVersionServiceBothAPI "L’API DocumentVersionService fournit un service permettant de créer et de supprimer des versions de documents. chaque version est un élément contenant le contenu du document et est fournie à l’aide d’une URL unique ou d’une pièce jointe. Une pièce jointe ne peut être ajoutée que dans l’interface utilisateur de la table Versions de documents [ds_document_version] et non avec l’API.") : le contenu du document est géré à l'aide des versions. {#DocumentServiceBothAPI__ul_krc_vmf_vpb} Utilisez l'API [DocumentReferenceService](https://servicenow-prod.fluidtopics.net/1J2XceoqQvVJILBmq4rM_g#DocumentReferenceServiceBothAPI "L’API DocumentReferenceService fournit des méthodes de gestion des références documentaires au sein d’une table cible, comme la table Incidents [incident] ou Knowledge [kb_knowledge]. Vous pouvez utiliser des références de document pour associer des informations à un enregistrement.") pour gérer les documents référencés dans une table cible, telle que la table Incidents \[incident\] ou Knowledge \[kb_knowledge\]. Le Document Management module d'extension prend également en charge la création de listes de modèles de documents à associer à votre document. Par exemple, une demande d'emploi nécessitant plusieurs documents tels qu'un diplôme, une carte d'identité ou un passeport. * [SystemDocumentList](https://servicenow-prod.fluidtopics.net/EvcAlSG7FpW_ORN2hK7csA#SystemDocumentListBothAPI "L’API SystemDocumentList fournit des méthodes pour définir les champs d’enregistrement dans la table Listes de documents [ds_document_lists].") : définit une liste de modèles de documents. * [DocumentListService](https://servicenow-prod.fluidtopics.net/lmh7SAsqglQjkA~y0ZxQTA#DocumentListServiceBothAPI "L’API DocumentListService fournit des méthodes pour créer, supprimer et mettre à jour une liste de documents.") : ajouter ou supprimer une liste de modèles de documents. * [SystemDocumentListEntry](https://servicenow-prod.fluidtopics.net/cndZR1uh4IPAXEpOIuN3MA#SystemDocumentListEntryBothAPI "L’API SystemDocumentListEntry fournit des méthodes pour définir les champs d’enregistrement dans la table Entrées de la liste de documents [ds_document_list_entry].") : définit une entrée de liste de modèles de documents. * [DocumentListEntryService](https://servicenow-prod.fluidtopics.net/FwA7c62zKCVLC0XJaXkyZg#DocumentListEntryServiceBothAPI "L’API DocumentListEntryService fournit des méthodes pour gérer les modèles de documents dans une liste de documents.") : ajouter ou supprimer une entrée de liste de modèles de documents. {#DocumentServiceBothAPI__ul_asn_gjg_vpb} ## DocumentService : DocumentService() {#ariaid-title2} Instancie un objet DocumentService . {#DocumentService-DocumentService__table_zw5_mcg_tpb__entry__3} | Nom | Type | Description | |-|-|-| | Aucun | | | [Tableau 1. Paramètres] {#DocumentService-DocumentService__table_zw5_mcg_tpb} L'exemple suivant montre comment instancier un objet DocumentService . var s = new sn_doc_services.DocumentService(); ## DocumentService : createDocument (document SystemDocument) {#ariaid-title3} Crée un enregistrement de document dans la table Documents \[ds_document\]. {#DocumentService-createDocument_O__table_w4z_2cg_tpb__entry__3} | Nom | Type | Description | |-|-|-| | document | [Document système](https://servicenow-prod.fluidtopics.net/0Q_RcHYN1RnUW4tDfGZdcw#SystemDocumentBothAPI "L’API SystemDocument fournit des méthodes pour définir les champs d’un enregistrement dans la table Documents [ds_document].") | Une ou plusieurs propriétés représentant les champs d'un nouvel enregistrement. La propriété name est requise et peut être définie à l'aide du constructeur SystemDocument ou de la méthode name(). | [Tableau 2. Paramètres] {#DocumentService-createDocument_O__table_w4z_2cg_tpb} {#DocumentService-createDocument_O__table_tj4_p5j_34b__entry__2}{#DocumentService-createDocument_O__row_pdfgen_ret_msgCnv} | Type | Description | |-|-| | Objet | Sys_id du nouvel enregistrement dans la table Documents \[ds_document\] avec un message de réussite. Message d'erreur sinon. { "message": "String", "request_id": "String", "status": "String" } | | \.Message | Message confirmant la réussite ou l'erreur. Valeurs possibles : * Créer un sysId de document : \ a réussi. * Le nom du document est obligatoire et doit être valide. * Le nom du document est obligatoire et ne doit pas être nul ou vide. * \< [propriété SystemDocument](https://servicenow-prod.fluidtopics.net/0Q_RcHYN1RnUW4tDfGZdcw#SystemDocumentBothAPI "L’API SystemDocument fournit des méthodes pour définir les champs d’un enregistrement dans la table Documents [ds_document].") nécessitant une entrée sys_id \> avec SysId : \<\< \ \>\> n'existe pas {#DocumentService-createDocument_O__ul_hwn_lbh_tpb} Type de données : chaîne | | \.request_id | Sys_id de l'enregistrement dans la table Documents \[ds_document\]. Type de données : chaîne | | \.statut | État indiquant si l'opération a réussi. Valeurs possibles : * réussite : l'opération s'est déroulée correctement. * échec : l'opération n'a pas réussi. Fournit message des détails. {#DocumentService-createDocument_O__ul_rlv_5cv_j4b} Type de données : chaîne | [Tableau 3. Renvoie] {#DocumentService-createDocument_O__table_tj4_p5j_34b} L'exemple suivant montre comment renseigner les propriétés de l'objet SystemDocument et créer un nouvel enregistrement de document. var d = new sn_doc_services.SystemDocument('My document'); // Define the document fields var reviewers = '62826bf03710200044e0bfc8bcbe5df1,a8f98bb0eb32010045e1a5115206fe3a'; d.description('description'); d.classification('restricted'); d.state('review'); d.department('93b25282c0a8000b0b55c8ab34e2f1e6'); d.template(false); d.type('policy'); d.reviewers(reviewers); d.audience('external'); var s = new sn_doc_services.DocumentService(); gs.info(JSON.stringify(s.createDocument(d), null, 2)); Sortie : { "message": "Create document sysId : 1040420224503410f877a6fed1c2b031 is successful.", "request_id": "1040420224503410f877a6fed1c2b031", "status": "success" } ## DocumentService : deleteDocument(String docSysId) {#ariaid-title4} Supprime un enregistrement de document de la table Documents \[ds_document\]. {#DocumentService-deleteDocument_S__table_w4z_2cg_tpb__entry__3}{#DocumentService-deleteDocument_S__ph_docserv_parm_docID} | Nom | Type | Description | |-|-|-| | ID docSysId | Chaîne | Sys_id d'un enregistrement de document dans la table Documents \[ds_document\]. | [Tableau 4. Paramètres] {#DocumentService-deleteDocument_S__table_w4z_2cg_tpb} {#DocumentService-deleteDocument_S__table_x4z_2cg_tpb__entry__2}{#DocumentService-deleteDocument_S__ph-docserv-ret-obj-basic} | Type | Description | |-|-| | Objet | Message de réussite ou d'erreur. { "message": "String", "request_id": "String", "status": "String" } {#DocumentService-deleteDocument_S__api_docserv_codeblock_dets} | | \.Message | Message confirmant la réussite ou l'erreur. Type de données : chaîne | | \.request_id | Sys_id de l'enregistrement dans la table Documents \[ds_document\]. Type de données : chaîne | | \.statut | État indiquant si l'opération a réussi. Valeurs possibles : * réussite : l'opération s'est déroulée correctement. * échec : l'opération n'a pas réussi. Fournit message des détails. {#DocumentService-deleteDocument_S__ul_rlv_5cv_j4b} Type de données : chaîne | [Tableau 5. Renvoie] {#DocumentService-deleteDocument_S__table_x4z_2cg_tpb} L'exemple suivant montre comment supprimer un enregistrement de document existant. var docid = ""; var svc = new sn_doc_services.DocumentService(); gs.info(JSON.stringify(svc.deleteDocument(docid), null, 2)); Sortie : { "message": "Delete document sysId : is successful.", "request_id": "", "status": "success" } ## DocumentService : updateDocument(String docSysId, doc SystemDocument) {#ariaid-title5} Met à jour les valeurs de champ d'un enregistrement de document existant. {#DocumentService-updateDocument_S_O__table_w4z_2cg_tpb__entry__3}{#DocumentService-updateDocument_S_O__ph_docserv_parm_docID} | Nom | Type | Description | |-|-|-| | ID docSysId | Chaîne | Sys_id d'un enregistrement de document dans la table Documents \[ds_document\]. | | document | [Document système](https://servicenow-prod.fluidtopics.net/0Q_RcHYN1RnUW4tDfGZdcw#SystemDocumentBothAPI "L’API SystemDocument fournit des méthodes pour définir les champs d’un enregistrement dans la table Documents [ds_document].") | Une ou plusieurs propriétés représentant les champs du document à mettre à jour. | [Tableau 6. Paramètres] {#DocumentService-updateDocument_S_O__table_w4z_2cg_tpb} {#DocumentService-updateDocument_S_O__table_x4z_2cg_tpb__entry__2}{#DocumentService-updateDocument_S_O__ph-docserv-ret-obj-basic} | Type | Description | |-|-| | Objet | Message de réussite ou d'erreur. { "message": "String", "request_id": "String", "status": "String" } {#DocumentService-updateDocument_S_O__api_docserv_codeblock_dets} | | \.Message | Message confirmant la réussite ou l'erreur. Type de données : chaîne | | \.request_id | Sys_id de l'enregistrement dans la table Documents \[ds_document\]. Type de données : chaîne | | \.statut | État indiquant si l'opération a réussi. Valeurs possibles : * réussite : l'opération s'est déroulée correctement. * échec : l'opération n'a pas réussi. Fournit message des détails. {#DocumentService-updateDocument_S_O__ul_rlv_5cv_j4b} Type de données : chaîne | [Tableau 7. Renvoie] {#DocumentService-updateDocument_S_O__table_x4z_2cg_tpb} L'exemple suivant montre comment modifier le nom d'un document. Voir aussi [SystemDocument](https://servicenow-prod.fluidtopics.net/0Q_RcHYN1RnUW4tDfGZdcw#SystemDocumentBothAPI "L’API SystemDocument fournit des méthodes pour définir les champs d’un enregistrement dans la table Documents [ds_document]."). var dId = "19aab54e24103410f877a6fed1c2b03d"; var d = new sn_doc_services.SystemDocument(); d.name("c22.txt"); var s = new sn_doc_services.DocumentService(); gs.info(JSON.stringify(s.updateDocument(dId, d), null, 2)); Sortie : { "message": "Update document sysId : 19aab54e24103410f877a6fed1c2b03d is successful.", "request_id": "19aab54e24103410f877a6fed1c2b03d", "status": "success" }