Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Export

This command does not only process the selected entities, this is normally indicative of a bulk action which supports being passed a TQL query which forms the basis of entities it should apply to.

ParameterDescription
columnsThe columns to export (if export all is set to false, this is an array of columns states i.e. [{ "Name": "col1", "IsVisible": true }, { "Name": "col2", "IsVisible": true }] )
commandNameMust be set to value 'Export'
exportAllExport all records (true/false)
projectIdId of the the project the action applies to (used by some actions to determine the custom fields & permissions required to complete the action)
targetPackageIdId of the target package (if any, normally same as the targetId)

Scenarios

  • CSV

Scenario "CSV"

Supported Types: Requirement, Script, Incident, AutomatedTest, ScriptAssignment, AutomatedTestAssignment, RequirementPackage, ScriptPackage, ExecutionPackage, AgileRun

This scenario has scenario-specific parameters:

ParameterDescription
delimiterThe CSV delimiter to use (valid values are 'comma', 'colon', 'pipe', 'semicolon' or 'tab')
encodingThe exporting enncoding type
includeAssociatedLinksBoolean value, if true then association columns (Associated requirements, Associated Scripts, Associated Incidents, External Identifiers) will include hyperlinks to the associated entities
includeAttachmentsLinksIf true, then include attachment URL links in the generated output (otherwise just include attachment names)
includeHeaderInclude headers in export file
includeStepsInclude steps for scripts
includeStepsResultsInclude step results for script assignments
onlyVisibleColumnsOnly export the visible columns
queryThe TQL query used to filter the items being exported to CSV
scenarioNameMust be set to value 'CSV'