/fuel-pump-inventories-pumps-patch-one¶
Summary¶
Source repository:
jef-systems/jef-fuel-pump-inventories-backendSource SHA:
16fea06e1f47b95c448a4709d78bc3131c3fef3aSource run id:
28367321603Lambda function:
jef-fuel-pump-inventories-patch-002HTTP method:
PATCHAPI path:
/fuel-pump-inventories-pumps-patch-oneEndpoint URL:
https://fsqf5slhc1.execute-api.ap-southeast-1.amazonaws.com/prod/fuel-pump-inventories-pumps-patch-onePayload mode:
json-body
Description¶
|
jef-fuel-pump-inventories-patch-002 Logical ID: jef-fuel-pump-inventories:jef-fuel-pump-inventories-pumps:patch-one Order Number: 002 |
|
jef-fuel-pump-inventories |
|
patch-one |
|
PATCH |
|
SYNCHRONOUS |
|
/fuel-pump-inventories-pumps-patch-one Endpoint Name: jef-fuel-pump-inventories-pumps-patch-one |
|
jef-fuel-pump-inventories-pumps |
|
pump_id |
API Gateway Response¶
|
Lambda proxy statusCode |
|
Lambda response reflects commit success or failure. |
Payload Example¶
|
e4e17b22-f48d-4aee-8799-58bebca7de2f |
|
e07ea318-4a7c-4151-ae0b-ad1721f799c6 |
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-fuel-pump-inventories-pumps",
"primary_key": "pump_id",
"required[0]": "pump_id",
"properties.pump_id.field": "pump_id",
"properties.pump_id.type": "S",
"properties.pump_id.required": "False",
"properties.pump_id.source_required": "True",
"properties.pump_id.server_generated": "True",
"properties.pump_id.autogenerated": "False",
"properties.pump_id.frontend_autocomputed": "False",
"properties.pump_id.format": "uuidv4",
"properties.pump_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.gas_station_id.field": "gas_station_id",
"properties.gas_station_id.type": "S",
"properties.gas_station_id.required": "True",
"properties.gas_station_id.source_required": "True",
"properties.gas_station_id.server_generated": "True",
"properties.gas_station_id.autogenerated": "False",
"properties.gas_station_id.frontend_autocomputed": "False",
"properties.gas_station_id.format": "uuidv4",
"properties.gas_station_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.pump_key.field": "pump_key",
"properties.pump_key.type": "S",
"properties.pump_key.required": "True",
"properties.pump_key.source_required": "True",
"properties.pump_key.server_generated": "False",
"properties.pump_key.autogenerated": "False",
"properties.pump_key.frontend_autocomputed": "False",
"properties.pump_key.regex": "^[A-Za-z0-9_-]{1,64}$",
"properties.pump_code.field": "pump_code",
"properties.pump_code.type": "S",
"properties.pump_code.required": "True",
"properties.pump_code.source_required": "True",
"properties.pump_code.server_generated": "False",
"properties.pump_code.autogenerated": "False",
"properties.pump_code.frontend_autocomputed": "False",
"properties.pump_code.regex": "^[A-Za-z0-9_-]{1,64}$",
"properties.pump_name.field": "pump_name",
"properties.pump_name.type": "S",
"properties.pump_name.required": "True",
"properties.pump_name.source_required": "True",
"properties.pump_name.server_generated": "False",
"properties.pump_name.autogenerated": "False",
"properties.pump_name.frontend_autocomputed": "False",
"properties.pump_name.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"properties.pump_number.field": "pump_number",
"properties.pump_number.type": "N",
"properties.pump_number.required": "True",
"properties.pump_number.source_required": "True",
"properties.pump_number.server_generated": "False",
"properties.pump_number.autogenerated": "False",
"properties.pump_number.frontend_autocomputed": "False",
"properties.pump_number.regex": "^\\d+$",
"properties.product.field": "product",
"properties.product.type": "S",
"properties.product.required": "True",
"properties.product.source_required": "True",
"properties.product.server_generated": "False",
"properties.product.autogenerated": "False",
"properties.product.frontend_autocomputed": "False",
"properties.product.regex": "^(diesel|regular|premium|unleaded)$",
"properties.display_order.field": "display_order",
"properties.display_order.type": "N",
"properties.display_order.required": "True",
"properties.display_order.source_required": "True",
"properties.display_order.server_generated": "False",
"properties.display_order.autogenerated": "False",
"properties.display_order.frontend_autocomputed": "False",
"properties.display_order.regex": "^\\d+$",
"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.remarks.field": "remarks",
"properties.remarks.type": "S",
"properties.remarks.required": "False",
"properties.remarks.source_required": "False",
"properties.remarks.server_generated": "False",
"properties.remarks.autogenerated": "False",
"properties.remarks.frontend_autocomputed": "False",
"properties.remarks.regex": "^.{0,500}$",
"children[0].parent_table": "jef-fuel-pump-inventories-pumps",
"children[0].child_table": "jef-fuel-pump-inventories-fuel-pump-inventories",
"children[0].parent_key": "pump_id",
"children[0].child_foreign_key": "pump_id",
"children[0].child_index_name": "gsi_1",
"children[0].child_index_key": "gsi_1_pk",
"children[0].aliases[0]": "jef-fuel-pump-inventories-fuel-pump-inventories",
"children[0].aliases[1]": "fuel-pump-inventories",
"children[0].aliases[2]": "fuel-pump-inventories-fuel-pump-inventories",
"children[0].aliases[3]": "jef_fuel_pump_inventories_fuel_pump_inventories",
"children[0].aliases[4]": "fuel_pump_inventories",
"children[0].aliases[5]": "fuel_pump_inventories_fuel_pump_inventories",
"children[0].aliases[6]": "inventories",
"patch.semantic_patch_version": "patch-ignore-immutable-v2",
"patch.allowed_fields[0]": "pump_id",
"patch.allowed_fields[1]": "gas_station_id",
"patch.allowed_fields[2]": "pump_key",
"patch.allowed_fields[3]": "pump_code",
"patch.allowed_fields[4]": "pump_name",
"patch.allowed_fields[5]": "pump_number",
"patch.allowed_fields[6]": "product",
"patch.allowed_fields[7]": "display_order",
"patch.allowed_fields[8]": "is_active",
"patch.allowed_fields[9]": "remarks",
"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.pump_id.field": "pump_id",
"patch.editable_attributes.pump_id.type": "S",
"patch.editable_attributes.pump_id.required": "False",
"patch.editable_attributes.pump_id.source_required": "True",
"patch.editable_attributes.pump_id.server_generated": "True",
"patch.editable_attributes.pump_id.autogenerated": "False",
"patch.editable_attributes.pump_id.frontend_autocomputed": "False",
"patch.editable_attributes.pump_id.format": "uuidv4",
"patch.editable_attributes.pump_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.gas_station_id.field": "gas_station_id",
"patch.editable_attributes.gas_station_id.type": "S",
"patch.editable_attributes.gas_station_id.required": "True",
"patch.editable_attributes.gas_station_id.source_required": "True",
"patch.editable_attributes.gas_station_id.server_generated": "True",
"patch.editable_attributes.gas_station_id.autogenerated": "False",
"patch.editable_attributes.gas_station_id.frontend_autocomputed": "False",
"patch.editable_attributes.gas_station_id.format": "uuidv4",
"patch.editable_attributes.gas_station_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.pump_key.field": "pump_key",
"patch.editable_attributes.pump_key.type": "S",
"patch.editable_attributes.pump_key.required": "True",
"patch.editable_attributes.pump_key.source_required": "True",
"patch.editable_attributes.pump_key.server_generated": "False",
"patch.editable_attributes.pump_key.autogenerated": "False",
"patch.editable_attributes.pump_key.frontend_autocomputed": "False",
"patch.editable_attributes.pump_key.regex": "^[A-Za-z0-9_-]{1,64}$",
"patch.editable_attributes.pump_code.field": "pump_code",
"patch.editable_attributes.pump_code.type": "S",
"patch.editable_attributes.pump_code.required": "True",
"patch.editable_attributes.pump_code.source_required": "True",
"patch.editable_attributes.pump_code.server_generated": "False",
"patch.editable_attributes.pump_code.autogenerated": "False",
"patch.editable_attributes.pump_code.frontend_autocomputed": "False",
"patch.editable_attributes.pump_code.regex": "^[A-Za-z0-9_-]{1,64}$",
"patch.editable_attributes.pump_name.field": "pump_name",
"patch.editable_attributes.pump_name.type": "S",
"patch.editable_attributes.pump_name.required": "True",
"patch.editable_attributes.pump_name.source_required": "True",
"patch.editable_attributes.pump_name.server_generated": "False",
"patch.editable_attributes.pump_name.autogenerated": "False",
"patch.editable_attributes.pump_name.frontend_autocomputed": "False",
"patch.editable_attributes.pump_name.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"patch.editable_attributes.pump_number.field": "pump_number",
"patch.editable_attributes.pump_number.type": "N",
"patch.editable_attributes.pump_number.required": "True",
"patch.editable_attributes.pump_number.source_required": "True",
"patch.editable_attributes.pump_number.server_generated": "False",
"patch.editable_attributes.pump_number.autogenerated": "False",
"patch.editable_attributes.pump_number.frontend_autocomputed": "False",
"patch.editable_attributes.pump_number.regex": "^\\d+$",
"patch.editable_attributes.product.field": "product",
"patch.editable_attributes.product.type": "S",
"patch.editable_attributes.product.required": "True",
"patch.editable_attributes.product.source_required": "True",
"patch.editable_attributes.product.server_generated": "False",
"patch.editable_attributes.product.autogenerated": "False",
"patch.editable_attributes.product.frontend_autocomputed": "False",
"patch.editable_attributes.product.regex": "^(diesel|regular|premium|unleaded)$",
"patch.editable_attributes.display_order.field": "display_order",
"patch.editable_attributes.display_order.type": "N",
"patch.editable_attributes.display_order.required": "True",
"patch.editable_attributes.display_order.source_required": "True",
"patch.editable_attributes.display_order.server_generated": "False",
"patch.editable_attributes.display_order.autogenerated": "False",
"patch.editable_attributes.display_order.frontend_autocomputed": "False",
"patch.editable_attributes.display_order.regex": "^\\d+$",
"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.remarks.field": "remarks",
"patch.editable_attributes.remarks.type": "S",
"patch.editable_attributes.remarks.required": "False",
"patch.editable_attributes.remarks.source_required": "False",
"patch.editable_attributes.remarks.server_generated": "False",
"patch.editable_attributes.remarks.autogenerated": "False",
"patch.editable_attributes.remarks.frontend_autocomputed": "False",
"patch.editable_attributes.remarks.regex": "^.{0,500}$",
"root.type": "object",
"root.attributes.pump_id.field": "pump_id",
"root.attributes.pump_id.type": "S",
"root.attributes.pump_id.required": "False",
"root.attributes.pump_id.source_required": "True",
"root.attributes.pump_id.server_generated": "True",
"root.attributes.pump_id.autogenerated": "False",
"root.attributes.pump_id.frontend_autocomputed": "False",
"root.attributes.pump_id.format": "uuidv4",
"root.attributes.pump_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.gas_station_id.field": "gas_station_id",
"root.attributes.gas_station_id.type": "S",
"root.attributes.gas_station_id.required": "True",
"root.attributes.gas_station_id.source_required": "True",
"root.attributes.gas_station_id.server_generated": "True",
"root.attributes.gas_station_id.autogenerated": "False",
"root.attributes.gas_station_id.frontend_autocomputed": "False",
"root.attributes.gas_station_id.format": "uuidv4",
"root.attributes.gas_station_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.pump_key.field": "pump_key",
"root.attributes.pump_key.type": "S",
"root.attributes.pump_key.required": "True",
"root.attributes.pump_key.source_required": "True",
"root.attributes.pump_key.server_generated": "False",
"root.attributes.pump_key.autogenerated": "False",
"root.attributes.pump_key.frontend_autocomputed": "False",
"root.attributes.pump_key.regex": "^[A-Za-z0-9_-]{1,64}$",
"root.attributes.pump_code.field": "pump_code",
"root.attributes.pump_code.type": "S",
"root.attributes.pump_code.required": "True",
"root.attributes.pump_code.source_required": "True",
"root.attributes.pump_code.server_generated": "False",
"root.attributes.pump_code.autogenerated": "False",
"root.attributes.pump_code.frontend_autocomputed": "False",
"root.attributes.pump_code.regex": "^[A-Za-z0-9_-]{1,64}$",
"root.attributes.pump_name.field": "pump_name",
"root.attributes.pump_name.type": "S",
"root.attributes.pump_name.required": "True",
"root.attributes.pump_name.source_required": "True",
"root.attributes.pump_name.server_generated": "False",
"root.attributes.pump_name.autogenerated": "False",
"root.attributes.pump_name.frontend_autocomputed": "False",
"root.attributes.pump_name.regex": "^[A-Za-z0-9 ._-]{1,100}$",
"root.attributes.pump_number.field": "pump_number",
"root.attributes.pump_number.type": "N",
"root.attributes.pump_number.required": "True",
"root.attributes.pump_number.source_required": "True",
"root.attributes.pump_number.server_generated": "False",
"root.attributes.pump_number.autogenerated": "False",
"root.attributes.pump_number.frontend_autocomputed": "False",
"root.attributes.pump_number.regex": "^\\d+$",
"root.attributes.product.field": "product",
"root.attributes.product.type": "S",
"root.attributes.product.required": "True",
"root.attributes.product.source_required": "True",
"root.attributes.product.server_generated": "False",
"root.attributes.product.autogenerated": "False",
"root.attributes.product.frontend_autocomputed": "False",
"root.attributes.product.regex": "^(diesel|regular|premium|unleaded)$",
"root.attributes.display_order.field": "display_order",
"root.attributes.display_order.type": "N",
"root.attributes.display_order.required": "True",
"root.attributes.display_order.source_required": "True",
"root.attributes.display_order.server_generated": "False",
"root.attributes.display_order.autogenerated": "False",
"root.attributes.display_order.frontend_autocomputed": "False",
"root.attributes.display_order.regex": "^\\d+$",
"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.remarks.field": "remarks",
"root.attributes.remarks.type": "S",
"root.attributes.remarks.required": "False",
"root.attributes.remarks.source_required": "False",
"root.attributes.remarks.server_generated": "False",
"root.attributes.remarks.autogenerated": "False",
"root.attributes.remarks.frontend_autocomputed": "False",
"root.attributes.remarks.regex": "^.{0,500}$"
}
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¶
{
"pump_id": "e4e17b22-f48d-4aee-8799-58bebca7de2f",
"gas_station_id": "e07ea318-4a7c-4151-ae0b-ad1721f799c6"
}
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://fsqf5slhc1.execute-api.ap-southeast-1.amazonaws.com/prod/fuel-pump-inventories-pumps-patch-one" -H "Content-Type: application/json" --data-raw "{\"pump_id\": \"e4e17b22-f48d-4aee-8799-58bebca7de2f\", \"gas_station_id\": \"e07ea318-4a7c-4151-ae0b-ad1721f799c6\"}"
PowerShell curl¶
curl.exe -X PATCH "https://fsqf5slhc1.execute-api.ap-southeast-1.amazonaws.com/prod/fuel-pump-inventories-pumps-patch-one" -H "Content-Type: application/json" --data-raw '{"pump_id": "e4e17b22-f48d-4aee-8799-58bebca7de2f", "gas_station_id": "e07ea318-4a7c-4151-ae0b-ad1721f799c6"}'