.. AUTO-GENERATED FILE. DO NOT EDIT. /desktop-store-entities-patch-one ================================= Summary ------- - **Source repository:** ``jef-systems/jef-desktop-store-backend`` - **Source SHA:** ``bda92d5a75228490cc0e642f6d9127e2733d829e`` - **Source run id:** ``28367053347`` - **Lambda function:** ``jef-desktop-store-patch-002`` - **HTTP method:** ``PATCH`` - **API path:** ``/desktop-store-entities-patch-one`` - **Endpoint URL:** ``https://u91anelyve.execute-api.ap-southeast-1.amazonaws.com/prod/desktop-store-entities-patch-one`` - **Payload mode:** ``json-body`` Description ----------- .. list-table:: :widths: 30 70 * - ``Function`` - jef-desktop-store-patch-002 Logical ID: jef-desktop-store:jef-desktop-store-entities:patch-one Order Number: 001 * - ``Module`` - jef-desktop-store * - ``Action`` - patch-one * - ``Method`` - PATCH * - ``Invocation Mode`` - SYNCHRONOUS * - ``Resource Path`` - /desktop-store-entities-patch-one Endpoint Name: jef-desktop-store-entities-patch-one * - ``Table`` - jef-desktop-store-entities * - ``Primary Key`` - entity\_id API Gateway Response -------------------- .. list-table:: :widths: 30 70 * - ``status\_code`` - Lambda proxy statusCode * - ``message`` - Lambda response reflects commit success or failure. Payload Example --------------- .. list-table:: :widths: 30 70 * - ``entity\_id`` - 0934b9b7-7f9a-468c-8693-53d30edc4935 * - ``entity\_number`` - value-001 Payload Schema -------------- .. code-block:: json { "type": "object", "additionalProperties": "False", "payload_mode": "parent-plus-children-wrapper", "allow_children_wrapper": "True", "children_wrapper_field": "children", "allow_batch": "False", "table": "jef-desktop-store-entities", "primary_key": "entity_id", "required[0]": "entity_id", "properties.entity_id.field": "entity_id", "properties.entity_id.type": "S", "properties.entity_id.required": "False", "properties.entity_id.source_required": "True", "properties.entity_id.server_generated": "True", "properties.entity_id.autogenerated": "False", "properties.entity_id.frontend_autocomputed": "False", "properties.entity_id.format": "uuidv4", "properties.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}$", "properties.entity_number.field": "entity_number", "properties.entity_number.type": "S", "properties.entity_number.required": "True", "properties.entity_number.source_required": "True", "properties.entity_number.server_generated": "False", "properties.entity_number.autogenerated": "False", "properties.entity_number.frontend_autocomputed": "False", "properties.entity_number.regex": "^[0-9]{4}$", "properties.entity_name.field": "entity_name", "properties.entity_name.type": "S", "properties.entity_name.required": "True", "properties.entity_name.source_required": "True", "properties.entity_name.server_generated": "False", "properties.entity_name.autogenerated": "False", "properties.entity_name.frontend_autocomputed": "False", "properties.entity_name.regex": "^[A-Za-z0-9 ._-]{1,120}$", "properties.entity_type.field": "entity_type", "properties.entity_type.type": "S", "properties.entity_type.required": "True", "properties.entity_type.source_required": "True", "properties.entity_type.server_generated": "False", "properties.entity_type.autogenerated": "False", "properties.entity_type.frontend_autocomputed": "False", "properties.entity_type.regex": "^(store|company|branch|organization)$", "properties.is_active.field": "is_active", "properties.is_active.type": "BOOL", "properties.is_active.required": "False", "properties.is_active.source_required": "True", "properties.is_active.server_generated": "False", "properties.is_active.autogenerated": "False", "properties.is_active.frontend_autocomputed": "False", "properties.is_active.regex": "^(true|false)$", "children[0].parent_table": "jef-desktop-store-entities", "children[0].child_table": "jef-desktop-store-allowed-applications", "children[0].parent_key": "entity_id", "children[0].child_foreign_key": "entity_id", "children[0].child_index_name": "gsi_1", "children[0].child_index_key": "gsi_1_pk", "children[0].aliases[0]": "jef-desktop-store-allowed-applications", "children[0].aliases[1]": "allowed-applications", "children[0].aliases[2]": "desktop-store-allowed-applications", "children[0].aliases[3]": "jef_desktop_store_allowed_applications", "children[0].aliases[4]": "allowed_applications", "children[0].aliases[5]": "desktop_store_allowed_applications", "children[0].aliases[6]": "applications", "children[1].parent_table": "jef-desktop-store-entities", "children[1].child_table": "jef-desktop-store-download-history", "children[1].parent_key": "entity_id", "children[1].child_foreign_key": "entity_id", "children[1].child_index_name": "gsi_1", "children[1].child_index_key": "gsi_1_pk", "children[1].aliases[0]": "jef-desktop-store-download-history", "children[1].aliases[1]": "download-history", "children[1].aliases[2]": "desktop-store-download-history", "children[1].aliases[3]": "jef_desktop_store_download_history", "children[1].aliases[4]": "download_history", "children[1].aliases[5]": "desktop_store_download_history", "children[1].aliases[6]": "history", "patch.semantic_patch_version": "patch-ignore-immutable-v2", "patch.allowed_fields[0]": "entity_id", "patch.allowed_fields[1]": "entity_number", "patch.allowed_fields[2]": "entity_name", "patch.allowed_fields[3]": "entity_type", "patch.allowed_fields[4]": "is_active", "patch.ignored_fields[0]": "created", "patch.ignored_fields[1]": "created_at", "patch.ignored_fields[2]": "deleted_at", "patch.ignored_fields[3]": "idempotency_key", "patch.ignored_fields[4]": "is_deleted", "patch.ignored_fields[5]": "schema_version", "patch.ignored_fields[6]": "updated", "patch.ignored_fields[7]": "updated_at", "patch.editable_attributes.entity_id.field": "entity_id", "patch.editable_attributes.entity_id.type": "S", "patch.editable_attributes.entity_id.required": "False", "patch.editable_attributes.entity_id.source_required": "True", "patch.editable_attributes.entity_id.server_generated": "True", "patch.editable_attributes.entity_id.autogenerated": "False", "patch.editable_attributes.entity_id.frontend_autocomputed": "False", "patch.editable_attributes.entity_id.format": "uuidv4", "patch.editable_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}$", "patch.editable_attributes.entity_number.field": "entity_number", "patch.editable_attributes.entity_number.type": "S", "patch.editable_attributes.entity_number.required": "True", "patch.editable_attributes.entity_number.source_required": "True", "patch.editable_attributes.entity_number.server_generated": "False", "patch.editable_attributes.entity_number.autogenerated": "False", "patch.editable_attributes.entity_number.frontend_autocomputed": "False", "patch.editable_attributes.entity_number.regex": "^[0-9]{4}$", "patch.editable_attributes.entity_name.field": "entity_name", "patch.editable_attributes.entity_name.type": "S", "patch.editable_attributes.entity_name.required": "True", "patch.editable_attributes.entity_name.source_required": "True", "patch.editable_attributes.entity_name.server_generated": "False", "patch.editable_attributes.entity_name.autogenerated": "False", "patch.editable_attributes.entity_name.frontend_autocomputed": "False", "patch.editable_attributes.entity_name.regex": "^[A-Za-z0-9 ._-]{1,120}$", "patch.editable_attributes.entity_type.field": "entity_type", "patch.editable_attributes.entity_type.type": "S", "patch.editable_attributes.entity_type.required": "True", "patch.editable_attributes.entity_type.source_required": "True", "patch.editable_attributes.entity_type.server_generated": "False", "patch.editable_attributes.entity_type.autogenerated": "False", "patch.editable_attributes.entity_type.frontend_autocomputed": "False", "patch.editable_attributes.entity_type.regex": "^(store|company|branch|organization)$", "patch.editable_attributes.is_active.field": "is_active", "patch.editable_attributes.is_active.type": "BOOL", "patch.editable_attributes.is_active.required": "False", "patch.editable_attributes.is_active.source_required": "True", "patch.editable_attributes.is_active.server_generated": "False", "patch.editable_attributes.is_active.autogenerated": "False", "patch.editable_attributes.is_active.frontend_autocomputed": "False", "patch.editable_attributes.is_active.regex": "^(true|false)$", "root.type": "object", "root.attributes.entity_id.field": "entity_id", "root.attributes.entity_id.type": "S", "root.attributes.entity_id.required": "False", "root.attributes.entity_id.source_required": "True", "root.attributes.entity_id.server_generated": "True", "root.attributes.entity_id.autogenerated": "False", "root.attributes.entity_id.frontend_autocomputed": "False", "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.field": "entity_number", "root.attributes.entity_number.type": "S", "root.attributes.entity_number.required": "True", "root.attributes.entity_number.source_required": "True", "root.attributes.entity_number.server_generated": "False", "root.attributes.entity_number.autogenerated": "False", "root.attributes.entity_number.frontend_autocomputed": "False", "root.attributes.entity_number.regex": "^[0-9]{4}$", "root.attributes.entity_name.field": "entity_name", "root.attributes.entity_name.type": "S", "root.attributes.entity_name.required": "True", "root.attributes.entity_name.source_required": "True", "root.attributes.entity_name.server_generated": "False", "root.attributes.entity_name.autogenerated": "False", "root.attributes.entity_name.frontend_autocomputed": "False", "root.attributes.entity_name.regex": "^[A-Za-z0-9 ._-]{1,120}$", "root.attributes.entity_type.field": "entity_type", "root.attributes.entity_type.type": "S", "root.attributes.entity_type.required": "True", "root.attributes.entity_type.source_required": "True", "root.attributes.entity_type.server_generated": "False", "root.attributes.entity_type.autogenerated": "False", "root.attributes.entity_type.frontend_autocomputed": "False", "root.attributes.entity_type.regex": "^(store|company|branch|organization)$", "root.attributes.is_active.field": "is_active", "root.attributes.is_active.type": "BOOL", "root.attributes.is_active.required": "False", "root.attributes.is_active.source_required": "True", "root.attributes.is_active.server_generated": "False", "root.attributes.is_active.autogenerated": "False", "root.attributes.is_active.frontend_autocomputed": "False", "root.attributes.is_active.regex": "^(true|false)$" } Response Schema --------------- .. code-block:: json { "type": "object", "properties.ok.type": "boolean", "properties.accepted.type": "boolean", "properties.is_committed.type": "boolean", "properties.request_id.type": "string", "properties.message.type": "string", "properties.table.type": "string", "properties.operation.type": "string", "properties.primary_key.type": "string", "properties.primary_key_value.type": "string", "properties.item_update_count.type": "number", "properties.child_update_count.type": "number" } Request Payload --------------- .. code-block:: json { "entity_id": "0934b9b7-7f9a-468c-8693-53d30edc4935", "entity_number": "value-001" } Response -------- .. code-block:: json { "type": "object", "properties.ok.type": "boolean", "properties.accepted.type": "boolean", "properties.is_committed.type": "boolean", "properties.request_id.type": "string", "properties.message.type": "string", "properties.table.type": "string", "properties.operation.type": "string", "properties.primary_key.type": "string", "properties.primary_key_value.type": "string", "properties.item_update_count.type": "number", "properties.child_update_count.type": "number" } CMD curl -------- .. code-block:: bat curl -X PATCH "https://u91anelyve.execute-api.ap-southeast-1.amazonaws.com/prod/desktop-store-entities-patch-one" -H "Content-Type: application/json" --data-raw "{\"entity_id\": \"0934b9b7-7f9a-468c-8693-53d30edc4935\", \"entity_number\": \"value-001\"}" PowerShell curl --------------- .. code-block:: powershell curl.exe -X PATCH "https://u91anelyve.execute-api.ap-southeast-1.amazonaws.com/prod/desktop-store-entities-patch-one" -H "Content-Type: application/json" --data-raw '{"entity_id": "0934b9b7-7f9a-468c-8693-53d30edc4935", "entity_number": "value-001"}'