---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# JSONStreamingAPI :スコープ指定

# JSONStreamingAPI :スコープ指定 {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：58分

大規模なストリーミング JSON ペイロードをビルドし、REST または SOAP 要求で使用して大量のデータをサードパーティ API に送信します。非ストリーミングオプション用の JSON 文字列としてペイロードを作成することもできます。
これらのメソッドを ワークフロースタジオ スクリプトステップで `sn_ih` 名前空間識別子とともに使用します。たとえば、この API を使用して ワークフロースタジオ スクリプトステップで JSON ペイロードを作成し、戻り値を REST ステップに渡して、要求をサードパーティサービスに送信できます。詳細については、「ワークフロースタジオ [スクリプトステップ](https://www.servicenow.com/docs/access?context=javascript-step-action-designer&version=xanadu&pubname=xanadu-build-workflows&ft:locale=en-US)」を参照してください。

この API は ワークフロースタジオ 環境内でのみ使用できます。

このクラスを使用するには、JSONStreamingBuilder クラスで build() メソッドを呼び出して JSONStreamingAPI オブジェクトを返す必要があります。「[JSONStreamingBuilder - スコープ指定](https://servicenow-prod.fluidtopics.net/41PiVgRUUD1hnDIGSFQecQ#JSONStreamingBuilderScopedAPI "大規模なストリーミング JSON ペイロードをビルドするために使用するビルダーオブジェクトを作成し、REST または SOAP 要求で使用して大量のデータをサードパーティ API に送信します。非ストリーミングオプション用の JSON 文字列としてペイロードを作成することもできます。")」を参照してください。

## API 呼び出し順 {#JSONStreamingAPIScopedAPI__section_owy_pd5_hlb}

次の API を順番に使用して JSON ペイロードを生成します。  

JSONStreamingBuilder：ビルダーオブジェクトを作成する
:   下記のメソッドを次の順番で使用して、ビルダーオブジェクトを作成します。  
    1. JSONStreamingBuilder()：JSONStreamingBuilder オブジェクトをインスタンス化します。{#JSONStreamingAPIScopedAPI__json-api-constructor}
    2. withAttachment()：オプション。ストリーミング添付ファイルとして JSON オブジェクトを作成し、ストリーミング添付ファイル \[streaming_attachment\] テーブルに格納します。このメソッドを呼び出さない場合、API はペイロードを JSON 文字列として作成します。{#JSONStreamingAPIScopedAPI__with-attachments}
    3. expiresAt()：オプション。添付ファイルの有効期限が切れる時刻を設定します。withAttachment() メソッドも呼び出す必要があります。{#JSONStreamingAPIScopedAPI__expires-at}
    4. build()：JSONStreamingAPI オブジェクトを返します。{#JSONStreamingAPIScopedAPI__build}
    {#JSONStreamingAPIScopedAPI__ol_obn_dd5_hlb}

JSONStreamingAPI：JSON ペイロードをビルドする
:   下記のメソッドを次の順番で使用して、JSON ペイロードを作成します。  
    1. startObject()：親 JSON オブジェクトを作成します。{#JSONStreamingAPIScopedAPI__start-object}
    2. JSON のキーと値のペアを生成するメソッド ：writeFieldName()、 writeString()、 writeNumberField() など。
    3. endObject()：親 JSON オブジェクトを閉じます。{#JSONStreamingAPIScopedAPI__end-object}
    4. getJSONString() または getAttachmentId()：作成した JSON 文字列または添付ファイル ID を返します。
    5. close()：JSONStreamingAPI オブジェクトを閉じます。{#JSONStreamingAPIScopedAPI__close}
    {#JSONStreamingAPIScopedAPI__ol_yzk_qgn_hlb}

## サイズ制限 {#JSONStreamingAPIScopedAPI__section_qkj_sd5_hlb}

この API を介して生成されたペイロードは、次のサイズ制限を超えることはできません。  
* 添付ファイル：200 MB
* 文字列：5 MB
{#JSONStreamingAPIScopedAPI__ul_syy_lsw_3lb}

## 例 {#JSONStreamingAPIScopedAPI__section_nzz_rd5_hlb}

この例では、JSON オブジェクトを作成し、定義された有効期限とともに添付ファイル \[sys_attachment\] テーブルに格納します。このオプションを使用すると、5 MB 未満のペイロードを作成できます。  

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

一方この例では、 スクリプトステップで API を使用し、ペイロードを JSON 文字列として作成します。このオプションを使用すると、5 MB 未満のペイロードを作成できます。  

    (function execute(inputs, outputs) {

      var builder = new sn_ih.JSONStreamingBuilder().build();
      
      builder.startObject()
        .enablePrettyPrint()
        .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()

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

出力：  

    {
    "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"
    } ]
    }

## JSONStreamingAPI - close() {#ariaid-title2}

JSONStreamingAPI オブジェクトを閉じます。 JSON オブジェクトの構築後は、このメソッドを呼び出してストリームを閉じる必要があります。
{#JSA-close__table_izv_lb5_hlb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 1. パラメーター]

{#JSA-close__table_izv_lb5_hlb} {#JSA-close__table_jzv_lb5_hlb__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 2. 返される内容]

{#JSA-close__table_jzv_lb5_hlb}  
この例では、JSON オブジェクトを作成し、定義された有効期限とともに添付ファイル \[sys_attachment\] テーブルに格納する方法を示します。

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

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

JSON 形式のプリティプリントを終了します。
このメソッドを呼び出す前に、まず enablePrettyPrint() を呼び出して、特定のセクションに JSON 形式を追加する必要があります。
{#JSA-disablePrettyPrint__table_ebl_hh2_1lb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 3. パラメーター]

{#JSA-disablePrettyPrint__table_ebl_hh2_1lb} {#JSA-disablePrettyPrint__table_fbl_hh2_1lb__entry__2}

| タイプ | 説明 |
|-|-|
| JSONStreamingAPI | ペイロードのビルドに使用されるストリーミング JSON オブジェクト。 |
[表 : 4. 返される内容]

{#JSA-disablePrettyPrint__table_fbl_hh2_1lb}  
この例では、`address` オブジェクトにプリティプリント形式を追加します。

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

      builder.startObject()
        .writeFieldName("firstName")
        .writeString("John")
        .writeFieldName("lastName")
        .writeString("Smith")  
        .writeNumberField("age","25")
        .enablePrettyPrint()
        .writeFieldName("address")
        .startObject()
        .writeStringField("streetAddress", "21 2nd Street")
        .writeStringField("city", "Santa Clara")
        .writeStringField("state", "CA")
        .writeStringField("postalCode", "11111")
        .endObject()
        .disablePrettyPrint()
        .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();
    }

出力：

    {"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"}]}

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

JSON オブジェクトまたは JSON オブジェクトのセクションにプリティプリント形式を追加します。
JSON オブジェクトセクションでプリティプリントの書式設定を無効にするには、disablePrettyPrint() メソッドを使用します。
{#JSA-enablePrettyPrint__table_h5h_gh2_1lb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 5. パラメーター]

{#JSA-enablePrettyPrint__table_h5h_gh2_1lb} {#JSA-enablePrettyPrint__table_fbl_hh2_1lb__entry__2}

| タイプ | 説明 |
|-|-|
| JSONStreamingAPI | ペイロードのビルドに使用されるストリーミング JSON オブジェクト。 |
[表 : 6. 返される内容]

{#JSA-enablePrettyPrint__table_fbl_hh2_1lb}  

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

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

出力：

    {
    "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"
    } ]
    }

## JSONStreamingAPI - endArray() {#ariaid-title5}

親 JSON オブジェクト内のアレイを閉じます。
最初に startArray() メソッドを呼び出してアレイを開きます。
{#JSA-endArray__table_p1h_kf2_1lb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 7. パラメーター]

{#JSA-endArray__table_p1h_kf2_1lb} {#JSA-endArray__table_q1h_kf2_1lb__entry__2}

| タイプ | 説明 |
|-|-|
| JSONStreamingAPI | ペイロードのビルドに使用されるストリーミング JSON オブジェクト。 |
[表 : 8. 返される内容]

{#JSA-endArray__table_q1h_kf2_1lb}  
この例では、JSON オブジェクトを作成し、定義された有効期限とともに添付ファイル \[sys_attachment\] テーブルに格納する方法を示します。

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

## JSONStreamingAPI - endObject() {#ariaid-title6}

親 JSON オブジェクト内のオブジェクトを閉じます。
最初に startObject() メソッドを呼び出してオブジェクトを開きます。
{#JSA-endObject__table_rzg_gf2_1lb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 9. パラメーター]

{#JSA-endObject__table_rzg_gf2_1lb} {#JSA-endObject__table_q1h_kf2_1lb__entry__2}

| タイプ | 説明 |
|-|-|
| JSONStreamingAPI | ペイロードのビルドに使用されるストリーミング JSON オブジェクト。 |
[表 : 10. 返される内容]

{#JSA-endObject__table_q1h_kf2_1lb}  
この例では、JSON オブジェクトを作成し、定義された有効期限とともに添付ファイル \[sys_attachment\] テーブルに格納する方法を示します。

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

## JSONStreamingAPI - getAttachmentId() {#ariaid-title7}

JSON ペイロードを含むストリーミング添付ファイル \[streaming_attachment\] テーブルの、添付ファイルのレコードの sys_id を返します。
このメソッドを呼び出す前に、JSONStreamingBuilder クラスの withAttachment() メソッドを呼び出して、JSON ペイロードを添付ファイルとして保存する必要があります。「[JSONStreamingBuilder - スコープ指定](https://servicenow-prod.fluidtopics.net/41PiVgRUUD1hnDIGSFQecQ#JSONStreamingBuilderScopedAPI "大規模なストリーミング JSON ペイロードをビルドするために使用するビルダーオブジェクトを作成し、REST または SOAP 要求で使用して大量のデータをサードパーティ API に送信します。非ストリーミングオプション用の JSON 文字列としてペイロードを作成することもできます。")」を参照してください。
{#JSA-getAttachmentId__table_j2q_p25_hlb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 11. パラメーター]

{#JSA-getAttachmentId__table_j2q_p25_hlb} {#JSA-getAttachmentId__table_k2q_p25_hlb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | JSON ペイロードを含むストリーミング添付ファイル \[streaming_attachment\] テーブルの、添付ファイルのレコードの sys_id。 |
[表 : 12. 返される内容]

{#JSA-getAttachmentId__table_k2q_p25_hlb}  
この例では、JSON オブジェクトを作成し、定義された有効期限とともに添付ファイル \[sys_attachment\] テーブルに格納する方法を示します。

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

## JSONStreamingAPI - getJSONString() {#ariaid-title8}

JSON オブジェクトを文字列として返します。
JSON オブジェクトを文字列として返すには、JSONStreamingBuilder クラスで withAttachment() メソッドを呼び出さないでください。「[JSONStreamingBuilder - スコープ指定](https://servicenow-prod.fluidtopics.net/41PiVgRUUD1hnDIGSFQecQ#JSONStreamingBuilderScopedAPI "大規模なストリーミング JSON ペイロードをビルドするために使用するビルダーオブジェクトを作成し、REST または SOAP 要求で使用して大量のデータをサードパーティ API に送信します。非ストリーミングオプション用の JSON 文字列としてペイロードを作成することもできます。")」を参照してください。
{#JSA-getJSONString__table_bth_r25_hlb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 13. パラメーター]

{#JSA-getJSONString__table_bth_r25_hlb} {#JSA-getJSONString__table_cth_r25_hlb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | JSONStreamingAPI を使用して構築された JSON オブジェクトが含まれます。 |
[表 : 14. 返される内容]

{#JSA-getJSONString__table_cth_r25_hlb}  

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

出力：

    {
    "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"
    } ]
    }

## JSONStreamingAPI - startArray() {#ariaid-title9}

親 JSON オブジェクト内のアレイを開きます。
アレイを閉じるには、endArray() メソッドを含めます。
{#JSA-startArray__table_ljl_3f2_1lb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 15. パラメーター]

{#JSA-startArray__table_ljl_3f2_1lb} {#JSA-startArray__table_q1h_kf2_1lb__entry__2}

| タイプ | 説明 |
|-|-|
| JSONStreamingAPI | ペイロードのビルドに使用されるストリーミング JSON オブジェクト。 |
[表 : 16. 返される内容]

{#JSA-startArray__table_q1h_kf2_1lb}  
この例では、JSON オブジェクトを作成し、定義された有効期限とともに添付ファイル \[sys_attachment\] テーブルに格納する方法を示します。

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

## JSONStreamingAPI - startArrayField(文字列 fieldName) {#ariaid-title10}

親 JSON オブジェクト内にアレイを作成します。
このメソッドを startArray() メソッドと endArray() メソッドで囲むと、アレイを開いて閉じることができます。
{#JSA-startArrayField_S__table_fmw_wg2_1lb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| fieldName | 文字列 | アレイの名前。 |
[表 : 17. パラメーター]

{#JSA-startArrayField_S__table_fmw_wg2_1lb} {#JSA-startArrayField_S__table_q1h_kf2_1lb__entry__2}

| タイプ | 説明 |
|-|-|
| JSONStreamingAPI | ペイロードのビルドに使用されるストリーミング JSON オブジェクト。 |
[表 : 18. 返される内容]

{#JSA-startArrayField_S__table_q1h_kf2_1lb}  

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

## JSONStreamingAPI - startObject() {#ariaid-title11}

親 JSON オブジェクト内のオブジェクトを開きます。
オブジェクトを閉じるには、endObject() メソッドが必要です。
{#JSA-startObject__table_fmc_2f2_1lb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 19. パラメーター]

{#JSA-startObject__table_fmc_2f2_1lb} {#JSA-startObject__table_q1h_kf2_1lb__entry__2}

| タイプ | 説明 |
|-|-|
| JSONStreamingAPI | ペイロードのビルドに使用されるストリーミング JSON オブジェクト。 |
[表 : 20. 返される内容]

{#JSA-startObject__table_q1h_kf2_1lb}  
この例では、JSON オブジェクトを作成し、定義された有効期限とともに添付ファイル \[sys_attachment\] テーブルに格納する方法を示します。

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

## JSONStreamingAPI - writeBoolean(ブーリアン state) {#ariaid-title12}

親 JSON オブジェクトにブール値を追加します。
{#JSA-writeBoolean_B__table_abc_4f2_1lb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| state | ブーリアン | 親 JSON オブジェクトに追加するブーリアン値。 有効な値： * true * false {#JSA-writeBoolean_B__ul_js4_hzs_1mb} |
[表 : 21. パラメーター]

{#JSA-writeBoolean_B__table_abc_4f2_1lb} {#JSA-writeBoolean_B__table_q1h_kf2_1lb__entry__2}

| タイプ | 説明 |
|-|-|
| JSONStreamingAPI | ペイロードのビルドに使用されるストリーミング JSON オブジェクト。 |
[表 : 22. 返される内容]

{#JSA-writeBoolean_B__table_q1h_kf2_1lb}  

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

      builder.startObject()
        .writeFieldName("firstName")
        .writeString("John")
        .writeFieldName("lastName")
        .writeString("Smith")
        .writeFieldName("activeUser")
        .writeBoolean(true)
        .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();
    }

## JSONStreamingAPI - writeBooleanField(文字列 fieldName, ブーリアン value) {#ariaid-title13}

親 JSON オブジェクトにブーリアンのフィールドと値を追加します。
{#JSA-writeBooleanField_S_B__table_qtm_dh2_1lb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| fieldName | 文字列 | 親 JSON オブジェクトに追加するフィールドの名前。 |
| value | ブーリアン | 親 JSON オブジェクトに追加するブーリアン値。 有効な値： * true * false {#JSA-writeBooleanField_S_B__ul_js4_hzs_1mb} |
[表 : 23. パラメーター]

{#JSA-writeBooleanField_S_B__table_qtm_dh2_1lb} {#JSA-writeBooleanField_S_B__table_q1h_kf2_1lb__entry__2}

| タイプ | 説明 |
|-|-|
| JSONStreamingAPI | ペイロードのビルドに使用されるストリーミング JSON オブジェクト。 |
[表 : 24. 返される内容]

{#JSA-writeBooleanField_S_B__table_q1h_kf2_1lb}  

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

      builder.startObject()
        .writeFieldName("firstName")
        .writeString("John")
        .writeFieldName("lastName")
        .writeString("Smith")
        .writeBooleanField("activeUser", true)
        .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();
    }

## JSONStreamingAPI - writeFieldName(文字列 name) {#ariaid-title14}

親 JSON オブジェクトにフィールド名を追加します。
{#JSA-writeFieldName_S__table_bsf_mf2_1lb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| name | 文字列 | 親 JSON オブジェクトに追加するフィールド名。 |
[表 : 25. パラメーター]

{#JSA-writeFieldName_S__table_bsf_mf2_1lb} {#JSA-writeFieldName_S__table_q1h_kf2_1lb__entry__2}

| タイプ | 説明 |
|-|-|
| JSONStreamingAPI | ペイロードのビルドに使用されるストリーミング JSON オブジェクト。 |
[表 : 26. 返される内容]

{#JSA-writeFieldName_S__table_q1h_kf2_1lb}  
この例では、JSON オブジェクトを作成し、定義された有効期限とともに添付ファイル \[sys_attachment\] テーブルに格納する方法を示します。

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

## JSONStreamingAPI - writeNull() {#ariaid-title15}

親 JSON オブジェクトに null 値を追加します。
{#JSA-writeNull__table_bdp_wf2_1lb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 27. パラメーター]

{#JSA-writeNull__table_bdp_wf2_1lb} {#JSA-writeNull__table_q1h_kf2_1lb__entry__2}

| タイプ | 説明 |
|-|-|
| JSONStreamingAPI | ペイロードのビルドに使用されるストリーミング JSON オブジェクト。 |
[表 : 28. 返される内容]

{#JSA-writeNull__table_q1h_kf2_1lb}  

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

      builder.startObject()
        .writeFieldName("firstName")
        .writeString("John")
        .writeFieldName("lastName")
        .writeString("Smith")
        .writeFieldName("activeUser")
        .writeNull()
        .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();
    }

## JSONStreamingAPI - writeNullField(文字列 fieldName) {#ariaid-title16}

親 JSON オブジェクトに null 値が入ったフィールドを追加します。
{#JSA-writeNullField_S__table_ifs_nh2_1lb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| fieldName | 文字列 | null フィールドの名前。 |
[表 : 29. パラメーター]

{#JSA-writeNullField_S__table_ifs_nh2_1lb} {#JSA-writeNullField_S__table_q1h_kf2_1lb__entry__2}

| タイプ | 説明 |
|-|-|
| JSONStreamingAPI | ペイロードのビルドに使用されるストリーミング JSON オブジェクト。 |
[表 : 30. 返される内容]

{#JSA-writeNullField_S__table_q1h_kf2_1lb}  

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

      builder.startObject()
        .writeFieldName("firstName")
        .writeString("John")
        .writeFieldName("lastName")
        .writeString("Smith")
        .writeNullField("activeUser")
        .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();
    }

## JSONStreamingAPI - writeNumberField(文字列 fieldName, 文字列 encodedValue) {#ariaid-title17}

親 JSON オブジェクトに数字のフィールドと値を追加します。
{#JSA-writeNumberField_S_S__table_bqd_rf2_1lb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| fieldName | 文字列 | 数字フィールドの名前。 |
| エンコードされた値 | 文字列 | 数字フィールドの値。 |
[表 : 31. パラメーター]

{#JSA-writeNumberField_S_S__table_bqd_rf2_1lb} {#JSA-writeNumberField_S_S__table_q1h_kf2_1lb__entry__2}

| タイプ | 説明 |
|-|-|
| JSONStreamingAPI | ペイロードのビルドに使用されるストリーミング JSON オブジェクト。 |
[表 : 32. 返される内容]

{#JSA-writeNumberField_S_S__table_q1h_kf2_1lb}  
この例では、JSON オブジェクトを作成し、定義された有効期限とともに添付ファイル \[sys_attachment\] テーブルに格納する方法を示します。

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

## JSONStreamingAPI - writeRaw(文字列 text) {#ariaid-title18}

親 JSON オブジェクトに生の値を追加します。
{#JSA-writeRaw_S__table_pkv_5f2_1lb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| text | 文字列 | 親 JSON オブジェクトに追加する生のテキスト。 |
[表 : 33. パラメーター]

{#JSA-writeRaw_S__table_pkv_5f2_1lb} {#JSA-writeRaw_S__table_q1h_kf2_1lb__entry__2}

| タイプ | 説明 |
|-|-|
| JSONStreamingAPI | ペイロードのビルドに使用されるストリーミング JSON オブジェクト。 |
[表 : 34. 返される内容]

{#JSA-writeRaw_S__table_q1h_kf2_1lb}  

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

      builder.startObject()
        .writeFieldName("firstName")
        .writeString("John")
        .writeFieldName("lastName")
        .writeString("Smith")
        .writeFieldName("filePath")
        .writeRaw("C:\Users\profile\aboutme.html")
        .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();
    }

## JSONStreamingAPI - writeString(文字列 text) {#ariaid-title19}

親 JSON オブジェクトに文字列の値を追加します。
{#JSA-writeString_S__table_arf_tf2_1lb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| text | 文字列 | 親 JSON オブジェクトに追加する文字列の値。 |
[表 : 35. パラメーター]

{#JSA-writeString_S__table_arf_tf2_1lb} {#JSA-writeString_S__table_q1h_kf2_1lb__entry__2}

| タイプ | 説明 |
|-|-|
| JSONStreamingAPI | ペイロードのビルドに使用されるストリーミング JSON オブジェクト。 |
[表 : 36. 返される内容]

{#JSA-writeString_S__table_q1h_kf2_1lb}  
この例では、JSON オブジェクトを作成し、定義された有効期限とともに添付ファイル \[sys_attachment\] テーブルに格納する方法を示します。

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

## JSONStreamingAPI - writeStringField(文字列 fieldName, 文字列 value) {#ariaid-title20}

親 JSON オブジェクトに文字列のフィールドと値を追加します。
{#JSA-writeStringField_S_S__table_qtm_dh2_1lb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| fieldName | 文字列 | 親 JSON オブジェクトに追加するフィールドの名前。 |
| value | 文字列 | フィールドの値。 |
[表 : 37. パラメーター]

{#JSA-writeStringField_S_S__table_qtm_dh2_1lb} {#JSA-writeStringField_S_S__table_q1h_kf2_1lb__entry__2}

| タイプ | 説明 |
|-|-|
| JSONStreamingAPI | ペイロードのビルドに使用されるストリーミング JSON オブジェクト。 |
[表 : 38. 返される内容]

{#JSA-writeStringField_S_S__table_q1h_kf2_1lb}  
この例では、JSON オブジェクトを作成し、定義された有効期限とともに添付ファイル \[sys_attachment\] テーブルに格納する方法を示します。

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


