.. _step-DeleteREST:


DeleteREST
==========

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

.. versionadded:: 1.5.0

* **Friendly name:** ``DeleteREST``
* **Step class:** ``base_steps_syncpack.steps.DeleteREST.DeleteREST``
* **Step version:** ``1.0.1``
* **Required parameters:** ``prefix_url``

Parameters
----------

This step adds no parameters of its own. It accepts exactly the
parameters of :ref:`step-HTTPBaseStep`.

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:** ``DeleteREST`` -> ``HTTPBaseStep`` -> ``BaseStep`` -> ``Serializable``
* **SyncPack modules:** ``base_steps_syncpack.steps.HTTPBaseStep``
* **External packages:** ``ipaascommon``

.. include:: /_step_notes/DeleteREST.rst