get https://api.ol-hub.com/backend/api/v1/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 name | Description | Format |
---|---|---|
offset | Integer | |
limit | Integer | |
bookmarked | Boolean | |
projectId | Project id | UUID |
module_type | ||
exclude_module_type |
Output parameters
Field name | Description | Format |
---|---|---|
elements | Container - see below | Elements |
total | Number of elements | Integer |
Elements:
Field name | Description | Format |
---|---|---|
id | Module id | UUID |
name | Module name | String |
modifiedAt | Date-time module was modified | Instant |
modifiedBy | User who modified the module | String |
description | Description text of module | String |
bookmarked | Is the module bookmarked? | Boolean |
createdAt | Date-time module was created | Instant |
additionalInfo | Container - see below | AdditionalInfo |
AdditionalInfo:
Field name | Description | Format |
---|---|---|
numOfAssets | Number of assets in module | Integer |
numOfProjects | Number of projects containing module | Integer |
type | Module type | String |
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
}