Skip to content

NovaStar Data / Service Parameter / formatPrettyPrint

Overview

The formatPrettyPrint service parameter indicates whether JSON output should be formatted with indentations.

Service Parameter Editor

The api-ui service can be used to edit a service request.

Service Parameter Syntax

The parameter syntax is as follows:

formatPrettyPrint=false
formatPrettyPrint=true

Service Parameter Values

Value                           Description Example                  
false Do not use pretty print for JSON. See below.
true Do use pretty print for JSON. Output is easier to read but response size is larger. See below.

Examples

false for /version service:

{"apiVersion":{"apiVersionMajor":"1","apiVersionMinor":"4","apiVersionMicro":"6","apiVersionModifier":"dev","apiVersionDate":"2020-02-27","apiVersionTime":"","apiDotDelimitedVersion":"1.4.6.dev"},"responseInfo":{"uri":"http://192.168.1.7:8080/novastar-rest/api/v1/version?formatPrettyPrint=false","uriEncoded":"http://192.168.1.7:8080/novastar-rest/api/v1/version?formatPrettyPrint=false","periodStart":null,"periodEnd":null,"size":1,"queryMs":0,"isCached":false,"cacheExpirationTime":null}}

true for /version service:

{
  "apiVersion" : {
    "apiVersionMajor" : "1",
    "apiVersionMinor" : "4",
    "apiVersionMicro" : "6",
    "apiVersionModifier" : "dev",
    "apiVersionDate" : "2020-02-27",
    "apiVersionTime" : "",
    "apiDotDelimitedVersion" : "1.4.6.dev"
  },
  "responseInfo" : {
    "uri" : "http://192.168.1.7:8080/novastar-rest/api/v1/version?jsonFormat=full",
    "uriEncoded" : "http://192.168.1.7:8080/novastar-rest/api/v1/version?jsonFormat=full",
    "periodStart" : null,
    "periodEnd" : null,
    "size" : 1,
    "queryMs" : 0,
    "isCached" : false,
    "cacheExpirationTime" : null
  }
}

Troubleshooting

See Also