/desktop-store-entities-patch-one

Summary

  • Source repository: jef-systems/jef-desktop-store-backend

  • Source SHA: 2b92d774a426674e0b8bd48728f9d3a7fcdd131d

  • Source run id: 28976251962

  • Lambda function: jef-desktop-store-patch-002

  • HTTP method: PATCH

  • API path: /desktop-store-entities-patch-one

  • Endpoint URL: https://api.jefoffice.com/desktop-store-entities-patch-one

  • Payload mode: json-body

Description

Function

jef-desktop-store-patch-002 Logical ID: jef-desktop-store:jef-desktop-store-entities:patch-one Order Number: 003

Module

jef-desktop-store

Action

patch-one

Method

PATCH

Invocation Mode

ASYNC

Resource Path

/desktop-store-entities-patch-one Endpoint Name: jef-desktop-store-entities-patch-one

Table

jef-desktop-store-entities

Primary Key

entity_id

API Gateway Response

status\_code

202

message

Request accepted for asynchronous processing.

Payload Example

entity\_id

6db68fe0-9579-4d97-81c0-9d2dc8e97c68

domain\_id

fcecf2a5-53f5-4d4c-92cc-3b7a61a2f923

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-desktop-store-entities",
  "primary_key": "entity_id",
  "required[0]": "entity_id",
  "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.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.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.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.entity_type.field": "entity_type",
  "properties.entity_type.type": "S",
  "properties.entity_type.required": "True",
  "properties.entity_type.source_required": "True",
  "properties.entity_type.server_generated": "False",
  "properties.entity_type.autogenerated": "False",
  "properties.entity_type.frontend_autocomputed": "False",
  "properties.entity_type.regex": "^(store|company|branch|organization)$",
  "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-desktop-store-entities",
  "children[0].child_table": "jef-desktop-store-allowed-applications",
  "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-desktop-store-allowed-applications",
  "children[0].aliases[1]": "allowed-applications",
  "children[0].aliases[2]": "desktop-store-allowed-applications",
  "children[0].aliases[3]": "jef_desktop_store_allowed_applications",
  "children[0].aliases[4]": "allowed_applications",
  "children[0].aliases[5]": "desktop_store_allowed_applications",
  "children[0].aliases[6]": "applications",
  "patch.semantic_patch_version": "patch-ignore-immutable-v2",
  "patch.allowed_fields[0]": "entity_id",
  "patch.allowed_fields[1]": "domain_id",
  "patch.allowed_fields[2]": "domain_name",
  "patch.allowed_fields[3]": "entity_number",
  "patch.allowed_fields[4]": "entity_name",
  "patch.allowed_fields[5]": "entity_type",
  "patch.allowed_fields[6]": "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.entity_id.field": "entity_id",
  "patch.editable_attributes.entity_id.type": "S",
  "patch.editable_attributes.entity_id.required": "False",
  "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.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.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.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.entity_name.field": "entity_name",
  "patch.editable_attributes.entity_name.type": "S",
  "patch.editable_attributes.entity_name.required": "True",
  "patch.editable_attributes.entity_name.source_required": "True",
  "patch.editable_attributes.entity_name.server_generated": "False",
  "patch.editable_attributes.entity_name.autogenerated": "False",
  "patch.editable_attributes.entity_name.frontend_autocomputed": "False",
  "patch.editable_attributes.entity_name.regex": "^[A-Za-z0-9 ._-]{1,120}$",
  "patch.editable_attributes.entity_type.field": "entity_type",
  "patch.editable_attributes.entity_type.type": "S",
  "patch.editable_attributes.entity_type.required": "True",
  "patch.editable_attributes.entity_type.source_required": "True",
  "patch.editable_attributes.entity_type.server_generated": "False",
  "patch.editable_attributes.entity_type.autogenerated": "False",
  "patch.editable_attributes.entity_type.frontend_autocomputed": "False",
  "patch.editable_attributes.entity_type.regex": "^(store|company|branch|organization)$",
  "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.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.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.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.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.entity_type.field": "entity_type",
  "root.attributes.entity_type.type": "S",
  "root.attributes.entity_type.required": "True",
  "root.attributes.entity_type.source_required": "True",
  "root.attributes.entity_type.server_generated": "False",
  "root.attributes.entity_type.autogenerated": "False",
  "root.attributes.entity_type.frontend_autocomputed": "False",
  "root.attributes.entity_type.regex": "^(store|company|branch|organization)$",
  "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

{
  "entity_id": "6db68fe0-9579-4d97-81c0-9d2dc8e97c68",
  "domain_id": "fcecf2a5-53f5-4d4c-92cc-3b7a61a2f923"
}

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/desktop-store-entities-patch-one" -H "Content-Type: application/json" --data-raw "{\"entity_id\": \"6db68fe0-9579-4d97-81c0-9d2dc8e97c68\", \"domain_id\": \"fcecf2a5-53f5-4d4c-92cc-3b7a61a2f923\"}"

PowerShell curl

curl.exe -X PATCH "https://api.jefoffice.com/desktop-store-entities-patch-one" -H "Content-Type: application/json" --data-raw '{"entity_id": "6db68fe0-9579-4d97-81c0-9d2dc8e97c68", "domain_id": "fcecf2a5-53f5-4d4c-92cc-3b7a61a2f923"}'