JSON services

Input parameters for closeArrayIterator

• iterator: Object - The iterator object returned by the getNextBatch service.

Output parameters for closeArrayIterator

None

Input parameters for documentToJSON

• document: Document - The document to be converted to a JSON object.

• strict: String. Optional. Valid values are true and false. The default value is false.

  Note: The input parameter jsonDocumentTypeName is currently not supported in deploy anywhere flow services.
  • When strict is false and jsonDocumentTypeName is not specified, there is no change in the behavior.
  • When strict is true and jsonDocumentTypeName is not specified, the service returns an exception.
  • When strict is false and jsonDocumentTypeName is specified, the transformation from Document to JSON object is loosely based on the JSON document type.
  • When strict is true and jsonDocumentTypeName is specified, the transformation from Document to JSON object is strictly based on the JSON document type. The validation is performed first before the transformation, and any deviations lead to transformation errors.
• loadAs: String. Specifies the format in which you need the converted jsonObj. Set to:
  • string to return jsonObj as a string. This is the default value.
  • bytes to return jsonObj as a byte array.
  • stream to return jsonObj as InputStream.
• prettyPrint: String. Optional. Whether the service formats the jsonObj output parameter for human readability by adding carriage returns and indentation to the JSON content. Set to:
  • true to format the jsonObj output variable for human readability.
  • false to leave the jsonObj output parameter in its unformatted state. The service does not add any additional carriage returns or indentation to the JSON content.

• encodeDateAs: String. Optional. Specifies how java.util.Date instances in the document are encoded in the returned JSON.

  • long to encode java.util.Date instances as timestamps, specifically the number of milliseconds since Jan 1, 1970 00:00:00.
  • ISO8601 to encode java.util.Date instances as strings in a standard ISO format of: YYYY-MM-DD'T'HH:mm:ss.sssZ.
  • ISO_LOCAL_DATE to encode java.util.Date instances as strings in a standard ISO format without an offset.
  • ISO_DATE to encode java.util.Date instances as strings in a standard ISO format with the offset if available.
  • ISO_ZONED_DATE_TIME to encode java.util.Date instances as strings in a standard ISO format with the offset and zone if available.
  • ISO_INSTANT to encode java.util.Date instances as strings in a standard ISO format in UTC.
  • BASIC_ISO_DATE to encode java.util.Date instances as strings in a standard ISO format without an offset.
  • RFC_1123_DATE_TIME to encode java.util.Date instances as strings in a standard ISO format.
  • Custom format in which dates are encoded as strings in the supplied pattern. The pattern must adhere to the date and time patterns as described in the java.text.SimpleDateFormat class in the Oracle Java API documentation. The dates are encoded as JSON strings.
  • null to use the jsondateEncoding setting already in effect for the HTTP client making the request.

  There is no default value for this input parameter.

• encodeStringAsNumber: Boolean. Optional. Specifies whether the service encodes strings as numbers. Set to:

  • true to convert all the numbers in the string format to numbers by removing the quotes.

  • false to retain all the numbers without converting.

  • <null> to retain the original encoding in the request.

  There is no default value for this input parameter.

• encodeStringAsBoolean: Boolean. Optional. Specifies how the service handles boolean values in the string format. Set to:

  • true to convert all the boolean values in the string format to Boolean by removing the quotes.

  • false to retain all the boolean values in the string format.

  • <null> to retain the original encoding in the request.

  There is no default value for this input parameter.

• encodeMapAsString: Boolean. Optional. Specifies how the service encodes instances of java.util.Map. Set to:
  • true to encode instances of java.util.Map as a JSON string.
  • false to encode instances of java.util.Map as a nested JSON structure.

  There is no default value for this input parameter.

• encodeListsAndSetsAsArrays: Boolean. Optional. Specifies how the service encodes instances of java.util.List or java.util.Set. Set to:
  • true to encode instances of java.util.List or java.util.Set as arrays.
  • false to encode instances of java.util.List or java.util.Set as a JSON string.

  There is no default value for this input parameter.

