Export Record

the export records native action enables you to export records from a specified application to a csv file this action provides filtering capabilities, allowing you to define which records to export based on custom criteria, as well as options to limit and paginate the export the exported data is provided as a downloadable attachment file, along with supporting metadata key benefits native action integrated directly into the playbook builder for streamlined workflow creation csv export exports records to csv format for easy import into spreadsheets or other systems flexible filtering build complex search queries using multiple conditions and operators field selection export entire records or only specific fields to optimize file size pagination support handle large result sets with limit and page number options large exports exempt from default search limit, allowing exports of more than 1000 records at least once execution ensures export results are retrieved even if the playbook is retried inputs the export records action requires the following inputs required inputs application select an application by either application id the unique identifier of the application application name the name of the application note you must provide either applicationid or applicationname , but not necessarily both filters filter conditions to apply to the export can be empty/no filters exports all records in the application (up to the limit) simple filters array of filter conditions complex filters nested clauses with and/or logic filter type how multiple filter conditions are combined and (default) all conditions must be true or at least one condition must be true optional inputs return fields specify which fields to export all fields (default) exports complete record data specific fields exports only the selected field keys note if returnfields is empty or not specified, all fields are exported limit maximum number of records to export per page default no limit (export action is exempt from default search limit) maximum limited by file size constraints minimum 1 record note the export action can handle larger exports than the search records action however, very large exports may be limited by file size constraints page number 0 based page offset for pagination default 0 (first page) use with limit to paginate through large result sets deprecated the offset parameter is deprecated; use pagenumber instead file format type of file format to export csv (default) comma separated values format currently, csv is the only supported format date filter type optional date filter type for date field filters (minute, hour, day, week, month, quarter, year, alltime) filter operators the export records action supports the same filter operators as search records equals field value exactly matches the specified value doesnotequal field value does not match the specified value contains field value contains the specified value (for strings) containsany field value contains any of the specified values excludes field value does not contain the specified value lessthan field value is less than the specified value lessthanorequal field value is less than or equal to the specified value greaterthan field value is greater than the specified value greaterthanorequal field value is greater than or equal to the specified value exists field exists (has a value) previous for date fields, matches previous period current for date fields, matches current period next for date fields, matches next period hour for date fields, matches specific hour dayofweek for date fields, matches specific day of week note available operators may vary depending on the field type (text, number, date, etc ) returning all records if you want to export all records for the application you selected, do not create any filter conditions however, be aware that very large exports may be limited by file size constraints large exports the export records action is exempt from the default 1000 record search limit, allowing you to export larger datasets however, exports are still subject to file size limits configuring the export records action step 1 select application from the inputs tab, select an application choose from the dropdown list of available applications, or use an expression to reference an application id or name dynamically step 2 configure filter conditions click add condition or use the condition builder to create filter conditions for each condition field click field to choose the field you want to filter on only fields available in the selected application are shown operator choose how the filter is evaluated using the operator dropdown available operators depend on the field type (see filter operators section above) value enter or select the value to compare against the chosen field and operator you can use static values playbook properties from upstream actions playbook inputs expressions add multiple conditions add additional conditions to refine your filter filter type use the all/any (and/or) selector at the top all (and) all conditions must be true for a record to be included (default) any (or) at least one condition must be true for inclusion note if you don't add any filter conditions, all records in the application will be exported (subject to file size limits) step 3 configure return fields choose what data to export find entire records exports all fields of the matching records (default behavior if no fields are specified) return specific fields select specific fields to export only those field values, reducing file size and improving performance example if you only need the tracking id and status, select only those fields instead of exporting all record data step 4 configure limit and pagination include limit enable/disable the limit on the number of records exported default no limit (export action can handle larger exports) maximum limited by file size constraints minimum 1 record number of records set the maximum number of records per export include page number enable/disable pagination for large result sets page number specify which page of results to export (0 based index) page 0 first page (records 1 to limit) page 1 second page (records limit+1 to 2 limit) and so on example to export records 1001 2000 set limit to 1000 set page number to 1 step 5 configure file format (optional) file format select the export format csv (default) comma separated values format currently, csv is the only supported format step 6 apply changes click apply to save your configuration outputs the export records action provides the following outputs success output when the export completes successfully, the action returns result exportfile an attachment object containing the exported csv file this can be downloaded directly used in downstream actions (e g , sent via email, uploaded to cloud storage) referenced using attachment properties result count the total number of records exported in this operation result limit the limit that was applied to this export result result pagenumber the page number (0 based) that was requested result hasnextpage a boolean indicating whether there are more pages of results available for export example access export results in downstream actions \# access the export file attachment $actions exportrecordsname result exportfile \# access file name $actions exportrecordsname result exportfile file name \# access file id $actions exportrecordsname result exportfile file \# get total count $actions exportrecordsname result count \# check if more pages exist $actions exportrecordsname result hasnextpage error output if the export fails, the action returns error error information containing details about why the export failed common error scenarios application not found invalid filter syntax invalid field references permission errors file size limit exceeded invalid limit or page number values csv file format the exported csv file includes header row contains field keys/names as column headers data rows each row represents one record with field values encoding utf 8 encoding quoting values containing commas, quotes, or newlines are automatically quoted field formatting dates are formatted according to system timezone settings array/multiselect fields are formatted as comma separated values reference fields show formatted record references attachment fields show attachment metadata use cases example 1 export all records scenario export all records from an application for backup or analysis configuration select the application do not add any filter conditions optionally specify return fields to limit exported columns optionally set limit if you want to paginate large exports result a csv file containing all records (or up to the limit) is generated example 2 export filtered records scenario export only high priority cases created in the last 30 days configuration select the application add filter conditions condition 1 priority equals "high" condition 2 created date greaterthanorequal (30 days ago) set filter type to and optionally specify return fields to export only relevant columns result a csv file containing only matching records is generated example 3 export specific fields scenario export only essential fields for reporting configuration select the application configure filters as needed select return specific fields choose only the fields you need (e g , tracking id , status , assigned to , created date ) result a smaller csv file with only the selected fields, making it easier to work with in spreadsheets example 4 paginated export scenario export large datasets in manageable chunks configuration add an export records action set limit to 5000 (or appropriate chunk size) set page number to 0 for the first page check result hasnextpage to determine if more pages exist use a loop or conditional logic to export additional pages if hasnextpage is true, increment pagenumber and export again result multiple csv files are generated, each containing a manageable chunk of records example 5 export and send via email scenario export records and email them to stakeholders configuration add an export records action to generate the csv file add a send notification or http request action to send an email attach the export file use $actions exportrecordsname result exportfile as the attachment result the csv file is automatically attached to the email and sent to recipients best practices use specific return fields when you only need certain fields, specify them in returnfields to reduce file size and improve export performance filter before exporting use filters to narrow results before exporting to reduce file size and processing time use pagination for large exports for very large datasets, use pagination to export in manageable chunks and avoid file size limits test export size test your export configuration with sample data to ensure the resulting file size is manageable handle file size limits be aware that exports are subject to file size limits if your export exceeds the limit, use pagination or filters to reduce the export size optimize filter conditions use specific filters to narrow results place the most selective filters first use exists operator to check for non null values consider field types some field types (attachments, references) may increase file size significantly consider excluding them if not needed use export for reporting export records is ideal for generating reports, backups, or data transfers to external systems troubleshooting export file not generated verify filter conditions are correct check that the application contains records matching your criteria review error output for specific error messages file size limit exceeded add more specific filter conditions to reduce the number of records use returnfields to export only essential fields use pagination to export in smaller chunks consider splitting the export into multiple actions missing fields in export if you specified returnfields , ensure the field keys are correct check that fields exist in the application verify field keys match the application's field definitions pagination not working ensure pagenumber is 0 based (0 = first page, 1 = second page) check that limit is set appropriately verify hasnextpage to determine if more pages exist application not found verify the application id or name is correct ensure the application exists and is accessible check that application references are properly formatted filter errors verify filter syntax is correct ensure field ids/keys match application field definitions check that operator is appropriate for the field type validate that filter values match the expected data types csv formatting issues csv files automatically handle special characters (commas, quotes, newlines) values containing special characters are automatically quoted date formats follow system timezone settings export feature not available the export records feature must be enabled for your account contact support if you believe this feature should be available