.. AUTO-GENERATED FILE. DO NOT EDIT.

get-entity-ingredients-list-by-entity
=====================================

Source
------

- Repository: ``jef-systems/jef-caferimo-backend``
- Module: ``caferimo``
- Documentation Scope: ``get``
- Lambda: ``jef-caferimo-get-4``

Endpoint
--------

- API Name: ``jef-caferimo``
- Action Name: ``get``
- Method: ``GET``
- Scope Label: ``GET``
- Resource Path: ``/get-entity-ingredients-list-by-entity``
- Complete Endpoint: ``https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/get-entity-ingredients-list-by-entity``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-caferimo-get-4``
- curl payload mode: ``query_string``

API Gateway Description
-----------------------

.. code-block:: text

   Function: jef-caferimo-get-4
   API Name: jef-caferimo
   Action: get
   Method: GET
   Resource Path: /get-entity-ingredients-list-by-entity
   
   Payload:
   - entity_number: string-4-digits-nonzerostart
   - limit: number-whole-number-optional
   - last_evaluated_key: string-optional
   
   Response:
   - exists: boolean
   - message: string
   - items: [{"pk":"string-{entity_number}#{jsin}","gsi_1_pk":"string-{entity_number}#{active}","gsi_1_sk":"string-product_name","entity_number":"string-4-digits-nonzerostart","jsin":"string","barcode":"string","product_name":"string","product_unit":"string","active":"boolean","on_hand_quantity":"number-two-decimals","reorder_level":"number-two-decimals-optional","unit_cost":"number-decimal-optional","notes":"string-optional","updated_at":"string-iso8601"}]
   - count: number-whole-number
   - last_evaluated_key: string-optional

Request Payload
---------------

.. code-block:: json

   {
     "entity_number": "string-4-digits-nonzerostart",
     "limit": "number-whole-number-optional",
     "last_evaluated_key": "string-optional"
   }

Response
--------

.. code-block:: json

   {
     "exists": "boolean",
     "message": "string",
     "items": "[{\"pk\":\"string-{entity_number}#{jsin}\",\"gsi_1_pk\":\"string-{entity_number}#{active}\",\"gsi_1_sk\":\"string-product_name\",\"entity_number\":\"string-4-digits-nonzerostart\",\"jsin\":\"string\",\"barcode\":\"string\",\"product_name\":\"string\",\"product_unit\":\"string\",\"active\":\"boolean\",\"on_hand_quantity\":\"number-two-decimals\",\"reorder_level\":\"number-two-decimals-optional\",\"unit_cost\":\"number-decimal-optional\",\"notes\":\"string-optional\",\"updated_at\":\"string-iso8601\"}]",
     "count": "number-whole-number",
     "last_evaluated_key": "string-optional"
   }

CMD curl
--------

.. code-block:: text

   curl "https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/get-entity-ingredients-list-by-entity?entity_number=string-4-digits-nonzerostart&limit=number-whole-number-optional&last_evaluated_key=string-optional"

PowerShell curl
---------------

.. code-block:: text

   curl.exe "https://lfyr4e0eqe.execute-api.ap-southeast-1.amazonaws.com/prod/get-entity-ingredients-list-by-entity?entity_number=string-4-digits-nonzerostart&limit=number-whole-number-optional&last_evaluated_key=string-optional"