.. AUTO-GENERATED FILE. DO NOT EDIT. /playstore-entities-patch-one ============================= Summary ------- - **Source repository:** ``jef-systems/jef-playstore-backend`` - **Source SHA:** ``17cb66a1825b9b2d8d46bf7a947bb061bb54c607`` - **Source run id:** ``29052735793`` - **Lambda function:** ``jef-playstore-entities-patch-one`` - **HTTP method:** ``PATCH`` - **API path:** ``/playstore/async-patch/playstore-entities-patch-one`` - **Endpoint URL:** ``https://api.jefoffice.com/playstore/async-patch/playstore-entities-patch-one`` - **Payload mode:** ``json-body`` Description ----------- .. list-table:: :widths: 30 70 * - ``Function`` - jef-playstore-entities-patch-one Logical ID: jef-playstore:jef-playstore-entities:patch-one Order Number: 004 * - ``Module`` - jef-playstore * - ``Action`` - patch-one * - ``Method`` - PATCH * - ``Invocation Mode`` - ASYNC * - ``Resource Path`` - /playstore-entities-patch-one Endpoint Name: jef-playstore-entities-patch-one * - ``Table`` - jef-playstore-entities * - ``Primary Key`` - entity\_id API Gateway Response -------------------- .. list-table:: :widths: 30 70 * - ``status\_code`` - 202 * - ``message`` - Request accepted for asynchronous processing. Payload Example --------------- .. list-table:: :widths: 30 70 * - ``entity\_id`` - db44efff-222d-4cb9-a5d4-2aee7e506854 * - ``domain\_id`` - 258bca24-1ba3-42c0-88a2-827849b164de 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-playstore-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.domain_id.field": "domain_id", "properties.domain_id.type": "S", "properties.domain_id.required": "True", "properties.domain_id.source_required": "True", "properties.domain_id.server_generated": "True", "properties.domain_id.autogenerated": "False", "properties.domain_id.frontend_autocomputed": "False", "properties.domain_id.format": "uuidv4", "properties.domain_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": "^\\d{1,20}$", "properties.name.field": "name", "properties.name.type": "S", "properties.name.required": "True", "properties.name.source_required": "True", "properties.name.server_generated": "False", "properties.name.autogenerated": "False", "properties.name.frontend_autocomputed": "False", "properties.name.regex": "^[A-Za-z0-9 ._@:/#,+&()_-]{1,160}$", "children[0].parent_table": "jef-playstore-entities", "children[0].child_table": "jef-playstore-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-playstore-allowed-applications", "children[0].aliases[1]": "allowed-applications", "children[0].aliases[2]": "playstore-allowed-applications", "children[0].aliases[3]": "jef_playstore_allowed_applications", "children[0].aliases[4]": "allowed_applications", "children[0].aliases[5]": "playstore_allowed_applications", "children[0].aliases[6]": "applications", "patch.semantic_patch_version": "patch-ignore-immutable-v2", "patch.allowed_fields[0]": "entity_id", "patch.allowed_fields[1]": "domain_id", "patch.allowed_fields[2]": "entity_number", "patch.allowed_fields[3]": "name", "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.domain_id.field": "domain_id", "patch.editable_attributes.domain_id.type": "S", "patch.editable_attributes.domain_id.required": "True", "patch.editable_attributes.domain_id.source_required": "True", "patch.editable_attributes.domain_id.server_generated": "True", "patch.editable_attributes.domain_id.autogenerated": "False", "patch.editable_attributes.domain_id.frontend_autocomputed": "False", "patch.editable_attributes.domain_id.format": "uuidv4", "patch.editable_attributes.domain_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": "^\\d{1,20}$", "patch.editable_attributes.name.field": "name", "patch.editable_attributes.name.type": "S", "patch.editable_attributes.name.required": "True", "patch.editable_attributes.name.source_required": "True", "patch.editable_attributes.name.server_generated": "False", "patch.editable_attributes.name.autogenerated": "False", "patch.editable_attributes.name.frontend_autocomputed": "False", "patch.editable_attributes.name.regex": "^[A-Za-z0-9 ._@:/#,+&()_-]{1,160}$", "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.domain_id.field": "domain_id", "root.attributes.domain_id.type": "S", "root.attributes.domain_id.required": "True", "root.attributes.domain_id.source_required": "True", "root.attributes.domain_id.server_generated": "True", "root.attributes.domain_id.autogenerated": "False", "root.attributes.domain_id.frontend_autocomputed": "False", "root.attributes.domain_id.format": "uuidv4", "root.attributes.domain_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": "^\\d{1,20}$", "root.attributes.name.field": "name", "root.attributes.name.type": "S", "root.attributes.name.required": "True", "root.attributes.name.source_required": "True", "root.attributes.name.server_generated": "False", "root.attributes.name.autogenerated": "False", "root.attributes.name.frontend_autocomputed": "False", "root.attributes.name.regex": "^[A-Za-z0-9 ._@:/#,+&()_-]{1,160}$" } 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": "db44efff-222d-4cb9-a5d4-2aee7e506854", "domain_id": "258bca24-1ba3-42c0-88a2-827849b164de" } 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://api.jefoffice.com/playstore/playstore-entities-patch-one" -H "Content-Type: application/json" --data-raw "{\"entity_id\": \"db44efff-222d-4cb9-a5d4-2aee7e506854\", \"domain_id\": \"258bca24-1ba3-42c0-88a2-827849b164de\"}" PowerShell curl --------------- .. code-block:: powershell curl.exe -X PATCH "https://api.jefoffice.com/playstore/playstore-entities-patch-one" -H "Content-Type: application/json" --data-raw '{"entity_id": "db44efff-222d-4cb9-a5d4-2aee7e506854", "domain_id": "258bca24-1ba3-42c0-88a2-827849b164de"}'