Retrieve evaluation/trial status for the current organization

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns the evaluation state of the organization -- trial days remaining, license edition, and pricing links.

Request URL

https://{server-hostname}:8383/dcapi/license/evaluationDetails

Scope

Admin.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/evaluationDetails.v1+jsonapplication/evaluationDetails.v1+jsonCopied!

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/license/evaluationDetails \
  --header 'Accept: application/evaluationDetails.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
evaluationDaysLeftlong

Days remaining in the trial/evaluation period. Present only in trial mode.

evalMsgstring

Localized trial banner message (e.g. 'Explore the product at its best for 22 days.'). Varies by remaining days.

priceQuoteMsgstring

CTA label for the pricing/quote action (e.g. 'Get Quote', 'Explore Editions'). Present only for admin users.

priceQuoteURLstring

Relative URL for the pricing/quote page. Present only for admin users.

isLicensePromotedboolean

True when the license has been promoted to a higher-edition trial. When true, additional promotion keys are included.

evaluationDaysstring

Days remaining in the promotional trial as a string. Present only when isLicensePromoted is true.

evalLicensestring

Localized message about the promotional trial state. Present only when isLicensePromoted is true.

recommendedPlanNamestring

The promoted edition name (e.g. 'Security'). Present only when isLicensePromoted is true.

buyNowstring

CTA label for purchasing the promoted edition. Present only when isLicensePromoted is true.

getQuotestring

CTA label for getting a quote. Present only when isLicensePromoted is true.

downgradeNowstring

CTA label for reverting to the previous edition. Present only when isLicensePromoted is true.

extendTrialstring

CTA label for extending the promotional trial. Present only when the trial has not yet been extended.

subscriptionstring

Label for the subscription page link. Present only when isLicensePromoted is true.

subscriptionUrlstring

Relative URL to the subscription page. Present only when isLicensePromoted is true.

- HTTP code 500

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_codeinteger

Error code. 1001 indicates an unexpected failure while retrieving evaluation details.

error_descriptionstring

Human-readable error message describing the failure.

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Organization is in trial mode with 22 days remaining

Copied!
  {
    "evaluationDaysLeft": 22,
    "priceQuoteMsg": "Get Quote",
    "priceQuoteURL": "/webclient#/uems/admin/subscription",
    "evalMsg": "Explore the product at its best for 22 days."
  }
                
Show full

License has been promoted to a higher-edition trial -- extendTrial present (trial not yet extended)

Copied!
  {
    "buyNow": "Buy Now",
    "getQuote": "Buy Now",
    "extendTrial": "Extend Trial",
    "subscription": "Subscription",
    "evaluationDays": "22",
    "recommendedPlanName": "Security",
    "downgradeNow": "Retain Current Edition",
    "isLicensePromoted": true,
    "evalMsg": "Try out the Security edition features for 22 more days.",
    "evalLicense": "Promoted Trial",
    "subscriptionUrl": "/webclient#/uems/admin/subscription"
  }
                
Show full

Promoted trial already extended once -- extendTrial key absent

Copied!
  {
    "buyNow": "Buy Now",
    "getQuote": "Buy Now",
    "subscription": "Subscription",
    "evaluationDays": "10",
    "recommendedPlanName": "Security",
    "downgradeNow": "Retain Current Edition",
    "isLicensePromoted": true,
    "evalMsg": "Try out the Security edition features for 10 more days.",
    "evalLicense": "Promoted Trial",
    "subscriptionUrl": "/webclient#/uems/admin/subscription"
  }
                
Show full

Registered or free edition -- not in trial, not promoted. Empty response.

Copied!
  {}
                
Show full

Sample Response: HTTP 500

Unexpected server error while fetching evaluation details

Copied!
  {
    "error_description": "An internal error occurred while processing the request.",
    "error_code": 1001
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.