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


---

# SystemDocument : champ d'application, global

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

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

L'API SystemDocument fournit des méthodes pour définir les champs d'un enregistrement dans la table Documents \[ds_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).

Pour créer un document, utilisez [l'API DocumentService](https://servicenow-prod.fluidtopics.net/2olPnwzicityLTQGD2Rxlw#DocumentServiceBothAPI "L’API DocumentService fournit des méthodes pour créer, supprimer et mettre à jour un document.").

## SystemDocument : SystemDocument(String docName) {#ariaid-title2}

Instancie un objet SystemDocument .
{#SystemDoc-SystemDocument_S__table_o12_jrk_spb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Nom du document | Chaîne | Nom du document. |
[Tableau 1. Paramètres]

{#SystemDoc-SystemDocument_S__table_o12_jrk_spb} {#SystemDoc-SystemDocument_S__table_p12_jrk_spb__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 2. Renvoie]

{#SystemDoc-SystemDocument_S__table_p12_jrk_spb}  
L'exemple suivant montre comment instancier un objet SystemDocument et définir plusieurs champs pour un enregistrement de document. Voir aussi [API DocumentService](https://servicenow-prod.fluidtopics.net/2olPnwzicityLTQGD2Rxlw#DocumentServiceBothAPI "L’API DocumentService fournit des méthodes pour créer, supprimer et mettre à jour un 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"
    }

## SystemDocument : audience (audience de chaîne) {#ariaid-title3}

Définit le champ Audience d'un enregistrement de document pour spécifier la disponibilité externe ou interne. Représente le champ Audience dans un Document Management formulaire.
{#SystemDoc-audience_S__table_o12_jrk_spb__entry__3}

| Nom | Type | Description |
|-|-|-|
| audience | Chaîne | Chaîne représentant le public cible du document. Valeurs possibles : * externe * interne {#SystemDoc-audience_S__ul_occ_ydl_spb}Par défaut : interne |
[Tableau 3. Paramètres]

{#SystemDoc-audience_S__table_o12_jrk_spb} {#SystemDoc-audience_S__table_p12_jrk_spb__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 4. Renvoie]

{#SystemDoc-audience_S__table_p12_jrk_spb}  
L'exemple suivant montre comment définir le champ Audience dans un nouvel enregistrement de document. Voir aussi [DocumentService : champ d'application, global](https://servicenow-prod.fluidtopics.net/2olPnwzicityLTQGD2Rxlw#DocumentServiceBothAPI "L’API DocumentService fournit des méthodes pour créer, supprimer et mettre à jour un document.").

    var d = new sn_doc_services.SystemDocument('My document');
    var s = new sn_doc_services.DocumentService();

    d.audience('external');

    gs.info(JSON.stringify(s.createDocument(d), null, 2));

Sortie :

    {
      "message": "Create document sysId : 1193fd4624103410f877a6fed1c2b016 is successful.",
      "request_id": "1193fd4624103410f877a6fed1c2b016",
      "status": "success"
    }

## SystemDocument : classification(classification de chaînes) {#ariaid-title4}

Définit le champ Classification d'un enregistrement de document pour identifier le niveau de sensibilité des informations. Représente le champ Classification dans un Document Management formulaire.
{#SystemDoc-classification_S__table_o12_jrk_spb__entry__3}

| Nom | Type | Description |
|-|-|-|
| classification | Chaîne | Classification du document. Valeurs possibles : * Confidentiel * publique * restreint {#SystemDoc-classification_S__ul_nk4_zfl_spb}Par défaut : public |
[Tableau 5. Paramètres]

{#SystemDoc-classification_S__table_o12_jrk_spb} {#SystemDoc-classification_S__table_p12_jrk_spb__entry__2}

| Type | Description |
|-|-|
| Chaîne | Valeur de la propriété de classification d'un objet SystemDocument . |
[Tableau 6. Renvoie]

{#SystemDoc-classification_S__table_p12_jrk_spb}  
L'exemple suivant montre comment définir le champ de classification dans un nouvel enregistrement de document. Voir aussi [API DocumentService](https://servicenow-prod.fluidtopics.net/2olPnwzicityLTQGD2Rxlw#DocumentServiceBothAPI "L’API DocumentService fournit des méthodes pour créer, supprimer et mettre à jour un document.").

    var d = new sn_doc_services.SystemDocument('My restricted document');
    var s = new sn_doc_services.DocumentService();

    d.classification('restricted');

    gs.info(JSON.stringify(s.createDocument(d), null, 2));

Sortie :

    {
      "message": "Create document sysId : d80435c624103410f877a6fed1c2b0d0 is successful.",
      "request_id": "d80435c624103410f877a6fed1c2b0d0",
      "status": "success"
    }

## SystemDocument : createdFromTemplate(String docTemplate) {#ariaid-title5}

Définit le modèle à partir duquel générer un document. Lorsque le document est généré, le modèle spécifié est répertorié dans le champ Créé à partir du modèle de la table Documents \[ds_document_list\].
{#SystemDoc-createdFromTemplate_S__table_o12_jrk_spb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Modèle de document | Chaîne | Sys_id d'un document répertorié dans la table Documents \[ds_document_list\]. La case Modèle doit être cochée sur le document (vrai). Voir aussi [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."). |
[Tableau 7. Paramètres]

{#SystemDoc-createdFromTemplate_S__table_o12_jrk_spb} {#SystemDoc-createdFromTemplate_S__table_p12_jrk_spb__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 8. Renvoie]

{#SystemDoc-createdFromTemplate_S__table_p12_jrk_spb}  
L'exemple suivant montre comment créer un enregistrement de document à partir d'un modèle existant. Voir aussi [API DocumentService](https://servicenow-prod.fluidtopics.net/2olPnwzicityLTQGD2Rxlw#DocumentServiceBothAPI "L’API DocumentService fournit des méthodes pour créer, supprimer et mettre à jour un document.").

    var d = new sn_doc_services.SystemDocument('New doc from template');
    var s = new sn_doc_services.DocumentService();

    d.createdFromTemplate('<doc_template_sys_id>');

    gs.info(JSON.stringify(s.createDocument(d), null, 2));

Sortie :

    {
      "message": "Create document sysId : deaef1ce24103410f877a6fed1c2b085 is successful.",
      "request_id": "deaef1ce24103410f877a6fed1c2b085",
      "status": "success"
    }

## SystemDocument : department (String docDept) {#ariaid-title6}

Définit le champ Département d'un enregistrement de document.
{#SystemDoc-department_S__table_o12_jrk_spb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Département du document | Chaîne | Sys_id d'un département répertorié dans la table Départements \[cmn_department\]. |
[Tableau 9. Paramètres]

{#SystemDoc-department_S__table_o12_jrk_spb} {#SystemDoc-department_S__table_p12_jrk_spb__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 10. Renvoie]

{#SystemDoc-department_S__table_p12_jrk_spb}  
L'exemple suivant montre comment définir le champ Département dans un nouvel enregistrement de document. Voir aussi [API DocumentService](https://servicenow-prod.fluidtopics.net/2olPnwzicityLTQGD2Rxlw#DocumentServiceBothAPI "L’API DocumentService fournit des méthodes pour créer, supprimer et mettre à jour un document.").

    var d = new sn_doc_services.SystemDocument('My document');

    // Assign the doc to the human resources department
    d.department('<dept_sys_id>');

    var s = new sn_doc_services.DocumentService();
    gs.info(JSON.stringify(s.createDocument(d), null, 2));

Sortie :

    {
      "message": "Create document sysId : 491efbee24187410f877a6fed1c2b0a9 is successful.",
      "request_id": "491efbee24187410f877a6fed1c2b0a9",
      "status": "success"
    }

## SystemDocument : description (description de chaîne) {#ariaid-title7}

Définit le champ Description d'un enregistrement de document.
{#SystemDoc-description_S__table_o12_jrk_spb__entry__3}

| Nom | Type | Description |
|-|-|-|
| description | Chaîne | Description du document. |
[Tableau 11. Paramètres]

{#SystemDoc-description_S__table_o12_jrk_spb} {#SystemDoc-description_S__table_p12_jrk_spb__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 12. Renvoie]

{#SystemDoc-description_S__table_p12_jrk_spb}  
L'exemple suivant montre comment définir le champ Description dans un enregistrement de document. Voir aussi : [API DocumentService](https://servicenow-prod.fluidtopics.net/2olPnwzicityLTQGD2Rxlw#DocumentServiceBothAPI "L’API DocumentService fournit des méthodes pour créer, supprimer et mettre à jour un document.").

    var d = new sn_doc_services.SystemDocument('My document');

    d.description('Information describing the doc.');

    var s = new sn_doc_services.DocumentService();
    gs.info(JSON.stringify(s.createDocument(d), null, 2));

Sortie :

    {
      "message": "Create document sysId : 9acd7fea24587410f877a6fed1c2b060 is successful.",
      "request_id": "9acd7fea24587410f877a6fed1c2b060",
      "status": "success"
    }

## SystemDocument : nom (String docName) {#ariaid-title8}

Définit le champ Nom d'un enregistrement de document.
Remarque :  
Vous pouvez également définir le nom en tant que paramètre dans le constructeur SystemDocument().
{#SystemDoc-name_S__table_o12_jrk_spb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Nom du document | Chaîne | Nom du document. |
[Tableau 13. Paramètres]

{#SystemDoc-name_S__table_o12_jrk_spb} {#SystemDoc-name_S__table_p12_jrk_spb__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 14. Renvoie]

{#SystemDoc-name_S__table_p12_jrk_spb}  
L'exemple suivant montre comment définir le champ Nom dans un nouvel enregistrement de document. Voir aussi [API DocumentService](https://servicenow-prod.fluidtopics.net/2olPnwzicityLTQGD2Rxlw#DocumentServiceBothAPI "L’API DocumentService fournit des méthodes pour créer, supprimer et mettre à jour un document.").

    var d = new sn_doc_services.SystemDocument();

    d.name('Document named using method instead of constructor');

    var s = new sn_doc_services.DocumentService();
    gs.info(JSON.stringify(s.createDocument(d), null, 2));

Sortie :

    {
      "message": "Create document sysId : c19d7f2624587410f877a6fed1c2b0eb is successful.",
      "request_id": "c19d7f2624587410f877a6fed1c2b0eb",
      "status": "success"
    }

## SystemDocument - propriétaire (propriétaire de la chaîne) {#ariaid-title9}

Définit le champ Propriétaire d'un enregistrement de document.
{#SystemDoc-owner_S__table_o12_jrk_spb__entry__3}

| Nom | Type | Description |
|-|-|-|
| propriétaire | Chaîne | Sys_id d'un utilisateur répertorié dans la table Utilisateurs \[sys_user\]. Rôle requis : administrateur Par défaut : Utilisateur actuel |
[Tableau 15. Paramètres]

{#SystemDoc-owner_S__table_o12_jrk_spb} {#SystemDoc-owner_S__table_p12_jrk_spb__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 16. Renvoie]

{#SystemDoc-owner_S__table_p12_jrk_spb}  
L'exemple suivant montre comment définir le champ Propriétaire dans un nouvel enregistrement de document. Voir aussi [API DocumentService](https://servicenow-prod.fluidtopics.net/2olPnwzicityLTQGD2Rxlw#DocumentServiceBothAPI "L’API DocumentService fournit des méthodes pour créer, supprimer et mettre à jour un document.").

    var d = new sn_doc_services.SystemDocument('My document');
    var s = new sn_doc_services.DocumentService();

    d.owner('aa826bf03710200044e0bfc8bcbe5dd6');

    gs.info(JSON.stringify(s.createDocument(d), null, 2));

Sortie :

    {
      "message": "Create document sysId : 4235318a24103410f877a6fed1c2b0ff is successful.",
      "request_id": "4235318a24103410f877a6fed1c2b0ff",
      "status": "success"
    }

## SystemDocument - reviewers(String reviewers) {#ariaid-title10}

Définit le champ Réviseurs d'un enregistrement de document.
{#SystemDoc-reviewers_S__table_o12_jrk_spb__entry__3}

| Nom | Type | Description |
|-|-|-|
| réviseurs | Chaîne | Liste d'un ou de plusieurs réviseurs de documents par sys_id. Le réviseur doit être un utilisateur répertorié dans la table Utilisateurs \[sys_user\]. |
[Tableau 17. Paramètres]

{#SystemDoc-reviewers_S__table_o12_jrk_spb} {#SystemDoc-reviewers_S__table_p12_jrk_spb__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 18. Renvoie]

{#SystemDoc-reviewers_S__table_p12_jrk_spb}  
L'exemple suivant montre comment définir le champ Réviseurs dans un nouvel enregistrement de document. Voir aussi [API DocumentService](https://servicenow-prod.fluidtopics.net/2olPnwzicityLTQGD2Rxlw#DocumentServiceBothAPI "L’API DocumentService fournit des méthodes pour créer, supprimer et mettre à jour un document.").

    var d = new sn_doc_services.SystemDocument('My document');

    var reviewers = '62826bf03710200044e0bfc8bcbe5df1,a8f98bb0eb32010045e1a5115206fe3a';
    d.reviewers(reviewers);

    var s = new sn_doc_services.DocumentService();
    gs.info(JSON.stringify(s.createDocument(d), null, 2));

Sortie :

    {
      "message": "Create document sysId : 8d19f9ca24103410f877a6fed1c2b0aa is successful.",
      "request_id": "8d19f9ca24103410f877a6fed1c2b0aa",
      "status": "success"
    }

## SystemDocument : état (état de la chaîne) {#ariaid-title11}

Définit le champ État d'un enregistrement de document.
{#SystemDoc-state_S__table_o12_jrk_spb__entry__3}

| Nom | Type | Description |
|-|-|-|
| État | Chaîne | État du document représentant l'emplacement du document dans le workflow. Valeurs valides : * brouillon * envoyer * révision * terminé {#SystemDoc-state_S__ul_o3h_zbm_spb}Par défaut : brouillon |
[Tableau 19. Paramètres]

{#SystemDoc-state_S__table_o12_jrk_spb} {#SystemDoc-state_S__table_thg_lcm_spb__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 20. Renvoie]

{#SystemDoc-state_S__table_thg_lcm_spb}  
L'exemple suivant montre comment définir le champ d'état dans un nouvel enregistrement de document. Voir aussi [API DocumentService](https://servicenow-prod.fluidtopics.net/2olPnwzicityLTQGD2Rxlw#DocumentServiceBothAPI "L’API DocumentService fournit des méthodes pour créer, supprimer et mettre à jour un document.").

    var d = new sn_doc_services.SystemDocument('My document');
    var s = new sn_doc_services.DocumentService();

    d.state('submit');

    gs.info(JSON.stringify(s.createDocument(d), null, 2));

Sortie :

    {
      "message": "Create document sysId : 19aab54e24103410f877a6fed1c2b03d is successful.",
      "request_id": "19aab54e24103410f877a6fed1c2b03d",
      "status": "success"
    }

## SystemDocument : modèle (modèle booléen) {#ariaid-title12}

Spécifie si un enregistrement de document est un modèle.
{#SystemDoc-template_S__table_o12_jrk_spb__entry__3}

| Nom | Type | Description |
|-|-|-|
| modèle | Booléen | Marqueur qui spécifie si un enregistrement de document est un modèle. Valeurs valides : * true : la version par défaut de ce document est un modèle. * faux : ce document n'est pas un modèle. {#SystemDoc-template_S__ul_pyf_cgm_spb} Valeur par défaut : false |
[Tableau 21. Paramètres]

{#SystemDoc-template_S__table_o12_jrk_spb} {#SystemDoc-template_S__table_p12_jrk_spb__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 22. Renvoie]

{#SystemDoc-template_S__table_p12_jrk_spb}  
L'exemple suivant montre comment indiquer qu'un enregistrement de document est un modèle. Voir aussi [API DocumentService](https://servicenow-prod.fluidtopics.net/2olPnwzicityLTQGD2Rxlw#DocumentServiceBothAPI "L’API DocumentService fournit des méthodes pour créer, supprimer et mettre à jour un document.").

    var d = new sn_doc_services.SystemDocument('My document');

    d.template(true);

    var s = new sn_doc_services.DocumentService();
    gs.info(JSON.stringify(s.createDocument(d), null, 2));

Sortie :

    {
      "message": "Create document sysId : f7f006ce24103410f877a6fed1c2b053 is successful.",
      "request_id": "f7f006ce24103410f877a6fed1c2b053",
      "status": "success"
    }

## SystemDocument : type(String docType) {#ariaid-title13}

Définit le champ Type d'un enregistrement de document.
{#SystemDoc-type_S__table_o12_jrk_spb__entry__3}

| Nom | Type | Description |
|-|-|-|
| docType | Chaîne | Type de document. Valeurs valides : * contrat * directive * policy * procédure {#SystemDoc-type_S__ul_xzq_qsl_spb}Par défaut : Aucun |
[Tableau 23. Paramètres]

{#SystemDoc-type_S__table_o12_jrk_spb} {#SystemDoc-type_S__table_p12_jrk_spb__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 24. Renvoie]

{#SystemDoc-type_S__table_p12_jrk_spb}  
L'exemple suivant montre comment définir le champ Type dans un nouvel enregistrement de document. Voir aussi [API DocumentService](https://servicenow-prod.fluidtopics.net/2olPnwzicityLTQGD2Rxlw#DocumentServiceBothAPI "L’API DocumentService fournit des méthodes pour créer, supprimer et mettre à jour un document.").

    var d = new sn_doc_services.SystemDocument('How to use the document mgmt API');
    var s = new sn_doc_services.DocumentService();

    d.type('guideline');

    gs.info(JSON.stringify(s.createDocument(d), null, 2));

Sortie :

    {
      "message": "Create document sysId : 8adfb10224503410f877a6fed1c2b0e4 is successful.",
      "request_id": "8adfb10224503410f877a6fed1c2b0e4",
      "status": "success"
    }