/one-entities-patch-one

Summary

• Source repository: jef-systems/jef-one-backend

• Source SHA: 9fd7130d1a3dabe738bc74fa2b9665f18d274b00

• Source run id: 28389233560

• Lambda function: jef-one-entities-patch-one

• HTTP method: PATCH

• API path: /one-entities-patch-one

• Endpoint URL: https://mfr670zvsh.execute-api.ap-southeast-1.amazonaws.com/prod/one-entities-patch-one

• Payload mode: json-body

Description

Function	jef-one-entities-patch-one Logical ID: jef-one:jef-one-entities:patch-one Order Number: 003
Module	jef-one
Action	patch-one
Method	PATCH
Invocation Mode	SYNCHRONOUS
Resource Path	/one-entities-patch-one Endpoint Name: jef-one-entities-patch-one
Table	jef-one-entities
Primary Key	entity_id

API Gateway Response

status\_code	Lambda proxy statusCode
message	Lambda response reflects commit success or failure.

Payload Example

entity\_id	0a463793-9a08-4e69-97c3-3080cd412bc5
entity\_number	value-001

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-one-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.main_parent_key_name.field": "main_parent_key_name",
  "properties.main_parent_key_name.type": "S",
  "properties.main_parent_key_name.required": "True",
  "properties.main_parent_key_name.source_required": "True",
  "properties.main_parent_key_name.server_generated": "False",
  "properties.main_parent_key_name.autogenerated": "False",
  "properties.main_parent_key_name.frontend_autocomputed": "False",
  "properties.main_parent_key_name.regex": "^[a-z][a-z0-9_]{0,63}$",
  "properties.main_parent_key_value.field": "main_parent_key_value",
  "properties.main_parent_key_value.type": "S",
  "properties.main_parent_key_value.required": "True",
  "properties.main_parent_key_value.source_required": "True",
  "properties.main_parent_key_value.server_generated": "False",
  "properties.main_parent_key_value.autogenerated": "False",
  "properties.main_parent_key_value.frontend_autocomputed": "False",
  "properties.main_parent_key_value.regex": "^.{1,255}$",
  "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-one-entities",
  "children[0].child_table": "jef-one-employees",
  "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-one-employees",
  "children[0].aliases[1]": "employees",
  "children[0].aliases[2]": "one-employees",
  "children[0].aliases[3]": "jef_one_employees",
  "children[0].aliases[4]": "one_employees",
  "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]": "main_parent_key_name",
  "patch.allowed_fields[4]": "main_parent_key_value",
  "patch.allowed_fields[5]": "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.main_parent_key_name.field": "main_parent_key_name",
  "patch.editable_attributes.main_parent_key_name.type": "S",
  "patch.editable_attributes.main_parent_key_name.required": "True",
  "patch.editable_attributes.main_parent_key_name.source_required": "True",
  "patch.editable_attributes.main_parent_key_name.server_generated": "False",
  "patch.editable_attributes.main_parent_key_name.autogenerated": "False",
  "patch.editable_attributes.main_parent_key_name.frontend_autocomputed": "False",
  "patch.editable_attributes.main_parent_key_name.regex": "^[a-z][a-z0-9_]{0,63}$",
  "patch.editable_attributes.main_parent_key_value.field": "main_parent_key_value",
  "patch.editable_attributes.main_parent_key_value.type": "S",
  "patch.editable_attributes.main_parent_key_value.required": "True",
  "patch.editable_attributes.main_parent_key_value.source_required": "True",
  "patch.editable_attributes.main_parent_key_value.server_generated": "False",
  "patch.editable_attributes.main_parent_key_value.autogenerated": "False",
  "patch.editable_attributes.main_parent_key_value.frontend_autocomputed": "False",
  "patch.editable_attributes.main_parent_key_value.regex": "^.{1,255}$",
  "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.main_parent_key_name.field": "main_parent_key_name",
  "root.attributes.main_parent_key_name.type": "S",
  "root.attributes.main_parent_key_name.required": "True",
  "root.attributes.main_parent_key_name.source_required": "True",
  "root.attributes.main_parent_key_name.server_generated": "False",
  "root.attributes.main_parent_key_name.autogenerated": "False",
  "root.attributes.main_parent_key_name.frontend_autocomputed": "False",
  "root.attributes.main_parent_key_name.regex": "^[a-z][a-z0-9_]{0,63}$",
  "root.attributes.main_parent_key_value.field": "main_parent_key_value",
  "root.attributes.main_parent_key_value.type": "S",
  "root.attributes.main_parent_key_value.required": "True",
  "root.attributes.main_parent_key_value.source_required": "True",
  "root.attributes.main_parent_key_value.server_generated": "False",
  "root.attributes.main_parent_key_value.autogenerated": "False",
  "root.attributes.main_parent_key_value.frontend_autocomputed": "False",
  "root.attributes.main_parent_key_value.regex": "^.{1,255}$",
  "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

{
  "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_id": "0a463793-9a08-4e69-97c3-3080cd412bc5",
  "entity_number": "value-001"
}

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://mfr670zvsh.execute-api.ap-southeast-1.amazonaws.com/prod/one-entities-patch-one" -H "Content-Type: application/json" --data-raw "{\"entity_id\": \"0a463793-9a08-4e69-97c3-3080cd412bc5\", \"entity_number\": \"value-001\"}"

PowerShell curl

curl.exe -X PATCH "https://mfr670zvsh.execute-api.ap-southeast-1.amazonaws.com/prod/one-entities-patch-one" -H "Content-Type: application/json" --data-raw '{"entity_id": "0a463793-9a08-4e69-97c3-3080cd412bc5", "entity_number": "value-001"}'