Skip to content
MoltaroMoltaroMoltaro Docs

Return model editor bootstrap data.

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

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

Bootstrap data for the Moltaro Entitlement Operations model editor.

object
ModelTypes

Supported typed entitlement model descriptors.

Array<object>
nullable

One supported typed entitlement model option exposed by the server.

object
ModelType
integer format: int32
Allowed values: 0 1 2 3
Key
string
nullable
DisplayName
string
nullable
AllowsResourceHierarchy
boolean
PartyTypes
Array<integer>
nullable
Allowed values: 0 1 2
LimitFamilies
Array<integer>
nullable
Allowed values: 0 1 2 3
EntityDefinitions

Eligible EntityDefinitions and compatible fields.

Array<object>
nullable

EntityDefinition option shown in setup and settings screens.

object
Id
string
nullable
Name
string
nullable
DisplayNameSingular
string
nullable
DisplayNamePlural
string
nullable
Fields
Array<object>
nullable

Field option shown in setup and settings screens.

object
Id
string
nullable
EntityDefinitionId
string
nullable
Key
string
nullable
DisplayName
string
nullable
FieldType
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
ReferenceToEntityDefinitionId
string
nullable
IsDisplayNameCompatible
boolean
IsReferenceCompatible
boolean
TableSurfaces
Array<object>
nullable

Table surface option shown for runtime lookup selection.

object
Id
string
nullable
EntityDefinitionId
string
nullable
Key
string
nullable
DisplayName
string
nullable
IsDefault
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": {
    "ModelTypes": [
      {
        "ModelType": 0,
        "PartyTypes": [
          0
        ],
        "LimitFamilies": [
          0
        ]
      }
    ],
    "EntityDefinitions": [
      {
        "Fields": [
          {
            "FieldType": 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"
}