Dependencies

Export dependencies to CSV

Changed on

Export all dependencies matching the filter criteria to CSV format. Ignores pagination parameters (limit/offset) and exports all matching records.

get/api/v1/dependencies/export/csv

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/dependencies/export/csv
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Query parameters

site_idstring uuid nullable

Filter by site ID

group_by'created_at' | 'name' | 'dependency_type' | 'updated_at' | 'site_id'

Fields that dependencies can be ordered/grouped by.

Primary ordering field (used for grouping). Always sorts ASC to keep groups together.

order_by'created_at' | 'name' | 'dependency_type' | 'updated_at' | 'site_id'

Fields that dependencies can be ordered/grouped by.

Secondary ordering field (sorting within groups or standalone sort).

order_direction'asc' | 'desc'

Direction for ORDER BY clauses.

Direction for order_by field (group_by always uses ASC).

limitinteger nullable

Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.

offsetinteger nullable

Number of results to skip. Default: 0.

atstring date-time nullable

As-of timestamp (ISO 8601). When set, returns SCD2 state as of this instant (snapshot view) instead of live state.

Response

CSV file containing Dependencies

Changes

    • breaking

      removed the enum value network_id from the property oneOf[DependencyOrderField]/ of the query request parameter group_by

    • breaking

      removed the enum value network_id from the property oneOf[DependencyOrderField]/ of the query request parameter order_by

    • warning

      deleted the query request parameter network_id

    • info

      added the new optional query request parameter site_id

    • info

      added the enum value site_id to the property oneOf[DependencyOrderField]/ of the query request parameter group_by

    • info

      added the enum value site_id to the property oneOf[DependencyOrderField]/ of the query request parameter order_by

    • info

      added the new optional query request parameter at