Skip to main content

Custom module object with comprehensive configuration and administrative details

ā€‹
_id
string

Unique identifier for the custom module (MongoDB ObjectId)

Example:

"62846484ed5be87b6f4358f3"

ā€‹
organizationId
string

Organization identifier that owns this custom module

Example:

"61dfa3b15b32000041005113"

ā€‹
name
string

Display name for the custom module menu option

Example:

"Custom Report"

ā€‹
label
string

System label automatically generated from name for backend processing

Example:

"custom-report"

ā€‹
url
string<uri>

URL or link that the custom module leads to

Example:

"https://example.com/v1"

ā€‹
inputType
string

The input type of the component (e.g., string, number, date, etc.)

ā€‹
isActive
boolean

Whether the custom module is currently active

Example:

true

ā€‹
isDeleted
boolean

Soft delete flag indicating if custom module is deleted

Example:

false

ā€‹
permissions
string[]

List of role IDs that have access to this custom module

Example:
[
  "65c1f68ea735b522d370ea24",
  "65c1f68ea735b522d370ea25"
]
ā€‹
configuration
object

Additional configuration settings for the custom module

ā€‹
createdTime
string<date-time>

ISO 8601 timestamp when custom module was created

Example:

"2022-05-18T03:14:12.989Z"

ā€‹
updatedTime
string<date-time>

ISO 8601 timestamp when custom module was last updated

Example:

"2022-05-18T03:14:12.989Z"

ā€‹
deletedTime
string<date-time>

ISO 8601 timestamp when custom module was deleted

Example:

"2022-05-18T05:00:58.000Z"

ā€‹
createdBy
string

Email of user who created this custom module

Example:

"admin@mile.app"

ā€‹
updatedBy
string

Email of user who last updated this custom module

Example:

"admin@mile.app"

ā€‹
metadata
object

Additional metadata for internal system use

ā€‹
failedCode
enum<string>

Custom Module business failedCode that indicate specific failure conditions or business rule violations during custom module operations. These codes help identify the failed operation of custom module-related and provide standardized failure identification across the system.

Possible values:

  • cmod-031: Duplicate entry - Custom module already exists
  • cmod-033: Custom module not found - Custom module does not exist
  • cmod-035: Access forbidden - User lacks custom module permission
  • cmod-036: Custom module creation failed - Failed to create custom module
  • cmod-037: Custom module update failed - Failed to update custom module
  • cmod-038: Custom module delete failed - Failed to delete custom module
  • cmod-039: Custom module permission denied - Custom module access denied
  • cmod-045: Server failure - Internal server failure
Available options:
cmod-031,
cmod-033,
cmod-035,
cmod-036,
cmod-037,
cmod-038,
cmod-039,
cmod-045