getCommonPropertyDefs() — Schema Manager

Retrieves the list of common property definitions that can be used when creating entity properties.

Request Format

getCommonPropertyDefs(
    token: string,          // Authentication token
    tenantCode?: string     // Optional tenant code
): Promise<{
    success: boolean,
    data?: Record<string, any>,
    error?: string
}>

Response Format

{
    "success": boolean,
    "data": {
        // Dictionary of property definitions with their IDs as keys
    },
    "error": "string"      // Present only if success is false
}

Common Property Definition Types

Type	Definition ID	Description
ID	5c0aa76f-9c32-4e7e-a4bc-b56e93877883	Unique identifier
String	c6c34bf3-f51b-4e69-a689-b09847be74b9	Text string
Number	35efcf9c-fff0-44d4-8972-73a9a32b93fa	Numeric value
Boolean	7868afdf-2709-45be-87e3-87de8d35f30f	True/false value
DateTime	12e647e0-ebd2-4ec2-a4e3-82c1dfe07da2	Date and time
Reference	924acba8-58c5-4881-940d-472ec01eba5f	Entity reference
Enum	7bf08f4f-7de0-469e-bbfb-f4c43762f4d7	Enumerated value
RichText	e07f578e-2705-49c1-b97f-3ca5963c67c0	Rich text content
Email	df7ce94b-d59c-4b67-8519-aa4c98ab477c	Email address
Password	7291fbc2-a7cf-4713-a876-0cff085cc035	Password field

Example

const result = await getCommonPropertyDefs("your-auth-token");
// Access a specific property definition
const stringType = result.data["c6c34bf3-f51b-4e69-a689-b09847be74b9"];