Public Web API: Model of module’s metadata description instance (Get metadata descriptions of a module by ID)

Methods

GET — Get metadata descriptions of a module by ID

Resource

{
    "error": "string",
    "module": {
        "__createdAt": "date-time",
        "__createdBy": "uuid",
        "__deletedAt": "date-time",
        "__id": "uuid",
        "__updatedAt": "date-time",
        "__updatedBy": "uuid",
        "author": "string",
        "code": "string",
        "description": "string",
        "enabled": "boolean",
        "help": "string",
        "language": "string",
        "name": "string",
        "namespace": "string",
        "summary": "string",
        "website": "string"
    },
    "success": "boolean"
}

Properties

Name	Type	Description	Additional
error	string	Error message if `success == false`	Optional
module	object	Full metadata description of a module	Optional
module.__createdAt	date-time	Date the module was created/installed	Optional
module.__createdBy	uuid	ID of the user who created or installed the module	Optional
module.__deletedAt	date-time	Date the module was deleted	Optional
module.__id	uuid	Module ID	Optional
module.__updatedAt	date-time	Date the module was edited/updated	Optional
module.__updatedBy	uuid	ID of the user who edited or updated the module	Optional
module.author	string	Module’s author	Optional
module.code	string	Module code	Optional
module.description	string	Expanded description of a module	Optional
module.enabled	boolean	Whether the module is active (enabled/disabled)	Optional
module.help	string	Help link	Optional
module.language	string	Module language	Optional
module.name	string	Module name	Optional
module.namespace	string	Namespace.	Optional
module.summary	string	Brief description of the module	Optional
module.website	string	Link to the module developer’s website	Optional
success	boolean	Successful request flag	Optional