.. AUTO-GENERATED FILE. DO NOT EDIT.

Get allowed desktop apps by entity number
=========================================

Summary
-------

- **Source repository:** ``jef-systems/jef-desktop-store-backend``
- **Source SHA:** ``d1284a9edc0941be3dbeb4c724fff6eb9bda6288``
- **Source run id:** ``28543308430``
- **Module:** ``Desktop-store``
- **Lambda function:** ``jef-desktop-store-get-allowed-desktop-apps-by-entity-number``
- **HTTP method:** ``GET``
- **Invocation mode:** ``sync``
- **Package mode:** ``no-package``
- **API category:** ``Desktop-store Complex No Package Sync GET APIs``
- **API path:** ``/jef-desktop-store-get-allowed-desktop-apps-by-entity-number``
- **Endpoint URL:** ``https://u91anelyve.execute-api.ap-southeast-1.amazonaws.com/prod/jef-desktop-store-get-allowed-desktop-apps-by-entity-number?entity\_number=1109``
- **Documentation scope:** ``lambda-complex-no-packages``

Sync Read Rule
--------------

This GET API is documented as a direct synchronous read path.

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

Complex no-packages Lambda that resolves entity\_number to entity, allowed desktop application links, and full desktop application details.

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

.. code-block:: json

   {
     "entity_number": "1109"
   }

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

.. code-block:: json

   {
     "root": {
       "type": "M",
       "required": true,
       "attributes": {
         "entity_number": {
           "type": "S",
           "required": true,
           "regex": "^[0-9]{4}$"
         },
         "include_inactive": {
           "type": "BOOL",
           "required": false
         },
         "limit": {
           "type": "N",
           "required": false
         }
       }
     }
   }

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

.. code-block:: json

   {
     "root": {
       "type": "M",
       "required": true,
       "attributes": {
         "is_accepted": {
           "type": "BOOL",
           "required": true
         },
         "is_valid": {
           "type": "BOOL",
           "required": true
         },
         "can_continue": {
           "type": "BOOL",
           "required": true
         },
         "entity_found": {
           "type": "BOOL",
           "required": true
         },
         "entity_active": {
           "type": "BOOL",
           "required": true
         },
         "message_type": {
           "type": "S",
           "required": true
         },
         "message": {
           "type": "S",
           "required": true
         },
         "next_action": {
           "type": "S",
           "required": true
         },
         "operation": {
           "type": "S",
           "required": true
         },
         "status_code": {
           "type": "N",
           "required": true
         },
         "entity_number": {
           "type": "S",
           "required": false
         },
         "entity": {
           "type": "M",
           "required": false
         },
         "allowed_application_count": {
           "type": "N",
           "required": false
         },
         "skipped_allowed_application_count": {
           "type": "N",
           "required": false
         },
         "allowed_applications": {
           "type": "L",
           "required": false
         },
         "skipped_allowed_applications": {
           "type": "L",
           "required": false
         },
         "include_inactive": {
           "type": "BOOL",
           "required": false
         },
         "limit": {
           "type": "N",
           "required": false
         },
         "failure_code": {
           "type": "S",
           "required": false
         },
         "failure_reason": {
           "type": "S",
           "required": false
         }
       }
     }
   }

CMD curl
--------

.. code-block:: bat

   curl -X GET "https://u91anelyve.execute-api.ap-southeast-1.amazonaws.com/prod/jef-desktop-store-get-allowed-desktop-apps-by-entity-number?entity_number=1109"

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

.. code-block:: powershell

   curl.exe -X GET "https://u91anelyve.execute-api.ap-southeast-1.amazonaws.com/prod/jef-desktop-store-get-allowed-desktop-apps-by-entity-number?entity_number=1109"