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

JSON Example

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

Write to File

Name: write

Writes the data to a JSON file.

Properties

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

Output

Type: FILE_ENTRY

Properties

Name	Type	Control Type
extension	STRING	TEXT
mimeType	STRING	TEXT
name	STRING	TEXT
url	STRING	TEXT

JSON Example

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