Skip to content
Moltaro Docs

Return compact operational counters for runtime entitlements.

GET
/api/workspace/entitlement-operations/entitlements/summary
curl --request GET \
  --url 'https://example.com/api/workspace/entitlement-operations/entitlements/summary?ConditionFamily=0&TermKind=0&TermUnit=0'

Authorizations

Section titled “Authorizations”
  • None

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
ModelId
string

Optional entitlement model filter.

PlanId
string

Optional entitlement plan filter.

PlanFamilyIds
Array<string>

Optional plan family ids that at least one current linked plan family must match.

ConditionFamily
integer format: int32
Allowed values: 0 1 2 3

Optional active condition family on the current linked plan.

TermKind
integer format: int32
Allowed values: 0 1 2 3

Optional derived active term shape on the current linked plan.

TermValue
integer format: int32

Optional duration/window value paired with TermKind.

TermUnit
integer format: int32
Allowed values: 0 1 2

Optional duration/window unit paired with TermKind.

RenewalPolicyId
string

Optional renewal policy currently assigned to the linked plan.

ExpiringSoonDays
integer format: int32

Look-ahead window in days. Defaults to 30.

UsagePressureThresholdPercent
integer format: int32

Remaining quantity threshold percent. Defaults to 20.

access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data

Operational summary for the runtime entitlements page.

object
GeneratedAtUtc
string format: date-time
AppliedFilters
object
key
additional properties
string
ActiveEntitlements

Compact operational counter shown on the runtime entitlements page.

object
Key
string
nullable
Value
integer format: int64
Severity
string
nullable
ExpiringSoon

Compact operational counter shown on the runtime entitlements page.

object
Key
string
nullable
Value
integer format: int64
Severity
string
nullable
FailedRenewals

Compact operational counter shown on the runtime entitlements page.

object
Key
string
nullable
Value
integer format: int64
Severity
string
nullable
UsagePressure

Compact operational counter shown on the runtime entitlements page.

object
Key
string
nullable
Value
integer format: int64
Severity
string
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}