json2Csv (Compute)

When To Use

Use json2Csv to turn a raw JSON payload — typically the body of an http^[1] source — into the tabular form that mapping and other computes expect. Point entryKey at the JSON array (or object) holding the entries, and list in properties the values to extract from each entry: the compute emits one row per entry, one column per property.

This is almost always the first compute in an HTTP source pipeline: parse the payload into a table immediately, then filter and reshape with regular table computes.

Syntax

sources:
  switches:
    type: http
    method: get
    path: /api/v1/inventory/switches
    resultContent: body
    computes:
    - type: json2Csv
      entryKey: /switches
      properties: /id;/name;/operationalStatus
      separator: ;

Properties

You may encounter two shorthand styles in examples: property pointers written without the leading / (properties: id;name;status), which resolve against each entry's top level, and array traversal expressed inside the property itself (properties: Members[*].@odata.id). Prefer the canonical form used by real connectors: entryKey pointing at the array, plus one leading-slash pointer per column (entryKey: /Members with properties: /@odata.id).

Table Transformation Example

{
  "switches": [
    { "id": "sw-01", "name": "edge-01", "operationalStatus": "ok" },
    { "id": "sw-02", "name": "core-01", "operationalStatus": "degraded" }
  ]
}

Equivalent serialized output:

/switches[0];sw-01;edge-01;ok
/switches[1];sw-02;core-01;degraded

Recommended Pattern

• Set resultContent: body on the HTTP source and put json2Csv first in its computes pipeline.
• Point entryKey at the array of records and keep every property pointer relative to a single record.
• Account for the leading entry column: the first property is $2, not $1.
• Quote the properties value when a pointer contains YAML-sensitive characters such as [0] (for example properties: "/@odata.id;/Links/Storage[0]/@odata.id").

Common Mistakes

• Off-by-one column references in mapping or later computes because the leading entry column was forgotten.
• Writing property pointers relative to the document root instead of relative to one entry under entryKey.
• Separating properties with commas: the list is semicolon-separated.
• Leaving entryKey pointing at a single object when the payload nests the records one level deeper, which yields a single mostly-empty row instead of one row per record.

Community Examples

• Redfish^[2]

computes:
- type: json2csv
  entryKey: /Members
  properties: /@odata.id;
  separator: ;