Find related Business Objects
GET/api/ece/business-objects/:graphDBId/:id/related
Returns Business Objects that share at least one Global Entity with the source Business Object, ranked in descending order of the number of shared Global Entities (sharedEntityCount). This is shared-entity traversal, not relationship extraction. The source object, the candidates and the shared entities are all limited to documents the caller can read.
Requires the content-lake-api.graphs.read permission (or hxpr.manage.everything).
Request
Responses
- 200
- 400
- 401
- 404
- 422
- 429
- 500
- 503
One page of related Business Objects.
ECE-400-INVALID_PARAM for an invalid source ID or pagination values; ECE-400-INVALID_PAGE_SIZE when limit exceeds 100. A query parameter that is not a number (for example limit=abc) returns 400 ECE-400-INVALID_PARAM ("For input string: ..."). A search body that cannot be parsed (malformed JSON, a value of the wrong type, or no body) is rejected before the ECE handler with 400 and the platform's generic HxprErrorResponse body instead.
Not authenticated, or the caller lacks the required permission. Token and permission checks run before the ECE handler, so these failures use the platform's generic HxprErrorResponse body. ECE-401-UNAUTHENTICATED is returned when the graph backend rejects the caller's credentials.
ECE-404-NOT_FOUND: the graphDBId is unknown ("Unknown graphDBId:
ECE-422-UNSATISFIABLE_FILTER: the request is syntactically valid but the graph backend reports it as semantically impossible to satisfy.
ECE-429-RATE_LIMITED: the request was throttled. Wait for the number of seconds in the Retry-After header before retrying.
Response Headers
Number of seconds to wait before retrying (defaults to 2).
ECE-500-INTERNAL: unexpected server error. The message is always Internal Server Error; report the traceId rather than retrying blindly.
ECE-503-BACKEND_UNAVAILABLE: the graph backend is unavailable, no graph store is configured, or the query exceeded its deadline. Treat as transient and retry with backoff after the Retry-After interval.
Response Headers
Number of seconds to wait before retrying (defaults to 2).