JSONStreamingBuilder - Dans le champ d’application

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 7 minutes de lecture

    • Créez un objet de générateur utilisé pour générer une charge utile JSON de diffusion volumineuse à utiliser dans une demande REST ou SOAP pour envoyer des données en bloc à une API tierce. Vous pouvez également créer la charge utile en tant que chaîne JSON pour une option autre que la diffusion en continu.

    Utilisez ces méthodes dans l’étape de Studio de workflow script avec l’identificateur d’espace de noms sn_ih. Par exemple, vous pouvez utiliser cette API pour créer une charge utile JSON dans l’étape Studio de workflow Script et transmettre la valeur renvoyée à l’étape REST pour envoyer la demande à un service tiers. Pour plus d’informations, reportez-vous à Studio de workflow l’étape Script.

    Vous ne pouvez utiliser cette API que dans l’environnement Studio de workflow .

    Ordre d’appel d’API

    Générez des charges utiles JSON à l’aide de ces API dans l’ordre suivant :

    JSONStreamingBuilder : crée un objet de générateur
    Utilisez ces méthodes dans l’ordre suivant pour créer un objet de générateur :
    1. JSONStreamingBuilder() : instancie l’objet JSONStreamingBuilder.
    2. withAttachment() : Facultatif. Crée l’objet JSON en tant que pièce jointe de diffusion et le stocke dans la table Pièces jointes de diffusion [streaming_attachment]. Si vous n’appelez pas cette méthode, l’API crée la charge utile sous la forme d’une chaîne JSON.
    3. expiresAt() : Optionnel. Définit une heure à laquelle la pièce jointe expire. Doit également appeler la méthode withAttachment().
    4. build() : Renvoie un objet JSONStreamingAPI.
    JSONStreamingAPI : génère la charge utile JSON
    Utilisez ces méthodes dans l’ordre suivant pour créer la charge utile JSON :
    1. startObject() : crée l’objet JSON parent.
    2. Méthodes permettant de générer les paires clé-valeur JSON, telles que writeFieldName(),writeString() et writeNumberField().
    3. endObject() : ferme l’objet JSON parent.
    4. getJSONString() ou getAttachmentId() : renvoie la chaîne JSON ou l’ID de pièce jointe que vous avez créé.
    5. close() : ferme l’objet JSONStreamingAPI.

    Limites de taille

    Les charges utiles générées via cette API ne peuvent pas dépasser ces limites de taille :

    • Pièces jointes : 200 Mo
    • Chaînes : 5 Mo

    Exemples

    Cet exemple montre comment créer un objet JSON et le stocker dans la table Pièce jointe [sys_attachment] avec une date d’expiration définie.

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

    Cet exemple montre également comment utiliser l’API dans l’étape Script et créer la charge utile en tant que chaîne JSON. Vous pouvez utiliser cette option pour créer des charges utiles de moins de 5 Mo.

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

    Sortie :

    {
"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()

    instancie l’objet JSONStreamingBuilder.

    Tableau 1. Paramètres
    Nom Type Description
    Aucun 
    var builder = new sn_ih.JSONStreamingBuilder()

    JSONStreamingBuilder : build()

    Renvoie un objet JSONStreamingAPI.

    Tableau 2. Paramètres
    Nom Type Description
    Aucun
    Tableau 3. Renvoie
    Type Description
    API JSONStreamingAPI Objet JSON de diffusion en continu utilisé pour construire la charge utile.

    Cet exemple montre comment créer un objet JSON et le stocker dans la table Pièce jointe [sys_attachment] avec une date d’expiration définie.

    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 : expiresAt(Object expiresAt)

    Définit une heure à laquelle la pièce jointe expire. Doit également appeler la méthode withAttachment(). Si vous n’appelez pas cette méthode, la pièce jointe expire deux heures après sa création.

    Tableau 4. Paramètres
    Nom Type Description
    expire à GlideDateTime Objet défini à l’expiration de la pièce jointe.
    • Valeur minimale : 7 200 secondes, ou deux heures, à partir du moment où la pièce jointe est créée. Faire défaut.
    • Valeur maximale : 172 800 secondes, soit 48 heures, à partir du moment où la pièce jointe est créée.
    Tableau 5. Renvoie
    Type Description
    JSONStreamingBuilder Objet de générateur utilisé pour lancer la charge utile JSON.

    Cet exemple montre comment créer un objet JSON et le stocker dans la table Pièce jointe [sys_attachment] avec une date d’expiration définie.

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

    Crée l’objet JSON en tant que pièce jointe de diffusion et le stocke dans la table Pièces jointes de diffusion [streaming_attachment]. Si vous n’appelez pas cette méthode, l’API crée la charge utile sous la forme d’une chaîne JSON.

    Tableau 6. Paramètres
    Nom Type Description
    Aucun
    Tableau 7. Renvoie
    Type Description
    JSONStreamingBuilder Objet de générateur utilisé pour lancer la charge utile JSON.

    Cet exemple montre comment créer la charge utile JSON et l’enregistrer en tant que pièce jointe.

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

    Cet exemple montre comment créer la charge utile JSON et l’enregistrer en tant que chaîne.

    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();
}
    Sortie :
    {
"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"
} ]
}