The createLookupFileFromPackageTemplate() GraphQL mutation field may be used to create a lookup file from a package lookup file template.

For more information on lookup files, see the Lookup API reference page. You may also want to look at the Packages documentation page for related information.


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

      viewName: RepoOrViewName!
      packageId: VersionedPackageSpecifier!
      lookupFileTemplateName: string!
      overrideName: string
   ): FileNameAndPath!

Given and Returned Datatypes

The given datatype RepoOrViewName and VersionedPackageSpecifier are scalar values. However, the returned datatype FileNameAndPath is a more complex datatype with its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: FileNameAndPath

namestring  The name of the file.
pathstring  Paths for files can be one of two types: absolute or relative. Absolute paths start with a slash, and relative paths start without a slash, like Unix paths. Every repository or view in the system is considered a "folder" in its own right, meaning that every relative path is relative to the current view. An absolute path points to something that can be addressed from any view, and a relative path points to a file located inside the view. If there is no path, it means the file is located at your current location.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.