ns_getSuiteQLMetadata
|
Tool Description |
Retrieves detailed metadata for NetSuite records that you can access with SuiteQL, including available fields, their data types, descriptions, nullability, and joinable fields. You can specify a record type to get its metadata. If you don't specify a record type, the tool returns a list of all supported record types. By obtaining this metadata, you can ensure that any SuiteQL queries reference only valid fields and relationships, which helps prevent errors when selecting, filtering, sorting, or joining data. This tool is called by ns_runCustomSuiteQL first before constructing and running custom SuiteQL queries. |
|
Annotation |
Get SuiteQL Metadata |
Properties
|
Property |
Type |
Required or Optional |
Description |
|---|---|---|---|
|
|
string |
Optional |
The NetSuite record type you want to get metadata for. If not specified, the tool returns a list of all supported record types. |
Permissions
There are no specific permission requirements to see this tool in the AI client. However, the data you can see or query with SuiteQL depends on the permissions assigned to your NetSuite role.