/one-employees-patch-one

Summary

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

  • Source SHA: d9654d8969ce90b3c2674d5a82811b02e2bdaf1d

  • Source run id: 29043491493

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

  • HTTP method: PATCH

  • API path: /one/async-patch/one-employees-patch-one

  • Endpoint URL: https://api.jefoffice.com/one/async-patch/one-employees-patch-one

  • Payload mode: json-body

Description

Function

jef-one-employees-patch-one Logical ID: jef-one:jef-one-employees:patch-one Order Number: 003

Module

jef-one

Action

patch-one

Method

PATCH

Invocation Mode

ASYNC

Resource Path

/one-employees-patch-one Endpoint Name: jef-one-employees-patch-one

Table

jef-one-employees

Primary Key

employee_id

API Gateway Response

status\_code

202

message

Request accepted for asynchronous processing.

Payload Example

employee\_id

5c7939f5-1f6b-4cef-903d-4bfbcb8c2d2d

domain\_id

ca170b81-6e4b-4f10-adb8-9563cc3ab135

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-employees",
  "primary_key": "employee_id",
  "required[0]": "employee_id",
  "properties.employee_id.field": "employee_id",
  "properties.employee_id.type": "S",
  "properties.employee_id.required": "False",
  "properties.employee_id.source_required": "True",
  "properties.employee_id.server_generated": "True",
  "properties.employee_id.autogenerated": "False",
  "properties.employee_id.frontend_autocomputed": "False",
  "properties.employee_id.format": "uuidv4",
  "properties.employee_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.domain_id.field": "domain_id",
  "properties.domain_id.type": "S",
  "properties.domain_id.required": "True",
  "properties.domain_id.source_required": "True",
  "properties.domain_id.server_generated": "True",
  "properties.domain_id.autogenerated": "False",
  "properties.domain_id.frontend_autocomputed": "False",
  "properties.domain_id.format": "uuidv4",
  "properties.domain_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_id.field": "entity_id",
  "properties.entity_id.type": "S",
  "properties.entity_id.required": "True",
  "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.employee_number.field": "employee_number",
  "properties.employee_number.type": "S",
  "properties.employee_number.required": "True",
  "properties.employee_number.source_required": "True",
  "properties.employee_number.server_generated": "False",
  "properties.employee_number.autogenerated": "False",
  "properties.employee_number.frontend_autocomputed": "False",
  "properties.employee_number.regex": "^[0-9]{5}$",
  "properties.display_name.field": "display_name",
  "properties.display_name.type": "S",
  "properties.display_name.required": "True",
  "properties.display_name.source_required": "True",
  "properties.display_name.server_generated": "False",
  "properties.display_name.autogenerated": "False",
  "properties.display_name.frontend_autocomputed": "False",
  "properties.display_name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
  "properties.employee_password_hash.field": "employee_password_hash",
  "properties.employee_password_hash.type": "S",
  "properties.employee_password_hash.required": "True",
  "properties.employee_password_hash.source_required": "True",
  "properties.employee_password_hash.server_generated": "False",
  "properties.employee_password_hash.autogenerated": "False",
  "properties.employee_password_hash.frontend_autocomputed": "False",
  "properties.employee_password_hash.regex": "^.{1,500}$",
  "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-employees",
  "children[0].child_table": "jef-one-employee-logs",
  "children[0].parent_key": "employee_id",
  "children[0].child_foreign_key": "employee_id",
  "children[0].child_index_name": "gsi_1",
  "children[0].child_index_key": "gsi_1_pk",
  "children[0].aliases[0]": "jef-one-employee-logs",
  "children[0].aliases[1]": "employee-logs",
  "children[0].aliases[2]": "one-employee-logs",
  "children[0].aliases[3]": "jef_one_employee_logs",
  "children[0].aliases[4]": "employee_logs",
  "children[0].aliases[5]": "one_employee_logs",
  "children[0].aliases[6]": "logs",
  "patch.semantic_patch_version": "patch-ignore-immutable-v2",
  "patch.allowed_fields[0]": "employee_id",
  "patch.allowed_fields[1]": "domain_id",
  "patch.allowed_fields[2]": "entity_id",
  "patch.allowed_fields[3]": "entity_number",
  "patch.allowed_fields[4]": "employee_number",
  "patch.allowed_fields[5]": "display_name",
  "patch.allowed_fields[6]": "employee_password_hash",
  "patch.allowed_fields[7]": "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.employee_id.field": "employee_id",
  "patch.editable_attributes.employee_id.type": "S",
  "patch.editable_attributes.employee_id.required": "False",
  "patch.editable_attributes.employee_id.source_required": "True",
  "patch.editable_attributes.employee_id.server_generated": "True",
  "patch.editable_attributes.employee_id.autogenerated": "False",
  "patch.editable_attributes.employee_id.frontend_autocomputed": "False",
  "patch.editable_attributes.employee_id.format": "uuidv4",
  "patch.editable_attributes.employee_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.domain_id.field": "domain_id",
  "patch.editable_attributes.domain_id.type": "S",
  "patch.editable_attributes.domain_id.required": "True",
  "patch.editable_attributes.domain_id.source_required": "True",
  "patch.editable_attributes.domain_id.server_generated": "True",
  "patch.editable_attributes.domain_id.autogenerated": "False",
  "patch.editable_attributes.domain_id.frontend_autocomputed": "False",
  "patch.editable_attributes.domain_id.format": "uuidv4",
  "patch.editable_attributes.domain_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_id.field": "entity_id",
  "patch.editable_attributes.entity_id.type": "S",
  "patch.editable_attributes.entity_id.required": "True",
  "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.employee_number.field": "employee_number",
  "patch.editable_attributes.employee_number.type": "S",
  "patch.editable_attributes.employee_number.required": "True",
  "patch.editable_attributes.employee_number.source_required": "True",
  "patch.editable_attributes.employee_number.server_generated": "False",
  "patch.editable_attributes.employee_number.autogenerated": "False",
  "patch.editable_attributes.employee_number.frontend_autocomputed": "False",
  "patch.editable_attributes.employee_number.regex": "^[0-9]{5}$",
  "patch.editable_attributes.display_name.field": "display_name",
  "patch.editable_attributes.display_name.type": "S",
  "patch.editable_attributes.display_name.required": "True",
  "patch.editable_attributes.display_name.source_required": "True",
  "patch.editable_attributes.display_name.server_generated": "False",
  "patch.editable_attributes.display_name.autogenerated": "False",
  "patch.editable_attributes.display_name.frontend_autocomputed": "False",
  "patch.editable_attributes.display_name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
  "patch.editable_attributes.employee_password_hash.field": "employee_password_hash",
  "patch.editable_attributes.employee_password_hash.type": "S",
  "patch.editable_attributes.employee_password_hash.required": "True",
  "patch.editable_attributes.employee_password_hash.source_required": "True",
  "patch.editable_attributes.employee_password_hash.server_generated": "False",
  "patch.editable_attributes.employee_password_hash.autogenerated": "False",
  "patch.editable_attributes.employee_password_hash.frontend_autocomputed": "False",
  "patch.editable_attributes.employee_password_hash.regex": "^.{1,500}$",
  "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.employee_id.field": "employee_id",
  "root.attributes.employee_id.type": "S",
  "root.attributes.employee_id.required": "False",
  "root.attributes.employee_id.source_required": "True",
  "root.attributes.employee_id.server_generated": "True",
  "root.attributes.employee_id.autogenerated": "False",
  "root.attributes.employee_id.frontend_autocomputed": "False",
  "root.attributes.employee_id.format": "uuidv4",
  "root.attributes.employee_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.domain_id.field": "domain_id",
  "root.attributes.domain_id.type": "S",
  "root.attributes.domain_id.required": "True",
  "root.attributes.domain_id.source_required": "True",
  "root.attributes.domain_id.server_generated": "True",
  "root.attributes.domain_id.autogenerated": "False",
  "root.attributes.domain_id.frontend_autocomputed": "False",
  "root.attributes.domain_id.format": "uuidv4",
  "root.attributes.domain_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_id.field": "entity_id",
  "root.attributes.entity_id.type": "S",
  "root.attributes.entity_id.required": "True",
  "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.employee_number.field": "employee_number",
  "root.attributes.employee_number.type": "S",
  "root.attributes.employee_number.required": "True",
  "root.attributes.employee_number.source_required": "True",
  "root.attributes.employee_number.server_generated": "False",
  "root.attributes.employee_number.autogenerated": "False",
  "root.attributes.employee_number.frontend_autocomputed": "False",
  "root.attributes.employee_number.regex": "^[0-9]{5}$",
  "root.attributes.display_name.field": "display_name",
  "root.attributes.display_name.type": "S",
  "root.attributes.display_name.required": "True",
  "root.attributes.display_name.source_required": "True",
  "root.attributes.display_name.server_generated": "False",
  "root.attributes.display_name.autogenerated": "False",
  "root.attributes.display_name.frontend_autocomputed": "False",
  "root.attributes.display_name.regex": "^[A-Za-z0-9 .,'_-]{1,120}$",
  "root.attributes.employee_password_hash.field": "employee_password_hash",
  "root.attributes.employee_password_hash.type": "S",
  "root.attributes.employee_password_hash.required": "True",
  "root.attributes.employee_password_hash.source_required": "True",
  "root.attributes.employee_password_hash.server_generated": "False",
  "root.attributes.employee_password_hash.autogenerated": "False",
  "root.attributes.employee_password_hash.frontend_autocomputed": "False",
  "root.attributes.employee_password_hash.regex": "^.{1,500}$",
  "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

{
  "employee_id": "5c7939f5-1f6b-4cef-903d-4bfbcb8c2d2d",
  "domain_id": "ca170b81-6e4b-4f10-adb8-9563cc3ab135"
}

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/one/one-employees-patch-one" -H "Content-Type: application/json" --data-raw "{\"employee_id\": \"5c7939f5-1f6b-4cef-903d-4bfbcb8c2d2d\", \"domain_id\": \"ca170b81-6e4b-4f10-adb8-9563cc3ab135\"}"

PowerShell curl

curl.exe -X PATCH "https://api.jefoffice.com/one/one-employees-patch-one" -H "Content-Type: application/json" --data-raw '{"employee_id": "5c7939f5-1f6b-4cef-903d-4bfbcb8c2d2d", "domain_id": "ca170b81-6e4b-4f10-adb8-9563cc3ab135"}'