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


---

# JSONStreamingBuilder -- Umfang

# JSONStreamingBuilder -- Umfang {#ariaid-title1}

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

Erstellen Sie ein Generatorobjekt, das zum Erstellen einer großen JSON-Streaming-Nutzlast verwendet wird, die in einer REST- oder SOAP-Anforderung verwendet werden soll, um Massendaten an eine Drittanbieter-API zu senden. Sie können die Nutzlast auch als JSON-Zeichenfolge für eine nicht-Streaming-Option erstellen.
Verwenden Sie diese Methoden in Workflow-StudioSkriptschritt mit `sn_ih `Namespace-Bezeichner. Sie können diese API beispielsweise verwenden, um eine JSON-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).

Sie können diese API nur innerhalb von verwenden Workflow-StudioUmgebung.

## API-Aufrufreihenfolge {#JSONStreamingBuilderScopedAPI__section_owy_pd5_hlb}

Generieren Sie JSON-Nutzlasten mit diesen APIs in der folgenden Reihenfolge:  

JSONStreamingBuilder : Erstellt ein Generatorobjekt
:   Verwenden Sie diese Methoden in der folgenden Reihenfolge, um ein Generatorobjekt zu erstellen:  
    1. JSONStreamingBuilder() : Instanziiert das JSONStreamingBuilder-Objekt. {#JSONStreamingBuilderScopedAPI__json-api-constructor}
    2. MitAnhang() : Optional. Erstellt das JSON-Objekt als Streaming-Anhang und speichert es in der Tabelle „Streaming-Anhänge" \[Streaming_attachment\]. Wenn Sie diese Methode nicht aufrufen, erstellt die API die Nutzlast als JSON-Zeichenfolge.{#JSONStreamingBuilderScopedAPI__with-attachments}
    3. AblaufAt() : Optional. Legt einen Zeitpunkt fest, zu dem der Anhang abläuft. Muss auch anrufen MitAnhang() Methode. {#JSONStreamingBuilderScopedAPI__expires-at}
    4. Build() : Gibt ein JSONStreamingAPI-Objekt zurück. {#JSONStreamingBuilderScopedAPI__build}
    {#JSONStreamingBuilderScopedAPI__ol_obn_dd5_hlb}

JSONStreamingAPI : Erstellt die JSON-Nutzlast
:   Verwenden Sie diese Methoden in der folgenden Reihenfolge, um die JSON-Nutzlast zu erstellen:  
    1. StartObject() : Erstellt das übergeordnete JSON-Objekt. {#JSONStreamingBuilderScopedAPI__start-object}
    2. Methoden zum Generieren der JSON-Schlüssel-Wert-Paare, z. B. WriteFeldname() , Schreibzeichenfolge() , Und WriteNumberField() .
    3. Endobjekt() : Schließt das übergeordnete JSON-Objekt. {#JSONStreamingBuilderScopedAPI__end-object}
    4. GetJSONString() Oder GetAttachmentId() : Gibt die von Ihnen erstellte JSON-Zeichenfolge oder Anhang-ID zurück.
    5. Schließen() : Schließt das JSONStreamingAPI-Objekt. {#JSONStreamingBuilderScopedAPI__close}
    {#JSONStreamingBuilderScopedAPI__ol_yzk_qgn_hlb}

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

Über diese API generierte Nutzlasten dürfen diese Größenbeschränkungen nicht überschreiten:  
* Anhänge: 200 MB
* Zeichenfolgen: 5 MB
{#JSONStreamingBuilderScopedAPI__ul_llq_msw_3lb}

## Beispiele {#JSONStreamingBuilderScopedAPI__section_nzz_rd5_hlb}

Dieses Beispiel zeigt, wie ein JSON-Objekt erstellt und in der Tabelle „Anhang" \[sys_attachment\] mit einem definierten Ablaufdatum gespeichert wird.  

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

      builder.startObject()  // Begins generating the JSON object.
    	.writeFieldName("firstName")  // Adds a "firstName" field 
    	.writeString("John")          // Writes the value of the "firstName" field
    	.writeFieldName("lastName")
    	.writeString("Smith")
    	.writeNumberField("age","25") // Write a number field named "age" with value "25"
    	.writeFieldName("address")
    	.startObject()                // Start a new object nested under the parent object
    		.writeStringField("streetAddress", "21 2nd Street")
    		.writeStringField("city", "Santa Clara")
    		.writeStringField("state", "CA")
    		.writeStringField("postalCode", "11111")
    	.endObject()
    	.writeFieldName("phoneNumber")
    	.startArray()                    // Start an array 
    		.startObject()               // Add the first object to the array 
    			.writeFieldName("type")
    			.writeString("home")
    			.writeFieldName("number")
    			.writeString("212 555-1234")
    		.endObject()
    		.startObject()               // Add another object to the array 
    			.writeFieldName("type")
    			.writeString("fax")
    			.writeFieldName("number")
    			.writeString("646 555-4567")
    		.endObject()
    	.endArray()
    	.endObject()

      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 JSON-Zeichenfolge erstellt wird. Sie können diese Option verwenden, um Nutzlasten unter 5 MB zu erstellen.  

    (function execute(inputs, outputs) {

      var builder = new sn_ih.JSONStreamingBuilder().build();
      
      builder.startObject()
        .enablePrettyPrint()
        .writeTextElement("firstName","John")
        .writeString("John")
        .writeFieldName("lastName")
        .writeString("Smith")
        .writeNumberField("age","25")
        .writeFieldName("address")
        .startObject()
          .writeStringField("streetAddress", "21 2nd Street")
          .writeStringField("city", "Santa Clara")
          .writeStringField("state", "CA")
          .writeStringField("postalCode", "11111")
        .endObject()
        .writeFieldName("phoneNumber")
        .startArray()
          .startObject()
            .writeFieldName("type")
            .writeString("home")
            .writeFieldName("number")
            .writeString("212 555-1234")
          .endObject()
          .startObject()
            .writeFieldName("type")
            .writeString("fax")
            .writeFieldName("number")
            .writeString("646 555-4567")
          .endObject()
        .endArray()
        .endObject()

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

Ausgabe:  

    {
    "firstName" : "John",
    "lastName" : "Smith",
    "age" : 25,
    "address" : {
      "streetAddress" : "21 2nd Street",
      "city" : "Santa Clara",
      "state" : "CA",
      "postalCode" : "11111"
    },
    "phoneNumber" : [ {
      "type" : "home",
      "number" : "212 555-1234"
    }, {
      "type" : "fax",
      "number" : "646 555-4567"
    } ]
    }

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

Instanziiert das JSONStreamingBuilder-Objekt.
{#JSB-JSONStreamingBuilder__table_mkq_q22_1lb__entry__3}

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

{#JSB-JSONStreamingBuilder__table_mkq_q22_1lb}  

    var builder = new sn_ih.JSONStreamingBuilder()

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

Gibt ein JSONStreamingAPI-Objekt zurück.
{#JSB-build__table_g3z_zf2_1lb__entry__3}

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

{#JSB-build__table_g3z_zf2_1lb} {#JSB-build__table_h3z_zf2_1lb__entry__2}

| Typ | Beschreibung |
|-|-|
| JSONStreamingAPI | Streaming-JSON-Objekt, das zum Erstellen der Nutzlast verwendet wird. |
[Tabelle : 3. Rückgaben]

{#JSB-build__table_h3z_zf2_1lb}  
Dieses Beispiel zeigt, wie ein JSON-Objekt erstellt und in der Tabelle „Anhang" \[sys_attachment\] mit einem definierten Ablaufdatum gespeichert wird.

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

      builder.startObject()  // Begins generating the JSON object.
    	.writeFieldName("firstName")  // Adds a "firstName" field 
    	.writeString("John")          // Writes the value of the "firstName" field
    	.writeFieldName("lastName")
    	.writeString("Smith")
    	.writeNumberField("age","25") // Write a number field named "age" with value "25"
    	.writeFieldName("address")
    	.startObject()                // Start a new object nested under the parent object
    		.writeStringField("streetAddress", "21 2nd Street")
    		.writeStringField("city", "Santa Clara")
    		.writeStringField("state", "CA")
    		.writeStringField("postalCode", "11111")
    	.endObject()
    	.writeFieldName("phoneNumber")
    	.startArray()                    // Start an array 
    		.startObject()               // Add the first object to the array 
    			.writeFieldName("type")
    			.writeString("home")
    			.writeFieldName("number")
    			.writeString("212 555-1234")
    		.endObject()
    		.startObject()               // Add another object to the array 
    			.writeFieldName("type")
    			.writeString("fax")
    			.writeFieldName("number")
    			.writeString("646 555-4567")
    		.endObject()
    	.endArray()
    	.endObject()

      gs.log(builder.getAttachmentId()); // Returns the sys_id of the attachment.
    } 

    catch (err) {
      gs.log(err);
    } 

    finally {
      builder.close();
    }

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

Legt einen Zeitpunkt fest, zu dem der Anhang abläuft. Muss auch anrufen MitAnhang() Methode. Wenn Sie diese Methode nicht aufrufen, läuft der Anhang zwei Stunden ab dem Zeitpunkt ab, zu dem der Anhang erstellt wird.
{#JSB-expiresAt_O__table_wlk_hzt_hlb__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. Standard. * Höchstwert: 172800 Sekunden oder 48 Stunden ab dem Zeitpunkt, zu dem der Anhang erstellt wird. {#JSB-expiresAt_O__ul_xsc_trx_3lb} |
[Tabelle : 4. Parameter]

{#JSB-expiresAt_O__table_wlk_hzt_hlb} {#JSB-expiresAt_O__table_xlk_hzt_hlb__entry__2}

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

{#JSB-expiresAt_O__table_xlk_hzt_hlb}  
Dieses Beispiel zeigt, wie ein JSON-Objekt erstellt und in der Tabelle „Anhang" \[sys_attachment\] mit einem definierten Ablaufdatum gespeichert wird.

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

      builder.startObject()  // Begins generating the JSON object.
    	.writeFieldName("firstName")  // Adds a "firstName" field 
    	.writeString("John")          // Writes the value of the "firstName" field
    	.writeFieldName("lastName")
    	.writeString("Smith")
    	.writeNumberField("age","25") // Write a number field named "age" with value "25"
    	.writeFieldName("address")
    	.startObject()                // Start a new object nested under the parent object
    		.writeStringField("streetAddress", "21 2nd Street")
    		.writeStringField("city", "Santa Clara")
    		.writeStringField("state", "CA")
    		.writeStringField("postalCode", "11111")
    	.endObject()
    	.writeFieldName("phoneNumber")
    	.startArray()                    // Start an array 
    		.startObject()               // Add the first object to the array 
    			.writeFieldName("type")
    			.writeString("home")
    			.writeFieldName("number")
    			.writeString("212 555-1234")
    		.endObject()
    		.startObject()               // Add another object to the array 
    			.writeFieldName("type")
    			.writeString("fax")
    			.writeFieldName("number")
    			.writeString("646 555-4567")
    		.endObject()
    	.endArray()
    	.endObject()

      gs.log(builder.getAttachmentId()); // Returns the sys_id of the attachment.
    } 

    catch (err) {
      gs.log(err);
    } 

    finally {
      builder.close();
    }

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

Erstellt das JSON-Objekt als Streaming-Anhang und speichert es in der Tabelle „Streaming-Anhänge" \[Streaming_attachment\]. Wenn Sie diese Methode nicht aufrufen, erstellt die API die Nutzlast als JSON-Zeichenfolge.
{#JSB-withAttachment__table_fm2_dzt_hlb__entry__3}

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

{#JSB-withAttachment__table_fm2_dzt_hlb} {#JSB-withAttachment__table_gm2_dzt_hlb__entry__2}

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

{#JSB-withAttachment__table_gm2_dzt_hlb}  
Dieses Beispiel zeigt, wie die JSON-Nutzlast erstellt und als Anhang gespeichert wird.

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

      builder.startObject()  // Begins generating the JSON object.
    	.writeFieldName("firstName")  // Adds a "firstName" field 
    	.writeString("John")          // Writes the value of the "firstName" field
    	.writeFieldName("lastName")
    	.writeString("Smith")
    	.writeNumberField("age","25") // Write a number field named "age" with value "25"
    	.writeFieldName("address")
    	.startObject()                // Start a new object nested under the parent object
    		.writeStringField("streetAddress", "21 2nd Street")
    		.writeStringField("city", "Santa Clara")
    		.writeStringField("state", "CA")
    		.writeStringField("postalCode", "11111")
    	.endObject()
    	.writeFieldName("phoneNumber")
    	.startArray()                    // Start an array 
    		.startObject()               // Add the first object to the array 
    			.writeFieldName("type")
    			.writeString("home")
    			.writeFieldName("number")
    			.writeString("212 555-1234")
    		.endObject()
    		.startObject()               // Add another object to the array 
    			.writeFieldName("type")
    			.writeString("fax")
    			.writeFieldName("number")
    			.writeString("646 555-4567")
    		.endObject()
    	.endArray()
    	.endObject()

      gs.log(builder.getAttachmentId()); // Returns the sys_id of the attachment.
    } 

    catch (err) {
      gs.log(err);
    } 

    finally {
      builder.close();
    }

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

    try {
      var builder = new sn_ih.JSONStreamingBuilder().build();

      builder.startObject()
        .writeFieldName("firstName")
        .writeString("John")
        .writeFieldName("lastName")
        .writeString("Smith")
        .writeNumberField("age","25")
        .writeFieldName("address")
        .startObject()
        .writeStringField("streetAddress", "21 2nd Street")
        .writeStringField("city", "Santa Clara")
        .writeStringField("state", "CA")
        .writeStringField("postalCode", "11111")
        .endObject()
        .writeFieldName("phoneNumber")
        .startArray()
        .startObject()
        .writeFieldName("type")
        .writeString("home")
        .writeFieldName("number")
        .writeString("212 555-1234")
        .endObject()
        .startObject()
        .writeFieldName("type")
        .writeString("fax")
        .writeFieldName("number")
        .writeString("646 555-4567")
        .endObject()
        .endArray()
        .endObject()

      gs.log(builder.getJSONString());
    } 

    catch (err) {
      gs.log("Exception: " + err);
    } 

    finally {
      builder.close();
    }

Ausgabe:

    {
    "firstName" : "John",
    "lastName" : "Smith",
    "age" : 25,
    "address" : {
      "streetAddress" : "21 2nd Street",
      "city" : "Santa Clara",
      "state" : "CA",
      "postalCode" : "11111"
    },
    "phoneNumber" : [ {
      "type" : "home",
      "number" : "212 555-1234"
    }, {
      "type" : "fax",
      "number" : "646 555-4567"
    } ]
    }


