Autotask icon

Autotask

Consume Autotask REST API

Actions389

Overview

This node operation retrieves multiple holiday records from the Autotask system using an advanced filtering mechanism. It allows users to specify complex query criteria in JSON format to filter the holidays returned. Users can choose to return all matching records or limit the number of results. Additional options include selecting specific fields to return, adding human-readable labels for picklist and reference fields, and flattening user-defined fields for easier access. This operation is useful for scenarios where detailed and customized holiday data retrieval is needed, such as generating reports, syncing holiday data with other systems, or applying business logic based on specific holiday attributes.

Properties

Name Meaning
Get All Determines whether to return all matching holiday records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of holiday records to return when 'Get All' is set to false. The value must be between 1 and 500.
Advanced Filter A required JSON string containing a 'filter' array that defines the Autotask API query criteria to filter holiday records. This allows for complex and precise filtering based on holiday fields.
Add Picklist Labels Indicates whether to automatically add '_label' fields for picklist fields in the output, providing human-readable values for those fields.
Add Reference Labels Indicates whether to automatically add '_label' fields for reference fields in the output, providing human-readable values for those fields.
Select Columns Names or IDs. Allows selection of specific holiday 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 Determines whether user-defined fields (UDFs) are brought up to the top level of each holiday object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - Unique identifier of the holiday record.
  • fieldName - Various holiday fields as specified by the selected columns or all fields if none selected.
  • fieldName_label - Human-readable labels for picklist or reference fields, if enabled.
  • userDefinedFields - Array of user-defined fields associated with the holiday, unless flattened.
  • userDefinedFieldName - User-defined fields brought to top-level properties if flattenUdfs is enabled.

Dependencies

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

Troubleshooting

  • Invalid JSON in the 'Advanced Filter' property can cause query failures. Ensure the JSON string is correctly formatted and contains a valid 'filter' array.
  • Requesting more records than allowed (max 500) when 'Get All' is false will result in an error. Adjust 'Max Records' to be within 1-500.
  • If no records are returned, verify that the filter criteria in 'Advanced Filter' correctly match existing holiday records.
  • Enabling 'Add Picklist Labels' or 'Add Reference Labels' when fields have empty values will not add labels for those fields.
  • Flattening user-defined fields may cause naming conflicts if UDF names overlap with standard fields; use with caution.

Links

Discussion