read module

The read module API sends a GET request to retrieve a module.

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

Authorization: API key

Input parameters:

Field nameDescriptionFormat
idModule idUUID

Output parameters:

Field nameDescriptionFormat
idModule idUUID
nameModule nameString
modifiedAtDate-time module modifiedInstant
modifiedByUser who modified the moduleString
descriptionModule descriptionString
bookmarkedIs module bookmarkerd?Boolean
createdAtDate-time module was createdInstant
additionalInfoContainer - see belowAdditionalInfo

AdditionalInfo:

Field nameDescriptionFormat
numOfAssetsNumber of assets in moduleInteger
numOfProjectsNumber of projects containing moduleInteger
typeType of moduleString

Example:

{
    "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"
    }
}
Language
Credentials
Header
Click Try It! to start a request and see the response here!