Parse

Converts raw input into parsed JSON or XML.

Use the Parse policy to convert raw request content into structured JSON or XML so it can be processed by downstream policies.

For more information on the policy parameter descriptions, see DataPower Nano Gateway documentation.

Example of a Parse policy in code view.

kind: parse
apiVersion: api.ibm.com\v1
metadata:
  name: "parse-request"
  version: 1.0
  namespace: sample
spec:
  input: "request" #the message name
  detectByContentType: {}


--- #Sample for detectByContentType
kind: parse
apiVersion: api.ibm.com\v1
metadata:
  name: "parse-request"
  version: 1.0
  namespace: sample
spec:
  input: "request"
  output: "request" #optional by default use input
  detectByContentType:
    maxDepth: 3 #all optional
    maxDocumentSize: 4096
    maxNameLength: 45
    maxValueLength: 4096
    maxWidth: 344
    maxNumberLength: 128
    maxNamespaces: 1024
    maxPrefixes: 1024

--- #Sample for detectByPayload

kind: parse
apiVersion: api.ibm.com\v1
metadata:
  name: "parse-request"
  version: 1.0
  namespace: sample
spec:
  input: "request"
  output: "request" #optional by default use input
  detectByPayload:
    maxDepth: 3 #all optional
    maxDocumentSize: 4096
    maxNameLength: 45
    maxValueLength: 4096
    maxWidth: 344
    maxNumberLength: 128
    maxNamespaces: 1024
    maxPrefixes: 1024
    

--- #Sample for json
kind: parse
apiVersion: api.ibm.com\v1
metadata:
  name: "parse-request"
  version: 1.0
  namespace: sample
spec:
  input: "request"
  output: "request" #optional by default use input
  json: #same for detectByPayload
    maxDepth: 3 #all optional
    maxDocumentSize: 4096
    maxNameLength: 45
    maxValueLength: 4096
    maxWidth: 344
    maxNumberLength: 128

--- #Sample for binary
kind: parse
apiVersion: api.ibm.com\v1
metadata:
  name: "parse-request"
  version: 1.0
  namespace: sample
spec:
  input: "request"
  output: "request" #optional by default use input
  binary:
    maxDocumentSize: 4194304 #optional