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

 Release :

    - xanadu

ft:locale :

    - de-DE

ft:publication_title :

    - Xanadu-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# XMLStreamingAPI: Bereichsbezogen

# XMLStreamingAPI: Bereichsbezogen {#ariaid-title1}

* Freigeben Version: Xanadu
* 
* Aktualisiert 1. August 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 14 Minuten Lesedauer

Erstellt eine große Streaming-XML-Nutzlast zur Verwendung in einer REST- oder SOAP-Anforderung zum Senden von Massendaten an eine Drittanbieter-API. Sie können die Nutzlast auch als XML-Zeichenfolge für eine Nicht-Streaming-Option erstellen.
Verwenden Sie diese Methoden in einem Workflow-Studio`-Skriptschritt` mit dem Namespace-Bezeichner sn_ih. Sie können diese API beispielsweise verwenden, um im Skriptschritt Workflow-Studio eine XML-Nutzlast zu erstellen und den zurückgegebenen Wert an den REST-Schritt zu übergeben, um die Anforderung an einen Drittanbieterservice zu senden. Weitere Informationen finden Sie im Workflow-Studio [Skriptschritt](https://www.servicenow.com/docs/access?context=javascript-step-action-designer&version=xanadu&pubname=xanadu-build-workflows&ft:locale=en-US).  
Hinweis:  
Sie können diese API nur in der Umgebung Workflow-Studio verwenden.

Für diese Klasse ist kein Konstruktor vorhanden. Stattdessen müssen Sie die Methode build() in der Klasse [XMLStreamingBuilder aufrufen](https://servicenow-prod.fluidtopics.net/uXXVfTSXY5cEK1dXqC8YJw#XMLStreamingBuilderScopedAPI "Erstellt ein Builder-Objekt zum Erstellen einer großen XML-Nutzlast zur Verwendung in einer REST- oder SOAP-Anforderung zum Senden von Massendaten an eine Drittanbieter-API. Sie können die Nutzlast auch als XML-Zeichenfolge für eine Nicht-Streaming-Option erstellen."), um ein XMLStreamingAPI-Objekt zurückzugeben.

## API-Aufrufreihenfolge {#XMLStreamingAPIScopedAPI__section_wk4_5bm_jlb}

Generieren Sie XML-Nutzlasten, indem Sie zuerst ein Builder-Objekt mit XMLStreamingBuilder instanziieren und dann die Methoden in der XMLStreamingAPI -Klasse aufrufen:  

1. XMLStreamingBuilder: Erstellt ein Builder-Objekt
:   Verwenden Sie diese Methoden in der folgenden Reihenfolge, um ein Builder-Objekt zu erstellen:  
    1. XMLStreamingBuilder(): Instanziiert das XMLStreamingBuilder-Objekt.
    2. withAttachment(): Optional. Erstellt ein XML-Dokument als Anhang und speichert es in der Tabelle „Streaming-Anhänge" \[streaming_attachment\]. Wenn Sie diese Methode nicht aufrufen, erstellt die API die Nutzlast als XML-Zeichenfolge.
    3. RunesAt(): Optional. Legt eine Uhrzeit fest, nach der der Anhang abläuft. Die Standardeinstellung ist „falsch". Muss auch withAttachment()- Methode aufrufen.
    4. build(): Gibt ein XMLStreamingAPI-Objekt zurück.
    {#XMLStreamingAPIScopedAPI__ol_gvr_k2k_jlb}

2. XMLStreamingAPI: Erstellt die XML-Nutzlast
:   Verwenden Sie diese Methoden in der folgenden Reihenfolge, um die XML-Nutzlast zu erstellen:  
    1. startDocument(): Erstellt das übergeordnete Element der obersten Ebene im XML-Dokument.
    2. Methoden zum Generieren von untergeordneten Elementen im XML-Dokument, z. B. writeTextElement(), startElement()und writeArray().
    3. Methoden zum Generieren von Attributen für ein Element, z. B. writeAttribute(), writeNamespace()und writeDtd().
    4. endElement(): Schließt ein XML-Element.
    5. endDocument: Schließt das übergeordnete Element der obersten Ebene.
    6. getXMLString() oder getAttachmentId(): Gibt die von Ihnen erstellte XML-Zeichenfolge oder Anhangs-ID zurück.
    7. close(): Schließt das XMLStreamingAPI-Objekt.
    {#XMLStreamingAPIScopedAPI__ol_hvr_k2k_jlb}

## Größenbeschränkungen {#XMLStreamingAPIScopedAPI__section_qkj_sd5_hlb}

Über diese API generierte Nutzlasten dürfen diese Größenbeschränkungen nicht überschreiten:  
* Anhänge: 200 MB
* Zeichenfolgen: 5 MB
{#XMLStreamingAPIScopedAPI__ul_syy_lsw_3lb}  
Das folgende Beispiel zeigt, wie Sie ein XML-Dokument erstellen und in der Tabelle „Streaming-Anhänge" \[streaming_attachment\] mit einem definierten Ablaufdatum speichern.  


    try {
      var ttl = new GlideDateTime("2011-01-01 12:00:00");
      var builder = new sn_ih.XMLStreamingBuilder()
        .withAttachment() // Creates the XML document in streaming mode within an attachment.
        .expiresAt(ttl) // Sets an expiration date for the attachment.
        .build(); // Creates the XMLStreamingAPI object.

      builder.startDocument("Employee") // Begins generating the XML document.
        .writeTextElement("firstName","John") // Writes a "firstName" element and value.
        .writeTextElement("lastName","Smith")
        .writeTextElement("age","25")
        .startElement("address") // Adds an "address" parent element.
          .writeTextElement("streetAddress", "21 2nd Street") // Writes a child element and value.
          .writeTextElement("city", "Santa Clara")
          .writeTextElement("state", "CA")
          .writeTextElement("postalCode", "11111")
        .endElement() // Adds a closing tag for the "address" element.
        .startElement("phoneNumber")
          .writeTextElement("type","home")
          .writeTextElement("number","212 555-1234")
          .writeTextElement("type","fax")
          .writeTextElement("number","646 555-4567")
        .endElement()
      .endDocument() // Stops generating the XML document.
          
      gs.log(builder.getAttachmentId()); // Returns the sys_id of the attachment.
    } catch (err) {
      gs.log(err);
    } finally {
      builder.close();
    }

Alternativ zeigt dieses Beispiel, wie Sie im Skriptschritt die API verwenden und die Nutzlast als XML-Zeichenfolge erstellen. Sie können diese Option verwenden, um Nutzlasten unter 5 MBzu erstellen.  

    (function execute(inputs, outputs) {

      var builder = new sn_ih.XMLStreamingBuilder().build();
      
      builder.startDocument("Employee")
        .enablePrettyPrint()
        .writeTextElement("firstName","John")
        .writeTextElement("lastName","Smith")
        .writeTextElement("age","25")
        .startElement("address")
          .writeTextElement("streetAddress", "21 2nd Street")
          .writeTextElement("city", "Santa Clara")
          .writeTextElement("state", "CA")
          .writeTextElement("postalCode", "11111")
        .endElement()
        .startElement("phoneNumber")
          .writeTextElement("type","home")
          .writeTextElement("number","212 555-1234")
          .writeTextElement("type","fax")
          .writeTextElement("number","646 555-4567")
        .endElement()
      .endDocument()

      outputs.payload = builder.getXMLString();
      
    })(inputs, outputs);

Ausgabe:  

    <?xml version="1.0" encoding="UTF-8"?>
    <firstName>John</firstName>
    <lastName>Smith</lastName>
    <age>25</age>
    <address>
      <streetAddress>21 2nd Street</streetAddress>
      <city>Santa Clara</city>
      <state>CA</state>
      <postalCode>11111</postalCode>
    </address>
    <phoneNumber>
      <type>home</type>
      <number>212 555-1234</number>
      <type>fax</type>
      <number>646 555-4567</number>
    </phoneNumber>

## XMLStreamingAPI -- schließen () {#ariaid-title2}

Schließt das XMLStreamingAPI-Objekt. Sie müssen diese Methode aufrufen, um den Stream nach dem Erstellen Ihres XML-Dokuments zu schließen.
{#XSA-close__table_pnn_31t_jlb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 1. Parameter]

{#XSA-close__table_pnn_31t_jlb} {#XSA-close__table_qnn_31t_jlb__entry__2}

| Typ | Beschreibung |
|-|-|
| void |   |
[Tabelle : 2. Ergebnisse]

{#XSA-close__table_qnn_31t_jlb}

### Beispiel

Das folgende Beispiel zeigt, wie Sie ein XML-Dokument erstellen und in der Tabelle „Streaming-Anhänge" \[streaming_attachment\] mit einem definierten Ablaufdatum speichern.


    try {
      var ttl = new GlideDateTime("2011-01-01 12:00:00");
      var builder = new sn_ih.XMLStreamingBuilder()
        .withAttachment() // Creates the XML document in streaming mode within an attachment.
        .expiresAt(ttl) // Sets an expiration date for the attachment.
        .build(); // Creates the XMLStreamingAPI object.

      builder.startDocument("Employee") // Begins generating the XML document.
        .writeTextElement("firstName","John") // Writes a "firstName" element and value.
        .writeTextElement("lastName","Smith")
        .writeTextElement("age","25")
        .startElement("address") // Adds an "address" parent element.
          .writeTextElement("streetAddress", "21 2nd Street") // Writes a child element and value.
          .writeTextElement("city", "Santa Clara")
          .writeTextElement("state", "CA")
          .writeTextElement("postalCode", "11111")
        .endElement() // Adds a closing tag for the "address" element.
        .startElement("phoneNumber")
          .writeTextElement("type","home")
          .writeTextElement("number","212 555-1234")
          .writeTextElement("type","fax")
          .writeTextElement("number","646 555-4567")
        .endElement()
      .endDocument() // Stops generating the XML document.
          
      gs.log(builder.getAttachmentId()); // Returns the sys_id of the attachment.
    } catch (err) {
      gs.log(err);
    } finally {
      builder.close();
    }

## XMLStreamingAPI -- disablePrettyPrint() {#ariaid-title3}

Beendet die XML-Formatierung für schön drucken.
Bevor Sie diese Methode aufrufen, müssen Sie enablePrettyPrint() aufrufen, um einem Abschnitt XML-Formatierungen hinzuzufügen.
{#XSA-disablePrettyPrint__table_exb_gct_jlb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 3. Parameter]

{#XSA-disablePrettyPrint__table_exb_gct_jlb} {#XSA-disablePrettyPrint__table_fxb_gct_jlb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingAPI | Streaming-XML-Objekt zum Erstellen der Nutzlast. |
[Tabelle : 4. Ergebnisse]

{#XSA-disablePrettyPrint__table_fxb_gct_jlb}  
Das folgende Beispiel zeigt, wie Sie dem Adresselement eine `ansprechende` Druckformatierung hinzufügen.

    try {
      var ttl = new GlideDateTime("2011-01-01 12:00:00");
      var builder = new sn_ih.XMLStreamingBuilder()
        .withAttachment()
        .expiresAt(ttl)
        .build();

      builder.startDocument("Employee")
        .writeTextElement("firstName","John")
        .writeTextElement("lastName","Smith")
        .writeTextElement("age","25")
        .enablePrettyPrint()
        .startElement("address")
          .writeTextElement("streetAddress", "21 2nd Street")
          .writeTextElement("city", "Santa Clara")
          .writeTextElement("state", "CA")
          .writeTextElement("postalCode", "11111")
        .endElement()
        .disablePrettyPrint()
        .startElement("phoneNumber")
          .writeTextElement("type","home")
          .writeTextElement("number","212 555-1234")
          .writeTextElement("type","fax")
          .writeTextElement("number","646 555-4567")
        .endElement()
      .endDocument()
          
      gs.log(builder.getAttachmentId());
    } catch (err) {
      gs.log(err);
    } finally {
      builder.close();
    }

## XMLStreamingAPI -- enablePrettyPrint() {#ariaid-title4}

Fügt einem XML-Element oder einer Struktur von Elementen eine ansprechende Druckformatierung hinzu.
Verwenden Sie die Methode disablePrettyPrint(), um die Formatierung zu beenden.
{#XSA-enablePrettyPrint__table_b2k_2ct_jlb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 5. Parameter]

{#XSA-enablePrettyPrint__table_b2k_2ct_jlb} {#XSA-enablePrettyPrint__table_c2k_2ct_jlb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingAPI | Streaming-XML-Objekt zum Erstellen der Nutzlast. |
[Tabelle : 6. Ergebnisse]

{#XSA-enablePrettyPrint__table_c2k_2ct_jlb}  
Das folgende Beispiel zeigt, wie Sie dem Adresselement eine `ansprechende` Druckformatierung hinzufügen.

    try {
      var ttl = new GlideDateTime("2011-01-01 12:00:00");
      var builder = new sn_ih.XMLStreamingBuilder()
        .withAttachment()
        .expiresAt(ttl)
        .build();

      builder.startDocument("Employee")
        .writeTextElement("firstName","John")
        .writeTextElement("lastName","Smith")
        .writeTextElement("age","25")
        .enablePrettyPrint()
        .startElement("address")
          .writeTextElement("streetAddress", "21 2nd Street")
          .writeTextElement("city", "Santa Clara")
          .writeTextElement("state", "CA")
          .writeTextElement("postalCode", "11111")
        .endElement()
        .disablePrettyPrint()
        .startElement("phoneNumber")
          .writeTextElement("type","home")
          .writeTextElement("number","212 555-1234")
          .writeTextElement("type","fax")
          .writeTextElement("number","646 555-4567")
        .endElement()
      .endDocument()
          
      gs.log(builder.getAttachmentId());
    } catch (err) {
      gs.log(err);
    } finally {
      builder.close();
    }

## XMLStreamingAPI -- endDocument() {#ariaid-title5}

Beendet die Struktur Ihres XML-Dokuments.
Nachdem Sie die startDocument()- Methode aufgerufen und Ihr Streaming-XML-Dokument organisiert haben, rufen Sie die endDocument()- Methode am Ende der Struktur Ihres Dokuments auf. Sie müssen diese beiden Methoden zusammen verwenden, um die Struktur Ihres Streaming-XML-Dokuments erfolgreich zu erstellen.
{#XSA-endDocument__table_nvn_bnz_clb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 7. Parameter]

{#XSA-endDocument__table_nvn_bnz_clb} {#XSA-endDocument__table_ovn_bnz_clb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingAPI | Streaming-XML-Objekt zum Erstellen der Nutzlast. |
[Tabelle : 8. Ergebnisse]

{#XSA-endDocument__table_ovn_bnz_clb}  
Das folgende Beispiel zeigt, wie Sie ein XML-Dokument erstellen, das Elemente zu einem Benutzer enthält.

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();

        streamingDocument.startDocument('Employee')
            .writeTextElement('firstName', 'John')
            .writeTextElement('lastName', 'Smith')
            .writeTextElement('age', '25')
            .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }

## XMLStreamingAPI -- endElement() {#ariaid-title6}

Fügt einem XML-Element ein schließendes Tag hinzu.
Verwenden Sie die folgenden Methoden in dieser Reihenfolge, um ein gültiges XML-Element zu erstellen:

1. Verwenden Sie die Methode startElement(), um ein Start-Tag hinzuzufügen.
2. Verwenden Sie die Methode endElement(), um das schließende Tag hinzuzufügen.
{#XSA-endElement__ol_uwy_qb3_bmb}
{#XSA-endElement__table_cct_vkh_dlb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 9. Parameter]

{#XSA-endElement__table_cct_vkh_dlb} {#XSA-endElement__table_dct_vkh_dlb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingAPI | Streaming-XML-Objekt zum Erstellen der Nutzlast. |
[Tabelle : 10. Ergebnisse]

{#XSA-endElement__table_dct_vkh_dlb}  
Das folgende Beispiel zeigt, wie ein übergeordnetes Element namens „ `dress` " erstellt und anschließend vier untergeordnete Elemente beschrieben werden.

    try {
      var ttl = new GlideDateTime("2011-01-01 12:00:00");
      var builder = new sn_ih.XMLStreamingBuilder()
        .withAttachment()
        .expiresAt(ttl)
        .build();

      builder.startDocument("Employee")
          .startElement("address")
          .writeTextElement("streetAddress", "21 2nd Street")
          .writeTextElement("city", "Santa Clara")
          .writeTextElement("state", "CA")
          .writeTextElement("postalCode", "11111")
        .endElement()
      .endDocument()
          
      gs.log(builder.getAttachmentId());
    } catch (err) {
      gs.log(err);
    } finally {
      builder.close();
    }

## XMLStreamingAPI -- getXMLString() {#ariaid-title7}

Gibt das XML-Dokument als Zeichenfolge zurück.
Um das XML-Dokument als Zeichenfolge zurückzugeben, rufen Sie nicht die getAttachementId()- Methode in der XMLStreamingBuilder -Klasse auf. Weitere Informationen finden Sie unter [XMLStreamingBuilder -- Bereichsbezogen](https://servicenow-prod.fluidtopics.net/uXXVfTSXY5cEK1dXqC8YJw#XMLStreamingBuilderScopedAPI "Erstellt ein Builder-Objekt zum Erstellen einer großen XML-Nutzlast zur Verwendung in einer REST- oder SOAP-Anforderung zum Senden von Massendaten an eine Drittanbieter-API. Sie können die Nutzlast auch als XML-Zeichenfolge für eine Nicht-Streaming-Option erstellen.").
{#XSA-getXMLString__table_rbj_kct_jlb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 11. Parameter]

{#XSA-getXMLString__table_rbj_kct_jlb} {#XSA-getXMLString__table_sbj_kct_jlb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Mit den XMLStreamingAPI- Methoden erstelltes XML-Dokument als Zeichenfolge |
[Tabelle : 12. Ergebnisse]

{#XSA-getXMLString__table_sbj_kct_jlb}  
Das folgende Beispiel zeigt, wie Sie ein XML-Dokument erstellen und dann als Zeichenfolge zurückgeben.  

    (function execute(inputs, outputs) {

      var builder = new sn_ih.XMLStreamingBuilder().build();
      
      builder.startDocument("Employee")
        .enablePrettyPrint()
        .writeTextElement("firstName","John")
        .writeTextElement("lastName","Smith")
        .writeTextElement("age","25")
        .startElement("address")
          .writeTextElement("streetAddress", "21 2nd Street")
          .writeTextElement("city", "Santa Clara")
          .writeTextElement("state", "CA")
          .writeTextElement("postalCode", "11111")
        .endElement()
        .startElement("phoneNumber")
          .writeTextElement("type","home")
          .writeTextElement("number","212 555-1234")
          .writeTextElement("type","fax")
          .writeTextElement("number","646 555-4567")
        .endElement()
      .endDocument()

      outputs.payload = builder.getXMLString();
      
    })(inputs, outputs);

Ausgabe:  

    <?xml version="1.0" encoding="UTF-8"?>
    <firstName>John</firstName>
    <lastName>Smith</lastName>
    <age>25</age>
    <address>
      <streetAddress>21 2nd Street</streetAddress>
      <city>Santa Clara</city>
      <state>CA</state>
      <postalCode>11111</postalCode>
    </address>
    <phoneNumber>
      <type>home</type>
      <number>212 555-1234</number>
      <type>fax</type>
      <number>646 555-4567</number>
    </phoneNumber>

## XMLStreamingAPI -- startDocument(String rootElement, Object namespaceDefinitionMap) {#ariaid-title8}

Startet die Erstellung eines XML-Dokuments.
Rufen Sie nach dem Aufrufen der build() -Methode die startDocument()- Methode auf, um mit der Organisation Ihres XML-Dokuments zu beginnen. Sie müssen auch die Methode endDocument am Ende der Struktur Ihres Dokuments aufrufen.
{#XSA-startDocument_S_O__table_yyj_tqg_dlb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| rootElement | Zeichenfolge | Optional. Stammelement oder übergeordnetes Element der obersten Ebene für Ihr XML-Dokument. |
| namespaceDefinitionMap | Objekt | Optional. Zuordnung von Schlüsseln und Werten für die Namespaces und die zugehörigen Werte in einer nachfolgenden Liste von Elementen. Beispiel: { 'namespaceOne':'namespaceValue', 'namespaceTwo':'namespaceValue' } |
[Tabelle : 13. Parameter]

{#XSA-startDocument_S_O__table_yyj_tqg_dlb} {#XSA-startDocument_S_O__table_zyj_tqg_dlb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingAPI | Streaming-XML-Objekt zum Erstellen der Nutzlast. |
[Tabelle : 14. Ergebnisse]

{#XSA-startDocument_S_O__table_zyj_tqg_dlb}  
Das folgende Beispiel zeigt, wie Sie ein XML-Dokument erstellen, das Elemente mit Informationen zu einem Mitarbeiter enthält.

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();

        streamingDocument.startDocument('Employee')
            .writeTextElement('firstName', 'John')
            .writeTextElement('lastName', 'Smith')
            .writeTextElement('age', '25')
            .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }

## XMLStreamingAPI - startElement (Zeichenfolgenname, ObjektnamespaceMap, ObjektattributeMap, Zeichenfolgenpräfix) {#ariaid-title9}

Fügt ein Start-Tag für ein XML-Element hinzu.
Verwenden Sie die folgenden Methoden in dieser Reihenfolge, um ein gültiges XML-Element zu erstellen:

1. Verwenden Sie die Methode startElement(), um ein Start-Tag hinzuzufügen.
2. Verwenden Sie die Methode endElement(), um das schließende Tag hinzuzufügen.
{#XSA-startElement_S_O_O_S__ol_uwy_qb3_bmb}
{#XSA-startElement_S_O_O_S__table_d1l_cjh_dlb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Name | Zeichenfolge | Name des XML-Elements. |
| namespaceMap | Objekt | Optional. Zuordnung von Schlüsseln und Werten für die Namespaces und die zugehörigen Werte in einer nachfolgenden Liste von Elementen. Beispiel: { 'namespaceOne':'namespaceValue', 'namespaceTwo':'namespaceValue' } |
| attributeMap | Objekt | Optional. Zuordnung von Schlüsseln und Werten für die Attribute und die zugehörigen Werte in einer nachfolgenden Liste von Elementen. |
| Präfix | Zeichenfolge | Optional. Präfix für das XML-Element. |
[Tabelle : 15. Parameter]

{#XSA-startElement_S_O_O_S__table_d1l_cjh_dlb} {#XSA-startElement_S_O_O_S__table_e1l_cjh_dlb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingAPI | Streaming-XML-Objekt zum Erstellen der Nutzlast. |
[Tabelle : 16. Ergebnisse]

{#XSA-startElement_S_O_O_S__table_e1l_cjh_dlb}  
Das folgende Beispiel zeigt, wie ein übergeordnetes Element namens „ dress " erstellt und anschließend vier untergeordnete Elemente beschrieben werden.

    try {
      var ttl = new GlideDateTime("2011-01-01 12:00:00");
      var builder = new sn_ih.XMLStreamingBuilder()
        .withAttachment()
        .expiresAt(ttl)
        .build();

      builder.startDocument("Employee")
          .startElement("address")
          .writeTextElement("streetAddress", "21 2nd Street")
          .writeTextElement("city", "Santa Clara")
          .writeTextElement("state", "CA")
          .writeTextElement("postalCode", "11111")
        .endElement()
      .endDocument()
          
      gs.log(builder.getAttachmentId());
    } catch (err) {
      gs.log(err);
    } finally {
      builder.close();
    }

## XMLStreamingAPI -- writeArray(String elementName, Array data, String WrappingElement) {#ariaid-title10}

Fügt Ihrem Streaming-XML-Dokument eine Liste geschachtelter Elemente mit vordefiniertem Text hinzu.
Nach dem Aufrufen der startDocument() -Methode können Sie die writeArray()- Methode aufrufen, um Ihrem XML-Streaming-Dokument einen Block geschachtelter Elemente hinzuzufügen.
{#XSA-writeArray_S_O_O__table_fgt_jbt_jlb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| elementName | Zeichenfolge | Name des XML-Elements, das jeder im Array data aufgeführten Zeichenfolge zugeordnet ist. |
| Daten | Array | Liste der Werte, die jedem in wrappingElementgeschachtelten Element zugewiesen werden sollen. |
| WrappingElement | Zeichenfolge | Übergeordnetes Element, das jeweils elementNameenthält. |
[Tabelle : 17. Parameter]

{#XSA-writeArray_S_O_O__table_fgt_jbt_jlb} {#XSA-writeArray_S_O_O__table_ggt_jbt_jlb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingAPI | Streaming-XML-Objekt zum Erstellen der Nutzlast. |
[Tabelle : 18. Ergebnisse]

{#XSA-writeArray_S_O_O__table_ggt_jbt_jlb}  
Das folgende Beispiel zeigt, wie ein übergeordnetes Element namens `„officeLocations`" erstellt und dann ein Array von fünf Elementen der `Stadt` geschachtelt wird.

    try {
      var ttl = new GlideDateTime("2011-01-01 12:00:00");
      var builder = new sn_ih.XMLStreamingBuilder()
        .withAttachment()
        .expiresAt(ttl)
        .build();

      builder.startDocument("Employee")
          .writeArray('city', ['Santa Clara','San Diego','Chicago','Sydney','London'], 'officeLocations')
      .endDocument()
          
      gs.log(builder.getAttachmentId());
    } catch (err) {
      gs.log(err);
    } finally {
      builder.close();
    }

## XMLStreamingAPI -- writeAttribute(Zeichenfolgenname, Zeichenfolgenwert) {#ariaid-title11}

Fügt einem Element in Ihrem XML-Dokument ein Attribut hinzu.
Nach dem Aufrufen der Methode startDocument(), startElement()oder writeTextElement() können Sie die Methode writeAttribute() aufrufen, um dem zugehörigen XML-Element ein Attribut hinzuzufügen.
{#XSA-writeAttribute_S_S__table_gwq_2bt_jlb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Name | Zeichenfolge | Name des Attributs des XML-Elements. |
| Wert | Zeichenfolge | Wert für das Attribut des XML-Elements. |
[Tabelle : 19. Parameter]

{#XSA-writeAttribute_S_S__table_gwq_2bt_jlb} {#XSA-writeAttribute_S_S__table_hwq_2bt_jlb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingAPI | Streaming-XML-Objekt zum Erstellen der Nutzlast. |
[Tabelle : 20. Ergebnisse]

{#XSA-writeAttribute_S_S__table_hwq_2bt_jlb}  
In diesem Beispiel wird dem Mitarbeiterelement ein Attribut mit der Bezeichnung „idNumber " hinzugefügt.

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();

        streamingDocument.startDocument('Employee')
        .writeAttribute('idNumber','12345')
            .writeTextElement('firstName', 'John')
            .writeTextElement('lastName', 'Smith')
            .writeTextElement('age', '25')
        .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }

## XMLStreamingAPI -- writeAttributes(Object attributeMap) {#ariaid-title12}

Fügt einem Element in Ihrem XML-Dokument Attribute hinzu.
Nach dem Aufrufen der Methode startDocument(), startElement()oder writeTextElement() können Sie die Methode writeAttributes() aufrufen, um dem zugehörigen XML-Element Attribute hinzuzufügen.
{#XSA-writeAttributes_O__table_nzt_gbt_jlb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| attributeMap | Objekt | Zuordnung von Schlüsseln und Werten, die Attributnamen und -werte enthalten, die dem XML-Element zugeordnet werden sollen. Beispiel: { 'attributeOne':'attributeValue', 'attributeTwo':'attributeValue' } |
[Tabelle : 21. Parameter]

{#XSA-writeAttributes_O__table_nzt_gbt_jlb} {#XSA-writeAttributes_O__table_ozt_gbt_jlb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingAPI | Streaming-XML-Objekt zum Erstellen der Nutzlast. |
[Tabelle : 22. Ergebnisse]

{#XSA-writeAttributes_O__table_ozt_gbt_jlb}  
In diesem Beispiel werden dem Element „ Mitarbeiter" die Attribute „ idNumber", „officeLocation" und „ department " hinzugefügt.

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();

        streamingDocument.startDocument('Employee')
        .writeAttributes({'idNumber':'12345', 'officeLocation':'San Diego', 'department':'Sales'})
            .writeTextElement('firstName', 'John')
            .writeTextElement('lastName', 'Smith')
            .writeTextElement('age', '25')
        .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }

## XMLStreamingAPI -- writeCData(Zeichenfolgendaten) {#ariaid-title13}

Fügt Ihrem XML-Dokument CDATA hinzu.
Nach dem Aufrufen der Methode writeCDataElement() können Sie die Methode writeCData() aufrufen, um CDATA innerhalb des Elements hinzuzufügen.
{#XSA-writeCData_S__table_ncx_qbt_jlb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| data | Zeichenfolge | Wert, der nach dem CDATA-Stichwort in Ihr CDATA-Element aufgenommen werden soll. |
[Tabelle : 23. Parameter]

{#XSA-writeCData_S__table_ncx_qbt_jlb} {#XSA-writeCData_S__table_ocx_qbt_jlb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingAPI | Streaming-XML-Objekt zum Erstellen der Nutzlast. |
[Tabelle : 24. Ergebnisse]

{#XSA-writeCData_S__table_ocx_qbt_jlb}  
In diesem Beispiel wird CDATA zum CDATA-Element `timeWorked hinzugefügt`.

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();

        streamingDocument.startDocument('Employee')
            .writeTextElement('firstName', 'John')
            .writeTextElement('lastName', 'Smith')
            .writeTextElement('age', '25')
            .writeCDataElement('timeWorked')
            .writeCData('< 2 years')
        .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }

## XMLStreamingAPI - writeCDataElement(Zeichenfolgenname, Zeichenfolgendaten, Objektpräfix) {#ariaid-title14}

Fügt Ihrem XML-Dokument ein CDATA-Element hinzu.
Nach dem Aufrufen der startDocument() -Methode können Sie die writeCDataElement()- Methode aufrufen, um Ihrem XML-Dokument ein CDATA-Element hinzuzufügen.
{#XSA-writeCDataElement_S_S_O__table_z31_tbt_jlb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Name | Zeichenfolge | Name des CDATA-Elements. |
| Daten | Zeichenfolge | Optional. Typ der Daten, als der das CDATA-Element analysiert werden soll. |
| Präfix | Objekt | Optional. Zuordnung der untergeordneten Elemente und Werte, die das CDATA-Element enthält. Beispiel: { 'prefixOne':'prefixValue', 'prefixTwo':'prefixValue' } Sie müssen das Präfix eines XML-Elements mithilfe von [writeNamespace()](https://servicenow-prod.fluidtopics.net/G79BIs5pCz23sMABswulVQ#XMLStreamingAPIScopedAPI "Erstellt eine große Streaming-XML-Nutzlast zur Verwendung in einer REST- oder SOAP-Anforderung zum Senden von Massendaten an eine Drittanbieter-API. Sie können die Nutzlast auch als XML-Zeichenfolge für eine Nicht-Streaming-Option erstellen.")einem Namespace zuordnen. |
[Tabelle : 25. Parameter]

{#XSA-writeCDataElement_S_S_O__table_z31_tbt_jlb} {#XSA-writeCDataElement_S_S_O__table_aj1_tbt_jlb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingAPI | Streaming-XML-Objekt zum Erstellen der Nutzlast. |
[Tabelle : 26. Ergebnisse]

{#XSA-writeCDataElement_S_S_O__table_aj1_tbt_jlb}  
In diesem Beispiel wird eine Dokumenttypdefinition mit der Bezeichnung „ `address ` " verwendet, um eine interne Dokumenttypdefinition für das XML-Dokument zu definieren.

    try {
      var ttl = new GlideDateTime("2011-01-01 12:00:00");
      var builder = new sn_ih.XMLStreamingBuilder()
        .withAttachment()
        .expiresAt(ttl)
        .build();

      builder.startDocument("Employee")
      .writeDtd('address')
      .writeCDataElement('home', '#PCDATA', {'streetAddress', 'city', 'state', 'postalCode'})
          .writeTextElement("streetAddress", "21 2nd Street")
          .writeTextElement("city", "Santa Clara")
          .writeTextElement("state", "CA")
          .writeTextElement("postalCode", "11111")
      .endDocument()
          
      gs.log(builder.getAttachmentId());
    } catch (err) {
      gs.log(err);
    } finally {
      builder.close();
    }

## XMLStreamingAPI -- writeCharacters(String text) {#ariaid-title15}

Fügt Ihrem XML-Dokument Text hinzu.
Verwenden Sie die Methode writeCharacters(), um Zeichenfolgendaten in einen Abschnitt in Ihrem XML-Dokument einzufügen.
{#XSA-writeCharacters_S__table_gwv_nbt_jlb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| text | Zeichenfolge | Text, der einem Abschnitt Ihres XML-Dokuments hinzugefügt werden soll. |
[Tabelle : 27. Parameter]

{#XSA-writeCharacters_S__table_gwv_nbt_jlb} {#XSA-writeCharacters_S__table_hwv_nbt_jlb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingAPI | Streaming-XML-Objekt zum Erstellen der Nutzlast. |
[Tabelle : 28. Ergebnisse]

{#XSA-writeCharacters_S__table_hwv_nbt_jlb}  
Das folgende Beispiel zeigt, wie Sie Elementen in Ihrem XML-Dokument Textwerte hinzufügen.

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();

        streamingDocument.startDocument('Employee')
            .startElement('firstName')
            .writeCharacters('John')
            .EndElement()
            .startElement('lastName')
            .writeCharacters('Smith')
            .endElement()
        .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }

## XMLStreamingAPI -- writeComment(Zeichenfolgenkommentar) {#ariaid-title16}

Fügt Ihrem XML-Dokument einen Kommentar hinzu.
Nach dem Aufrufen der startDocument() -Methode können Sie die writeComment()- Methode aufrufen, um Ihrem XML-Dokument einen Kommentar hinzuzufügen.
{#XSA-writeComment_S__table_i2x_vbt_jlb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Anmerkung | Zeichenfolge | Einzubeziehender Kommentartext. |
[Tabelle : 29. Parameter]

{#XSA-writeComment_S__table_i2x_vbt_jlb} {#XSA-writeComment_S__table_j2x_vbt_jlb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingAPI | Streaming-XML-Objekt zum Erstellen der Nutzlast. |
[Tabelle : 30. Ergebnisse]

{#XSA-writeComment_S__table_j2x_vbt_jlb}  
Das folgende Beispiel zeigt, wie einem XML-Dokument ein Kommentar hinzugefügt wird.

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();

        streamingDocument.startDocument('Employee')
            .writeComment('Element for information related to active employees.')
            .writeTextElement('firstName', 'John')
            .writeTextElement('lastName', 'Smith')
            .writeTextElement('age', '25')
        .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }

## XMLStreamingAPI -- writeDtd(String dtd) {#ariaid-title17}

Fügt Ihrem XML-Dokument eine Dokumenttypdefinition hinzu.
Nach dem Aufrufen der startDocument() -Methode können Sie die writeDtd()- Methode aufrufen, um Ihrem XML-Dokument eine gültige XML-Dokumenttypdefinition hinzuzufügen.
{#XSA-writeDtd_S__table_iyt_xbt_jlb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| DTD | Zeichenfolge | Name einer gültigen XML-Dokumenttypdefinition. |
[Tabelle : 31. Parameter]

{#XSA-writeDtd_S__table_iyt_xbt_jlb} {#XSA-writeDtd_S__table_jyt_xbt_jlb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingAPI | Streaming-XML-Objekt zum Erstellen der Nutzlast. |
[Tabelle : 32. Ergebnisse]

{#XSA-writeDtd_S__table_jyt_xbt_jlb}  
In diesem Beispiel wird eine Dokumenttypdefinition mit der Bezeichnung „ address " verwendet, um eine interne Dokumenttypdefinition für das XML-Dokument zu definieren.

    try {
      var ttl = new GlideDateTime("2011-01-01 12:00:00");
      var builder = new sn_ih.XMLStreamingBuilder()
        .withAttachment()
        .expiresAt(ttl)
        .build();

      builder.startDocument("Employee")
      .writeDtd('address')
      .writeCDataElement('home', '#PCDATA', {'streetAddress', 'city', 'state', 'postalCode'})
          .writeTextElement("streetAddress", "21 2nd Street")
          .writeTextElement("city", "Santa Clara")
          .writeTextElement("state", "CA")
          .writeTextElement("postalCode", "11111")
      .endDocument()
          
      gs.log(builder.getAttachmentId());
    } catch (err) {
      gs.log(err);
    } finally {
      builder.close();
    }

## XMLStreamingAPI -- writeNamespace (Zeichenfolgenpräfix, Zeichenfolge namespaceURI) {#ariaid-title18}

Fügt einem Element in Ihrem XML-Dokument einen Namespace hinzu.
Nach dem Aufrufen der Methode startDocument(), startElement()oder writeTextElement() können Sie die Methode writeNamespace() aufrufen, um dem zugehörigen XML-Element einen Namespace hinzuzufügen.
{#XSA-writeNamespace_S_S__table_edp_qzs_jlb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Präfix | Zeichenfolge | Präfix für den XML-Namespace. |
| namespaceURI | Zeichenfolge | Optional. URI für den Namespace. |
[Tabelle : 33. Parameter]

{#XSA-writeNamespace_S_S__table_edp_qzs_jlb} {#XSA-writeNamespace_S_S__table_fdp_qzs_jlb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingAPI | Streaming-XML-Objekt zum Erstellen der Nutzlast. |
[Tabelle : 34. Ergebnisse]

{#XSA-writeNamespace_S_S__table_fdp_qzs_jlb}  
Das folgende Beispiel zeigt, wie Sie dem Stammelement des `Unternehmens` einen Namespace und einen URI hinzufügen und dann das Präfix dem geschachtelten Element `„companyName" zuweisen`.

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();

        streamingDocument.startDocument('company')
        .writeNamespace('x','https://www.servicenow.com')
            .writeTextElement('companyName', 'ServiceNow')
            .writeNamespace('x')
        .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }

## XMLStreamingAPI -- writeNamespaces(Object namespaceMap) {#ariaid-title19}

Fügt dem Stammelement in Ihrem XML-Dokument Namespaces hinzu.
Nach dem Aufrufen der Methode startDocument() oder startElement() können Sie die Methode writeNamespaces() aufrufen, um Namespaces für das zugeordnete XML-Element zu deklarieren.
{#XSA-writeNamespaces_O__table_z4l_21t_jlb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| namespaceMap | Objekt | Zuordnung von Schlüsseln und Werten, die Namespace-Präfixe und URIs enthalten, die dem Stammelement des XML-Dokuments XML zugeordnet werden sollen. Beispiel: { 'namespaceOne':'namespaceValue', 'namespaceTwo':'namespaceValue' } |
[Tabelle : 35. Parameter]

{#XSA-writeNamespaces_O__table_z4l_21t_jlb} {#XSA-writeNamespaces_O__table_apl_21t_jlb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingAPI | Streaming-XML-Objekt zum Erstellen der Nutzlast. |
[Tabelle : 36. Ergebnisse]

{#XSA-writeNamespaces_O__table_apl_21t_jlb}  
In diesem Beispiel werden dem Stammelement des Unternehmens zwei Namespaces und URIs hinzugefügt, und anschließend werden den geschachtelten Elementen die entsprechenden Präfixe zugewiesen.

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();

        streamingDocument.startDocument('company')
        .writeNamespaces({'x':'https://www.servicenow.com', 'y':'https://www.developer.servicenow.com'})
            .writeTextElement('companyName', 'ServiceNow')
            .writeNamespace('x')
            .writeTextElement('devFramework', 'UI Framework')
            .writeNamespace('y')
        .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }

## XMLStreamingAPI -- writeTextElement(Zeichenfolgenname, Zeichenfolgentext, Objektpräfix) {#ariaid-title20}

Fügt Ihrem XML-Dokument ein einzelnes XML-Element hinzu.
Nach dem Aufrufen der startDocument() -Methode können Sie die writeTextElement()- Methode aufrufen, um der Struktur Ihres XML-Dokuments ein einzelnes XML-Element hinzuzufügen.
{#XSA-writeTextElement_S_S_O__table_ryd_zkh_dlb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Name | Zeichenfolge | Name des XML-Elements. |
| HTML | Zeichenfolge | Wert für das XML-Element. |
| Präfix | Objekt | Optional. Zuordnung der Präfixe und Werte, die dem XML-Element zugeordnet sind. Beispiel: { 'prefixOne':'prefixValue', 'prefixTwo':'prefixValue' } Sie müssen das Präfix eines XML-Elements mithilfe von [writeNamespace()](https://servicenow-prod.fluidtopics.net/G79BIs5pCz23sMABswulVQ#XMLStreamingAPIScopedAPI "Erstellt eine große Streaming-XML-Nutzlast zur Verwendung in einer REST- oder SOAP-Anforderung zum Senden von Massendaten an eine Drittanbieter-API. Sie können die Nutzlast auch als XML-Zeichenfolge für eine Nicht-Streaming-Option erstellen.")einem Namespace zuordnen. |
[Tabelle : 37. Parameter]

{#XSA-writeTextElement_S_S_O__table_ryd_zkh_dlb} {#XSA-writeTextElement_S_S_O__table_syd_zkh_dlb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingAPI | Streaming-XML-Objekt zum Erstellen der Nutzlast. |
[Tabelle : 38. Ergebnisse]

{#XSA-writeTextElement_S_S_O__table_syd_zkh_dlb}  
Das folgende Beispiel zeigt, wie Sie ein XML-Dokument erstellen, das drei Elemente mit Informationen zu einem Mitarbeiter enthält.

    try {
        var ttl = new GlideDateTime('2011-01-01 12:00:00');
        var builder = new sn_ih.XMLStreamingBuilder().withAttachment().expiresAt(ttl);
        var streamingDocument = builder.build();

        streamingDocument.startDocument('Employee')
            .writeTextElement('firstName', 'John')
            .writeTextElement('lastName', 'Smith')
            .writeTextElement('age', '25')
        .endDocument();
        gs.log(streamingDocument.getAttachmentId());
    } catch (err) {
        gs.log(err);
    } finally {
        streamingDocument.close();
    }