read all modules

The read all modules API sends a GET request to retrieve all modules.

Prerequisites: The caller must supply the id for the requested module.

Authorization: API key

Input parameters:

Field nameDescriptionFormat
offsetInteger
limitInteger
bookmarkedBoolean
projectIdProject idUUID
module_type
exclude_module_type

Output parameters

Field nameDescriptionFormat
elementsContainer - see belowElements
totalNumber of elementsInteger

Elements:

Field nameDescriptionFormat
idModule idUUID
nameModule nameString
modifiedAtDate-time module was modifiedInstant
modifiedByUser who modified the moduleString
descriptionDescription text of moduleString
bookmarkedIs the module bookmarked?Boolean
createdAtDate-time module was createdInstant
additionalInfoContainer - see belowAdditionalInfo

AdditionalInfo:

Field nameDescriptionFormat
numOfAssetsNumber of assets in moduleInteger
numOfProjectsNumber of projects containing moduleInteger
typeModule typeString

Example:

{
    "elements": [
        {
            "id": "2f2fe37f-01f2-4ffb-9a97-3fd7d60ada5e",
            "name": "demo-account",
            "modifiedAt": "2021-07-18T12:54:22.139933Z",
            "modifiedBy": "OpenLegacy",
            "description": "Demo Account",
            "bookmarked": false,
            "createdAt": "2021-07-18T12:54:22.139933Z",
            "additionalInfo": {
                "numOfAssets": 1,
                "numOfProjects": 1,
                "type": "oracle_db"
            }
        }
    ],
    "total": 1
}
Language
Credentials
Header
Click Try It! to start a request and see the response here!