/store-stores-patch-one¶
Summary¶
Source repository:
jef-systems/jef-store-backendSource SHA:
8268dc359b63dc3e4d3c8fbcf5f91c0628e40da2Source run id:
28375649454Lambda function:
jef-store-stores-patch-oneHTTP method:
PATCHAPI path:
/store-stores-patch-oneEndpoint URL:
https://dqo3268ty9.execute-api.ap-southeast-1.amazonaws.com/prod/store-stores-patch-onePayload mode:
json-body
Description¶
|
jef-store-stores-patch-one Logical ID: jef-store:jef-store-stores:patch-one Order Number: 005 |
|
jef-store |
|
patch-one |
|
PATCH |
|
SYNCHRONOUS |
|
/store-stores-patch-one Endpoint Name: jef-store-stores-patch-one |
|
jef-store-stores |
|
entity_number |
API Gateway Response¶
|
Lambda proxy statusCode |
|
Lambda response reflects commit success or failure. |
Payload Example¶
|
7e4ed9a6-c117-48df-9a24-1a2927bc2c93 |
|
Sample Name |
Payload Schema¶
{
"type": "object",
"additionalProperties": "False",
"payload_mode": "parent-plus-children-wrapper",
"allow_children_wrapper": "True",
"children_wrapper_field": "children",
"allow_batch": "False",
"table": "jef-store-stores",
"primary_key": "entity_number",
"required[0]": "entity_number",
"properties.entity_number.field": "entity_number",
"properties.entity_number.type": "S",
"properties.entity_number.required": "False",
"properties.entity_number.source_required": "True",
"properties.entity_number.server_generated": "True",
"properties.entity_number.autogenerated": "False",
"properties.entity_number.frontend_autocomputed": "False",
"properties.entity_number.format": "uuidv4",
"properties.entity_number.regex": "^[1-9a-fA-F][0-9a-fA-F]{7}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"properties.branch_name.field": "branch_name",
"properties.branch_name.type": "S",
"properties.branch_name.required": "True",
"properties.branch_name.source_required": "True",
"properties.branch_name.server_generated": "False",
"properties.branch_name.autogenerated": "False",
"properties.branch_name.frontend_autocomputed": "False",
"properties.branch_name.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"properties.store_name.field": "store_name",
"properties.store_name.type": "S",
"properties.store_name.required": "True",
"properties.store_name.source_required": "True",
"properties.store_name.server_generated": "False",
"properties.store_name.autogenerated": "False",
"properties.store_name.frontend_autocomputed": "False",
"properties.store_name.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"properties.store_legal_name.field": "store_legal_name",
"properties.store_legal_name.type": "S",
"properties.store_legal_name.required": "True",
"properties.store_legal_name.source_required": "True",
"properties.store_legal_name.server_generated": "False",
"properties.store_legal_name.autogenerated": "False",
"properties.store_legal_name.frontend_autocomputed": "False",
"properties.store_legal_name.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"properties.store_tagline.field": "store_tagline",
"properties.store_tagline.type": "S",
"properties.store_tagline.required": "True",
"properties.store_tagline.source_required": "True",
"properties.store_tagline.server_generated": "False",
"properties.store_tagline.autogenerated": "False",
"properties.store_tagline.frontend_autocomputed": "False",
"properties.store_tagline.regex": "^.{0,500}$",
"properties.address_line_1.field": "address_line_1",
"properties.address_line_1.type": "S",
"properties.address_line_1.required": "True",
"properties.address_line_1.source_required": "True",
"properties.address_line_1.server_generated": "False",
"properties.address_line_1.autogenerated": "False",
"properties.address_line_1.frontend_autocomputed": "False",
"properties.address_line_1.regex": "^.{0,500}$",
"properties.address_line_2.field": "address_line_2",
"properties.address_line_2.type": "S",
"properties.address_line_2.required": "True",
"properties.address_line_2.source_required": "True",
"properties.address_line_2.server_generated": "False",
"properties.address_line_2.autogenerated": "False",
"properties.address_line_2.frontend_autocomputed": "False",
"properties.address_line_2.regex": "^.{0,500}$",
"properties.city.field": "city",
"properties.city.type": "S",
"properties.city.required": "True",
"properties.city.source_required": "True",
"properties.city.server_generated": "False",
"properties.city.autogenerated": "False",
"properties.city.frontend_autocomputed": "False",
"properties.city.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"properties.province.field": "province",
"properties.province.type": "S",
"properties.province.required": "True",
"properties.province.source_required": "True",
"properties.province.server_generated": "False",
"properties.province.autogenerated": "False",
"properties.province.frontend_autocomputed": "False",
"properties.province.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"properties.postal_code.field": "postal_code",
"properties.postal_code.type": "S",
"properties.postal_code.required": "True",
"properties.postal_code.source_required": "True",
"properties.postal_code.server_generated": "False",
"properties.postal_code.autogenerated": "False",
"properties.postal_code.frontend_autocomputed": "False",
"properties.postal_code.regex": "^[A-Za-z0-9 -]{0,20}$",
"properties.country.field": "country",
"properties.country.type": "S",
"properties.country.required": "True",
"properties.country.source_required": "True",
"properties.country.server_generated": "False",
"properties.country.autogenerated": "False",
"properties.country.frontend_autocomputed": "False",
"properties.country.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"properties.contact_number.field": "contact_number",
"properties.contact_number.type": "S",
"properties.contact_number.required": "True",
"properties.contact_number.source_required": "True",
"properties.contact_number.server_generated": "False",
"properties.contact_number.autogenerated": "False",
"properties.contact_number.frontend_autocomputed": "False",
"properties.contact_number.regex": "^[0-9+() .-]{0,30}$",
"properties.email.field": "email",
"properties.email.type": "S",
"properties.email.required": "True",
"properties.email.source_required": "True",
"properties.email.server_generated": "False",
"properties.email.autogenerated": "False",
"properties.email.frontend_autocomputed": "False",
"properties.email.regex": "^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$",
"properties.website.field": "website",
"properties.website.type": "S",
"properties.website.required": "True",
"properties.website.source_required": "True",
"properties.website.server_generated": "False",
"properties.website.autogenerated": "False",
"properties.website.frontend_autocomputed": "False",
"properties.website.regex": "^[A-Za-z0-9 ._:/-]{1,240}$",
"properties.tin.field": "tin",
"properties.tin.type": "S",
"properties.tin.required": "True",
"properties.tin.source_required": "True",
"properties.tin.server_generated": "False",
"properties.tin.autogenerated": "False",
"properties.tin.frontend_autocomputed": "False",
"properties.tin.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"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": "True",
"properties.is_active.autogenerated": "False",
"properties.is_active.frontend_autocomputed": "False",
"properties.is_active.regex": "^(true|false)$",
"properties.version.field": "version",
"properties.version.type": "N",
"properties.version.required": "True",
"properties.version.source_required": "True",
"properties.version.server_generated": "False",
"properties.version.autogenerated": "False",
"properties.version.frontend_autocomputed": "False",
"properties.version.regex": "^\\d+$",
"children[0].parent_table": "jef-store-stores",
"children[0].child_table": "jef-store-application-preferences",
"children[0].parent_key": "entity_number",
"children[0].child_foreign_key": "entity_number",
"children[0].child_index_name": "gsi_1",
"children[0].child_index_key": "gsi_1_pk",
"children[0].aliases[0]": "jef-store-application-preferences",
"children[0].aliases[1]": "application-preferences",
"children[0].aliases[2]": "store-application-preferences",
"children[0].aliases[3]": "jef_store_application_preferences",
"children[0].aliases[4]": "application_preferences",
"children[0].aliases[5]": "store_application_preferences",
"children[0].aliases[6]": "preferences",
"children[1].parent_table": "jef-store-stores",
"children[1].child_table": "jef-store-attendances",
"children[1].parent_key": "entity_number",
"children[1].child_foreign_key": "entity_number",
"children[1].child_index_name": "gsi_1",
"children[1].child_index_key": "gsi_1_pk",
"children[1].aliases[0]": "jef-store-attendances",
"children[1].aliases[1]": "attendances",
"children[1].aliases[2]": "store-attendances",
"children[1].aliases[3]": "jef_store_attendances",
"children[1].aliases[4]": "store_attendances",
"children[2].parent_table": "jef-store-stores",
"children[2].child_table": "jef-store-auth-login-attempts",
"children[2].parent_key": "entity_number",
"children[2].child_foreign_key": "entity_number",
"children[2].child_index_name": "gsi_1",
"children[2].child_index_key": "gsi_1_pk",
"children[2].aliases[0]": "jef-store-auth-login-attempts",
"children[2].aliases[1]": "auth-login-attempts",
"children[2].aliases[2]": "store-auth-login-attempts",
"children[2].aliases[3]": "jef_store_auth_login_attempts",
"children[2].aliases[4]": "auth_login_attempts",
"children[2].aliases[5]": "store_auth_login_attempts",
"children[2].aliases[6]": "attempts",
"children[3].parent_table": "jef-store-stores",
"children[3].child_table": "jef-store-auth-sessions",
"children[3].parent_key": "entity_number",
"children[3].child_foreign_key": "entity_number",
"children[3].child_index_name": "gsi_1",
"children[3].child_index_key": "gsi_1_pk",
"children[3].aliases[0]": "jef-store-auth-sessions",
"children[3].aliases[1]": "auth-sessions",
"children[3].aliases[2]": "store-auth-sessions",
"children[3].aliases[3]": "jef_store_auth_sessions",
"children[3].aliases[4]": "auth_sessions",
"children[3].aliases[5]": "store_auth_sessions",
"children[3].aliases[6]": "sessions",
"children[4].parent_table": "jef-store-stores",
"children[4].child_table": "jef-store-carts",
"children[4].parent_key": "entity_number",
"children[4].child_foreign_key": "entity_number",
"children[4].child_index_name": "gsi_1",
"children[4].child_index_key": "gsi_1_pk",
"children[4].aliases[0]": "jef-store-carts",
"children[4].aliases[1]": "carts",
"children[4].aliases[2]": "store-carts",
"children[4].aliases[3]": "jef_store_carts",
"children[4].aliases[4]": "store_carts",
"children[5].parent_table": "jef-store-stores",
"children[5].child_table": "jef-store-checkout-drafts",
"children[5].parent_key": "entity_number",
"children[5].child_foreign_key": "entity_number",
"children[5].child_index_name": "gsi_1",
"children[5].child_index_key": "gsi_1_pk",
"children[5].aliases[0]": "jef-store-checkout-drafts",
"children[5].aliases[1]": "checkout-drafts",
"children[5].aliases[2]": "store-checkout-drafts",
"children[5].aliases[3]": "jef_store_checkout_drafts",
"children[5].aliases[4]": "checkout_drafts",
"children[5].aliases[5]": "store_checkout_drafts",
"children[5].aliases[6]": "drafts",
"children[6].parent_table": "jef-store-stores",
"children[6].child_table": "jef-store-customer-settings",
"children[6].parent_key": "entity_number",
"children[6].child_foreign_key": "entity_number",
"children[6].child_index_name": "gsi_1",
"children[6].child_index_key": "gsi_1_pk",
"children[6].aliases[0]": "jef-store-customer-settings",
"children[6].aliases[1]": "customer-settings",
"children[6].aliases[2]": "store-customer-settings",
"children[6].aliases[3]": "jef_store_customer_settings",
"children[6].aliases[4]": "customer_settings",
"children[6].aliases[5]": "store_customer_settings",
"children[6].aliases[6]": "settings",
"children[7].parent_table": "jef-store-stores",
"children[7].child_table": "jef-store-customers",
"children[7].parent_key": "entity_number",
"children[7].child_foreign_key": "entity_number",
"children[7].child_index_name": "gsi_1",
"children[7].child_index_key": "gsi_1_pk",
"children[7].aliases[0]": "jef-store-customers",
"children[7].aliases[1]": "customers",
"children[7].aliases[2]": "store-customers",
"children[7].aliases[3]": "jef_store_customers",
"children[7].aliases[4]": "store_customers",
"children[8].parent_table": "jef-store-stores",
"children[8].child_table": "jef-store-employees",
"children[8].parent_key": "entity_number",
"children[8].child_foreign_key": "entity_number",
"children[8].child_index_name": "gsi_1",
"children[8].child_index_key": "gsi_1_pk",
"children[8].aliases[0]": "jef-store-employees",
"children[8].aliases[1]": "employees",
"children[8].aliases[2]": "store-employees",
"children[8].aliases[3]": "jef_store_employees",
"children[8].aliases[4]": "store_employees",
"children[9].parent_table": "jef-store-stores",
"children[9].child_table": "jef-store-jefgas-purchase-orders",
"children[9].parent_key": "entity_number",
"children[9].child_foreign_key": "entity_number",
"children[9].child_index_name": "gsi_1",
"children[9].child_index_key": "gsi_1_pk",
"children[9].aliases[0]": "jef-store-jefgas-purchase-orders",
"children[9].aliases[1]": "jefgas-purchase-orders",
"children[9].aliases[2]": "store-jefgas-purchase-orders",
"children[9].aliases[3]": "jef_store_jefgas_purchase_orders",
"children[9].aliases[4]": "jefgas_purchase_orders",
"children[9].aliases[5]": "store_jefgas_purchase_orders",
"children[9].aliases[6]": "orders",
"children[10].parent_table": "jef-store-stores",
"children[10].child_table": "jef-store-orders",
"children[10].parent_key": "entity_number",
"children[10].child_foreign_key": "entity_number",
"children[10].child_index_name": "gsi_1",
"children[10].child_index_key": "gsi_1_pk",
"children[10].aliases[0]": "jef-store-orders",
"children[10].aliases[1]": "orders",
"children[10].aliases[2]": "store-orders",
"children[10].aliases[3]": "jef_store_orders",
"children[10].aliases[4]": "store_orders",
"children[11].parent_table": "jef-store-stores",
"children[11].child_table": "jef-store-printer-profiles",
"children[11].parent_key": "entity_number",
"children[11].child_foreign_key": "entity_number",
"children[11].child_index_name": "gsi_1",
"children[11].child_index_key": "gsi_1_pk",
"children[11].aliases[0]": "jef-store-printer-profiles",
"children[11].aliases[1]": "printer-profiles",
"children[11].aliases[2]": "store-printer-profiles",
"children[11].aliases[3]": "jef_store_printer_profiles",
"children[11].aliases[4]": "printer_profiles",
"children[11].aliases[5]": "store_printer_profiles",
"children[11].aliases[6]": "profiles",
"children[12].parent_table": "jef-store-stores",
"children[12].child_table": "jef-store-products",
"children[12].parent_key": "entity_number",
"children[12].child_foreign_key": "entity_number",
"children[12].child_index_name": "gsi_1",
"children[12].child_index_key": "gsi_1_pk",
"children[12].aliases[0]": "jef-store-products",
"children[12].aliases[1]": "products",
"children[12].aliases[2]": "store-products",
"children[12].aliases[3]": "jef_store_products",
"children[12].aliases[4]": "store_products",
"patch.semantic_patch_version": "patch-ignore-immutable-v2",
"patch.allowed_fields[0]": "entity_number",
"patch.allowed_fields[1]": "branch_name",
"patch.allowed_fields[2]": "store_name",
"patch.allowed_fields[3]": "store_legal_name",
"patch.allowed_fields[4]": "store_tagline",
"patch.allowed_fields[5]": "address_line_1",
"patch.allowed_fields[6]": "address_line_2",
"patch.allowed_fields[7]": "city",
"patch.allowed_fields[8]": "province",
"patch.allowed_fields[9]": "postal_code",
"patch.allowed_fields[10]": "country",
"patch.allowed_fields[11]": "contact_number",
"patch.allowed_fields[12]": "email",
"patch.allowed_fields[13]": "website",
"patch.allowed_fields[14]": "tin",
"patch.allowed_fields[15]": "is_active",
"patch.allowed_fields[16]": "version",
"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_number.field": "entity_number",
"patch.editable_attributes.entity_number.type": "S",
"patch.editable_attributes.entity_number.required": "False",
"patch.editable_attributes.entity_number.source_required": "True",
"patch.editable_attributes.entity_number.server_generated": "True",
"patch.editable_attributes.entity_number.autogenerated": "False",
"patch.editable_attributes.entity_number.frontend_autocomputed": "False",
"patch.editable_attributes.entity_number.format": "uuidv4",
"patch.editable_attributes.entity_number.regex": "^[1-9a-fA-F][0-9a-fA-F]{7}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"patch.editable_attributes.branch_name.field": "branch_name",
"patch.editable_attributes.branch_name.type": "S",
"patch.editable_attributes.branch_name.required": "True",
"patch.editable_attributes.branch_name.source_required": "True",
"patch.editable_attributes.branch_name.server_generated": "False",
"patch.editable_attributes.branch_name.autogenerated": "False",
"patch.editable_attributes.branch_name.frontend_autocomputed": "False",
"patch.editable_attributes.branch_name.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"patch.editable_attributes.store_name.field": "store_name",
"patch.editable_attributes.store_name.type": "S",
"patch.editable_attributes.store_name.required": "True",
"patch.editable_attributes.store_name.source_required": "True",
"patch.editable_attributes.store_name.server_generated": "False",
"patch.editable_attributes.store_name.autogenerated": "False",
"patch.editable_attributes.store_name.frontend_autocomputed": "False",
"patch.editable_attributes.store_name.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"patch.editable_attributes.store_legal_name.field": "store_legal_name",
"patch.editable_attributes.store_legal_name.type": "S",
"patch.editable_attributes.store_legal_name.required": "True",
"patch.editable_attributes.store_legal_name.source_required": "True",
"patch.editable_attributes.store_legal_name.server_generated": "False",
"patch.editable_attributes.store_legal_name.autogenerated": "False",
"patch.editable_attributes.store_legal_name.frontend_autocomputed": "False",
"patch.editable_attributes.store_legal_name.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"patch.editable_attributes.store_tagline.field": "store_tagline",
"patch.editable_attributes.store_tagline.type": "S",
"patch.editable_attributes.store_tagline.required": "True",
"patch.editable_attributes.store_tagline.source_required": "True",
"patch.editable_attributes.store_tagline.server_generated": "False",
"patch.editable_attributes.store_tagline.autogenerated": "False",
"patch.editable_attributes.store_tagline.frontend_autocomputed": "False",
"patch.editable_attributes.store_tagline.regex": "^.{0,500}$",
"patch.editable_attributes.address_line_1.field": "address_line_1",
"patch.editable_attributes.address_line_1.type": "S",
"patch.editable_attributes.address_line_1.required": "True",
"patch.editable_attributes.address_line_1.source_required": "True",
"patch.editable_attributes.address_line_1.server_generated": "False",
"patch.editable_attributes.address_line_1.autogenerated": "False",
"patch.editable_attributes.address_line_1.frontend_autocomputed": "False",
"patch.editable_attributes.address_line_1.regex": "^.{0,500}$",
"patch.editable_attributes.address_line_2.field": "address_line_2",
"patch.editable_attributes.address_line_2.type": "S",
"patch.editable_attributes.address_line_2.required": "True",
"patch.editable_attributes.address_line_2.source_required": "True",
"patch.editable_attributes.address_line_2.server_generated": "False",
"patch.editable_attributes.address_line_2.autogenerated": "False",
"patch.editable_attributes.address_line_2.frontend_autocomputed": "False",
"patch.editable_attributes.address_line_2.regex": "^.{0,500}$",
"patch.editable_attributes.city.field": "city",
"patch.editable_attributes.city.type": "S",
"patch.editable_attributes.city.required": "True",
"patch.editable_attributes.city.source_required": "True",
"patch.editable_attributes.city.server_generated": "False",
"patch.editable_attributes.city.autogenerated": "False",
"patch.editable_attributes.city.frontend_autocomputed": "False",
"patch.editable_attributes.city.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"patch.editable_attributes.province.field": "province",
"patch.editable_attributes.province.type": "S",
"patch.editable_attributes.province.required": "True",
"patch.editable_attributes.province.source_required": "True",
"patch.editable_attributes.province.server_generated": "False",
"patch.editable_attributes.province.autogenerated": "False",
"patch.editable_attributes.province.frontend_autocomputed": "False",
"patch.editable_attributes.province.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"patch.editable_attributes.postal_code.field": "postal_code",
"patch.editable_attributes.postal_code.type": "S",
"patch.editable_attributes.postal_code.required": "True",
"patch.editable_attributes.postal_code.source_required": "True",
"patch.editable_attributes.postal_code.server_generated": "False",
"patch.editable_attributes.postal_code.autogenerated": "False",
"patch.editable_attributes.postal_code.frontend_autocomputed": "False",
"patch.editable_attributes.postal_code.regex": "^[A-Za-z0-9 -]{0,20}$",
"patch.editable_attributes.country.field": "country",
"patch.editable_attributes.country.type": "S",
"patch.editable_attributes.country.required": "True",
"patch.editable_attributes.country.source_required": "True",
"patch.editable_attributes.country.server_generated": "False",
"patch.editable_attributes.country.autogenerated": "False",
"patch.editable_attributes.country.frontend_autocomputed": "False",
"patch.editable_attributes.country.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"patch.editable_attributes.contact_number.field": "contact_number",
"patch.editable_attributes.contact_number.type": "S",
"patch.editable_attributes.contact_number.required": "True",
"patch.editable_attributes.contact_number.source_required": "True",
"patch.editable_attributes.contact_number.server_generated": "False",
"patch.editable_attributes.contact_number.autogenerated": "False",
"patch.editable_attributes.contact_number.frontend_autocomputed": "False",
"patch.editable_attributes.contact_number.regex": "^[0-9+() .-]{0,30}$",
"patch.editable_attributes.email.field": "email",
"patch.editable_attributes.email.type": "S",
"patch.editable_attributes.email.required": "True",
"patch.editable_attributes.email.source_required": "True",
"patch.editable_attributes.email.server_generated": "False",
"patch.editable_attributes.email.autogenerated": "False",
"patch.editable_attributes.email.frontend_autocomputed": "False",
"patch.editable_attributes.email.regex": "^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$",
"patch.editable_attributes.website.field": "website",
"patch.editable_attributes.website.type": "S",
"patch.editable_attributes.website.required": "True",
"patch.editable_attributes.website.source_required": "True",
"patch.editable_attributes.website.server_generated": "False",
"patch.editable_attributes.website.autogenerated": "False",
"patch.editable_attributes.website.frontend_autocomputed": "False",
"patch.editable_attributes.website.regex": "^[A-Za-z0-9 ._:/-]{1,240}$",
"patch.editable_attributes.tin.field": "tin",
"patch.editable_attributes.tin.type": "S",
"patch.editable_attributes.tin.required": "True",
"patch.editable_attributes.tin.source_required": "True",
"patch.editable_attributes.tin.server_generated": "False",
"patch.editable_attributes.tin.autogenerated": "False",
"patch.editable_attributes.tin.frontend_autocomputed": "False",
"patch.editable_attributes.tin.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"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": "True",
"patch.editable_attributes.is_active.autogenerated": "False",
"patch.editable_attributes.is_active.frontend_autocomputed": "False",
"patch.editable_attributes.is_active.regex": "^(true|false)$",
"patch.editable_attributes.version.field": "version",
"patch.editable_attributes.version.type": "N",
"patch.editable_attributes.version.required": "True",
"patch.editable_attributes.version.source_required": "True",
"patch.editable_attributes.version.server_generated": "False",
"patch.editable_attributes.version.autogenerated": "False",
"patch.editable_attributes.version.frontend_autocomputed": "False",
"patch.editable_attributes.version.regex": "^\\d+$",
"root.type": "object",
"root.attributes.entity_number.field": "entity_number",
"root.attributes.entity_number.type": "S",
"root.attributes.entity_number.required": "False",
"root.attributes.entity_number.source_required": "True",
"root.attributes.entity_number.server_generated": "True",
"root.attributes.entity_number.autogenerated": "False",
"root.attributes.entity_number.frontend_autocomputed": "False",
"root.attributes.entity_number.format": "uuidv4",
"root.attributes.entity_number.regex": "^[1-9a-fA-F][0-9a-fA-F]{7}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"root.attributes.branch_name.field": "branch_name",
"root.attributes.branch_name.type": "S",
"root.attributes.branch_name.required": "True",
"root.attributes.branch_name.source_required": "True",
"root.attributes.branch_name.server_generated": "False",
"root.attributes.branch_name.autogenerated": "False",
"root.attributes.branch_name.frontend_autocomputed": "False",
"root.attributes.branch_name.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"root.attributes.store_name.field": "store_name",
"root.attributes.store_name.type": "S",
"root.attributes.store_name.required": "True",
"root.attributes.store_name.source_required": "True",
"root.attributes.store_name.server_generated": "False",
"root.attributes.store_name.autogenerated": "False",
"root.attributes.store_name.frontend_autocomputed": "False",
"root.attributes.store_name.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"root.attributes.store_legal_name.field": "store_legal_name",
"root.attributes.store_legal_name.type": "S",
"root.attributes.store_legal_name.required": "True",
"root.attributes.store_legal_name.source_required": "True",
"root.attributes.store_legal_name.server_generated": "False",
"root.attributes.store_legal_name.autogenerated": "False",
"root.attributes.store_legal_name.frontend_autocomputed": "False",
"root.attributes.store_legal_name.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"root.attributes.store_tagline.field": "store_tagline",
"root.attributes.store_tagline.type": "S",
"root.attributes.store_tagline.required": "True",
"root.attributes.store_tagline.source_required": "True",
"root.attributes.store_tagline.server_generated": "False",
"root.attributes.store_tagline.autogenerated": "False",
"root.attributes.store_tagline.frontend_autocomputed": "False",
"root.attributes.store_tagline.regex": "^.{0,500}$",
"root.attributes.address_line_1.field": "address_line_1",
"root.attributes.address_line_1.type": "S",
"root.attributes.address_line_1.required": "True",
"root.attributes.address_line_1.source_required": "True",
"root.attributes.address_line_1.server_generated": "False",
"root.attributes.address_line_1.autogenerated": "False",
"root.attributes.address_line_1.frontend_autocomputed": "False",
"root.attributes.address_line_1.regex": "^.{0,500}$",
"root.attributes.address_line_2.field": "address_line_2",
"root.attributes.address_line_2.type": "S",
"root.attributes.address_line_2.required": "True",
"root.attributes.address_line_2.source_required": "True",
"root.attributes.address_line_2.server_generated": "False",
"root.attributes.address_line_2.autogenerated": "False",
"root.attributes.address_line_2.frontend_autocomputed": "False",
"root.attributes.address_line_2.regex": "^.{0,500}$",
"root.attributes.city.field": "city",
"root.attributes.city.type": "S",
"root.attributes.city.required": "True",
"root.attributes.city.source_required": "True",
"root.attributes.city.server_generated": "False",
"root.attributes.city.autogenerated": "False",
"root.attributes.city.frontend_autocomputed": "False",
"root.attributes.city.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"root.attributes.province.field": "province",
"root.attributes.province.type": "S",
"root.attributes.province.required": "True",
"root.attributes.province.source_required": "True",
"root.attributes.province.server_generated": "False",
"root.attributes.province.autogenerated": "False",
"root.attributes.province.frontend_autocomputed": "False",
"root.attributes.province.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"root.attributes.postal_code.field": "postal_code",
"root.attributes.postal_code.type": "S",
"root.attributes.postal_code.required": "True",
"root.attributes.postal_code.source_required": "True",
"root.attributes.postal_code.server_generated": "False",
"root.attributes.postal_code.autogenerated": "False",
"root.attributes.postal_code.frontend_autocomputed": "False",
"root.attributes.postal_code.regex": "^[A-Za-z0-9 -]{0,20}$",
"root.attributes.country.field": "country",
"root.attributes.country.type": "S",
"root.attributes.country.required": "True",
"root.attributes.country.source_required": "True",
"root.attributes.country.server_generated": "False",
"root.attributes.country.autogenerated": "False",
"root.attributes.country.frontend_autocomputed": "False",
"root.attributes.country.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"root.attributes.contact_number.field": "contact_number",
"root.attributes.contact_number.type": "S",
"root.attributes.contact_number.required": "True",
"root.attributes.contact_number.source_required": "True",
"root.attributes.contact_number.server_generated": "False",
"root.attributes.contact_number.autogenerated": "False",
"root.attributes.contact_number.frontend_autocomputed": "False",
"root.attributes.contact_number.regex": "^[0-9+() .-]{0,30}$",
"root.attributes.email.field": "email",
"root.attributes.email.type": "S",
"root.attributes.email.required": "True",
"root.attributes.email.source_required": "True",
"root.attributes.email.server_generated": "False",
"root.attributes.email.autogenerated": "False",
"root.attributes.email.frontend_autocomputed": "False",
"root.attributes.email.regex": "^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$",
"root.attributes.website.field": "website",
"root.attributes.website.type": "S",
"root.attributes.website.required": "True",
"root.attributes.website.source_required": "True",
"root.attributes.website.server_generated": "False",
"root.attributes.website.autogenerated": "False",
"root.attributes.website.frontend_autocomputed": "False",
"root.attributes.website.regex": "^[A-Za-z0-9 ._:/-]{1,240}$",
"root.attributes.tin.field": "tin",
"root.attributes.tin.type": "S",
"root.attributes.tin.required": "True",
"root.attributes.tin.source_required": "True",
"root.attributes.tin.server_generated": "False",
"root.attributes.tin.autogenerated": "False",
"root.attributes.tin.frontend_autocomputed": "False",
"root.attributes.tin.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"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": "True",
"root.attributes.is_active.autogenerated": "False",
"root.attributes.is_active.frontend_autocomputed": "False",
"root.attributes.is_active.regex": "^(true|false)$",
"root.attributes.version.field": "version",
"root.attributes.version.type": "N",
"root.attributes.version.required": "True",
"root.attributes.version.source_required": "True",
"root.attributes.version.server_generated": "False",
"root.attributes.version.autogenerated": "False",
"root.attributes.version.frontend_autocomputed": "False",
"root.attributes.version.regex": "^\\d+$"
}
Response Schema¶
{
"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¶
{
"entity_number": "7e4ed9a6-c117-48df-9a24-1a2927bc2c93",
"branch_name": "Sample Name"
}
Response¶
{
"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¶
curl -X PATCH "https://dqo3268ty9.execute-api.ap-southeast-1.amazonaws.com/prod/store-stores-patch-one" -H "Content-Type: application/json" --data-raw "{\"entity_number\": \"7e4ed9a6-c117-48df-9a24-1a2927bc2c93\", \"branch_name\": \"Sample Name\"}"
PowerShell curl¶
curl.exe -X PATCH "https://dqo3268ty9.execute-api.ap-southeast-1.amazonaws.com/prod/store-stores-patch-one" -H "Content-Type: application/json" --data-raw '{"entity_number": "7e4ed9a6-c117-48df-9a24-1a2927bc2c93", "branch_name": "Sample Name"}'