NinjaOne icon

NinjaOne

Consume NinjaOne API

Actions158

Queries → Get Custom Fields Detailed Report

AI-generated

Overview

This node interacts with the NinjaOne API to retrieve a detailed report of custom fields related to queries. It is designed to fetch paginated data about custom fields, optionally filtered by device, update date, and other parameters. This node is useful for IT administrators or automation engineers who want to programmatically access detailed metadata about custom fields in their NinjaOne environment, such as for auditing, reporting, or integration with other systems.

Practical examples include:

  • Retrieving all custom fields updated after a certain date to sync with an external database.
  • Fetching a limited number of records per page to process large datasets incrementally.
  • Filtering results by device or specific fields to focus on relevant data subsets.

Properties

Name Meaning
Df Device filter: filter the query results by a specific device identifier or name.
Cursor Cursor name: used for pagination to continue fetching results from where the last request ended.
Page Size Limit number of records per page: controls how many records are returned in one API call.
Updated After Custom fields updated after specified date: filters results to only those updated after this date.
Fields Comma-separated list of fields: specify which fields to include in the response.
Show Secure Values Flag indicating if secure values should be returned as plain text without encryption (true/false).

Output

The node outputs JSON data representing the detailed report of custom fields retrieved from the NinjaOne API. The structure corresponds directly to the API response and includes the requested fields, pagination cursors, and any metadata provided by the API.

If the API returns binary data (not indicated for this operation), it would be included accordingly, but for this operation, output is purely JSON.

Dependencies

  • Requires an active connection to the NinjaOne API using OAuth2 authentication.
  • The node depends on the NinjaOne API endpoint /v2/queries/custom-fields-detailed-report (inferred from context).
  • Proper API credentials must be configured in n8n to authenticate requests.

Troubleshooting

  • Common issues:
    • Missing or invalid API credentials will cause authentication failures.
    • Incorrect property values (e.g., invalid date format for "Updated After") may result in API errors.
    • Pagination issues if the cursor is not managed correctly could lead to repeated or missed data.
  • Error messages:
    • Errors from the API will be returned in the node's output if "Continue On Fail" is enabled.
    • Typical errors include unauthorized access, invalid parameters, or rate limiting.
  • Resolutions:
    • Verify API credentials and permissions.
    • Ensure date strings and other inputs conform to expected formats.
    • Use the cursor property properly to paginate through large datasets.

Links and References


Note: The exact API endpoint path for this operation is not explicitly shown in the bundled code snippet but is inferred from the operation name and typical REST conventions.

Discussion