newFile()

The newFile() GraphQL mutation may be used to create a new file.

For information on loading and using files, see the Lookup Files documentation page.

Below is the syntax for the newFile() mutation field:

graphql

newFile(
     fileName: string!, 
     name: string!
   ): UploadedFileSnapshot!

The returned datatype UploadedFileSnapshot has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: UploadedFileSnapshot

Parameter	Type	Required	Description
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Oct 4, 2024
`filterString`	string		Any string on which to filter the data.
`headers`	[string]	yes	The headers for the uploaded snapshot file.
`limit`	integer	yes	The file upload limit.
`lines`	[string]	yes	The contents of the file in the form of a list of lines, with each line being itself a list of column values. When the file is empty or nothing matches filterString, then `[]` is returned.
`nameAndPath`	`FileNameAndPath`	yes	The name and path of the uploaded snapshot file. See `FileNameAndPath`.
`offset`	integer	yes	This is the offset supplied to a file query. For a new or updated file, this is always 0.
`totalLinesCount`	long	yes	The total number of lines in the uploaded snapshot file.