Autotask icon

Autotask

Consume Autotask REST API

Actions389

Overview

This node operation retrieves multiple Contract Block Hour Factor records from the Autotask REST API using an advanced filtering mechanism. It is useful for users who need to query contract block hour factors with complex criteria, such as filtering by specific fields or conditions, and control the number of records returned. For example, a user can fetch all contract block hour factors that meet certain business rules or constraints, or limit the results to a manageable subset for reporting or integration purposes.

Properties

Name Meaning
Get All Determines whether to return all matching Contract Block Hour Factor records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of Contract Block Hour Factor records to return when 'Get All' is false. The value must be between 1 and 500.
Advanced Filter A required JSON string containing a 'filter' array that defines the query criteria according to the Autotask API's advanced query syntax. This allows precise filtering of records based on field values and conditions.
Add Picklist Labels If enabled, the node automatically adds additional fields with '_label' suffix for picklist fields, providing human-readable labels for those fields.
Add Reference Labels If enabled, the node automatically adds additional fields with '_label' suffix for reference fields, providing human-readable labels for those fields.
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 regardless of selection.
Flatten User-Defined Fields If enabled, user-defined fields (UDFs) are brought up to the top level of each returned object instead of being nested inside a 'userDefinedFields' array, simplifying access to these fields.

Output

JSON

  • id - Unique identifier of the Contract Block Hour Factor record.
  • fieldName - Various fields of the Contract Block Hour Factor record as returned by the Autotask API, including standard and user-defined fields.
  • picklistField_label - Human-readable labels for picklist fields, if 'Add Picklist Labels' is enabled.
  • referenceField_label - Human-readable labels for reference fields, if 'Add Reference Labels' is enabled.
  • userDefinedFields - Array of user-defined fields, unless 'Flatten User-Defined Fields' is enabled, in which case these fields appear at the top level.

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 well-formed and follows Autotask API filter syntax.
  • Requesting more than 500 records when 'Get All' is false and 'Max Records' exceeds 500 will cause errors. Limit 'Max Records' to 500 or less.
  • If no records are returned, verify that the filter criteria in 'Advanced Filter' correctly match existing Contract Block Hour Factor records.
  • Enabling 'Add Picklist Labels' or 'Add Reference Labels' may increase response size; disable if not needed to improve performance.
  • Incorrect field names in 'Select Columns' or 'Advanced Filter' can cause errors; use 'Get Field Info' and 'Search Filter Build' tools to confirm field names.

Links

Discussion