Return runtime entitlements matching the supplied filters.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://example.com/api/workspace/entitlement-operations/entitlements?ConditionFamily=0&TermKind=0&TermUnit=0&Status=0"),};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/entitlement-operations/entitlements?ConditionFamily=0&TermKind=0&TermUnit=0&Status=0';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/api/workspace/entitlement-operations/entitlements?ConditionFamily=0&TermKind=0&TermUnit=0&Status=0'Authorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Optional entitlement model filter.
Optional entitlement plan filter.
Optional plan family ids that at least one current linked plan family must match.
Optional active condition family on the current linked plan.
Optional derived active term shape on the current linked plan.
Optional duration/window value paired with TermKind.
Optional duration/window unit paired with TermKind.
Optional renewal policy currently assigned to the linked plan.
Optional owner party role filter.
Optional owner party instance filter.
Optional lifecycle status filter.
Optional inclusive start boundary.
Optional inclusive start boundary end.
Optional inclusive end boundary.
Optional inclusive end boundary end.
Optional search text matched against plan/model/party display names.
One-based page number.
Requested page size.
Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Responses
Section titled “Responses”OK
object
Paginated runtime entitlement list response.
object
Runtime entitlement summary row.
object
Compact customer-owned entity instance reference.
object
Plan family reference shown on runtime entitlement rows.
object
Resource-neutral current invariant state and complete object-operation decision set.
object
object
Current safe state of every applicable enabled Business Invariant.
Current safe state of one Business Invariant target for one resource.
object
Stable invariant key.
Stable target key within the invariant.
Whether the invariant is active for the current resource state.
Localized safe active-state message, or null when inactive.
Explicit decision for every applicable and discoverable Object Operation Catalog entry on the current surface.
object
Composed current decision for one applicable object operation.
object
Stable Object Operation Catalog key.
Whether all independent authorities allow the operation.
Deterministically ordered safe denial details.
One safe denial contributing to a composed object-operation decision.
object
Identifies the independent authority that denied an object operation.
Stable source identity, such as an invariant key or domain policy key.
Stable machine-readable reason code.
Non-empty localized safe message.
object
object
object
object
Example
{ "Data": { "Items": [ { "ModelType": 0, "Status": 0, "EffectiveState": 0, "ObjectInvariant": { "Operations": { "additionalProperty": { "Denials": [ { "Source": 0 } ] } } } } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}