.. _step-GetREST:


GetREST
=======

Step facilitates REST GET interactions and will return the returned data dictionary and specified headers as data to the next step

.. versionadded:: 1.5.0

* **Friendly name:** ``GetREST``
* **Step class:** ``base_steps_syncpack.steps.GetREST.GetREST``
* **Step version:** ``1.0.0``
* **Required parameters:** ``prefix_url``

Parameters
----------

.. list-table::
   :header-rows: 1
   :widths: 22 16 8 16 38

   * - Name
     - Type
     - Required
     - Default
     - Description
   * - ``chunk_size``
     - number
     - no
     - ``0``
     - The max number of records to fetch in one REST call. Example: ``1000``
   * - ``chunk_name_for_pos_in_url``
     - string
     - no
     - --
     - The value that is specified in the url to indicate where to start grabbing data. For example: ?offset=50. Example: ``offset``
   * - ``chunk_name_for_max_in_url``
     - string
     - no
     - --
     - The value that is specified in the url to indicate the max number of records to return in this REST call. For example: ?limit=1000. Example: ``limit``
   * - ``chunk_name_for_total``
     - string
     - no
     - ``total_matched``
     - If the data is set in chunks, the field name in the response that indicates how many total rows for this object.
   * - ``chunk_name_for_returned``
     - string
     - no
     - ``total_returned``
     - If the data is set in chunks, the field name in the response that indicates how many rows were returned.
   * - ``missing_return_total``
     - boolean
     - no
     - ``False``
     - Enable if api response does not contain a response total count

Required inherited parameters
-----------------------------

These are defined on :ref:`step-HTTPBaseStep` but are **required** here, so a
working configuration must set them.

.. list-table::
   :header-rows: 1
   :widths: 22 16 8 16 38

   * - Name
     - Type
     - Required
     - Default
     - Description
   * - ``prefix_url``
     - string
     - yes
     - --
     - used with relative_url to create the full URL. Example: ``http://host.example.com``

Other inherited parameters
--------------------------

This step also accepts 31 optional parameter(s) inherited from
:ref:`step-HTTPBaseStep`.

Every step also accepts the platform parameters common to all steps --
see :ref:`platform-parameters`.

Dependencies
------------

* **Inherits from:** ``GetREST`` -> ``HTTPBaseStep`` -> ``BaseStep`` -> ``Serializable``
* **SyncPack modules:** ``base_steps_syncpack.steps.HTTPBaseStep``, ``base_steps_syncpack.util.request_params``
* **External packages:** ``ipaascommon``

.. include:: /_step_notes/GetREST.rst