kotaoue/Fetch Salesforce Field Definitions
Fetch FieldDefinition records from Salesforce Tooling API and save them to a file or directory.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| format | Output format. One of: json, csv, json-per-object, csv-per-object, package-xml (for field definitions), entity-json, entity-csv (for entity definitions). | yes | json |
| output_dir | Directory to write output files into. Defaults to docs/ relative to the caller workspace. | no | docs |
| object_scope | Object scope filter. One of: all, system, custom. | no | all |
| field_definition_fields | Comma-separated FieldDefinition fields to select. Defaults to all supported fields. | no | "" |
| entity_definition_fields | Comma-separated EntityDefinition fields to select. Defaults to all supported fields. Only used when format is entity-json or entity-csv. | no | "" |
| updated_within | Only fetch objects modified within this duration (e.g. '2days', '12hours', '30min', '1week'). Leave empty to fetch all objects. | no | "" |
| metadata_api_version | Salesforce Metadata API version to declare in the generated package.xml (e.g. '62.0'). Only used when format is package-xml. | no | "" |
| sfdx_auth_url | SFDX Auth URL used to authenticate to Salesforce (e.g. from secrets.SFDX_AUTH_URL). | yes | — |
| sf_username | Salesforce username to run queries as (e.g. from secrets.SF_USERNAME). | yes | — |
Outputs
no outputs