---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Systemdokument: Bereichsbezogen, global

# Systemdokument: Bereichsbezogen, global {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 Minuten Lesedauer

Die Systemdokument Die API bietet Methoden zum Festlegen von Feldern eines Datensatzes in der Tabelle „Dokumente" \[ds_document\].

Diese API erfordert DokumentverwaltungPlugin (com.snc.platform_document_management) und wird in bereitgestellt `sn_doc_Services `Namespace. Informationen finden Sie unter [Dokumentservices](https://www.servicenow.com/docs/access?context=document-services-landing-page&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US).

Verwenden Sie zum Erstellen eines Dokuments [DocumentService-API](https://servicenow-prod.fluidtopics.net/_goxCLzTWhfVJff2X~tfJQ#DocumentServiceBothAPI "Die DocumentService Die API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.").

## SystemDocument -- SystemDocument (Zeichenfolgendokumentation) {#ariaid-title2}

Instanziiert einen Systemdokument Objekt.
{#SystemDoc-SystemDocument_S__table_o12_jrk_spb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Dokumentname | Zeichenfolge | Name des Dokuments. |
[Tabelle : 1. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 2. Rückgaben]

{#SystemDoc-SystemDocument_S__table_p12_jrk_spb}  
Das folgende Beispiel zeigt, wie ein instanziiert wird Systemdokument Objekt und mehrere Felder für einen Dokumentdatensatz festlegen. Siehe auch [DocumentService-API](https://servicenow-prod.fluidtopics.net/_goxCLzTWhfVJff2X~tfJQ#DocumentServiceBothAPI "Die DocumentService Die API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.").

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

Ausgabe:

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

## Systemdokument -- Zielgruppe (Zielgruppe mit Zeichenfolge) {#ariaid-title3}

Legt das Zielgruppenfeld eines Dokumentdatensatzes fest, um die externe oder interne Verfügbarkeit anzugeben. Stellt das Zielgruppenfeld in einem dar DokumentverwaltungFormular.
{#SystemDoc-audience_S__table_o12_jrk_spb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| audience | Zeichenfolge | Zeichenfolge, die die beabsichtigte Zielgruppe des Dokuments darstellt. Mögliche Werte: * external * Intern {#SystemDoc-audience_S__ul_occ_ydl_spb}Standard: Intern |
[Tabelle : 3. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 4. Rückgaben]

{#SystemDoc-audience_S__table_p12_jrk_spb}  
Das folgende Beispiel zeigt, wie das Feld „Zielgruppe" in einem neuen Dokumentdatensatz festgelegt wird. Siehe auch [DocumentService: Bereichsbezogen, global](https://servicenow-prod.fluidtopics.net/_goxCLzTWhfVJff2X~tfJQ#DocumentServiceBothAPI "Die DocumentService Die API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.").

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

Ausgabe:

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

## Systemdokument -- Klassifizierung (Zeichenfolgenklassifizierung) {#ariaid-title4}

Legt das Feld „Klassifizierung" eines Dokumentdatensatzes fest, um den Grad der Informationssensibilität zu identifizieren. Stellt das Klassifizierungsfeld in einem dar DokumentverwaltungFormular.
{#SystemDoc-classification_S__table_o12_jrk_spb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Klassifizierung | Zeichenfolge | Klassifizierung des Dokuments. Mögliche Werte: * Vertraulich * Öffentlich * Eingeschränkt {#SystemDoc-classification_S__ul_nk4_zfl_spb}Standard: Öffentlich |
[Tabelle : 5. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Der Wert der Klassifizierungseigenschaft von Systemdokument Objekt. |
[Tabelle : 6. Rückgaben]

{#SystemDoc-classification_S__table_p12_jrk_spb}  
Das folgende Beispiel zeigt, wie das Klassifizierungsfeld in einem neuen Dokumentdatensatz festgelegt wird. Siehe auch [DocumentService-API](https://servicenow-prod.fluidtopics.net/_goxCLzTWhfVJff2X~tfJQ#DocumentServiceBothAPI "Die DocumentService Die API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.").

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

Ausgabe:

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

## SystemDocument -- createdFromTemplate(Zeichenfolgendokumentvorlage) {#ariaid-title5}

Legt die Vorlage fest, aus der ein Dokument generiert werden soll. Wenn das Dokument generiert wird, wird die angegebene Vorlage im Feld „aus Vorlage erstellt" in der Tabelle „Dokumente" \[ds_document_list\] aufgeführt.
{#SystemDoc-createdFromTemplate_S__table_o12_jrk_spb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| DocTemplate | Zeichenfolge | SYS_ID eines Dokuments, das in der Tabelle „Dokumente" \[ds_document_list\] aufgeführt ist. Für das Dokument muss das Kontrollkästchen „Vorlage" aktiviert sein (wahr). Siehe auch [DocumentVersionService-API](https://servicenow-prod.fluidtopics.net/M7FhlAVg1QqKrJLOgaXywQ#DocumentVersionServiceBothAPI "Die DocumentVersionService Die API bietet einen Service zum Erstellen und Löschen von Dokumentversionen. Jede Version ist ein Element, das den Dokumentinhalt enthält und wird mithilfe einer einzelnen URL oder eines einzelnen Anhangs bereitgestellt. Ein Anhang kann nur in der Tabellen-UI „Dokumentversionen“ [ds_document_Version] und nicht mit der API hinzugefügt werden."). |
[Tabelle : 7. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 8. Rückgaben]

{#SystemDoc-createdFromTemplate_S__table_p12_jrk_spb}  
Das folgende Beispiel zeigt, wie ein neuer Dokumentdatensatz aus einer vorhandenen Vorlage erstellt wird. Siehe auch [DocumentService-API](https://servicenow-prod.fluidtopics.net/_goxCLzTWhfVJff2X~tfJQ#DocumentServiceBothAPI "Die DocumentService Die API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.").

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

Ausgabe:

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

## Systemdokument -- Abteilung (Zeichenfolge docDept) {#ariaid-title6}

Legt das Feld „Abteilung" eines Dokumentdatensatzes fest.
{#SystemDoc-department_S__table_o12_jrk_spb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| DocDept | Zeichenfolge | SYS_ID einer Abteilung, die in der Tabelle „Abteilungen" \[cmn_Department\] aufgeführt ist. |
[Tabelle : 9. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 10. Rückgaben]

{#SystemDoc-department_S__table_p12_jrk_spb}  
Das folgende Beispiel zeigt, wie das Feld „Abteilung" in einem neuen Dokumentdatensatz festgelegt wird. Siehe auch [DocumentService-API](https://servicenow-prod.fluidtopics.net/_goxCLzTWhfVJff2X~tfJQ#DocumentServiceBothAPI "Die DocumentService Die API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.").

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

Ausgabe:

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

## Systemdokument -- Beschreibung (Zeichenfolgenbeschreibung) {#ariaid-title7}

Legt das Beschreibungsfeld eines Dokumentdatensatzes fest.
{#SystemDoc-description_S__table_o12_jrk_spb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Beschreibung | Zeichenfolge | Beschreibung des Dokuments. |
[Tabelle : 11. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 12. Rückgaben]

{#SystemDoc-description_S__table_p12_jrk_spb}  
Das folgende Beispiel zeigt, wie das Beschreibungsfeld in einem Dokumentdatensatz festgelegt wird. Siehe auch: [DocumentService-API](https://servicenow-prod.fluidtopics.net/_goxCLzTWhfVJff2X~tfJQ#DocumentServiceBothAPI "Die DocumentService Die API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.").

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

Ausgabe:

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

## Systemdokument -- Name (Zeichenfolgendokumentname) {#ariaid-title8}

Legt das Namensfeld eines Dokumentdatensatzes fest.
Hinweis:  
Sie können den Namen auch als Parameter in festlegen Systemdokument () Konstruktor.
{#SystemDoc-name_S__table_o12_jrk_spb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Dokumentname | Zeichenfolge | Name des Dokuments. |
[Tabelle : 13. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 14. Rückgaben]

{#SystemDoc-name_S__table_p12_jrk_spb}  
Das folgende Beispiel zeigt, wie das Feld „Name" in einem neuen Dokumentdatensatz festgelegt wird. Siehe auch [DocumentService-API](https://servicenow-prod.fluidtopics.net/_goxCLzTWhfVJff2X~tfJQ#DocumentServiceBothAPI "Die DocumentService Die API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.").

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

Ausgabe:

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

## Systemdokument -- Besitzer (Zeichenfolgenbesitzer) {#ariaid-title9}

Legt das Feld „Besitzer" eines Dokumentdatensatzes fest.
{#SystemDoc-owner_S__table_o12_jrk_spb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Eigentümer | Zeichenfolge | SYS_ID eines Anwenders, der in der Tabelle Anwender \[sys_user\] aufgeführt ist. Erforderliche Rolle: Administrator Standard: Aktueller Anwender |
[Tabelle : 15. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 16. Rückgaben]

{#SystemDoc-owner_S__table_p12_jrk_spb}  
Das folgende Beispiel zeigt, wie das Besitzerfeld in einem neuen Dokumentdatensatz festgelegt wird. Siehe auch [DocumentService-API](https://servicenow-prod.fluidtopics.net/_goxCLzTWhfVJff2X~tfJQ#DocumentServiceBothAPI "Die DocumentService Die API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.").

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

Ausgabe:

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

## Systemdokument -- Überprüfer (Zeichenfolgenüberprüfer) {#ariaid-title10}

Legt das Feld „Prüfer" eines Dokumentdatensatzes fest.
{#SystemDoc-reviewers_S__table_o12_jrk_spb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Überprüfer | Zeichenfolge | Liste von mindestens einem Dokumentüberprüfer nach sys_ID Der Überprüfer muss ein Anwender sein, der in der Tabelle Anwender \[sys_user\] aufgeführt ist. |
[Tabelle : 17. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 18. Rückgaben]

{#SystemDoc-reviewers_S__table_p12_jrk_spb}  
Das folgende Beispiel zeigt, wie das Feld „Prüfer" in einem neuen Dokumentdatensatz festgelegt wird. Siehe auch [DocumentService-API](https://servicenow-prod.fluidtopics.net/_goxCLzTWhfVJff2X~tfJQ#DocumentServiceBothAPI "Die DocumentService Die API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.").

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

Ausgabe:

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

## Systemdokument -- Status (Zeichenfolgenstatus) {#ariaid-title11}

Legt das Feld „Status" eines Dokumentdatensatzes fest.
{#SystemDoc-state_S__table_o12_jrk_spb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Staat | Zeichenfolge | Status des Dokuments, das angibt, wo sich das Dokument im Workflow befindet. Gültige Werte: * Entwurf * absenden * Überprüfen * Abschließen {#SystemDoc-state_S__ul_o3h_zbm_spb}Standard: Entwurf |
[Tabelle : 19. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 20. Rückgaben]

{#SystemDoc-state_S__table_thg_lcm_spb}  
Das folgende Beispiel zeigt, wie das Statusfeld in einem neuen Dokumentdatensatz festgelegt wird. Siehe auch [DocumentService-API](https://servicenow-prod.fluidtopics.net/_goxCLzTWhfVJff2X~tfJQ#DocumentServiceBothAPI "Die DocumentService Die API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.").

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

Ausgabe:

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

## Systemdokument -- Vorlage (boolesche Vorlage) {#ariaid-title12}

Gibt an, ob ein Dokumentdatensatz eine Vorlage ist.
{#SystemDoc-template_S__table_o12_jrk_spb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Vorlage | Boolean | Kennzeichnung, die angibt, ob ein Dokumentdatensatz eine Vorlage ist. Gültige Werte: * Wahr: Die Standardversion dieses Dokuments ist eine Vorlage. * Falsch: Dieses Dokument ist keine Vorlage. {#SystemDoc-template_S__ul_pyf_cgm_spb} Standard: Falsch |
[Tabelle : 21. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 22. Rückgaben]

{#SystemDoc-template_S__table_p12_jrk_spb}  
Das folgende Beispiel zeigt, wie angegeben wird, dass ein Dokumentdatensatz eine Vorlage ist. Siehe auch [DocumentService-API](https://servicenow-prod.fluidtopics.net/_goxCLzTWhfVJff2X~tfJQ#DocumentServiceBothAPI "Die DocumentService Die API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.").

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

Ausgabe:

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

## Systemdokument -- Typ (Zeichenfolge DOCTYPE) {#ariaid-title13}

Legt das Feld Typ eines Dokumentdatensatzes fest.
{#SystemDoc-type_S__table_o12_jrk_spb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| docType | Zeichenfolge | Typ des Dokuments. Gültige Werte: * contract * leitlinie * Richtlinie * Verfahren {#SystemDoc-type_S__ul_xzq_qsl_spb}Standard: Keine |
[Tabelle : 23. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 24. Rückgaben]

{#SystemDoc-type_S__table_p12_jrk_spb}  
Das folgende Beispiel zeigt, wie das Typfeld in einem neuen Dokumentdatensatz festgelegt wird. Siehe auch [DocumentService-API](https://servicenow-prod.fluidtopics.net/_goxCLzTWhfVJff2X~tfJQ#DocumentServiceBothAPI "Die DocumentService Die API bietet Methoden zum Erstellen, Löschen und Aktualisieren eines Dokuments.").

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

Ausgabe:

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