Output parameters for documentToJSON

• jsonObj: Object. Conditional. JSON of type byte array, string or stream (java.io.InputStream) resulting from the conversion of a document depending on the loadAs value.

Input parameters for documentToJSONBytes

• document: Document - The document to be converted to JSON bytes (byte array).

• encodeDateAs: String. Optional. Specifies how java.util.Date instances in the document are encoded in the returned JSON.

  • long to encode java.util.Date instances as timestamps, specifically the number of milliseconds since Jan 1, 1970 00:00:00.
  • ISO8601 to encode java.util.Date instances as strings in a standard ISO format of: YYYY-MM-DD'T'HH:mm:ss.sssZ.
  • ISO_LOCAL_DATE to encode java.util.Date instances as strings in a standard ISO format without an offset.
  • ISO_DATE to encode java.util.Date instances as strings in a standard ISO format with the offset if available.
  • ISO_ZONED_DATE_TIME to encode java.util.Date instances as strings in a standard ISO format with the offset and zone if available.
  • ISO_INSTANT to encode java.util.Date instances as strings in a standard ISO format in UTC.
  • BASIC_ISO_DATE to encode java.util.Date instances as strings in a standard ISO format without an offset.
  • RFC_1123_DATE_TIME to encode java.util.Date instances as strings in a standard ISO format.
  • null to use the dateEncoding setting already in effect for the HTTP client making the request.

• encodeStringAsNumber: String. Optional.

  • true, to convert all the numbers in the string format to numbers by removing the quotes.

  • false, to retain all the numbers without converting.

  The default value is false.

• encodeStringAsBoolean: String. Optional.

  • true, to convert all the boolean values in the string format to Boolean by removing the quotes.

  • false, to retain all the boolean values without converting. The default value is false.

Output parameters for documentToJSONBytes

• jsonBytes: Object - JSON bytes (byte array) resulting from the conversion of a document.

Input parameters for documentToJSONStream

• document: Document - The document to be converted to a JSON stream.

• encodeDateAs: String. Optional. Specifies how java.util.Date instances in the document are encoded in the returned JSON.

  • long to encode java.util.Date instances as timestamps, specifically the number of milliseconds since Jan 1, 1970 00:00:00.

  • ISO8601 to encode java.util.Date instances as strings in a standard ISO format of: YYYY-MM-DD'T'HH:mm:ss.sssZ.

  • ISO_LOCAL_DATE to encode java.util.Date instances as strings in a standard ISO format without an offset.

  • ISO_DATE to encode java.util.Date instances as strings in a standard ISO format with the offset if available.

  • ISO_ZONED_DATE_TIME to encode java.util.Date instances as strings in a standard ISO format with the offset and zone if available.

  • ISO_INSTANT to encode java.util.Date instances as strings in a standard ISO format in UTC.

  • BASIC_ISO_DATE to encode java.util.Date instances as strings in a standard ISO format without an offset.

  • RFC_1123_DATE_TIME to encode java.util.Date instances as strings in a standard ISO format.

  • null to use the dateEncoding setting already in effect for the HTTP client making the request.

• encodeStringAsNumber: String. Optional.

  • true, to convert all the numbers in the string format to numbers by removing the quotes.

  • false, to retain all the numbers without converting.

  The default value is false.

• encodeStringAsBoolean: String. Optional.

  • true, to convert all the boolean values in the string format to Boolean by removing the quotes.

  • false, to retain all the boolean values without converting. The default value is false.

Output parameters for documentToJSONStream

• jsonStream: java.io.InputStream - JSON stream resulting from the conversion of a document.

Input parameters for documentToJSONString

• document: Document - The document to be converted to a JSON string.

