.. AUTO-GENERATED FILE. DO NOT EDIT.

/one-entities-patch-one
=======================

Summary
-------

- **Source repository:** ``jef-systems/jef-one-backend``
- **Source SHA:** ``3270463a2e6a5d905ceae779f9a588fdde3cef87``
- **Source run id:** ``25887982658``
- **Lambda function:** ``jef-one-entities-patch-one``
- **HTTP method:** ``PATCH``
- **API path:** ``/one-entities-patch-one``
- **Endpoint URL:** ``https://mfr670zvsh.execute-api.ap-southeast-1.amazonaws.com/prod/one-entities-patch-one``
- **Payload mode:** ``json-body``

Description
-----------

- ``Function``: jef-one-entities-patch-one
- ``Module``: jef-one
- ``Action``: patch-one
- ``Method``: PATCH
- ``Invocation Mode``: ASYNC
- ``Resource Path``: /one-entities-patch-one
- ``Table``: jef-one-entities
- ``Primary Key``: entity\_id

API Gateway Response
--------------------

- ``status\_code``: 202
- ``message``: Request accepted for asynchronous processing.

Payload Example
---------------

- ``entity\_id``: d49b8a8c-30d9-4172-bb72-71855d5804c2
- ``entity\_number``: 1001
- ``name``: Jef One Entities - Metro Manila Trading
- ``children.entity\_desktop\_application\_access\[0\].entity\_desktop\_application\_access\_id``: ba6032c1-882e-4f20-bd06-3b4265e6f443
- ``children.entity\_desktop\_application\_access\[0\].entity\_id``: d49b8a8c-30d9-4172-bb72-71855d5804c2
- ``children.entity\_mobile\_application\_access\[0\].entity\_mobile\_application\_access\_id``: 8e8185ac-5d64-4378-9811-9ebfb4016461
- ``children.entity\_mobile\_application\_access\[0\].entity\_id``: d49b8a8c-30d9-4172-bb72-71855d5804c2
- ``children.entity\_mobile\_application\_access\[0\].mobile\_application\_id``: 16b06bf7-7f70-454d-8947-ab94fdb81ada

Payload Schema
--------------

.. code-block:: json

   {
     "root.type": "M",
     "root.required": "True",
     "root.attributes.entity_id.type": "S",
     "root.attributes.entity_id.required": "True",
     "root.attributes.entity_id.format": "uuidv4",
     "root.attributes.entity_id.regex": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
     "root.attributes.entity_number.type": "S",
     "root.attributes.entity_number.required": "False",
     "root.attributes.entity_number.regex": "^[A-Za-z0-9_-]{1,64}$",
     "root.attributes.name.type": "S",
     "root.attributes.name.required": "False",
     "root.attributes.name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
     "root.attributes.children.type": "M",
     "root.attributes.children.required": "False",
     "root.attributes.children.attributes.entity_desktop_application_access.type": "L",
     "root.attributes.children.attributes.entity_desktop_application_access.required": "False",
     "root.attributes.children.attributes.entity_desktop_application_access.items.type": "M",
     "root.attributes.children.attributes.entity_desktop_application_access.items.attributes.entity_desktop_application_access_id.type": "S",
     "root.attributes.children.attributes.entity_desktop_application_access.items.attributes.entity_desktop_application_access_id.required": "True",
     "root.attributes.children.attributes.entity_desktop_application_access.items.attributes.entity_desktop_application_access_id.format": "uuidv4",
     "root.attributes.children.attributes.entity_desktop_application_access.items.attributes.entity_desktop_application_access_id.regex": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
     "root.attributes.children.attributes.entity_desktop_application_access.items.attributes.entity_id.type": "S",
     "root.attributes.children.attributes.entity_desktop_application_access.items.attributes.entity_id.required": "False",
     "root.attributes.children.attributes.entity_desktop_application_access.items.attributes.entity_id.format": "uuidv4",
     "root.attributes.children.attributes.entity_desktop_application_access.items.attributes.entity_id.regex": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
     "root.attributes.children.attributes.entity_mobile_application_access.type": "L",
     "root.attributes.children.attributes.entity_mobile_application_access.required": "False",
     "root.attributes.children.attributes.entity_mobile_application_access.items.type": "M",
     "root.attributes.children.attributes.entity_mobile_application_access.items.attributes.entity_mobile_application_access_id.type": "S",
     "root.attributes.children.attributes.entity_mobile_application_access.items.attributes.entity_mobile_application_access_id.required": "True",
     "root.attributes.children.attributes.entity_mobile_application_access.items.attributes.entity_mobile_application_access_id.format": "uuidv4",
     "root.attributes.children.attributes.entity_mobile_application_access.items.attributes.entity_mobile_application_access_id.regex": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
     "root.attributes.children.attributes.entity_mobile_application_access.items.attributes.entity_id.type": "S",
     "root.attributes.children.attributes.entity_mobile_application_access.items.attributes.entity_id.required": "False",
     "root.attributes.children.attributes.entity_mobile_application_access.items.attributes.entity_id.format": "uuidv4",
     "root.attributes.children.attributes.entity_mobile_application_access.items.attributes.entity_id.regex": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
     "root.attributes.children.attributes.entity_mobile_application_access.items.attributes.mobile_application_id.type": "S",
     "root.attributes.children.attributes.entity_mobile_application_access.items.attributes.mobile_application_id.required": "False",
     "root.attributes.children.attributes.entity_mobile_application_access.items.attributes.mobile_application_id.format": "uuidv4",
     "root.attributes.children.attributes.entity_mobile_application_access.items.attributes.mobile_application_id.regex": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
   }

