.. AUTO-GENERATED FILE. DO NOT EDIT.

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

Summary
-------

- **Source repository:** ``jef-systems/jef-one-backend``
- **Source SHA:** ``cabdf720f0e0bb4038428358fd150f2f95c55ff8``
- **Source run id:** ``26362915503``
- **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``: 1000
- ``entity\_name``: North Branch
- ``is\_active``: True
- ``created\_at``: 2026-05-24T13:38:18Z
- ``updated\_at``: 2026-05-24T13:38:18Z
- ``children.employees\[0\].employee\_id``: 14c92d5d-daa7-4ea9-9507-dd366304dbf2
- ``children.employees\[0\].entity\_id``: d49b8a8c-30d9-4172-bb72-71855d5804c2
- ``children.employees\[0\].entity\_number``: 1000
- ``children.employees\[0\].employee\_number``: 10000
- ``children.employees\[0\].display\_name``: Ramon Santos
- ``children.employees\[0\].employee\_password\_hash``: Sample text 001
- ``children.employees\[0\].is\_active``: True
- ``children.employees\[0\].created\_at``: 2026-05-24T13:38:18Z
- ``children.employees\[0\].updated\_at``: 2026-05-24T13:38:18Z

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": "^[0-9]{4}$",
     "root.attributes.entity_name.type": "S",
     "root.attributes.entity_name.required": "False",
     "root.attributes.entity_name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
     "root.attributes.is_active.type": "BOOL",
     "root.attributes.is_active.required": "False",
     "root.attributes.is_active.regex": "^(true|false)$",
     "root.attributes.created_at.type": "S",
     "root.attributes.created_at.required": "False",
     "root.attributes.created_at.format": "iso8601",
     "root.attributes.created_at.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
     "root.attributes.updated_at.type": "S",
     "root.attributes.updated_at.required": "False",
     "root.attributes.updated_at.format": "iso8601",
     "root.attributes.updated_at.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
     "root.attributes.children.type": "M",
     "root.attributes.children.required": "False",
     "root.attributes.children.attributes.employees.type": "L",
     "root.attributes.children.attributes.employees.required": "False",
     "root.attributes.children.attributes.employees.items.type": "M",
     "root.attributes.children.attributes.employees.items.attributes.employee_id.type": "S",
     "root.attributes.children.attributes.employees.items.attributes.employee_id.required": "True",
     "root.attributes.children.attributes.employees.items.attributes.employee_id.format": "uuidv4",
     "root.attributes.children.attributes.employees.items.attributes.employee_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.employees.items.attributes.entity_id.type": "S",
     "root.attributes.children.attributes.employees.items.attributes.entity_id.required": "False",
     "root.attributes.children.attributes.employees.items.attributes.entity_id.format": "uuidv4",
     "root.attributes.children.attributes.employees.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.employees.items.attributes.entity_number.type": "S",
     "root.attributes.children.attributes.employees.items.attributes.entity_number.required": "False",
     "root.attributes.children.attributes.employees.items.attributes.entity_number.regex": "^[0-9]{4}$",
     "root.attributes.children.attributes.employees.items.attributes.employee_number.type": "S",
     "root.attributes.children.attributes.employees.items.attributes.employee_number.required": "False",
     "root.attributes.children.attributes.employees.items.attributes.employee_number.regex": "^[0-9]{5}$",
     "root.attributes.children.attributes.employees.items.attributes.display_name.type": "S",
     "root.attributes.children.attributes.employees.items.attributes.display_name.required": "False",
     "root.attributes.children.attributes.employees.items.attributes.display_name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
     "root.attributes.children.attributes.employees.items.attributes.employee_password_hash.type": "S",
     "root.attributes.children.attributes.employees.items.attributes.employee_password_hash.required": "False",
     "root.attributes.children.attributes.employees.items.attributes.employee_password_hash.regex": "^.{1,500}$",
     "root.attributes.children.attributes.employees.items.attributes.is_active.type": "BOOL",
     "root.attributes.children.attributes.employees.items.attributes.is_active.required": "False",
     "root.attributes.children.attributes.employees.items.attributes.is_active.regex": "^(true|false)$",
     "root.attributes.children.attributes.employees.items.attributes.created_at.type": "S",
     "root.attributes.children.attributes.employees.items.attributes.created_at.required": "False",
     "root.attributes.children.attributes.employees.items.attributes.created_at.format": "iso8601",
     "root.attributes.children.attributes.employees.items.attributes.created_at.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
     "root.attributes.children.attributes.employees.items.attributes.updated_at.type": "S",
     "root.attributes.children.attributes.employees.items.attributes.updated_at.required": "False",
     "root.attributes.children.attributes.employees.items.attributes.updated_at.format": "iso8601",
     "root.attributes.children.attributes.employees.items.attributes.updated_at.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$"
   }

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": "1000",
     "entity_name": "North Branch",
     "is_active": "True",
     "created_at": "2026-05-24T13:38:18Z",
     "updated_at": "2026-05-24T13:38:18Z",
     "children.employees[0].employee_id": "14c92d5d-daa7-4ea9-9507-dd366304dbf2",
     "children.employees[0].entity_id": "d49b8a8c-30d9-4172-bb72-71855d5804c2",
     "children.employees[0].entity_number": "1000",
     "children.employees[0].employee_number": "10000",
     "children.employees[0].display_name": "Ramon Santos",
     "children.employees[0].employee_password_hash": "Sample text 001",
     "children.employees[0].is_active": "True",
     "children.employees[0].created_at": "2026-05-24T13:38:18Z",
     "children.employees[0].updated_at": "2026-05-24T13:38:18Z"
   }

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\": \"1000\", \"entity_name\": \"North Branch\", \"is_active\": true, \"created_at\": \"2026-05-24T13:38:18Z\", \"updated_at\": \"2026-05-24T13:38:18Z\", \"children\": {\"employees\": [{\"employee_id\": \"14c92d5d-daa7-4ea9-9507-dd366304dbf2\", \"entity_id\": \"d49b8a8c-30d9-4172-bb72-71855d5804c2\", \"entity_number\": \"1000\", \"employee_number\": \"10000\", \"display_name\": \"Ramon Santos\", \"employee_password_hash\": \"Sample text 001\", \"is_active\": true, \"created_at\": \"2026-05-24T13:38:18Z\", \"updated_at\": \"2026-05-24T13:38:18Z\"}]}}"

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": "1000", "entity_name": "North Branch", "is_active": true, "created_at": "2026-05-24T13:38:18Z", "updated_at": "2026-05-24T13:38:18Z", "children": {"employees": [{"employee_id": "14c92d5d-daa7-4ea9-9507-dd366304dbf2", "entity_id": "d49b8a8c-30d9-4172-bb72-71855d5804c2", "entity_number": "1000", "employee_number": "10000", "display_name": "Ramon Santos", "employee_password_hash": "Sample text 001", "is_active": true, "created_at": "2026-05-24T13:38:18Z", "updated_at": "2026-05-24T13:38:18Z"}]}}'