• Note: The Strict parameter is supported in deploy anywhere flow services only.
  strict: String. Optional - Valid values are true and false. The default value is false.
  Note: The input parameter jsonDocumentTypeName is currently not supported in deploy anywhere flow services and flow services.
  • When strict is false and jsonDocumentTypeName is not specified, there is no change in the behavior.
  • When strict is true and jsonDocumentTypeName is not specified, the service returns an exception.
  • When strict is false and jsonDocumentTypeName is specified, the transformation from Document to JSON object is loosely based on the JSON document type.
  • When strict is true and jsonDocumentTypeName is specified, the transformation from Document to JSON object is strictly based on the JSON document type. The validation is performed first before the transformation, and any deviations lead to transformation errors.

• prettyPrint: String - Formats the jsonString output parameter for human readability by adding carriage returns and indentation to the JSON content.

  Set to:

  • true to format the jsonString output field for human readability.

  • false to leave the jsonString output field in its unformed state.

  The service will not add any additional carriage returns or indentation to the JSON content.

• encodeDateAs: String. Optional. Specifies how java.util.Date instances in the document are encoded in the returned JSON.

  • long to encode java.util.Date instances as timestamps, specifically the number of milliseconds since Jan 1, 1970 00:00:00.

  • ISO8601 to encode java.util.Date instances as strings in a standard ISO format of: YYYY-MM-DD'T'HH:mm:ss.sssZ.

  • ISO_LOCAL_DATE to encode java.util.Date instances as strings in a standard ISO format without an offset.

  • ISO_DATE to encode java.util.Date instances as strings in a standard ISO format with the offset if available.

  • ISO_ZONED_DATE_TIME to encode java.util.Date instances as strings in a standard ISO format with the offset and zone if available.

  • ISO_INSTANT to encode java.util.Date instances as strings in a standard ISO format in UTC.

  • BASIC_ISO_DATE to encode java.util.Date instances as strings in a standard ISO format without an offset.

  • RFC_1123_DATE_TIME to encode java.util.Date instances as strings in a standard ISO format.

  • null to use the dateEncoding setting already in effect for the HTTP client making the request.

• encodeStringAsNumber: String. Optional.

  • true, to convert all the numbers in the string format to numbers by removing the quotes.

  • false, to retain all the numbers without converting.

  The default value is false.

• encodeStringAsBoolean: String. Optional.

  • true, to convert all the boolean values in the string format to Boolean by removing the quotes.

  • false, to retain all the boolean values without converting.

    The default value is false.

• Note: The encodeMapAsStringparameter is supported in deploy anywhere flow services only.
  encodeMapAsString: String. Optional - Specifies how the documentToJSONString service encodes java.util.Map objects in the document. Set to:
  • true to encode java.util.Map objects as a JSON string.
  • false to encode java.util.Map objects as a nested JSON structure.

  There is no default value for this parameter.

• Note: The encodeListsAndSetsAsArraysparameter is supported in deploy anywhere flow services only.
  encodeListsAndSetsAsArrays: String. Optional - Specifies how the documentToJSONString service encodes instances of java.util.List or java.util.Set. Set to:
  • true to encode instances of java.util.List or java.util.Set as arrays.
  • false to encode instances of java.util.List and java.util.Set as one String value.

  There is no default value for this parameter.

Output parameters for documentToJSONString

• jsonString: Object - JSON string resulting from the conversion of a document.

Input parameters for getArrayIterator

                    "topping": [{
                    "toppingA": [{
                    "toppingA1": ["None71", "Glazed82"]
                    ...
                    }]}]

                

• containsKey: String - Indicates whether the specified hashtable element exists. A value of:

  • true - Indicates that the element exists.

  • false - Indicates that the element does not exist.

• decodeRealAsDouble: String. Optional - Converts real numbers from jsonStream to either a Float or Double Java™ wrapper type. Set to:

  • true to convert real numbers to Double Java wrapper type. This is the default.

  • false to convert real numbers to Float Java wrapper type.

• decodeIntegerAsLong: String. Optional - Converts integers from jsonStream to either a Long or Integer Java wrapper type. Set to:

  • true to convert integers to Long Java wrapper types. This is the default.

  • false to convert integers to Integer Java wrapper types.

