Discussions
Product Notice: Eloqua Application API User endpoints minimal depth change [May 2022]
Overview
With the arrival of Eloqua release 22B (May 2022), we have modified the Eloqua Application API endpoints used to retrieve Users, so that minimal depth will no longer return createdBy and updatedBy.
What’s changing?
With 22B, we have modified the Eloqua Application API endpoints used to retrieve Users, so that minimal depth will no longer return createdBy and updatedBy, impacting the following endpoints:
- 1.0
- Retrieve a user: GET /api/REST/1.0/system/user/{id}
- § Default depth is complete
- Retrieve a list of users: GET /api/REST/1.0/system/users
- Default depth is minimal
- Retrieve a user: GET /api/REST/1.0/system/user/{id}
- 2.0
- Retrieve a user: GET /api/REST/2.0/system/user/{id}
- Default depth is complete
- Retrieve a list of users: GET /api/REST/2.0/system/users
- Default depth is minimal
- Retrieve a user: GET /api/REST/2.0/system/user/{id}
Examples:
Before 22B, minimal depth would have returned createdBy and updatedBy for User endpoints:
Request:
GET /api/REST/2.0/system/users
Response: 200 OK
{
"elements": [
{
"type": "User",
"id": "11",
"createdAt": "1378838897",
"createdBy": "10",
"depth": "minimal",
"description": "API User",
"name": "API User",
"updatedAt": "1576714238",
"updatedBy": "11",
"isDisabled": "False"
},
{
"type": "User",
"id": "12",
"createdAt": "1393273317",
"createdBy": "11",
"depth": "minimal",
"description": "Test User",
"name": "Test User",
"updatedAt": "1528489352",
"updatedBy": "11",
"isDisabled": "True"
},
{
"type": "User",
"id": "14",
"createdAt": "1446843885",
"createdBy": "11",
"depth": "minimal",
"description": "Test Test",
"name": "Test Test",
"updatedAt": "1599160452",
"updatedBy": "11",
"isDisabled": "False"
}
],
"page": 1,
"pageSize": 1000,
"total": 3
}
After 22B, minimal depth now no longer return createdBy and updatedBy for User endpoints:
Request:
GET /api/REST/2.0/system/users
Response: 200 OK
{
"elements": [
{
"type": "User",
"id": "11",
"createdAt": "1378838897",
"depth": "minimal",
"description": "API User",
"name": "API User",
"updatedAt": "1576714238",
"isDisabled": "False"
},
{
"type": "User",
"id": "12",
"createdAt": "1393273317",
"depth": "minimal",
"description": "Test User",
"name": "Test User",
"updatedAt": "1528489352",
"isDisabled": "True"
},
{
"type": "User",
"id": "14",
"createdAt": "1446843885",
"depth": "minimal",
"description": "Test Test",
"name": "Test Test",
"updatedAt": "1599160452",
"isDisabled": "False"
}
],
"page": 1,
"pageSize": 1000,
"total": 3
}
Timeline
With the arrival of Eloqua release 22B (May 2022), we have modified the Eloqua Application API endpoints used to retrieve Users, so that minimal depth will no longer return createdBy and updatedBy. Check the Eloqua Release Center for specific dates and times.
Next Steps
If you are using the User endpoints with a depth of minimal to retrieve createdBy and updatedBy, these API calls should be updated to complete depth.
Additional Resources
View changes for Eloqua's APIs including, new features, significant recent changes, and platform notices, on the Eloqua Developer Changelog.
If you have questions, post a discussion on Developer Tools!
FAQ
Q: What endpoints are impacted by this change?
A: The following endpoints are impacted:
- 1.0
- Retrieve a user: GET /api/REST/1.0/system/user/{id}
- Default depth is complete
- Retrieve a list of users: GET /api/REST/1.0/system/users
- Default depth is minimal
- Retrieve a user: GET /api/REST/1.0/system/user/{id}
- 2.0
- Retrieve a user: GET /api/REST/2.0/system/user/{id}
- Default depth is complete
- Retrieve a user: GET /api/REST/2.0/system/user/{id}
- Retrieve a list of users: GET /api/REST/2.0/system/users
- Default depth is minimal
Group Product Manager, CX - Marketing: Eloqua