JSON File

Reads and writes data from a JSON file.

Categories: helpers

Type: jsonFile/v1

Actions

Read from File

Name: read

Reads data from a JSON file.

Properties

Name	Label	Type	Description	Required
fileType	File Type	STRING Options JSON, JSONL	The file type to choose.	true
fileEntry	File	FILE_ENTRY	The object property which contains a reference to the JSON file to read from.	true
isArray	Is Array	BOOLEAN Options true, false	The object input is array?	null
path	Path	STRING	The path where the array is e.g ‘data’. Leave blank to use the top level object.	null
pageSize	Page Size	INTEGER	The amount of child elements to return in a page.	null
pageNumber	Page Number	INTEGER	The page number to get.	null

Example JSON Structure

{
  "label" : "Read from File",
  "name" : "read",
  "parameters" : {
    "fileType" : "",
    "fileEntry" : {
      "extension" : "",
      "mimeType" : "",
      "name" : "",
      "url" : ""
    },
    "isArray" : false,
    "path" : "",
    "pageSize" : 1,
    "pageNumber" : 1
  },
  "type" : "jsonFile/v1/read"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Write to File

Name: write

Writes the data to a JSON file.

Properties

Name	Label	Type	Description	Required
fileType	File Type	STRING Options JSON, JSONL	The file type to choose.	true
type	Type	STRING Options OBJECT, ARRAY	The value type.	null
source	Source	OBJECT Properties {}	The object to write to the file.	true
source	Source	ARRAY Items []	The array to write to the file.	true
filename	Filename	STRING	Filename to set for binary data. By default, “file.json” will be used.	true

Example JSON Structure

{
  "label" : "Write to File",
  "name" : "write",
  "parameters" : {
    "fileType" : "",
    "type" : "",
    "source" : [ ],
    "filename" : ""
  },
  "type" : "jsonFile/v1/write"
}

Output

Type: FILE_ENTRY

Properties

Name	Type	Description
extension	STRING
mimeType	STRING
name	STRING
url	STRING

Output Example

{
  "extension" : "",
  "mimeType" : "",
  "name" : "",
  "url" : ""
}