• decodeRealAsString: String. Optional - Converts real numbers in the jsonStream to String. Set to:

  • true to convert real numbers to String.

  • false to not convert real numbers to String. The real numbers are then converted to either Float or Double Java wrapper type depending on the value specified in decodeRealAsDouble. This is the default value.

• unescapeSpecialChars: String. Optional - Controls whether webMethods Integration unescapes the special characters '\n', '\r', '\t', '\b', '\f', '\\', '\"' while parsing JSON documents. Set to:

  • true to unescape these special characters (that is, '\n' will be replaced with new line, similarly other characters will also be replaced) in the output document. This is the default.

  • false to keep these characters as is in the output document.

Output parameters for getArrayIterator

• iterator: Object - A batch iterator object that has the list of arrays to be parsed in the JSON input stream. This object is passed as input to the getNextBatch service.

Usage notes for getArrayIterator

None

Input parameters for getNextBatch

• iterator: Object - The iterator object returned by the getArrayIterator service.

• batchSize: Object - Number of array elements that the service should retrieve in one batch.

Output parameters for getNextBatch

Usage notes for getNextBatch

The getNextBatch service completes the retrieval of elements from one array in the iterator and starts retrieving from the next array that matches in the subsequent iteration. This is explained in the following example:

Suppose you want the service to parse a JSON file with 2 arrays, for example, A and B with 6 and 2 elements each. Set the batchSize input parameter to 5 and invoke the service in a loop until the service returns the hasNext parameter as false. In the first batch of the output, the first five elements of array A are returned. In the next batch, only the last element of array A is returned, even though the defined batch limit is 5. At this point, the hasNext parameter is true because array B is not parsed yet. In the next batch, the service returns both the elements of array B. Since there are no more elements left either in the array A or B, the hasNext parameter becomes false .

Guidelines

• If two array paths overlap, the path that the service finds first in the input JSON stream is parsed and the other path is ignored. If you provide arrayPath[0] as /a/b and arrayPath[1] as /a/b/0/c to parse the following array, arrayPath[1] is ignored as the paths overlap and the first path retrieves all elements.

  {
                              "a": {
                              "b": [{
                              "f1": "v1",
                              "c": [1, 2, 3]
                              }]
                              }
                              }

• If an invalid array path is provided in the input, the getNextBatch service does not return any result on parsing the array.

• If the arrayPaths input parameter is not set, then the getNextBatch service parses the input considering that the input stream has a single anonymous array at the root level.

• If the arrayPaths input parameter is set, then it cannot contain null or empty elements.

• If one or more array paths are invalid, then the getArrayIterator service still creates an iterator object containing these paths. However, the getNextBatch service ignores the invalid paths.

  If all the paths are invalid, the getNextBatch service returns the documents and values parameters as null, the hasNext parameter as false, and all other output parameters as 0.

Input parameters for jsonToDocument

• document: Object. The document to be converted to a JSON string.

• jsonData: Object. JSON content in a string or an input stream to be converted to a document.
• documentTypeName: String. Optional. If specified, the transformation from the JSON data to document is based on the document type. Any deviations from the provided document result in errors. documentTypeName accepts all kinds of document types.

  This parameter must be in the format: project.<projectName>.documenttypes:documentTypeName

  For example: project.NewProject1.documentTypes:employeeData

• decodeIntegerAs: String. Optional. Converts all the integer values in jsonData to either String, Integer, Long, or BigInteger Java wrapper type. Depending on the data type to which you want to convert the integer values in jsonData, set to:
  • String to convert all the integer values to String. This is the default.
  • Integer to convert all the integer values to Integer.
  • Long to convert all the integer values to Long.
  • BigInteger to convert all the integer values to BigInteger.
  • Auto to check the Java wrapper type range in which the input value fits and convert the value to the appropriate wrapper type.

  If there is no user selection and documentTypeName is not specified, then by default, converts the value to String.

  Note: If you select the datatype as Integer and the JSON data contains a value outside the range of Integer, the service fails with an error.
