Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Contract Role Costs records from the Autotask system using an advanced filtering mechanism. It is useful for users who need to query contract role cost data 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 role costs related to a particular contract or role, or apply custom filters to analyze cost data for reporting or integration purposes.

Properties

Name Meaning
Get All Determines whether to return all matching records or limit the number of results.
Max Records Specifies the maximum number of 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 query criteria according to the Autotask API's advanced query syntax. This allows complex filtering of contract role costs based on various fields.
Add Picklist Labels If enabled, adds additional fields with human-readable labels for picklist fields in the response, improving readability.
Add Reference Labels If enabled, adds additional fields with human-readable labels for reference fields in the response.
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 promoted to top-level properties in each returned object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - Unique identifier of the contract role cost record.
  • contractID - Identifier of the associated contract.
  • roleID - Identifier of the role associated with the cost.
  • cost - Cost value for the contract role.
  • effectiveDate - Date when the cost becomes effective.
  • expirationDate - Date when the cost expires.
  • userDefinedFields - Array of user-defined fields related to the contract role cost, if not flattened.
    _label - Human-readable label for picklist or reference fields, added if enabled in input properties.

Dependencies

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

Troubleshooting

  • Ensure the 'Advanced Filter' JSON string is correctly formatted and follows the Autotask API query syntax; invalid JSON or incorrect filter structure will cause errors.
  • If no records are returned, verify that the filter criteria match existing contract role costs in Autotask.
  • When selecting specific columns, ensure the field names or IDs are valid for the Contract Role Costs resource; invalid fields may cause the request to fail.
  • If the node returns authentication errors, check that the Autotask API credentials are correctly configured and have sufficient permissions.

Links

  • Autotask API Basic Query Calls - Official Autotask documentation describing the advanced filter query syntax used in the 'Advanced Filter' property.

Discussion