:py:mod:`airflow.providers.salesforce.operators.salesforce_apex_rest`
=====================================================================

.. py:module:: airflow.providers.salesforce.operators.salesforce_apex_rest


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   airflow.providers.salesforce.operators.salesforce_apex_rest.SalesforceApexRestOperator


.. py:class:: SalesforceApexRestOperator(*, endpoint, method = 'GET', payload, salesforce_conn_id = 'salesforce_default', **kwargs)

   Bases: :py:obj:`airflow.models.BaseOperator`

   Execute a APEX Rest API action

   .. seealso::
       For more information on how to use this operator, take a look at the guide:
       :ref:`howto/operator:SalesforceApexRestOperator`

   :param endpoint: The REST endpoint for the request.
   :param method: HTTP method for the request (default GET)
   :param payload: A dict of parameters to send in a POST / PUT request
   :param salesforce_conn_id: The :ref:`Salesforce Connection id <howto/connection:SalesforceHook>`.

   .. py:method:: execute(self, context)

      Makes an HTTP request to an APEX REST endpoint and pushes results to xcom.
      :param context: The task context during execution.
      :return: Apex response
      :rtype: dict