.. AUTO-GENERATED FILE. DO NOT EDIT. /one-domains-patch-one ====================== Summary ------- - **Source repository:** ``jef-systems/jef-one-backend`` - **Source SHA:** ``d9654d8969ce90b3c2674d5a82811b02e2bdaf1d`` - **Source run id:** ``29043491493`` - **Lambda function:** ``jef-one-patch-002`` - **HTTP method:** ``PATCH`` - **API path:** ``/one/async-patch/one-domains-patch-one`` - **Endpoint URL:** ``https://api.jefoffice.com/one/async-patch/one-domains-patch-one`` - **Payload mode:** ``json-body`` Description ----------- .. list-table:: :widths: 30 70 * - ``Function`` - jef-one-patch-002 Logical ID: jef-one:jef-one-domains:patch-one Order Number: 002 * - ``Module`` - jef-one * - ``Action`` - patch-one * - ``Method`` - PATCH * - ``Invocation Mode`` - ASYNC * - ``Resource Path`` - /one-domains-patch-one Endpoint Name: jef-one-domains-patch-one * - ``Table`` - jef-one-domains * - ``Primary Key`` - domain\_id API Gateway Response -------------------- .. list-table:: :widths: 30 70 * - ``status\_code`` - 202 * - ``message`` - Request accepted for asynchronous processing. Payload Example --------------- .. list-table:: :widths: 30 70 * - ``domain\_id`` - 87ef2348-42be-4d63-bbf8-b4affbdf54c5 * - ``domain\_name`` - Sample Name Payload Schema -------------- .. code-block:: json { "type": "object", "additionalProperties": "False", "payload_mode": "parent-plus-children-wrapper", "allow_children_wrapper": "True", "children_wrapper_field": "children", "allow_batch": "False", "table": "jef-one-domains", "primary_key": "domain_id", "required[0]": "domain_id", "properties.domain_id.field": "domain_id", "properties.domain_id.type": "S", "properties.domain_id.required": "False", "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.domain_name.field": "domain_name", "properties.domain_name.type": "S", "properties.domain_name.required": "True", "properties.domain_name.source_required": "True", "properties.domain_name.server_generated": "False", "properties.domain_name.autogenerated": "False", "properties.domain_name.frontend_autocomputed": "False", "properties.domain_name.regex": "^[A-Za-z0-9 ._-]{1,120}$", "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-domains", "children[0].child_table": "jef-one-applications", "children[0].parent_key": "domain_id", "children[0].child_foreign_key": "domain_id", "children[0].child_index_name": "gsi_1", "children[0].child_index_key": "gsi_1_pk", "children[0].aliases[0]": "jef-one-applications", "children[0].aliases[1]": "applications", "children[0].aliases[2]": "one-applications", "children[0].aliases[3]": "jef_one_applications", "children[0].aliases[4]": "one_applications", "children[1].parent_table": "jef-one-domains", "children[1].child_table": "jef-one-employees", "children[1].parent_key": "domain_id", "children[1].child_foreign_key": "domain_id", "children[1].child_index_name": "gsi_1", "children[1].child_index_key": "gsi_1_pk", "children[1].aliases[0]": "jef-one-employees", "children[1].aliases[1]": "employees", "children[1].aliases[2]": "one-employees", "children[1].aliases[3]": "jef_one_employees", "children[1].aliases[4]": "one_employees", "children[2].parent_table": "jef-one-domains", "children[2].child_table": "jef-one-entities", "children[2].parent_key": "domain_id", "children[2].child_foreign_key": "domain_id", "children[2].child_index_name": "gsi_1", "children[2].child_index_key": "gsi_1_pk", "children[2].aliases[0]": "jef-one-entities", "children[2].aliases[1]": "entities", "children[2].aliases[2]": "one-entities", "children[2].aliases[3]": "jef_one_entities", "children[2].aliases[4]": "one_entities", "children[3].parent_table": "jef-one-domains", "children[3].child_table": "jef-one-sessions", "children[3].parent_key": "domain_id", "children[3].child_foreign_key": "domain_id", "children[3].child_index_name": "gsi_1", "children[3].child_index_key": "gsi_1_pk", "children[3].aliases[0]": "jef-one-sessions", "children[3].aliases[1]": "sessions", "children[3].aliases[2]": "one-sessions", "children[3].aliases[3]": "jef_one_sessions", "children[3].aliases[4]": "one_sessions", "patch.semantic_patch_version": "patch-ignore-immutable-v2", "patch.allowed_fields[0]": "domain_id", "patch.allowed_fields[1]": "domain_name", "patch.allowed_fields[2]": "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.domain_id.field": "domain_id", "patch.editable_attributes.domain_id.type": "S", "patch.editable_attributes.domain_id.required": "False", "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.domain_name.field": "domain_name", "patch.editable_attributes.domain_name.type": "S", "patch.editable_attributes.domain_name.required": "True", "patch.editable_attributes.domain_name.source_required": "True", "patch.editable_attributes.domain_name.server_generated": "False", "patch.editable_attributes.domain_name.autogenerated": "False", "patch.editable_attributes.domain_name.frontend_autocomputed": "False", "patch.editable_attributes.domain_name.regex": "^[A-Za-z0-9 ._-]{1,120}$", "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.domain_id.field": "domain_id", "root.attributes.domain_id.type": "S", "root.attributes.domain_id.required": "False", "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.domain_name.field": "domain_name", "root.attributes.domain_name.type": "S", "root.attributes.domain_name.required": "True", "root.attributes.domain_name.source_required": "True", "root.attributes.domain_name.server_generated": "False", "root.attributes.domain_name.autogenerated": "False", "root.attributes.domain_name.frontend_autocomputed": "False", "root.attributes.domain_name.regex": "^[A-Za-z0-9 ._-]{1,120}$", "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 --------------- .. code-block:: json { "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 --------------- .. code-block:: json { "domain_id": "87ef2348-42be-4d63-bbf8-b4affbdf54c5", "domain_name": "Sample Name" } Response -------- .. code-block:: json { "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 -------- .. code-block:: bat curl -X PATCH "https://api.jefoffice.com/one/one-domains-patch-one" -H "Content-Type: application/json" --data-raw "{\"domain_id\": \"87ef2348-42be-4d63-bbf8-b4affbdf54c5\", \"domain_name\": \"Sample Name\"}" PowerShell curl --------------- .. code-block:: powershell curl.exe -X PATCH "https://api.jefoffice.com/one/one-domains-patch-one" -H "Content-Type: application/json" --data-raw '{"domain_id": "87ef2348-42be-4d63-bbf8-b4affbdf54c5", "domain_name": "Sample Name"}'