.. include:: ../common.txt
.. include:: ../links.txt


###############
Getting Started
###############

The Getting Started Guide introduces key tools and concepts to be understood
before using the |TOOLKIT_REST|. Below, you will find the links and references
needed to introduce and begin usage of the |TOOLKIT_REST|.


*************
Prerequisites
*************

Before using the |TOOLKIT_REST| for development, you should know what the
|SNIPPET_FRAMEWORK| is by reviewing the `Getting Started`_ guide of the
|SNIPPET_FRAMEWORK| (aka silo_low_code). That section walks you through what
you need to know to begin developing with this and other toolkits.


********
Overview
********

The |TOOLKIT_REST| PowerPack is an extension of the |SNIPPET_FRAMEWORK| for
building REST based Dynamic Applications in a low-code manner.

The |TOOLKIT_REST| PowerPack includes:

    * An execution environment with REST and other standard steps necessary
      for REST Dynamic Application development.

    * A template Dynamic Application that demonstrates the REST steps.

    * Support for basic authentication APIs.

    * This toolkit PowerPack is also the end-product of what one would build
      when following the |SNIPPET_FRAMEWORK| `Development tutorial`_.


***************************
Authentication Capabilities
***************************

The |TOOLKIT_REST| following authentication schemas are supported
out-of-the-box:

    * Basic
    * Token Bearer
    * API Key
    * Oauth2

        * Client credentials grant type
        * Resource owner password credentials grant type


Refer to :ref:`Authentication` for an in-depth overview on how to use the different
authenticators.


*******************************
Converting from REST PowerPack
*******************************

While the REST PowerPack and |TOOLKIT_REST| share the concept of
low-code for development, the results of execution are not 1:1.
The |TOOLKIT_REST| uses different indices than the REST PowerPack.
This will cause the existing Dynamic Application to have new
indices and the historical data will be lost. If you wish to
maintain the same indices of the REST PowerPack, you must create
a step that stores the data as a dictionary where the dictionary
keys align with the indices from the REST PowerPack.

***************
Troubleshooting
***************

If you encounter issues while using the |TOOLKIT_REST| or |SNIPPET_FRAMEWORK|,
you can find additional information at `Logging/Debugging`_.


************
Known Issues
************

Some fields may display incorrectly when a user changes a previously selected
``Authentication Type`` to a new type in the REST Snippet Framework credential.
To correct these fields, you must close out the in-progress configuration of
the credential without saving. Then, re-open and select the desired
``Authentication Type``.