---
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


---

# DocumentReferenceService : champ d'application, global

# DocumentReferenceService : champ d'application, global {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes de lecture

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.

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).  
Les API suivantes vous permettent de définir et de gérer des documents :

* [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].") : définit un objet de document.
* [DocumentService](https://servicenow-prod.fluidtopics.net/2olPnwzicityLTQGD2Rxlw#DocumentServiceBothAPI "L’API DocumentService fournit des méthodes pour créer, supprimer et mettre à jour un document.") : ajouter, mettre à jour ou supprimer un document.
{#DocumentReferenceServiceBothAPI__ul_krc_vmf_vpb}

## DocumentReferenceService : DocumentReferenceService() {#ariaid-title2}

Instancie un objet DocumentReferenceService .
{#DRS-DocumentReferenceService__table_zw5_mcg_tpb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 1. Paramètres]

{#DRS-DocumentReferenceService__table_zw5_mcg_tpb}  
L'exemple suivant montre comment instancier un objet DocumentReferenceService .

    var result = new sn_doc_services.DocumentReferenceService();

## DocumentReferenceService : addDocumentReference(String docSysId, String targetTable, String tableSysId) {#ariaid-title3}

Ajoute une référence de document à un enregistrement de table cible.
{#DRS-addDocumentReference_S_S_S__table_w4z_2cg_tpb__entry__3}{#DRS-addDocumentReference_S_S_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\]. |
| targetTable | Chaîne | Nom de la table cible sur laquelle fournir une référence de document. |
| tableSysId | Chaîne | Sys_id de l'enregistrement de la table cible à laquelle la référence du document doit être ajoutée. |
[Tableau 2. Paramètres]

{#DRS-addDocumentReference_S_S_S__table_w4z_2cg_tpb} {#DRS-addDocumentReference_S_S_S__table_x4z_2cg_tpb__entry__2}

| Type | Description |
|-|-|
| Objet | Sys_id du nouvel enregistrement dans la table Références documentaires \[ds_document_reference\] avec un message de réussite. Message d'erreur sinon. { "message": "String", "status": "String" } {#DRS-addDocumentReference_S_S_S__api_docserv_codeblock_dets} |
| \<Object\>.Message | Message confirmant la réussite ou l'erreur. En cas de réussite, inclut le sys_id de l'enregistrement auquel la référence du document a été ajoutée. Type de données : chaîne |
| \<Object\>.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. {#DRS-addDocumentReference_S_S_S__ul_rlv_5cv_j4b} Type de données : chaîne |
[Tableau 3. Renvoie]

{#DRS-addDocumentReference_S_S_S__table_x4z_2cg_tpb}  
L'exemple suivant montre comment ajouter une référence de document à un enregistrement de la table Incidents \[incident\].

    var docReference = new sn_doc_services.DocumentReferenceService();

    var result = docReference.addDocumentReference("<docSysId>", "incident", "<tableSysId>");

    gs.info(JSON.stringify(result, null, 2));

Sortie :

    {
      "message": "Adding an entry to DocumentReference for the given docId to target table : incident, sysId : <tableSysId> is successful.",
      "status": "success"
    }

## DocumentReferenceService : removeDocumentReference(String docSysId, String targetTable, String tableSysId) {#ariaid-title4}

Supprime une référence de document de la table Références documentaires \[ds_document_reference\].
{#DRS-removeDocumentReference_S_S_S__table_w4z_2cg_tpb__entry__3}{#DRS-removeDocumentReference_S_S_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\]. |
| targetTable | Chaîne | Nom de la table contenant la référence du document. Ces informations sont répertoriées avec le document dans le tableau Références documentaires \[ds_document_reference\]. |
| tableSysId | Chaîne | Sys_id de l'enregistrement à partir duquel le document est référencé. Vous pouvez trouver des informations connexes répertoriées avec le document dans le tableau Références documentaires \[ds_document_reference\]. |
[Tableau 4. Paramètres]

{#DRS-removeDocumentReference_S_S_S__table_w4z_2cg_tpb} {#DRS-removeDocumentReference_S_S_S__table_x4z_2cg_tpb__entry__2}

| Type | Description |
|-|-|
| Objet | Message de réussite. Message d'erreur sinon. { "message": "String", "status": "String" } {#DRS-removeDocumentReference_S_S_S__api_docserv_codeblock_dets} |
| \<Object\>.Message | Message confirmant la réussite ou l'erreur. En cas de réussite, inclut la sys_id de l'enregistrement à partir duquel la référence du document a été supprimée. Type de données : chaîne |
| \<Object\>.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. {#DRS-removeDocumentReference_S_S_S__ul_rlv_5cv_j4b} Type de données : chaîne |
[Tableau 5. Renvoie]

{#DRS-removeDocumentReference_S_S_S__table_x4z_2cg_tpb}  
L'exemple suivant montre comment supprimer une référence de document d'un enregistrement dans la table Incidents \[incident\].

    var docReference = new sn_doc_services.DocumentReferenceService();

    var result = docReference.removeDocumentReference("<docSysId>", "incident", "<tableSysId>");

    gs.info(JSON.stringify(result, null, 2));

Sortie :

    {
      "message": "Deleting an entry to DocumentReference for the given docId to target table : incident, sysId : <tableSysId> is successful.",
      "status": "success"
    }