Audit Business Concept Coverage (v3)

Returns read-only direct coverage for visible association targets of every supported type, plus direct and derived coverage for readable Forms and Dashboards.

Derived coverage follows backing-form and form-member references and includes an evidence path. It never creates or persists inferred associations; callers can use uncovered references as input to a governed human or AI review workflow.

REST Resource

POST /HyperionPlanning/rest/v3/applications/{application}/businessconcepts/action/coverage

Required Roles

Service Administrator

Requests

Supported Media Types: application/json

The following table summarizes the client request parameters:

Table 3-94 Audit Business Concept Coverage - Request Parameters

Name Description Type Required
application Application name. string Yes
objectTypes Object types to audit. array No
limit Maximum coverage records returned. integer No
includeUnassociatedReferences When true, includes readable form-member references that have no direct Business Concept association and may merit review. boolean No
referenceLimitPerArtifact Maximum unassociated member references returned for each artifact while totalUnassociatedReferences reports the full count. integer No

Sample Request Payload:

{
  "objectTypes": [
    "Dashboard",
    "Form"
  ],
  "limit": 100,
  "includeUnassociatedReferences": true,
  "referenceLimitPerArtifact": 25
}

Response

The following table lists the Response parameters:

Table 3-95 Audit Business Concept Coverage - Response Parameters

Name Description Type
items Returned Business Concept coverages. array
totalResults Number of readable artifacts matching the requested audit scope before limit is applied. integer
hasMore True when more readable artifacts match the audit scope than were returned. boolean

Sample Response:

{
  "items": [
    {
      "artifactId": "da2f51ec-d322-48a7-0000-c38fc846b761",
      "artifactType": "Form",
      "artifactName": "Revenue Planning",
      "artifactPath": "/Library/Revenue Planning",
      "directBusinessConcepts": [
        {
          "conceptId": "33333333-3333-4333-8333-333333333333",
          "conceptCode": "CUSTOM.RECURRING_REVENUE",
          "displayName": "Recurring Revenue",
          "relationship": "REPRESENTS",
          "evidencePath": []
        }
      ],
      "derivedBusinessConcepts": [],
      "missingDirectAssociations": [],
      "unassociatedReferences": [],
      "totalUnassociatedReferences": 0,
      "hasMoreUnassociatedReferences": false
    }
  ],
  "totalResults": 1,
  "hasMore": false
}