Actions389
- Contract Actions
- Ticket History Actions
- Ticket Note Webhook Actions
- Ticket Note Actions
- Ticket Webhook Actions
- Time Entry Actions
- Resource Actions
- Role Actions
- Resource Role Actions
- Search Filter Actions
- Service Actions
- Skill Actions
- Service Call Actions
- Survey Results Actions
- Survey Actions
- Ticket Actions
- Opportunity Actions
- Notification History Actions
- Invoice Actions
- Product Actions
- Product Vendor Actions
- Project Actions
- Project Charge Actions
- Project Phase Actions
- Project Task Actions
- Project Note Actions
- Contract Retainer Actions
- Contract Service Actions
- Contract Service Adjustment Actions
- Contract Service Bundle Actions
- Contract Service Bundle Unit Actions
- Contract Service Bundle Adjustment Actions
- Contract Ticket Purchase Actions
- Contract Service Unit Actions
- Domain Registrar Actions
- Holiday Actions
- Holiday Set Actions
- Contract Exclusion Billing Code Actions
- Contract Rate Actions
- Contract Exclusion Role Actions
- Contract Exclusion Sets Actions
- Contract Exclusion Set Excluded Role Actions
- Contract Exclusion Set Excluded Work Type Actions
- Contract Milestone Actions
- Contract Note Actions
- Contract Role Costs Actions
- Contact Groups Actions
- Contact Actions
- Contact Webhook Actions
- Contact Group Contacts Actions
- Contract Block Hour Factor Actions
- Contract Block Actions
- Contract Billing Rule Actions
- Contract Charge Actions
- Configuration Item Category Actions
- Configuration Item Category UDF Association Actions
- Configuration Item DNS Record Actions
- Configuration Item Note Actions
- Configuration Item Related Item Actions
- Configuration Item SSL Subject Alternative Name Actions
- Configuration Item Type Actions
- Configuration Item Webhook Actions
- Company Alert Actions
- Company Actions
- Billing Code Actions
- Company Location Actions
- Company Note Actions
- Company Webhook Actions
- Configuration Item Actions
- Configuration Item Billing Product Association Actions
Overview
The 'Contract Block - Get Many (Advanced)' operation allows users to retrieve multiple contract block records from the Autotask system using advanced filtering criteria. This operation is beneficial when users need to query contract blocks with complex conditions beyond simple retrieval, such as filtering by multiple fields or nested criteria. For example, a user can fetch all contract blocks that meet specific status and date range conditions or other custom filters defined in the Autotask API query language.
Properties
| Name | Meaning |
|---|---|
| Get All | Determines whether to return all matching contract block records or limit the number of results. |
| Max Records | Specifies the maximum number of contract block 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 Autotask API query criteria for filtering contract blocks. Users should construct this JSON using the Autotask API documentation and tools like 'Get Field Info' and 'Search Filter Build'. |
| Add Picklist Labels | Indicates whether to automatically add human-readable '_label' fields for picklist fields in the output. Empty values will not have labels added. |
| Add Reference Labels | Indicates whether to automatically add human-readable '_label' fields for reference fields in the output. Empty values will not have labels added. |
| 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 contract block record.fieldName- Various contract block fields 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 unless 'Flatten User-Defined Fields' is enabled, in which case UDFs appear as top-level properties.
Dependencies
- Requires an Autotask API key credential for authentication.
- Relies on the Autotask REST API to perform advanced filtered queries on contract blocks.
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 'Get All' enabled may result in incomplete data. Use 'Get All' to retrieve all matching records or adjust 'Max Records' accordingly.
- If picklist or reference labels are not appearing, verify that 'Add Picklist Labels' and 'Add Reference Labels' are enabled and that the fields contain non-empty values.
- Selecting invalid or unsupported columns in 'Select Columns' may cause errors or missing data. Use 'Get Field Info' to confirm valid field names.
- API rate limits or authentication errors may occur if the Autotask API key is invalid or overused. Check credentials and API usage limits.
Links
- Autotask API Basic Query Calls - Official Autotask documentation for constructing advanced filter queries used in this operation.