/one-entities-post-one¶
Summary¶
Source repository:
jef-systems/jef-one-backendSource SHA:
e6d90f29ab4b076938829f02d6199b3d644ba174Source run id:
28388871773Lambda function:
jef-one-post-003HTTP method:
POSTAPI path:
/one-entities-post-oneEndpoint URL:
https://mfr670zvsh.execute-api.ap-southeast-1.amazonaws.com/prod/one-entities-post-onePayload mode:
json-body
Description¶
|
jef-one-post-003 Logical ID: jef-one:jef-one-entities:post-one Order Number: 003 |
|
jef-one |
|
post-one |
|
POST |
|
ASYNC |
|
/one-entities-post-one Endpoint Name: jef-one-entities-post-one |
|
jef-one-entities |
|
entity_id |
API Gateway Response¶
|
202 |
|
Request accepted for asynchronous processing. |
Payload Example¶
|
5288443d-64c7-4acd-a561-6ec28f5128f9 |
|
value-001 |
|
Sample Name |
|
Sample Name |
|
value-001 |
|
True |
|
2026-06-29T16:55:47Z |
|
2026-06-29T16:55:47Z |
|
fe23966c-9098-4fc7-ad49-6f29c3fbc9cd |
|
5288443d-64c7-4acd-a561-6ec28f5128f9 |
|
value-001 |
|
value-001 |
|
Sample Name |
|
value-001 |
|
True |
|
2026-06-29T16:55:47Z |
|
2026-06-29T16:55:47Z |
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_number",
"required[1]": "entity_name",
"required[2]": "main_parent_key_name",
"required[3]": "main_parent_key_value",
"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)$",
"properties.created.field": "created",
"properties.created.type": "S",
"properties.created.required": "False",
"properties.created.source_required": "True",
"properties.created.server_generated": "True",
"properties.created.autogenerated": "False",
"properties.created.frontend_autocomputed": "False",
"properties.created.format": "iso8601",
"properties.created.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
"properties.updated.field": "updated",
"properties.updated.type": "S",
"properties.updated.required": "False",
"properties.updated.source_required": "True",
"properties.updated.server_generated": "True",
"properties.updated.autogenerated": "False",
"properties.updated.frontend_autocomputed": "False",
"properties.updated.format": "iso8601",
"properties.updated.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
"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",
"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)$",
"root.attributes.created.field": "created",
"root.attributes.created.type": "S",
"root.attributes.created.required": "False",
"root.attributes.created.source_required": "True",
"root.attributes.created.server_generated": "True",
"root.attributes.created.autogenerated": "False",
"root.attributes.created.frontend_autocomputed": "False",
"root.attributes.created.format": "iso8601",
"root.attributes.created.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$",
"root.attributes.updated.field": "updated",
"root.attributes.updated.type": "S",
"root.attributes.updated.required": "False",
"root.attributes.updated.source_required": "True",
"root.attributes.updated.server_generated": "True",
"root.attributes.updated.autogenerated": "False",
"root.attributes.updated.frontend_autocomputed": "False",
"root.attributes.updated.format": "iso8601",
"root.attributes.updated.regex": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,6})?Z?$"
}
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_write_count.type": "number",
"properties.child_write_count.type": "number"
}
Request Payload¶
{
"entity_id": "5288443d-64c7-4acd-a561-6ec28f5128f9",
"entity_number": "value-001",
"entity_name": "Sample Name",
"main_parent_key_name": "Sample Name",
"main_parent_key_value": "value-001",
"is_active": "True",
"created": "2026-06-29T16:55:47Z",
"updated": "2026-06-29T16:55:47Z",
"children.jef-one-employees[0].employee_id": "fe23966c-9098-4fc7-ad49-6f29c3fbc9cd",
"children.jef-one-employees[0].entity_id": "5288443d-64c7-4acd-a561-6ec28f5128f9",
"children.jef-one-employees[0].entity_number": "value-001",
"children.jef-one-employees[0].employee_number": "value-001",
"children.jef-one-employees[0].display_name": "Sample Name",
"children.jef-one-employees[0].employee_password_hash": "value-001",
"children.jef-one-employees[0].is_active": "True",
"children.jef-one-employees[0].created": "2026-06-29T16:55:47Z",
"children.jef-one-employees[0].updated": "2026-06-29T16:55:47Z"
}
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_write_count.type": "number",
"properties.child_write_count.type": "number"
}
CMD curl¶
curl -X POST "https://mfr670zvsh.execute-api.ap-southeast-1.amazonaws.com/prod/one-entities-post-one" -H "Content-Type: application/json" --data-raw "{\"entity_id\": \"5288443d-64c7-4acd-a561-6ec28f5128f9\", \"entity_number\": \"value-001\", \"entity_name\": \"Sample Name\", \"main_parent_key_name\": \"Sample Name\", \"main_parent_key_value\": \"value-001\", \"is_active\": true, \"created\": \"2026-06-29T16:55:47Z\", \"updated\": \"2026-06-29T16:55:47Z\", \"children\": {\"jef-one-employees\": [{\"employee_id\": \"fe23966c-9098-4fc7-ad49-6f29c3fbc9cd\", \"entity_id\": \"5288443d-64c7-4acd-a561-6ec28f5128f9\", \"entity_number\": \"value-001\", \"employee_number\": \"value-001\", \"display_name\": \"Sample Name\", \"employee_password_hash\": \"value-001\", \"is_active\": true, \"created\": \"2026-06-29T16:55:47Z\", \"updated\": \"2026-06-29T16:55:47Z\"}]}}"
PowerShell curl¶
curl.exe -X POST "https://mfr670zvsh.execute-api.ap-southeast-1.amazonaws.com/prod/one-entities-post-one" -H "Content-Type: application/json" --data-raw '{"entity_id": "5288443d-64c7-4acd-a561-6ec28f5128f9", "entity_number": "value-001", "entity_name": "Sample Name", "main_parent_key_name": "Sample Name", "main_parent_key_value": "value-001", "is_active": true, "created": "2026-06-29T16:55:47Z", "updated": "2026-06-29T16:55:47Z", "children": {"jef-one-employees": [{"employee_id": "fe23966c-9098-4fc7-ad49-6f29c3fbc9cd", "entity_id": "5288443d-64c7-4acd-a561-6ec28f5128f9", "entity_number": "value-001", "employee_number": "value-001", "display_name": "Sample Name", "employee_password_hash": "value-001", "is_active": true, "created": "2026-06-29T16:55:47Z", "updated": "2026-06-29T16:55:47Z"}]}}'