Response Schema
---------------

.. code-block:: json

   {
     "root.type": "M",
     "root.required": "True",
     "root.attributes.is_accepted.type": "BOOL",
     "root.attributes.is_accepted.required": "True",
     "root.attributes.message.type": "S",
     "root.attributes.message.required": "True",
     "root.attributes.request_id.type": "S",
     "root.attributes.request_id.required": "False"
   }

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

.. code-block:: json

   {
     "entity_id": "d49b8a8c-30d9-4172-bb72-71855d5804c2",
     "entity_number": "1001",
     "name": "Jef One Entities - Metro Manila Trading",
     "children.entity_desktop_application_access[0].entity_desktop_application_access_id": "ba6032c1-882e-4f20-bd06-3b4265e6f443",
     "children.entity_desktop_application_access[0].entity_id": "d49b8a8c-30d9-4172-bb72-71855d5804c2",
     "children.entity_mobile_application_access[0].entity_mobile_application_access_id": "8e8185ac-5d64-4378-9811-9ebfb4016461",
     "children.entity_mobile_application_access[0].entity_id": "d49b8a8c-30d9-4172-bb72-71855d5804c2",
     "children.entity_mobile_application_access[0].mobile_application_id": "16b06bf7-7f70-454d-8947-ab94fdb81ada"
   }

Response
--------

.. code-block:: json

   {
     "root.type": "M",
     "root.required": "True",
     "root.attributes.is_accepted.type": "BOOL",
     "root.attributes.is_accepted.required": "True",
     "root.attributes.message.type": "S",
     "root.attributes.message.required": "True",
     "root.attributes.request_id.type": "S",
     "root.attributes.request_id.required": "False"
   }

CMD curl
--------

.. code-block:: bat

   curl -X PATCH "https://mfr670zvsh.execute-api.ap-southeast-1.amazonaws.com/prod/one-entities-patch-one" -H "Content-Type: application/json" --data-raw "{\"entity_id\": \"d49b8a8c-30d9-4172-bb72-71855d5804c2\", \"entity_number\": \"1001\", \"name\": \"Jef One Entities - Metro Manila Trading\", \"children\": {\"entity_desktop_application_access\": [{\"entity_desktop_application_access_id\": \"ba6032c1-882e-4f20-bd06-3b4265e6f443\", \"entity_id\": \"d49b8a8c-30d9-4172-bb72-71855d5804c2\"}], \"entity_mobile_application_access\": [{\"entity_mobile_application_access_id\": \"8e8185ac-5d64-4378-9811-9ebfb4016461\", \"entity_id\": \"d49b8a8c-30d9-4172-bb72-71855d5804c2\", \"mobile_application_id\": \"16b06bf7-7f70-454d-8947-ab94fdb81ada\"}]}}"

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

.. code-block:: powershell

   curl.exe -X PATCH "https://mfr670zvsh.execute-api.ap-southeast-1.amazonaws.com/prod/one-entities-patch-one" -H "Content-Type: application/json" --data-raw '{"entity_id": "d49b8a8c-30d9-4172-bb72-71855d5804c2", "entity_number": "1001", "name": "Jef One Entities - Metro Manila Trading", "children": {"entity_desktop_application_access": [{"entity_desktop_application_access_id": "ba6032c1-882e-4f20-bd06-3b4265e6f443", "entity_id": "d49b8a8c-30d9-4172-bb72-71855d5804c2"}], "entity_mobile_application_access": [{"entity_mobile_application_access_id": "8e8185ac-5d64-4378-9811-9ebfb4016461", "entity_id": "d49b8a8c-30d9-4172-bb72-71855d5804c2", "mobile_application_id": "16b06bf7-7f70-454d-8947-ab94fdb81ada"}]}}'