Query Business Concept Associations (v3)

Returns a flat, pageable list of Business Concept associations for audit, governance, and AI introspection.

The q parameter accepts Mongo-style filters over fields such as concept, relationship, objectType, objectName, and objectPath.

REST Resource

GET /HyperionPlanning/rest/v3/applications/{application}/businessconceptassociations

Required Roles

Service Administrator

Requests

Supported Media Types: application/json

The following table summarizes the client request parameters:

Table 3-84 Query Business Concept Associations — Request Parameters

Name Description Type Required
application Application name. Specified in the resource path. string Yes
q Mongo-style JSON query filter. Specified as a query parameter. string No
offset Zero-based start index. integer No
limit Maximum number of associations to return. Default: 25. Maximum: 5000. integer No

Response

Success schema: BusinessConceptAssociationCollection

The following table lists the response parameters:

Table 3-85 Query Business Concept Associations — Response Parameters

Name Description Type
items Business Concept associations returned for the requested page. array of BusinessConceptAssociation
totalResults Number of associations matching the query before pagination. integer
hasMore true when more matching associations are available. boolean

Sample Response:

{
  "items": [
    {
      "concept": "CUSTOM.RECURRING_REVENUE",
      "relationship": "REPRESENTS",
      "objectId": "da2f51ec-d322-48a7-0000-c38fc846b761",
      "objectName": "Revenue Planning",
      "objectType": "Form",
      "objectPath": "/Library/Revenue Planning"
    }
  ],
  "totalResults": 1,
  "hasMore": false
}