Get entity by entity number

Summary

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

• Source SHA: fc63b90deba131d1510b6789c172b240e305d07c

• Source run id: 26362659871

• Module: One

• Lambda function: jef-one-get-entity-by-entity-number

• HTTP method: GET

• Invocation mode: sync

• Package mode: no-package

• API category: One Complex No Package Sync GET APIs

• API path: /jef-one-get-entity-by-entity-number

• Endpoint URL: https://mfr670zvsh.execute-api.ap-southeast-1.amazonaws.com/prod/jef-one-get-entity-by-entity-number?entity\_number=1001

• Documentation scope: lambda-complex-no-packages

Sync Read Rule

This GET API is documented as a direct synchronous read path.

Description

GET endpoint that retrieves one active entity from jef-one-entities by entity_number using gsi_2 index get-by-entity-number. It detects missing, inactive, duplicate, and incomplete entity records.

Payload Example

{
  "entity_number": "1001"
}

Payload Schema

{
  "root": {
    "type": "M",
    "required": true,
    "attributes": {
      "entity_number": {
        "type": "S",
        "required": true,
        "regex": "^[0-9]{4}$"
      }
    }
  }
}

Response Schema

{
  "root": {
    "type": "M",
    "required": true,
    "attributes": {
      "is_accepted": {
        "type": "BOOL",
        "required": true
      },
      "is_found": {
        "type": "BOOL",
        "required": true
      },
      "can_continue": {
        "type": "BOOL",
        "required": true
      },
      "entity_active": {
        "type": "BOOL",
        "required": true
      },
      "message_type": {
        "type": "S",
        "required": true
      },
      "message": {
        "type": "S",
        "required": true
      },
      "next_action": {
        "type": "S",
        "required": true
      },
      "operation": {
        "type": "S",
        "required": true
      },
      "status_code": {
        "type": "N",
        "required": true
      },
      "entity_id": {
        "type": "S",
        "required": false
      },
      "entity_number": {
        "type": "S",
        "required": false
      },
      "entity_name": {
        "type": "S",
        "required": false
      },
      "is_active": {
        "type": "BOOL",
        "required": false
      },
      "created_at": {
        "type": "S",
        "required": false
      },
      "updated_at": {
        "type": "S",
        "required": false
      },
      "failure_code": {
        "type": "S",
        "required": false
      },
      "failure_reason": {
        "type": "S",
        "required": false
      },
      "missing_fields": {
        "type": "L",
        "required": false
      }
    }
  }
}

CMD curl

curl -X GET "https://mfr670zvsh.execute-api.ap-southeast-1.amazonaws.com/prod/jef-one-get-entity-by-entity-number?entity_number=1001"

PowerShell curl

curl.exe -X GET "https://mfr670zvsh.execute-api.ap-southeast-1.amazonaws.com/prod/jef-one-get-entity-by-entity-number?entity_number=1001"