.. _auto_api_requests_generation:

*API REQUESTS GENERATION*
=========================

Generates an API request collection (e.g., Postman) from the d3VIEW platform's available endpoints. Use this worker to scaffold and export a ready-to-import API collection for external tooling or integration testing.

When to use
-----------

Tagged: ``api``, ``collection``, ``export``, ``http``, ``integration``, ``postman``, ``rest``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Collection Name
     - collection_name
     - text
     - d3VIEW API Requests 001
     - 
     - Human-readable name assigned to the generated API collection; defaults to 'D3VIEW API Requests 001' and can be left as-is for a single unnamed export.
   * - Collection Description
     - collection_description
     - text
     - —
     - 
     - Optional free-text description embedded in the exported collection to document its purpose; leave null if no description is needed.
   * - Software Format
     - software_format
     - text
     - postman
     - 
     - Target API client format for the exported collection; currently only 'postman' (Postman Collection v2) is supported — leave as default unless additional formats become available.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - API Collection
     - api_data
     - json
     - Raw JSON payload of the generated API collection in the selected software format (e.g., Postman Collection JSON), suitable for direct file import.
   * - API Collection
     - dataset
     - json
     - Structured JSON dataset representation of the same API collection, intended for downstream programmatic consumption or workflow chaining within d3VIEW.

Disciplines
-----------

- platform.integration

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>platform</code> schema. Worker id: <code>api_requests_generation</code>. Schema hash: <code>ba73474ace01</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>