You can use the Lucidum API to:
-
Retrieve a list of changes for a single asset or a single user with a description and data type for each field, the date of change, the old value, and the new value.
- Query Lucidum as you would from the Lucidum Query Builder, including using OR and AND statements
The following sections describe the endpoints for these actions.
Headers #
Requests to the endpoints in the Lucidum API v2 must also include a header with:
-
Content-Type of JSON.
Retrieve the List of Changes for an Asset: /CMDB/v2/data/metadata/cmdb/asset/change #
The endpoint for querying the list of changes for an asset in the Lucidum database. The response includes:
-
an entry for every change to each field in the record
-
a date-time stamp for each change
-
the old value and the new value for each change.
If a single field is changed multiple times, the response will include multiple entries for that single field.
|
Endpoint |
Method |
Parameters in URL |
|---|---|---|
|
/CMDB/v2/data/metadata/cmdb/asset/change |
GET |
|
Example cURL Query #
curl --location 'https://demo.lucidum.cloud/CMDB/v2/data/cmdb/asset/change?id=ZWMKXM1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer abcdefghijklmnowQRSTUV'-
Line 1. The cURL call. The method defaults to GET. The URL is host name plus the endpoint for the change management API. We included the parameter “id=ZWMKXM1”, to retrieve data about the asset ZWMKXM1.
-
Line 2. The header specifies to return results in JSON.
-
Line 3. The header specifies to use a Bearer Token for authentication and provides the bearer token.
Example Response #
{
"id": "ZWMKXM1",
"type": "Asset",
"field": "OS",
"oldValue": "Windows 7",
"newValue": "Windows XP",
"changeTimeEpoch": 1697161296,
"changeTimeUTC": "2023-10-13T01:41:36Z"
},
{
"id": "ZWMKXM1",
"type": "Asset",
"field": "OS",
"oldValue": "Windows XP",
"newValue": "Windows 7",
"changeTimeEpoch": 1696988393,
"changeTimeUTC": "2023-10-11T01:39:53Z"
},
{
"id": "ZWMKXM1",
"type": "Asset",
"field": "Risk_Score",
"oldValue": 2.0,
"newValue": 6.0,
"changeTimeEpoch": 1696988393,
"changeTimeUTC": "2023-10-11T01:39:53Z"
}The response displays details about changes to the field “OS” and the field “Risk Score”.
Retrieve the List of Changes for a User: /CMDB/v2/data/metadata/cmdb/user/change #
The endpoint for querying the list of changes for a user in the Lucidum database. The response includes:
-
an entry for every change to each field in the record
-
a date-time stamp for each change
-
the old value and the new value for each change.
If a single field is changed multiple times, the response will include multiple entries for that single field.
|
Endpoint |
Method |
Parameters in URL |
|---|---|---|
|
/CMDB/v2/data/metadata/cmdb/user/change |
GET |
|
Example cURL Query #
curl --location 'https://demo.lucidum.cloud/CMDB/v2/data/cmdb/user/change?id=AWRIGHT' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer abcdefghijklmnowQRSTUV
-
Line 1. The cURL call. The method defaults to GET. The URL is host name plus the endpoint for the change management API. We included the parameter “id=AWRIGHT”, to retrieve data about the user AWRIGHT.
-
Line 2. The header specifies to return results in JSON.
-
Line 3. The header specifies to use a Bearer Token for authentication and provides the bearer token.
Example Response #
{
"id": "AWRIGHT",
"type": "User",
"field": "Owner_Manager",
"oldValue": "Robert Cummings",
"newValue": "Ann Langholz",
"changeTimeEpoch": 1697161286,
"changeTimeUTC": "2023-10-13T01:41:26Z"
}
The response displays details about changes to the field “Owner_Manager”.
