:orphan:

.. role:: json(code)
   :language: json

.. role:: python(code)
   :language: python

.. _pages:

Pages API
=========

.. contents:: :depth: 3


Endpoints
#########

Get Pages
---------

.. code::

    GET /core/v1/pages


200 OK
******

.. code:: json

    {
      "pages": [
        {
          "id": "65ac9cd5ffbb0054ec62a7a7",
          "path": "st/Custom_Page_1",
          "layout": "Custom_Page_1",
          "scenario": {
            "__version__": 1,
            "steps": []
          }
        },
        ...
      ]
    }


Create Page
-----------

.. code::

    POST /core/v1/pages

.. code:: json

    {
      "id": "65ac9cd5ffbb0054ec62a7a7",
      "path": "st/Custom_Page_1",
      "layout": "Custom_Page_1",
      "scenario": {
        "__version__": 1,
        "steps": []
      }
    }

200 OK
******

.. code:: json

    {
      "page": {
        "id": "65ac9cd5ffbb0054ec62a7a7",
        "path": "st/Custom_Page_1",
        "layout": "Custom_Page_1",
        "scenario": {
          "__version__": 1,
          "steps": []
        }
      }
    }


Get Page
-----------

.. code::

    GET /core/v1/pages/65ac9cd5ffbb0054ec62a7a7

200 OK
******

.. code:: json

    {
      "page": {
        "id": "65ac9cd5ffbb0054ec62a7a7",
        "path": "st/Custom_Page_1",
        "layout": "Custom_Page_1",
        "scenario": {
          "__version__": 1,
          "steps": []
        }
      }
    }


Update Page
--------------

.. code::

    PUT /core/v1/pages/65ac9cd5ffbb0054ec62a7a7

.. code:: json

    {
      "id": "65ac9cd5ffbb0054ec62a7a7",
      "path": "path/to/custom/page/1",
      "layout": "Generic_Custom_Page_Layout",
      "scenario": {
        "__version__": 1,
        "steps": [
          {
            "$assign": {
              "custom_page_no": 1
            }
          }
        ]
      }
    }

200 OK
******

.. code:: json

    {
      "page": {
        "id": "65ac9cd5ffbb0054ec62a7a7",
        "path": "path/to/custom/page/1",
        "layout": "Generic_Custom_Page_Layout",
        "scenario": {
          "__version__": 1,
          "steps": [
            {
              "$assign": {
                "custom_page_no": 1
              }
            }
          ]
        }
      }
    }


Remove Page
-----------

.. code::

    DELETE /core/v1/pages/65ac9cd5ffbb0054ec62a7a7

200 OK
******

.. code:: json

    {}