Skip to content
MoltaroMoltaroMoltaro Docs

Return active entitlement models available to runtime plan pages.

GET
/api/workspace/entitlement-operations/models
curl --request GET \
  --url https://example.com/api/workspace/entitlement-operations/models

Authorizations

Section titled “Authorizations”
  • None

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
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

Runtime model list for Entitlement Operations.

object
Items
Array<object>
nullable

Runtime entitlement model summary exposed to operational pages.

object
Id
string
nullable
Key
string
nullable
DisplayName
string
nullable
Description
string
nullable
ModelType
integer format: int32
Allowed values: 0 1 2 3
PartyType
integer format: int32
Allowed values: 0 1 2
AccessMode
integer format: int32
Allowed values: 0 1 2
OwnerParty

Runtime selector metadata for a party role.

object
Id
string
nullable
DisplayName
string
nullable
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
InstancePickerInputType
integer format: int32
Allowed values: 0 1 2 3
InstanceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
InstanceLookupTableSurfaceKey
string
nullable
DelegateParty

Runtime selector metadata for a party role.

object
Id
string
nullable
DisplayName
string
nullable
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
InstancePickerInputType
integer format: int32
Allowed values: 0 1 2 3
InstanceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
InstanceLookupTableSurfaceKey
string
nullable
ResourceScopeMode
integer format: int32
Allowed values: 0 1
ResourceBindingMode
integer format: int32
Allowed values: 0 1
Resource

Runtime selector metadata for a root resource role.

object
Id
string
nullable
DisplayName
string
nullable
EntityDefinitionId
string
nullable
EntityDisplayName
string
nullable
ResourcePickerInputType
integer format: int32
Allowed values: 0 1 2 3
ResourceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
ResourceLookupTableSurfaceKey
string
nullable
AllowedActions

Server-computed runtime actions for one entitlement model.

object
CanManagePlans
boolean
CanManageEntitlements
boolean
CanReadEntitlements
boolean
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
{
  "Data": {
    "Items": [
      {
        "ModelType": 0,
        "PartyType": 0,
        "AccessMode": 0,
        "OwnerParty": {
          "InstancePickerInputType": 0,
          "InstanceLookupTableSelectorMode": 0
        },
        "DelegateParty": {
          "InstancePickerInputType": 0,
          "InstanceLookupTableSelectorMode": 0
        },
        "ResourceScopeMode": 0,
        "ResourceBindingMode": 0,
        "Resource": {
          "ResourcePickerInputType": 0,
          "ResourceLookupTableSelectorMode": 0
        }
      }
    ]
  },
  "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"
}