JsonUtils

Inclusion code:

Service Deployment
Port NameLocationProtocolInterfaces
JsonUtils documentation:
JsonUtils--JsonUtilsInterface

List of Available Interfaces

JsonUtilsInterface

Interface documentation:

Operation NameInput TypeOutput TypeFaults
getJsonStringGetJsonStringRequestGetJsonStringResponseJSONCreationError( undefined )
getJsonValueGetJsonValueRequestGetJsonValueResponseJSONCreationError( undefined )

Operation Description

getJsonString

Operation documentation: Returns the value converted into a JSON string

  Each child value corresponds to an attribute, the base values are saved as the default values (attribute "$" or singular value), the "_" helper childs disappear (e.g. a._[i]._[j] -> a[i][j]), the rest gets converted recursively

Invocation template:

getJsonString@JsonUtils( request )( response )

Request type

Type: GetJsonStringRequest

type GetJsonStringRequest: undefined

GetJsonStringRequest : any

Response type

Type: GetJsonStringResponse

GetJsonStringResponse : string

Possible faults thrown

Fault JSONCreationError with type undefined

Fault-handling install template:

install ( JSONCreationError => /* error-handling code */ )

getJsonValue

Operation documentation: Returns the JSON string converted into a value

  Each attribute corresponds to a child value, the default values (attribute "$" or singular value) are saved as the base values, nested arrays get mapped with the "_" helper childs (e.g. a[i][j] -> a._[i]._[j]), the rest gets converted recursively

Invocation template:

getJsonValue@JsonUtils( request )( response )

Request type

Type: GetJsonValueRequest

type GetJsonValueRequest: any {
    .strictEncoding?: bool
    .charset?: string
}

GetJsonValueRequest : any

  • strictEncoding : bool
  • charset : string

Response type

Type: GetJsonValueResponse

type GetJsonValueResponse: undefined

GetJsonValueResponse : any

Possible faults thrown

Fault JSONCreationError with type undefined

Fault-handling install template:

install ( JSONCreationError => /* error-handling code */ )