.. AUTO-GENERATED FILE. DO NOT EDIT.

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

Summary
-------

- **Source repository:** ``jef-systems/jef-desktop-store-backend``
- **Source SHA:** ``e232be4906186f04feaa615c6305547117289c31``
- **Source run id:** ``30188645608``
- **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 Sync No Package GET APIs``
- **API path:** ``/desktop-store/complex-sync-no-packages/jef-desktop-store-get-allowed-desktop-apps-by-entity-number``
- **Endpoint URL:** ``https://api.jefoffice.com/desktop-store/complex-sync-no-packages/jef-desktop-store-get-allowed-desktop-apps-by-entity-number``
- **Documentation scope:** ``lambda-complex-sync-no-packages``

Synchronous Lambda Complex Rule
-------------------------------

This API is documented as a synchronous Lambda complex no-package API.
API Gateway waits for the Lambda result and returns the final Lambda response.

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

Returns domain-authorized applications and performs metadata-only release validation without per-application S3 calls.

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

.. code-block:: json

   {
     "entity_number": "1109",
     "include_inactive": false,
     "limit": 100
   }

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

.. code-block:: json

   {
     "root": {
       "type": "M",
       "required": true,
       "attributes": {
         "entity_number": {
           "type": "S",
           "required": true,
           "regex": "^[0-9]{4}$"
         },
         "application_domain_id": {
           "type": "S",
           "required": false,
           "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}$"
         },
         "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
         },
         "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,
           "integer": true
         },
         "failure_code": {
           "type": "S",
           "required": false
         },
         "failure_reason": {
           "type": "S",
           "required": false
         },
         "entity_found": {
           "type": "BOOL",
           "required": true
         },
         "entity_active": {
           "type": "BOOL",
           "required": true
         },
         "application_domain_found": {
           "type": "BOOL",
           "required": true
         },
         "application_domain_active": {
           "type": "BOOL",
           "required": true
         },
         "application_domain_id": {
           "type": "S",
           "required": false
         },
         "application_domain_name": {
           "type": "S",
           "required": false
         },
         "application_domain": {
           "type": "M",
           "required": false,
           "attributes": {
             "application_domain_id": {
               "type": "S",
               "required": false
             },
             "application_domain_name": {
               "type": "S",
               "required": false
             },
             "is_active": {
               "type": "BOOL",
               "required": false
             },
             "created": {
               "type": "S",
               "required": false
             },
             "updated": {
               "type": "S",
               "required": false
             }
           }
         },
         "entity_number": {
           "type": "S",
           "required": false
         },
         "entity": {
           "type": "M",
           "required": false,
           "attributes": {
             "entity_id": {
               "type": "S",
               "required": false
             },
             "application_domain_id": {
               "type": "S",
               "required": false
             },
             "application_domain_name": {
               "type": "S",
               "required": false
             },
             "entity_number": {
               "type": "S",
               "required": false
             },
             "entity_name": {
               "type": "S",
               "required": false
             },
             "entity_type": {
               "type": "S",
               "required": false
             },
             "is_active": {
               "type": "BOOL",
               "required": false
             },
             "created": {
               "type": "S",
               "required": false
             },
             "updated": {
               "type": "S",
               "required": false
             }
           }
         },
         "allowed_application_count": {
           "type": "N",
           "required": false,
           "integer": true
         },
         "skipped_allowed_application_count": {
           "type": "N",
           "required": false,
           "integer": true
         },
         "allowed_applications": {
           "type": "L",
           "required": false,
           "items": {
             "type": "M",
             "required": false,
             "attributes": {
               "allowed_application_id": {
                 "type": "S",
                 "required": false
               },
               "application_domain_id": {
                 "type": "S",
                 "required": false
               },
               "application_domain_name": {
                 "type": "S",
                 "required": false
               },
               "application_id": {
                 "type": "S",
                 "required": false
               },
               "entity_id": {
                 "type": "S",
                 "required": false
               },
               "entity_number": {
                 "type": "S",
                 "required": false
               },
               "application_name": {
                 "type": "S",
                 "required": false
               },
               "is_active": {
                 "type": "BOOL",
                 "required": false
               },
               "created": {
                 "type": "S",
                 "required": false
               },
               "updated": {
                 "type": "S",
                 "required": false
               },
               "is_allowed": {
                 "type": "BOOL",
                 "required": false
               },
               "application_found": {
                 "type": "BOOL",
                 "required": false
               },
               "application_active": {
                 "type": "BOOL",
                 "required": false
               },
               "skip_reason": {
                 "type": "S",
                 "required": false
               },
               "application": {
                 "type": "M",
                 "required": false,
                 "attributes": {
                   "application_id": {
                     "type": "S",
                     "required": false
                   },
                   "application_domain_id": {
                     "type": "S",
                     "required": false
                   },
                   "application_domain_name": {
                     "type": "S",
                     "required": false
                   },
                   "application_name": {
                     "type": "S",
                     "required": false
                   },
                   "display_name": {
                     "type": "S",
                     "required": false
                   },
                   "version": {
                     "type": "S",
                     "required": false
                   },
                   "platform": {
                     "type": "S",
                     "required": false
                   },
                   "installer_type": {
                     "type": "S",
                     "required": false
                   },
                   "s3_key": {
                     "type": "S",
                     "required": false
                   },
                   "is_active": {
                     "type": "BOOL",
                     "required": false
                   },
                   "created": {
                     "type": "S",
                     "required": false
                   },
                   "updated": {
                     "type": "S",
                     "required": false
                   },
                   "published_version": {
                     "type": "S",
                     "required": false
                   },
                   "is_downloadable": {
                     "type": "BOOL",
                     "required": false
                   },
                   "release_contract_valid": {
                     "type": "BOOL",
                     "required": false
                   },
                   "release_status": {
                     "type": "S",
                     "required": false
                   },
                   "release_failure_code": {
                     "type": "S",
                     "required": false
                   },
                   "installer_file_name": {
                     "type": "S",
                     "required": false
                   },
                   "file_extension": {
                     "type": "S",
                     "required": false
                   },
                   "s3_bucket": {
                     "type": "S",
                     "required": false
                   }
                 }
               },
               "is_downloadable": {
                 "type": "BOOL",
                 "required": false
               },
               "release_contract_valid": {
                 "type": "BOOL",
                 "required": false
               },
               "release_status": {
                 "type": "S",
                 "required": false
               },
               "release_failure_code": {
                 "type": "S",
                 "required": false
               },
               "published_version": {
                 "type": "S",
                 "required": false
               },
               "installer_file_name": {
                 "type": "S",
                 "required": false
               }
             }
           }
         },
         "skipped_allowed_applications": {
           "type": "L",
           "required": false,
           "items": {
             "type": "M",
             "required": false,
             "attributes": {
               "allowed_application_id": {
                 "type": "S",
                 "required": false
               },
               "application_domain_id": {
                 "type": "S",
                 "required": false
               },
               "application_domain_name": {
                 "type": "S",
                 "required": false
               },
               "application_id": {
                 "type": "S",
                 "required": false
               },
               "entity_id": {
                 "type": "S",
                 "required": false
               },
               "entity_number": {
                 "type": "S",
                 "required": false
               },
               "application_name": {
                 "type": "S",
                 "required": false
               },
               "is_active": {
                 "type": "BOOL",
                 "required": false
               },
               "created": {
                 "type": "S",
                 "required": false
               },
               "updated": {
                 "type": "S",
                 "required": false
               },
               "is_allowed": {
                 "type": "BOOL",
                 "required": false
               },
               "application_found": {
                 "type": "BOOL",
                 "required": false
               },
               "application_active": {
                 "type": "BOOL",
                 "required": false
               },
               "skip_reason": {
                 "type": "S",
                 "required": false
               },
               "application": {
                 "type": "M",
                 "required": false,
                 "attributes": {
                   "application_id": {
                     "type": "S",
                     "required": false
                   },
                   "application_domain_id": {
                     "type": "S",
                     "required": false
                   },
                   "application_domain_name": {
                     "type": "S",
                     "required": false
                   },
                   "application_name": {
                     "type": "S",
                     "required": false
                   },
                   "display_name": {
                     "type": "S",
                     "required": false
                   },
                   "version": {
                     "type": "S",
                     "required": false
                   },
                   "platform": {
                     "type": "S",
                     "required": false
                   },
                   "installer_type": {
                     "type": "S",
                     "required": false
                   },
                   "s3_key": {
                     "type": "S",
                     "required": false
                   },
                   "is_active": {
                     "type": "BOOL",
                     "required": false
                   },
                   "created": {
                     "type": "S",
                     "required": false
                   },
                   "updated": {
                     "type": "S",
                     "required": false
                   },
                   "published_version": {
                     "type": "S",
                     "required": false
                   },
                   "is_downloadable": {
                     "type": "BOOL",
                     "required": false
                   },
                   "release_contract_valid": {
                     "type": "BOOL",
                     "required": false
                   },
                   "release_status": {
                     "type": "S",
                     "required": false
                   },
                   "release_failure_code": {
                     "type": "S",
                     "required": false
                   },
                   "installer_file_name": {
                     "type": "S",
                     "required": false
                   },
                   "file_extension": {
                     "type": "S",
                     "required": false
                   },
                   "s3_bucket": {
                     "type": "S",
                     "required": false
                   }
                 }
               },
               "is_downloadable": {
                 "type": "BOOL",
                 "required": false
               },
               "release_contract_valid": {
                 "type": "BOOL",
                 "required": false
               },
               "release_status": {
                 "type": "S",
                 "required": false
               },
               "release_failure_code": {
                 "type": "S",
                 "required": false
               },
               "published_version": {
                 "type": "S",
                 "required": false
               },
               "installer_file_name": {
                 "type": "S",
                 "required": false
               }
             }
           }
         },
         "include_inactive": {
           "type": "BOOL",
           "required": false
         },
         "limit": {
           "type": "N",
           "required": false,
           "integer": true
         },
         "metadata_warning_count": {
           "type": "N",
           "required": false,
           "integer": true
         },
         "metadata_warnings": {
           "type": "L",
           "required": false,
           "items": {
             "type": "M",
             "required": false,
             "attributes": {
               "code": {
                 "type": "S",
                 "required": true
               },
               "record_type": {
                 "type": "S",
                 "required": true
               },
               "record_id": {
                 "type": "S",
                 "required": true
               },
               "field": {
                 "type": "S",
                 "required": true
               }
             }
           }
         },
         "downloadable_application_count": {
           "type": "N",
           "required": false,
           "integer": true
         },
         "invalid_release_application_count": {
           "type": "N",
           "required": false,
           "integer": true
         }
       }
     }
   }

CMD curl
--------

.. code-block:: bat

   curl.exe -X GET "https://api.jefoffice.com/desktop-store/complex-sync-no-packages/jef-desktop-store-get-allowed-desktop-apps-by-entity-number"

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

.. code-block:: powershell

   curl.exe -X GET "https://api.jefoffice.com/desktop-store/complex-sync-no-packages/jef-desktop-store-get-allowed-desktop-apps-by-entity-number"