Resolve Business Concepts from user language (v3)

Resolves natural-language user text to candidate Business Concepts. Resolve applies stronger weighting to synonyms, example phrases, and curated search keywords so AI agents can map user intent to governed concepts before looking up associated members, forms, dashboards, and other objects.

REST Resource

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

Required Roles

Service Administraror

Requests

Supported Media Types: application/json

The following table summarizes the client request parameters:

Table 3-90 Resolve Business Concepts - Request Parameters

Name Description Type Required
application Application name. string Yes
text Keyword or natural-language text to search or resolve. string Yes
locale Locale hint for matching text; defaults to the request locale. string No
limit Maximum number of matches to return. integer No

Sample Request Payload:

{
  "text": "How can I lower discretionary spend?",
  "locale": "en",
  "limit": 5
}

Response

The following table lists the Response parameters:

Table 3-91 Resolve Business Concepts - Response Parameters

Name Description Type
items Returned Business Concept matches. array
totalResults Number of returned matches. integer
hasMore True when more results are available. boolean

Sample Response:

{
  "items": [
    {
      "concept": {
        "id": "33333333-3333-4333-8333-333333333333",
        "code": "CUSTOM.DISCRETIONARY_SPEND",
        "displayName": "Discretionary Spend",
        "source": "CUSTOMER",
        "status": "APPROVED"
      },
      "score": 145,
      "matchedFields": [
        "examplePhrases"
      ],
      "matchedTerms": [
        "lower",
        "discretionary",
        "spend"
      ]
    }
  ],
  "totalResults": 1,
  "hasMore": false
}