/hardware-toolboxes-patch-one

Summary

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

• Source SHA: 1146eff13985802eaaa2190d185be080bba0aad5

• Source run id: 28799104519

• Lambda function: jef-hardware-toolboxes-patch-one

• HTTP method: PATCH

• API path: /hardware-toolboxes-patch-one

• Endpoint URL: https://api.jefoffice.com/hardware-toolboxes-patch-one

• Payload mode: json-body

Description

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

API Gateway Response

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

Payload Example

toolbox\_id	5330a4d8-e752-4e7c-8fe3-f36bb62d73c9
store\_id	11ceb548-e34e-4252-aeb0-fa4fa9828447

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-hardware-toolboxes",
  "primary_key": "toolbox_id",
  "required[0]": "toolbox_id",
  "properties.toolbox_id.field": "toolbox_id",
  "properties.toolbox_id.type": "S",
  "properties.toolbox_id.required": "False",
  "properties.toolbox_id.source_required": "True",
  "properties.toolbox_id.server_generated": "True",
  "properties.toolbox_id.autogenerated": "False",
  "properties.toolbox_id.frontend_autocomputed": "False",
  "properties.toolbox_id.format": "uuidv4",
  "properties.toolbox_id.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.store_id.field": "store_id",
  "properties.store_id.type": "S",
  "properties.store_id.required": "True",
  "properties.store_id.source_required": "True",
  "properties.store_id.server_generated": "True",
  "properties.store_id.autogenerated": "False",
  "properties.store_id.frontend_autocomputed": "False",
  "properties.store_id.format": "uuidv4",
  "properties.store_id.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.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.toolbox_number.field": "toolbox_number",
  "properties.toolbox_number.type": "S",
  "properties.toolbox_number.required": "True",
  "properties.toolbox_number.source_required": "True",
  "properties.toolbox_number.server_generated": "False",
  "properties.toolbox_number.autogenerated": "False",
  "properties.toolbox_number.frontend_autocomputed": "False",
  "properties.toolbox_number.regex": "^[A-Za-z0-9_-]{1,64}$",
  "properties.toolbox_code.field": "toolbox_code",
  "properties.toolbox_code.type": "S",
  "properties.toolbox_code.required": "True",
  "properties.toolbox_code.source_required": "True",
  "properties.toolbox_code.server_generated": "False",
  "properties.toolbox_code.autogenerated": "False",
  "properties.toolbox_code.frontend_autocomputed": "False",
  "properties.toolbox_code.regex": "^[A-Za-z0-9_-]{1,64}$",
  "properties.toolbox_name.field": "toolbox_name",
  "properties.toolbox_name.type": "S",
  "properties.toolbox_name.required": "True",
  "properties.toolbox_name.source_required": "True",
  "properties.toolbox_name.server_generated": "False",
  "properties.toolbox_name.autogenerated": "False",
  "properties.toolbox_name.frontend_autocomputed": "False",
  "properties.toolbox_name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
  "properties.equipment_name.field": "equipment_name",
  "properties.equipment_name.type": "S",
  "properties.equipment_name.required": "True",
  "properties.equipment_name.source_required": "True",
  "properties.equipment_name.server_generated": "False",
  "properties.equipment_name.autogenerated": "False",
  "properties.equipment_name.frontend_autocomputed": "False",
  "properties.equipment_name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
  "properties.category.field": "category",
  "properties.category.type": "S",
  "properties.category.required": "True",
  "properties.category.source_required": "True",
  "properties.category.server_generated": "False",
  "properties.category.autogenerated": "False",
  "properties.category.frontend_autocomputed": "False",
  "properties.category.regex": "^[A-Za-z0-9_-]{1,64}$",
  "properties.daily_rate.field": "daily_rate",
  "properties.daily_rate.type": "N",
  "properties.daily_rate.required": "True",
  "properties.daily_rate.source_required": "True",
  "properties.daily_rate.server_generated": "False",
  "properties.daily_rate.autogenerated": "False",
  "properties.daily_rate.frontend_autocomputed": "False",
  "properties.daily_rate.regex": "^-?\\d+(\\.\\d+)?$",
  "properties.status.field": "status",
  "properties.status.type": "S",
  "properties.status.required": "True",
  "properties.status.source_required": "True",
  "properties.status.server_generated": "False",
  "properties.status.autogenerated": "False",
  "properties.status.frontend_autocomputed": "False",
  "properties.status.regex": "^[A-Za-z0-9_-]{1,64}$",
  "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": "True",
  "properties.version.autogenerated": "False",
  "properties.version.frontend_autocomputed": "False",
  "properties.version.regex": "^\\d+$",
  "children[0].parent_table": "jef-hardware-toolboxes",
  "children[0].child_table": "jef-hardware-toolbox-items",
  "children[0].parent_key": "toolbox_id",
  "children[0].child_foreign_key": "toolbox_id",
  "children[0].child_index_name": "gsi_1",
  "children[0].child_index_key": "gsi_1_pk",
  "children[0].aliases[0]": "jef-hardware-toolbox-items",
  "children[0].aliases[1]": "toolbox-items",
  "children[0].aliases[2]": "hardware-toolbox-items",
  "children[0].aliases[3]": "jef_hardware_toolbox_items",
  "children[0].aliases[4]": "toolbox_items",
  "children[0].aliases[5]": "hardware_toolbox_items",
  "children[0].aliases[6]": "items",
  "patch.semantic_patch_version": "patch-ignore-immutable-v2",
  "patch.allowed_fields[0]": "toolbox_id",
  "patch.allowed_fields[1]": "store_id",
  "patch.allowed_fields[2]": "entity_number",
  "patch.allowed_fields[3]": "toolbox_number",
  "patch.allowed_fields[4]": "toolbox_code",
  "patch.allowed_fields[5]": "toolbox_name",
  "patch.allowed_fields[6]": "equipment_name",
  "patch.allowed_fields[7]": "category",
  "patch.allowed_fields[8]": "daily_rate",
  "patch.allowed_fields[9]": "status",
  "patch.allowed_fields[10]": "is_active",
  "patch.allowed_fields[11]": "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.toolbox_id.field": "toolbox_id",
  "patch.editable_attributes.toolbox_id.type": "S",
  "patch.editable_attributes.toolbox_id.required": "False",
  "patch.editable_attributes.toolbox_id.source_required": "True",
  "patch.editable_attributes.toolbox_id.server_generated": "True",
  "patch.editable_attributes.toolbox_id.autogenerated": "False",
  "patch.editable_attributes.toolbox_id.frontend_autocomputed": "False",
  "patch.editable_attributes.toolbox_id.format": "uuidv4",
  "patch.editable_attributes.toolbox_id.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.store_id.field": "store_id",
  "patch.editable_attributes.store_id.type": "S",
  "patch.editable_attributes.store_id.required": "True",
  "patch.editable_attributes.store_id.source_required": "True",
  "patch.editable_attributes.store_id.server_generated": "True",
  "patch.editable_attributes.store_id.autogenerated": "False",
  "patch.editable_attributes.store_id.frontend_autocomputed": "False",
  "patch.editable_attributes.store_id.format": "uuidv4",
  "patch.editable_attributes.store_id.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.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.toolbox_number.field": "toolbox_number",
  "patch.editable_attributes.toolbox_number.type": "S",
  "patch.editable_attributes.toolbox_number.required": "True",
  "patch.editable_attributes.toolbox_number.source_required": "True",
  "patch.editable_attributes.toolbox_number.server_generated": "False",
  "patch.editable_attributes.toolbox_number.autogenerated": "False",
  "patch.editable_attributes.toolbox_number.frontend_autocomputed": "False",
  "patch.editable_attributes.toolbox_number.regex": "^[A-Za-z0-9_-]{1,64}$",
  "patch.editable_attributes.toolbox_code.field": "toolbox_code",
  "patch.editable_attributes.toolbox_code.type": "S",
  "patch.editable_attributes.toolbox_code.required": "True",
  "patch.editable_attributes.toolbox_code.source_required": "True",
  "patch.editable_attributes.toolbox_code.server_generated": "False",
  "patch.editable_attributes.toolbox_code.autogenerated": "False",
  "patch.editable_attributes.toolbox_code.frontend_autocomputed": "False",
  "patch.editable_attributes.toolbox_code.regex": "^[A-Za-z0-9_-]{1,64}$",
  "patch.editable_attributes.toolbox_name.field": "toolbox_name",
  "patch.editable_attributes.toolbox_name.type": "S",
  "patch.editable_attributes.toolbox_name.required": "True",
  "patch.editable_attributes.toolbox_name.source_required": "True",
  "patch.editable_attributes.toolbox_name.server_generated": "False",
  "patch.editable_attributes.toolbox_name.autogenerated": "False",
  "patch.editable_attributes.toolbox_name.frontend_autocomputed": "False",
  "patch.editable_attributes.toolbox_name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
  "patch.editable_attributes.equipment_name.field": "equipment_name",
  "patch.editable_attributes.equipment_name.type": "S",
  "patch.editable_attributes.equipment_name.required": "True",
  "patch.editable_attributes.equipment_name.source_required": "True",
  "patch.editable_attributes.equipment_name.server_generated": "False",
  "patch.editable_attributes.equipment_name.autogenerated": "False",
  "patch.editable_attributes.equipment_name.frontend_autocomputed": "False",
  "patch.editable_attributes.equipment_name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
  "patch.editable_attributes.category.field": "category",
  "patch.editable_attributes.category.type": "S",
  "patch.editable_attributes.category.required": "True",
  "patch.editable_attributes.category.source_required": "True",
  "patch.editable_attributes.category.server_generated": "False",
  "patch.editable_attributes.category.autogenerated": "False",
  "patch.editable_attributes.category.frontend_autocomputed": "False",
  "patch.editable_attributes.category.regex": "^[A-Za-z0-9_-]{1,64}$",
  "patch.editable_attributes.daily_rate.field": "daily_rate",
  "patch.editable_attributes.daily_rate.type": "N",
  "patch.editable_attributes.daily_rate.required": "True",
  "patch.editable_attributes.daily_rate.source_required": "True",
  "patch.editable_attributes.daily_rate.server_generated": "False",
  "patch.editable_attributes.daily_rate.autogenerated": "False",
  "patch.editable_attributes.daily_rate.frontend_autocomputed": "False",
  "patch.editable_attributes.daily_rate.regex": "^-?\\d+(\\.\\d+)?$",
  "patch.editable_attributes.status.field": "status",
  "patch.editable_attributes.status.type": "S",
  "patch.editable_attributes.status.required": "True",
  "patch.editable_attributes.status.source_required": "True",
  "patch.editable_attributes.status.server_generated": "False",
  "patch.editable_attributes.status.autogenerated": "False",
  "patch.editable_attributes.status.frontend_autocomputed": "False",
  "patch.editable_attributes.status.regex": "^[A-Za-z0-9_-]{1,64}$",
  "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": "True",
  "patch.editable_attributes.version.autogenerated": "False",
  "patch.editable_attributes.version.frontend_autocomputed": "False",
  "patch.editable_attributes.version.regex": "^\\d+$",
  "root.type": "object",
  "root.attributes.toolbox_id.field": "toolbox_id",
  "root.attributes.toolbox_id.type": "S",
  "root.attributes.toolbox_id.required": "False",
  "root.attributes.toolbox_id.source_required": "True",
  "root.attributes.toolbox_id.server_generated": "True",
  "root.attributes.toolbox_id.autogenerated": "False",
  "root.attributes.toolbox_id.frontend_autocomputed": "False",
  "root.attributes.toolbox_id.format": "uuidv4",
  "root.attributes.toolbox_id.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.store_id.field": "store_id",
  "root.attributes.store_id.type": "S",
  "root.attributes.store_id.required": "True",
  "root.attributes.store_id.source_required": "True",
  "root.attributes.store_id.server_generated": "True",
  "root.attributes.store_id.autogenerated": "False",
  "root.attributes.store_id.frontend_autocomputed": "False",
  "root.attributes.store_id.format": "uuidv4",
  "root.attributes.store_id.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.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.toolbox_number.field": "toolbox_number",
  "root.attributes.toolbox_number.type": "S",
  "root.attributes.toolbox_number.required": "True",
  "root.attributes.toolbox_number.source_required": "True",
  "root.attributes.toolbox_number.server_generated": "False",
  "root.attributes.toolbox_number.autogenerated": "False",
  "root.attributes.toolbox_number.frontend_autocomputed": "False",
  "root.attributes.toolbox_number.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.toolbox_code.field": "toolbox_code",
  "root.attributes.toolbox_code.type": "S",
  "root.attributes.toolbox_code.required": "True",
  "root.attributes.toolbox_code.source_required": "True",
  "root.attributes.toolbox_code.server_generated": "False",
  "root.attributes.toolbox_code.autogenerated": "False",
  "root.attributes.toolbox_code.frontend_autocomputed": "False",
  "root.attributes.toolbox_code.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.toolbox_name.field": "toolbox_name",
  "root.attributes.toolbox_name.type": "S",
  "root.attributes.toolbox_name.required": "True",
  "root.attributes.toolbox_name.source_required": "True",
  "root.attributes.toolbox_name.server_generated": "False",
  "root.attributes.toolbox_name.autogenerated": "False",
  "root.attributes.toolbox_name.frontend_autocomputed": "False",
  "root.attributes.toolbox_name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
  "root.attributes.equipment_name.field": "equipment_name",
  "root.attributes.equipment_name.type": "S",
  "root.attributes.equipment_name.required": "True",
  "root.attributes.equipment_name.source_required": "True",
  "root.attributes.equipment_name.server_generated": "False",
  "root.attributes.equipment_name.autogenerated": "False",
  "root.attributes.equipment_name.frontend_autocomputed": "False",
  "root.attributes.equipment_name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
  "root.attributes.category.field": "category",
  "root.attributes.category.type": "S",
  "root.attributes.category.required": "True",
  "root.attributes.category.source_required": "True",
  "root.attributes.category.server_generated": "False",
  "root.attributes.category.autogenerated": "False",
  "root.attributes.category.frontend_autocomputed": "False",
  "root.attributes.category.regex": "^[A-Za-z0-9_-]{1,64}$",
  "root.attributes.daily_rate.field": "daily_rate",
  "root.attributes.daily_rate.type": "N",
  "root.attributes.daily_rate.required": "True",
  "root.attributes.daily_rate.source_required": "True",
  "root.attributes.daily_rate.server_generated": "False",
  "root.attributes.daily_rate.autogenerated": "False",
  "root.attributes.daily_rate.frontend_autocomputed": "False",
  "root.attributes.daily_rate.regex": "^-?\\d+(\\.\\d+)?$",
  "root.attributes.status.field": "status",
  "root.attributes.status.type": "S",
  "root.attributes.status.required": "True",
  "root.attributes.status.source_required": "True",
  "root.attributes.status.server_generated": "False",
  "root.attributes.status.autogenerated": "False",
  "root.attributes.status.frontend_autocomputed": "False",
  "root.attributes.status.regex": "^[A-Za-z0-9_-]{1,64}$",
  "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": "True",
  "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

{
  "toolbox_id": "5330a4d8-e752-4e7c-8fe3-f36bb62d73c9",
  "store_id": "11ceb548-e34e-4252-aeb0-fa4fa9828447"
}

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://api.jefoffice.com/hardware-toolboxes-patch-one" -H "Content-Type: application/json" --data-raw "{\"toolbox_id\": \"5330a4d8-e752-4e7c-8fe3-f36bb62d73c9\", \"store_id\": \"11ceb548-e34e-4252-aeb0-fa4fa9828447\"}"

PowerShell curl

curl.exe -X PATCH "https://api.jefoffice.com/hardware-toolboxes-patch-one" -H "Content-Type: application/json" --data-raw '{"toolbox_id": "5330a4d8-e752-4e7c-8fe3-f36bb62d73c9", "store_id": "11ceb548-e34e-4252-aeb0-fa4fa9828447"}'