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


---

# XMLStreamingBuilder -- Umfang

# XMLStreamingBuilder -- Umfang {#ariaid-title1}

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

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

## API-Aufrufreihenfolge {#XMLStreamingBuilderScopedAPI__section_j2q_1ll_jlb}

Generieren Sie XML-Nutzlasten, indem Sie zuerst ein Generatorobjekt mit instanziieren XMLStreamingBuilder Und ruft dann die Methoden in auf XMLStreamingAPI Klasse:  

1. XMLStreamingBuilder : Erstellt ein Generatorobjekt
:   Verwenden Sie diese Methode in der folgenden Reihenfolge, um ein Generatorobjekt zu erstellen:  
    1. XMLStreamingBuilder() : Instanziiert das XMLStreamingBuilder-Objekt.
    2. MitAnhang() : 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. AblaufAt() : Optional. Legt einen Zeitpunkt fest, zu dem der Anhang abläuft. „Falsch" ist der Standard. Muss auch anrufen MitAnhang() Methode.
    4. Build() : Gibt ein XMLStreamingAPI-Objekt zurück.
    {#XMLStreamingBuilderScopedAPI__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 untergeordneter Elemente 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. EndDokument : Schließt das übergeordnete Element der obersten Ebene.
    6. GetXMLZeichenfolge() Oder GetAttachmentId() : Gibt die von Ihnen erstellte XML-Zeichenfolge oder Anhang-ID zurück.
    7. Schließen() : Schließt das XMLStreamingAPI-Objekt.
    {#XMLStreamingBuilderScopedAPI__ol_hvr_k2k_jlb}

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

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


    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 die API im Skriptschritt verwendet und die Nutzlast als XML-Zeichenfolge erstellt wird. Sie können diese Option verwenden, um Nutzlasten unter zu erstellen 5 MB .  

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

## XMLStreamingBuilder -- XMLStreamingBuilder() {#ariaid-title2}

Instanziiert das XMLStreamingBuilder-Objekt.
{#XSB-XMLStreamingBuilder__table_ogh_vhz_clb__entry__3}

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

{#XSB-XMLStreamingBuilder__table_ogh_vhz_clb}  
Dieses Beispiel zeigt, wie ein instanziiert wird `generator `Objekt.

    var builder = new sn_ih.XMLStreamingBuilder()

## XMLStreamingBuilder -- Build() {#ariaid-title3}

Gibt ein XMLStreamingAPI-Objekt zurück.
{#XSB-build__table_cr5_yms_jlb__entry__3}

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

{#XSB-build__table_cr5_yms_jlb} {#XSB-build__table_dr5_yms_jlb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingAPI | Streaming-XML-Objekt zum Erstellen der Nutzlast. |
[Tabelle : 3. Rückgaben]

{#XSB-build__table_dr5_yms_jlb}  
Das folgende Beispiel zeigt, wie ein XML-Dokument erstellt und in der Tabelle „Streaming-Anhänge" \[Streaming_attachment\] mit einem definierten Ablaufdatum gespeichert wird.


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

## XMLStreamingBuilder -- ExpresAt(Object ExpresAt) {#ariaid-title4}

Legt einen Zeitpunkt fest, zu dem der Anhang abläuft. Muss auch anrufen MitAnhang() Methode.
{#XSB-expiresAt_O__table_kc4_25s_jlb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| expiresAt | [GlideDateTime](https://servicenow-prod.fluidtopics.net/3E4k~hw2Yf_nMTVTCjn4Xw#c_GlideDateTimeScoped "Der Umfang ist festgelegt GlideDateTime Die Klasse stellt Methoden zum Ausführen von Vorgängen für GlideDateTime-Objekte bereit.") | Objekt, das festgelegt wird, wenn der Anhang abläuft. * Mindestwert: 7200 Sekunden oder zwei Stunden ab dem Zeitpunkt, zu dem der Anhang erstellt wird. Dies ist der Standardwert, wenn Sie nicht aufrufen AblaufAt() Methode. * Höchstwert: 172800 Sekunden oder 48 Stunden ab dem Zeitpunkt, zu dem der Anhang erstellt wird. {#XSB-expiresAt_O__ul_xsc_trx_3lb} |
[Tabelle : 4. Parameter]

{#XSB-expiresAt_O__table_kc4_25s_jlb} {#XSB-expiresAt_O__table_lc4_25s_jlb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingBuilder | Generatorobjekt, das zum Initiieren der XML-Nutzlast verwendet wird. |
[Tabelle : 5. Rückgaben]

{#XSB-expiresAt_O__table_lc4_25s_jlb}  
Das folgende Beispiel zeigt, wie ein XML-Dokument erstellt und in der Tabelle „Streaming-Anhänge" \[Streaming_attachment\] mit einem definierten Ablaufdatum gespeichert wird.


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

## XMLStreamingBuilder -- withAttachment() {#ariaid-title5}

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 das XML-Dokument als Zeichenfolge.
{#XSB-withAttachment__table_oqn_zps_jlb__entry__3}

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

{#XSB-withAttachment__table_oqn_zps_jlb} {#XSB-withAttachment__table_pqn_zps_jlb__entry__2}

| Typ | Beschreibung |
|-|-|
| XMLStreamingBuilder | Generatorobjekt, das zum Initiieren der XML-Nutzlast verwendet wird. |
[Tabelle : 7. Rückgaben]

{#XSB-withAttachment__table_pqn_zps_jlb}  
Das folgende Beispiel zeigt, wie ein XML-Dokument erstellt und in der Tabelle „Streaming-Anhänge" \[Streaming_attachment\] mit einem definierten Ablaufdatum gespeichert wird.  


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

Dieses Beispiel zeigt, wie die XML-Nutzlast erstellt und als Zeichenfolge gespeichert wird.  

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


