Methods

  • GET — Get a list of modules’ metadata descriptions

Resource

{
    "error": "string",
    "result": {
        "result": [
            {
                "__createdAt": "date-time",
                "__createdBy": "uuid",
                "__deletedAt": "date-time",
                "__id": "uuid",
                "__updatedAt": "date-time",
                "__updatedBy": "uuid",
                "code": "string",
                "name": "string",
                "namespace": "string"
            }
        ],
        "total": "int64"
    },
    "success": "boolean"
}

Properties

Name Type Description Additional
error string

Error message if success == false

Optional
result object Optional
result.result[] array

Found items

Optional
result.result[].__createdAt date-time

Date the module was created/installed

Optional
result.result[].__createdBy uuid

ID of the user who created or installed the module

Optional
result.result[].__deletedAt date-time

Date the module was deleted

Optional
result.result[].__id uuid

Module ID

Optional
result.result[].__updatedAt date-time

Date the module was edited/updated

Optional
result.result[].__updatedBy uuid

ID of the user who edited or updated the module

Optional
result.result[].code string

Module code

Optional
result.result[].name string

Module name

Optional
result.result[].namespace string Namespace. Optional
result.total int64

Total number of items

Optional
success boolean

Successful request flag

Optional