Autotask icon

Autotask

Consume Autotask REST API

Actions389

Overview

The 'Get Many (Advanced)' operation for the Domain Registrar resource allows users to retrieve multiple domain registrar records from the Autotask API using advanced filtering criteria. This operation is beneficial when users need to query domain registrar data with complex conditions, such as filtering by specific fields or combinations of fields, beyond simple retrieval. For example, a user can fetch all domain registrars that match certain status codes or registration dates by providing a JSON filter array. It supports pagination control by allowing users to specify whether to return all matching records or limit the number of records returned.

Properties

Name Meaning
Get All Determines whether to return all matching domain registrar records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of domain registrar 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 for filtering domain registrar records. Users should construct this JSON filter according to Autotask API documentation to specify complex query conditions.
Add Picklist Labels Indicates whether to automatically add human-readable '_label' fields for picklist fields in the output. No labels are added for empty values.
Add Reference Labels Indicates whether to automatically add human-readable '_label' fields for reference fields in the output. No labels are added for empty 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 regardless of selection.
Flatten User-Defined Fields Determines whether user-defined fields (UDFs) are brought up to the top level of each returned object instead of being nested inside a 'userDefinedFields' array.

Output

JSON

  • id - Unique identifier of the domain registrar record.
  • fieldName - Various fields of the domain registrar record as specified by the selected columns or all fields if none selected.
  • fieldName_label - Human-readable labels for picklist or reference fields if 'Add Picklist Labels' or 'Add Reference Labels' is enabled.
  • userDefinedFields - Array of user-defined fields associated with the domain registrar record, unless 'Flatten User-Defined Fields' 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 too many records without pagination or limits may lead to timeouts or API rate limiting. Use 'Get All' judiciously or set a reasonable 'Max Records' limit.
  • Selecting invalid or non-existent fields in 'Select Columns' may result in errors or missing data. Use 'Get Field Info' or API documentation to confirm field names.
  • If picklist or reference labels are not appearing, verify that 'Add Picklist Labels' and 'Add Reference Labels' options are enabled and that the fields contain values.

Links

Discussion