• decodeDecimalAs: String. Optional. Converts all the decimal values in jsonData to either String, Float, Double, or BigDecimal Java wrapper type. Depending on the data type to which you want to convert the decimal values in jsonData, set to:
  • String to convert all the decimal values to String. This is the default.
  • Float to convert all the decimal values to Float.
  • Double to convert all the decimal values to Double.
  • BigDecimal to convert all the decimal values to BigDecimal.
  • Auto to check the Java wrapper type range in which the input value fits and convert the value to the appropriate wrapper type.

  If there is no user selection and documentTypeName is not specified, then by default, converts the value to String.

  Note: If you select the datatype as Float and the JSON data contains a value outside the range of Float, the service fails with an error.
• decodeBooleanAs: String Optional. Converts all the boolean values in jsonData to String or Boolean. Depending on the value of the variable in jsonData, set to:
  • String to convert all the boolean values to String. This is the default.
  • Boolean to convert all the boolean values to Boolean.

  If there is no user selection and documentTypeName is not specified, then by default, converts the value to String.

• decodeNullRootAsEmpty: String. Optional. Converts a null value that webMethods Integration retrieves from JSON content to either IData or empty IData. Set to:

  • true to convert the null value to an empty IData.

  • false to convert the null value in the JSON data to an IData with $rootValue.

  Default value is false.

• unescapeSpecialChars: String. Optional. Controls whether webMethods Integration unescapes the special characters '\n', '\r', '\t', '\b', '\f', '\', '"' while parsing JSON documents. Set to:

  • true to unescape these special characters (that is, '\n' will be replaced with new line, similarly other characters will also be replaced) in the output document.

  • false to keep these characters as is in the output document.

  Default value is true.

Output parameters for jsonToDocument

• document: Document - Document resulting from the conversion of jsonData.

Input parameters for jsonBytesToDocument

• jsonBytes: java.lang.Byte[] - JSON content in bytes (byte array) to convert to a document.

• decodeRealAsDouble - String Optional - Converts real numbers from jsonBytes to either a Float or Double Java wrapper type.

  Set to:

  • true to convert real numbers to Double Java wrapper types.

  • false to convert real numbers to Float Java wrapper types.

  Default value is true.

• decodeIntegerAsLong: String Optional - Converts integers from jsonBytes to either a Long or Integer Java wrapper type.

  Set to:

  • true to convert integers to Long Java wrapper types.

  • false to convert integers to Integer Java wrapper types.

  Default value is true.

• decodeRealAsString: String. Optional. Converts real numbers in the jsonStream to String. Set to:

  • true to convert real numbers to String.

  • false to not convert real numbers to String. The real numbers are then converted to either Float or Double Java wrapper type depending on the values specified in decodeRealAsDouble.

  Default value is false.

• decodeNullRootAsEmpty: String. Optional. Converts a null value that webMethods Integration retrieves from JSON content to either IData or empty IData. Set to:

  • true to convert the null value to empty IData. The subsequent encoding of empty IData creates a JSON text of {}. This JSON content is different from the original JSON content (null) as the original null value gets converted to JSON text of {}.

  • false to convert the null value to IData.

  Default value is false.

• unescapeSpecialChars: String. Optional. Controls whether webMethods Integration unescapes the special characters '\n', '\r', '\t', '\b', '\f', '\', '"' while parsing JSON documents. Set to:

  • true to unescape these special characters (that is, '\n' will be replaced with new line, similarly other characters will also be replaced) in the output document.

  • false to keep these characters as is in the output document.

  Default value is true.

Output parameters for jsonBytesToDocument

• document: Document - Document resulting from the conversion of jsonBytes.

Input parameters for jsonStreamToDocument

• jsonStream: java.io.InputStream - JSON content in an input stream to convert to a document.

