Skip to content
MoltaroMoltaroMoltaro Docs

Validate setup input without writing changes.

POST
/api/workspace/admin/entitlement-operations/setup-plan
curl --request POST \
  --url https://example.com/api/workspace/admin/entitlement-operations/setup-plan \
  --header 'Content-Type: application/json' \
  --data '{ "EntitlementModel": { "Key": "example", "DisplayName": "example", "Description": "example", "ModelType": 0, "PartyType": 0, "AccessMode": 0, "OwnerParty": { "DisplayName": "example", "EntityDefinitionId": "example", "InstancePickerInputType": 0, "InstanceLookupTableSelectorMode": 0, "InstanceLookupTableSurfaceKey": "example" }, "PartyDelegationPath": { "PathKey": "example" }, "ResourceScopeMode": 0, "Resource": { "DisplayName": "example", "EntityDefinitionId": "example", "ResourcePickerInputType": 0, "ResourceLookupTableSelectorMode": 0, "ResourceLookupTableSurfaceKey": "example" }, "ResourceHierarchyPath": { "PathKey": "example" }, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } }'

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.

Request Body

Section titled “Request Body”

Request used to validate a Moltaro Entitlement Operations setup without writing changes.

object
EntitlementModel
required

Entitlement model aggregate submitted by setup planning and settings screens.

object
Key
string
nullable
DisplayName
required
string
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
required

Party role submitted as part of an entitlement model.

object
DisplayName
required
string
EntityDefinitionId
required
string
InstancePickerInputType
integer format: int32
Allowed values: 0 1 2 3
InstanceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
InstanceLookupTableSurfaceKey
string
nullable
PartyDelegationPath

Delegation path submitted for a delegated entitlement model.

object
PathKey
required
string
ResourceScopeMode
integer format: int32
Allowed values: 0 1
Resource
required

Resource role submitted as part of an entitlement model.

object
DisplayName
required
string
EntityDefinitionId
required
string
ResourcePickerInputType
integer format: int32
Allowed values: 0 1 2 3
ResourceLookupTableSelectorMode
integer format: int32
Allowed values: 0 1
ResourceLookupTableSurfaceKey
string
nullable
ResourceHierarchyPath

Resource hierarchy path submitted when a model includes related resources.

object
PathKey
required
string
RowVersion
string format: uuid
nullable

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data

Validation plan returned by setup-plan without mutating configuration.

object
IsValid
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
PartyRoleCount
integer format: int32
ResourceRoleCount
integer format: int32
HasPartyDelegationPath
boolean
HasResourceHierarchyPath
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": {
    "Errors": [
      {
        "Type": 0,
        "Severity": 0
      }
    ],
    "Warnings": [
      {
        "Type": 0,
        "Severity": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
Data

Validation plan returned by setup-plan without mutating configuration.

object
IsValid
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
PartyRoleCount
integer format: int32
ResourceRoleCount
integer format: int32
HasPartyDelegationPath
boolean
HasResourceHierarchyPath
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": {
    "Errors": [
      {
        "Type": 0,
        "Severity": 0
      }
    ],
    "Warnings": [
      {
        "Type": 0,
        "Severity": 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"
}