.. AUTO-GENERATED FILE. DO NOT EDIT.

one-entity-desktop-application-access-patch-one
===============================================

Source
------

- Repository: ``jef-systems/jef-one-backend``
- Source Run ID: ``25256541517``
- Source SHA: ``944e655286e0c87c6e611453ffc46df43159a83d``
- Module: ``one``
- Documentation Scope: ``async``
- Lambda: ``jef-one-patch-8``

Endpoint
--------

- API Name: ``jef-one``
- Action Name: ``patch``
- Method: ``PATCH``
- Scope Label: ``Async``
- Resource Path: ``/one-entity-desktop-application-access-patch-one``
- Complete Endpoint: ``https://mfr670zvsh.execute-api.ap-southeast-1.amazonaws.com/prod/one-entity-desktop-application-access-patch-one``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-one-patch-8``
- curl payload mode: ``json_body``

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

.. code-block:: text

   Function: jef-one-patch-8
   Module: jef-one
   Action: patch
   Method: PATCH
   Invocation Mode: ASYNC
   Resource Path: /one-entity-desktop-application-access-patch-one
   
   API Gateway Response:
   - status_code: 202
   - message: Request accepted for asynchronous processing.
   
   Table:
   - table: jef-one-entity-desktop-application-access
   
   Payload Example:
   - pk: ENTITY-001
   - sk: DESKTOP-APP-001
   - gsi_1_pk: DESKTOP-APP-001
   - gsi_1_sk: ENTITY-001
   - entity_number: ENTITY-001
   - desktop_application_number: DESKTOP-APP-001
   - is_active: True
   
   Payload Schema:
   - pk: string-{entity_number}
   - sk: string-{desktop_application_number}
   - gsi_1_pk: string-{desktop_application_number}
   - gsi_1_sk: string-{entity_number}
   - entity_number: string
   - desktop_application_number: string
   - is_active: boolean
   
   Response Schema:
   - is_accepted: boolean
   - message: string

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

.. code-block:: json

   {
     "pk": "ENTITY-001",
     "sk": "DESKTOP-APP-001",
     "gsi_1_pk": "DESKTOP-APP-001",
     "gsi_1_sk": "ENTITY-001",
     "entity_number": "ENTITY-001",
     "desktop_application_number": "DESKTOP-APP-001",
     "is_active": "True"
   }

Response
--------

.. code-block:: json

   {
     "is_accepted": "boolean",
     "message": "string"
   }

CMD curl
--------

.. code-block:: text

   curl -X PATCH "https://mfr670zvsh.execute-api.ap-southeast-1.amazonaws.com/prod/one-entity-desktop-application-access-patch-one" -H "Content-Type: application/json" --data-raw "{\"pk\": \"ENTITY-001\", \"sk\": \"DESKTOP-APP-001\", \"gsi_1_pk\": \"DESKTOP-APP-001\", \"gsi_1_sk\": \"ENTITY-001\", \"entity_number\": \"ENTITY-001\", \"desktop_application_number\": \"DESKTOP-APP-001\", \"is_active\": true}"

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

.. code-block:: text

   curl.exe -X PATCH "https://mfr670zvsh.execute-api.ap-southeast-1.amazonaws.com/prod/one-entity-desktop-application-access-patch-one" -H "Content-Type: application/json" --data-raw '{"pk": "ENTITY-001", "sk": "DESKTOP-APP-001", "gsi_1_pk": "DESKTOP-APP-001", "gsi_1_sk": "ENTITY-001", "entity_number": "ENTITY-001", "desktop_application_number": "DESKTOP-APP-001", "is_active": true}'