• Note: The Strict parameter is supported in deploy anywhere flow services only.
  strict: String. Optional - Valid values are true and false. The default value is false.
  Note: The input parameter jsonDocumentTypeName is currently not supported in deploy anywhere flow services and flow services.
  • When strict is false and jsonDocumentTypeName is not specified, there is no change in the behavior.
  • When strict is true and jsonDocumentTypeName is not specified, the service returns an exception.
  • When strict is false and jsonDocumentTypeName is specified, the transformation from JSON stream to document is loosely based on the JSON document type.
  • When strict is true and jsonDocumentTypeName is specified, the transformation from JSON stream to document is strictly based on the JSON document type. The validation is performed first before the transformation, and any deviations lead to transformation errors. The decodeRealAsDouble, decodeIntegerAsLong, and decodeRealAsString parameters and the server configuration parameters, if specified, are ignored.

• decodeRealAsDouble - String Optional - Converts real numbers from jsonStream to either a Float or Double Java wrapper type.

  Set to:

  • true to convert real numbers to Double Java wrapper types.

  • false to convert real numbers to Float Java wrapper types.

  Default value is true.

• decodeIntegerAsLong: String Optional - Converts integers from jsonStream to either a Long or Integer Java wrapper type.

  Set to:

  • true to convert integers to Long Java wrapper types.

  • false to convert integers to Integer Java wrapper types.

  Default value is true.

• decodeRealAsString: String. Optional. Converts real numbers in the jsonStream to String. Set to:

  • true to convert real numbers to String.

  • false to not convert real numbers to String. The real numbers are then converted to either Float or Double Java wrapper type depending on the values specified in decodeRealAsDouble.

  Default value is false.

• decodeNullRootAsEmpty: String. Optional. Converts a null value that webMethods Integration retrieves from JSON content to either IData or empty IData. Set to:

  • true to convert the null value to empty IData. The subsequent encoding of empty IData creates a JSON text of “{}”. This JSON content is different from the original JSON content (null) as the original null value gets converted to JSON text of "{}".

  • false to convert the null value to IData.

  Default value is false.

• unescapeSpecialChars: String. Optional. Controls whether webMethods Integration unescapes the special characters '\n', '\r', '\t', '\b', '\f', '\', '"' while parsing JSON documents. Set to:

  • true to unescape these special characters (that is, '\n' will be replaced with new line, similarly other characters will also be replaced) in the output document.

  • false to keep these characters as is in the output document.

  Default value is true.

Output parameters for jsonStreamToDocument

• document: Document - Document resulting from the conversion of jsonStream.

Input parameters for jsonStringToDocument

• jsonString: String - JSON content string to convert to a document.

• decodeRealAsDouble - String Optional - Converts real numbers from jsonString to either a Float or Double Java wrapper type.

  Set to:

  • true to convert real numbers to Double Java wrapper types.

  • false to convert real numbers to Float Java wrapper types.

  Default value is true.

• decodeIntegerAsLong: String Optional - Converts integers from jsonString to either a Long or Integer Java wrapper type.

  Set to:

  • true to convert integers to Long Java wrapper types.

  • false to convert integers to Integer Java wrapper types.

  Default value is true.

• decodeRealAsString: String. Optional. Converts real numbers in the jsonStream to String. Set to:

  • true to convert real numbers to String.

  • false to not convert real numbers to String. The real numbers are then converted to either Float or Double Java wrapper type depending on the values specified in decodeRealAsDouble.

  Default value is false.

• decodeNullRootAsEmpty: String. Optional. Converts a null value that webMethods Integration retrieves from JSON content to either IData or empty IData. Set to:

  • true to convert the null value to empty IData. The subsequent encoding of empty IData creates a JSON text of “{}”. This JSON content is different from the original JSON content (null) as the original null value gets converted to JSON text of "{}".

  • false to convert the null value to IData.

  Default value is false.

• unescapeSpecialChars: String. Optional. Controls whether webMethods Integration unescapes the special characters '\n', '\r', '\t', '\b', '\f', '\', '"' while parsing JSON documents. Set to:

  • true to unescape these special characters (that is, '\n' will be replaced with new line, similarly other characters will also be replaced) in the output document.

  • false to keep these characters as is in the output document.

  Default value is true.

Output parameters for jsonStringToDocument

• document: Document - Document resulting from the conversion of jsonString.