Export project
export_projectExport a Railyard project to downstream formats such as Nautobot CSV, NetBox CSV, or JSON, and retrieve the generated files. Unresolved placements are reported, with optional placeholders for missing device types.
Instructions
Export a project into a downstream format (see list_export_formats for the ids — e.g. nautobot-csv, netbox-csv, designbuilder-yaml, json) and return the generated files' content, plus any unresolved placements and warnings. A placement whose deviceTypeRef matches no catalogue entry is REPORTED, never silently dropped: set placeholders=true to emit it as a placeholder device type so the row still imports. Targets that need prerequisite objects return the whole ordered bundle, not just the headline table. Large files are truncated in the reply — the app's download gives the complete artefact.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| org | No | Organisation to target: an org id (org_…), slug, or name. Defaults to RAILYARD_ORG, or to your first (personal) org if that is unset. Use list_orgs to see the options. | |
| ref | No | A saved project's id (prj_…) or slug to export. | |
| format | Yes | Export format id, e.g. "nautobot-csv". Use list_export_formats to see them. | |
| project | No | An inline project document to export instead of a saved one. | |
| placeholders | No | Emit placements with no matching device type as placeholders (default false: they are skipped, but still reported). | |
| fallbackLocation | No | Location name given to racks with no resolvable site (default "Railyard-Unassigned"). |