Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Holiday Set records from the Autotask REST API using advanced filtering criteria. It is useful for users who need to query holiday sets with complex conditions, such as filtering by specific fields or combinations of fields, and control the number of records returned. For example, a user can fetch all holiday sets that apply to a certain region or time period, or retrieve a limited number of holiday sets matching custom criteria.

Properties

Name Meaning
Get All Determines whether to return all matching holiday set records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of holiday set records to return when 'Get All' is false. The value must be between 1 and 500.
Advanced Filter A JSON string containing a 'filter' array that defines the Autotask API query criteria for filtering holiday sets. This allows complex queries using Autotask's REST API filtering syntax.
Add Picklist Labels If enabled, adds additional '_label' fields to the output for picklist fields, providing human-readable values instead of raw codes.
Add Reference Labels If enabled, adds additional '_label' fields to the output for reference fields, providing human-readable values.
Select Columns Names or IDs. Allows selection of specific fields to include in the response. If no fields are selected, all fields are returned. The ID field is always included.
Flatten User-Defined Fields If enabled, user-defined fields (UDFs) are moved to the top level of each returned object instead of being nested inside a 'userDefinedFields' array.

Output

JSON

  • id - Unique identifier of the holiday set record.
  • name - Name of the holiday set.
  • description - Description of the holiday set.
  • userDefinedFields - Array of user-defined fields associated with the holiday set, unless flattened.
    _label - Human-readable label for picklist fields if 'Add Picklist Labels' is enabled._label - Human-readable label for reference fields if 'Add Reference Labels' is enabled.

Dependencies

  • Requires an Autotask API key credential for authentication to access the Autotask REST API.

Troubleshooting

  • Invalid JSON in 'Advanced Filter' property can cause query failures. Ensure the JSON string is correctly formatted and follows Autotask API filter syntax.
  • Requesting more than 500 records when 'Get All' is false will be limited to 500 due to API constraints.
  • If no records are returned, verify that the filter criteria match existing holiday sets.
  • Enabling 'Add Picklist Labels' or 'Add Reference Labels' may increase response size; disable if not needed.
  • Flattening user-defined fields may cause naming conflicts if UDF names overlap with standard fields.

Links

Discussion